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