gromacs-dev 4.6.5-1build1 / usr / include / gromacs / names.h

/*
 * This file is part of the GROMACS molecular simulation package.
 *
 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
 * Copyright (c) 2001-2004, The GROMACS development team,
 * check out http://www.gromacs.org for more information.
 * Copyright (c) 2012,2013, by the GROMACS development team, led by
 * David van der Spoel, Berk Hess, Erik Lindahl, and including many
 * others, as listed in the AUTHORS file in the top-level source
 * directory and at http://www.gromacs.org.
 *
 * GROMACS is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 *
 * GROMACS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with GROMACS; if not, see
 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
 *
 * If you want to redistribute modifications to GROMACS, please
 * consider that scientific software is very special. Version
 * control is crucial - bugs must be traceable. We will be happy to
 * consider code for inclusion in the official distribution, but
 * derived work must not be called official GROMACS. Details are found
 * in the README & COPYING files - if they are missing, get the
 * official version at http://www.gromacs.org.
 *
 * To help us fund GROMACS development, we humbly ask that you cite
 * the research papers on the package. Check out http://www.gromacs.org.
 */

#ifndef _names_h
#define _names_h

#include "visibility.h"
#include "typedefs.h"

#ifdef __cplusplus
extern "C" {
#endif

/* All string arrays are NULL terminated, and therefore have an
 * extra argument (the +1)
 * these should correspond to names.c and include/types/enums.h
 */
GMX_LIBGMX_EXPORT
extern const char *epbc_names[epbcNR+1];
GMX_LIBGMX_EXPORT
extern const char *etcoupl_names[etcNR+1];
GMX_LIBGMX_EXPORT
extern const char *epcoupl_names[epcNR+1];
GMX_LIBGMX_EXPORT
extern const char *epcoupltype_names[epctNR+1];
GMX_LIBGMX_EXPORT
extern const char *erefscaling_names[erscNR+1];
GMX_LIBGMX_EXPORT
extern const char *ecutscheme_names[ecutsNR+1];
GMX_LIBGMX_EXPORT
extern const char *ens_names[ensNR+1];
GMX_LIBGMX_EXPORT
extern const char *ei_names[eiNR+1];
GMX_LIBGMX_EXPORT
extern const char *yesno_names[BOOL_NR+1];
GMX_LIBGMX_EXPORT
extern const char *bool_names[BOOL_NR+1];
GMX_LIBGMX_EXPORT
extern const char *eintmod_names[eintmodNR+1];
GMX_LIBGMX_EXPORT
extern const char *eel_names[eelNR+1];
GMX_LIBGMX_EXPORT
extern const char *eewg_names[eewgNR+1];
GMX_LIBGMX_EXPORT
extern const char *evdw_names[evdwNR+1];
GMX_LIBGMX_EXPORT
extern const char *econstr_names[econtNR+1];
GMX_LIBGMX_EXPORT
extern const char *ptype_str[eptNR+1];
GMX_LIBGMX_EXPORT
extern const char *egrp_nm[egNR+1];
GMX_LIBGMX_EXPORT
extern const char *edisre_names[edrNR+1];
GMX_LIBGMX_EXPORT
extern const char *edisreweighting_names[edrwNR+1];
GMX_LIBGMX_EXPORT
extern const char *enbf_names[eNBF_NR+1];
GMX_LIBGMX_EXPORT
extern const char *ecomb_names[eCOMB_NR+1];
GMX_LIBGMX_EXPORT
extern const char *gtypes[egcNR+1];
GMX_LIBGMX_EXPORT
extern const char *esimtemp_names[esimtempNR+1];
GMX_LIBGMX_EXPORT
extern const char *efep_names[efepNR+1];
GMX_LIBGMX_EXPORT
extern const char *efpt_names[efptNR+1];
GMX_LIBGMX_EXPORT
extern const char *efpt_singular_names[efptNR+1];
GMX_LIBGMX_EXPORT
extern const char *elamstats_names[elamstatsNR+1];
GMX_LIBGMX_EXPORT
extern const char *elmcmove_names[elmcmoveNR+1];
GMX_LIBGMX_EXPORT
extern const char *elmceq_names[elmceqNR+1];
GMX_LIBGMX_EXPORT
extern const char *separate_dhdl_file_names[esepdhdlfileNR+1];
GMX_LIBGMX_EXPORT
extern const char *dhdl_derivatives_names[edhdlderivativesNR+1];
GMX_LIBGMX_EXPORT
extern const char *esol_names[esolNR+1];
GMX_LIBGMX_EXPORT
extern const char *edispc_names[edispcNR+1];
GMX_LIBGMX_EXPORT
extern const char *ecm_names[ecmNR+1];
GMX_LIBGMX_EXPORT
extern const char *eann_names[eannNR+1];
GMX_LIBGMX_EXPORT
extern const char *egb_names[egbNR+1];
GMX_LIBGMX_EXPORT
extern const char *eis_names[eisNR+1];
GMX_LIBGMX_EXPORT
extern const char *esa_names[esaNR+1];
GMX_LIBGMX_EXPORT
extern const char *ewt_names[ewtNR+1];
GMX_LIBGMX_EXPORT
extern const char *epull_names[epullNR+1];
GMX_LIBGMX_EXPORT
extern const char *epullg_names[epullgNR+1];
GMX_LIBGMX_EXPORT
extern const char *erotg_names[erotgNR+1];
extern const char *erotg_originnames[erotgNR+1];
GMX_LIBGMX_EXPORT
extern const char *erotg_fitnames[erotgFitNR+1];
GMX_LIBGMX_EXPORT
extern const char *eQMmethod_names[eQMmethodNR+1];
GMX_LIBGMX_EXPORT
extern const char *eQMbasis_names[eQMbasisNR+1];
GMX_LIBGMX_EXPORT
extern const char *eQMMMscheme_names[eQMMMschemeNR+1];
extern const char *eMultentOpt_names[eMultentOptNR+1];
GMX_LIBGMX_EXPORT
extern const char *eAdresstype_names[eAdressNR+1];
GMX_LIBGMX_EXPORT
extern const char *eAdressICtype_names[eAdressICNR+1];
GMX_LIBGMX_EXPORT
extern const char *eAdressSITEtype_names[eAdressSITENR+1];
GMX_LIBGMX_EXPORT
extern const char *gmx_nblist_geometry_names[GMX_NBLIST_GEOMETRY_NR+1];
extern const char *gmx_nbkernel_elec_names[GMX_NBKERNEL_ELEC_NR+1];
extern const char *gmx_nbkernel_vdw_names[GMX_NBKERNEL_VDW_NR+1];

#define UNDEFINED       "UNDEFINED"
#define ENUM_NAME(e, max, names)  ((((e) < 0) || ((e) >= (max))) ? UNDEFINED : (names)[e])

#define EBOOL(e)       ENUM_NAME(e, BOOL_NR, bool_names)
#define ECUTSCHEME(e)  ENUM_NAME(e, ecutsNR, ecutscheme_names)
#define ENS(e)         ENUM_NAME(e, ensNR, ens_names)
#define EI(e)          ENUM_NAME(e, eiNR, ei_names)
#define EPBC(e)        ENUM_NAME(e, epbcNR, epbc_names)
#define ETCOUPLTYPE(e) ENUM_NAME(e, etcNR, etcoupl_names)
#define EPCOUPLTYPE(e) ENUM_NAME(e, epcNR, epcoupl_names)
#define EPCOUPLTYPETYPE(e) ENUM_NAME(e, epctNR, epcoupltype_names)
#define EREFSCALINGTYPE(e) ENUM_NAME(e, erscNR, erefscaling_names)
#define EBLOCKS(e)     ENUM_NAME(e, ebNR, eblock_names)
#define EPARAM(e)      ENUM_NAME(e, epNR, eparam_names)
#define INTMODIFIER(e) ENUM_NAME(e, eintmodNR, eintmod_names)
#define EELTYPE(e)     ENUM_NAME(e, eelNR, eel_names)
#define EVDWTYPE(e)    ENUM_NAME(e, evdwNR, evdw_names)
#define ECONSTRTYPE(e) ENUM_NAME(e, econtNR, econstr_names)
#define EDISRETYPE(e)  ENUM_NAME(e, edrNR, edisre_names)
#define EDISREWEIGHTING(e)  ENUM_NAME(e, edrwNR, edisreweighting_names)
#define ENBFNAME(e)    ENUM_NAME(e, eNBF_NR, enbf_names)
#define ECOMBNAME(e)   ENUM_NAME(e, eCOMB_NR, ecomb_names)
#define ESIMTEMP(e)    ENUM_NAME(e, esimtempNR, esimtemp_names)
#define EFEPTYPE(e)    ENUM_NAME(e, efepNR, efep_names)
#define SEPDHDLFILETYPE(e) ENUM_NAME(e, esepdhdlfileNR, separate_dhdl_file_names)
#define DHDLDERIVATIVESTYPE(e) ENUM_NAME(e, edhdlderivativesNR, dhdl_derivatives_names)
#define ESOLTYPE(e)    ENUM_NAME(e, esolNR, esol_names)
#define ENLISTTYPE(e)  ENUM_NAME(e, enlistNR, enlist_names)
#define EDISPCORR(e)   ENUM_NAME(e, edispcNR, edispc_names)
#define ECOM(e)        ENUM_NAME(e, ecmNR, ecm_names)
#define EANNEAL(e)      ENUM_NAME(e, eannNR, eann_names)
#define EGBALGORITHM(e) ENUM_NAME(e, egbNR, egb_names)
#define ESAALGORITHM(e) ENUM_NAME(e, esaNR, esa_names)
#define EIMPLICITSOL(e) ENUM_NAME(e, eisNR, eis_names)
#define EWALLTYPE(e)   ENUM_NAME(e, ewtNR, ewt_names)
#define EPULLTYPE(e)   ENUM_NAME(e, epullNR, epull_names)
#define EPULLGEOM(e)   ENUM_NAME(e, epullgNR, epullg_names)
#define EROTGEOM(e)    ENUM_NAME(e, erotgNR, erotg_names)
#define EROTORIGIN(e)  ENUM_NAME(e, erotgOriginNR, erotg_originnames)
#define EROTFIT(e)     ENUM_NAME(e, erotgFitNR, erotg_fitnames)
#define EQMMETHOD(e)   ENUM_NAME(e, eQMmethodNR, eQMmethod_names)
#define EQMBASIS(e)    ENUM_NAME(e, eQMbasisNR, eQMbasis_names)
#define EQMMMSCHEME(e) ENUM_NAME(e, eQMMMschemeNR, eQMMMscheme_names)
#define EMULTENTOPT(e) ENUM_NAME(e, eMultentOptNR, eMultentOpt_names)
#define EADRESSTYPE(e) ENUM_NAME(e, eAdressNR, eAdresstype_names)
#define EADRESSICTYPE(e) ENUM_NAME(e, eAdressICNR, eAdressICtype_names)
#define EADRESSSITETYPE(e) ENUM_NAME(e, eAdressSITENR, eAdressSITEtype_names)

#ifdef __cplusplus
}
#endif

#endif  /* _names_h */