src/gromacs/utility/errorcodes.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,2014,2015,2016,2019, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \internal \file
  36  * \brief
  37  * Implements functions in errorcodes.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "errorcodes.h"
  45
  46 namespace gmx
  47 {
  48
  49 namespace
  50 {
  51
  52 /*! \brief
  53  * Strings corresponding to gmx::ErrorCode values.
  54  *
  55  * This has to match the enum in errorcodes.h!
  56  *
  57  * \ingroup module_utility
  58  */
  59 const char* const error_names[] = {
  60     "No error",
  61     "Out of memory",
  62     "File not found",
  63     "System I/O error",
  64     "Error in user input",
  65     "Inconsistency in user input",
  66     "Requested tolerance cannot be achieved",
  67     "Simulation instability detected",
  68
  69     "Feature not implemented",
  70     "Invalid value (bug)",
  71     "Invalid call (bug)",
  72     "Internal error (bug)",
  73     "API error (bug)",
  74     "Range checking error (possible bug)",
  75     "Communication (parallel processing) problem",
  76
  77     "Unknown error",
  78 };
  79
  80 } // namespace
  81
  82 const char* getErrorCodeString(int errorcode)
  83 {
  84     if (errorcode < 0 || errorcode >= eeUnknownError)
  85     {
  86         errorcode = eeUnknownError;
  87     }
  88     return error_names[errorcode];
  89 }
  90
  91 } // namespace gmx