Implemented changes to preprocessor to work with MiMiC QM/MM
[alexxy/gromacs.git] / src / gromacs / mdtypes / md_enums.h
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5  * Copyright (c) 2001-2004, The GROMACS development team.
6  * Copyright (c) 2013,2014,2015,2016,2017,2018, by the GROMACS development team, led by
7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
8  * and including many others, as listed in the AUTHORS file in the
9  * top-level source directory and at http://www.gromacs.org.
10  *
11  * GROMACS is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public License
13  * as published by the Free Software Foundation; either version 2.1
14  * of the License, or (at your option) any later version.
15  *
16  * GROMACS is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public
22  * License along with GROMACS; if not, see
23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
25  *
26  * If you want to redistribute modifications to GROMACS, please
27  * consider that scientific software is very special. Version
28  * control is crucial - bugs must be traceable. We will be happy to
29  * consider code for inclusion in the official distribution, but
30  * derived work must not be called official GROMACS. Details are found
31  * in the README & COPYING files - if they are missing, get the
32  * official version at http://www.gromacs.org.
33  *
34  * To help us fund GROMACS development, we humbly ask that you cite
35  * the research papers on the package. Check out http://www.gromacs.org.
36  */
37 /*! \file
38  * \brief
39  * Declares enumerated types used throughout the code.
40  *
41  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
42  * \inpublicapi
43  * \ingroup module_mdtypes
44  */
45 #ifndef GMX_MDTYPES_MD_ENUMS_H
46 #define GMX_MDTYPES_MD_ENUMS_H
47
48 #include "gromacs/utility/basedefinitions.h"
49
50 /*! \brief Return a string from a list of strings
51  *
52  * If index if within 0 .. max_index-1 returns the corresponding string
53  * or "no name defined" otherwise, in other words this is a range-check that does
54  * not crash.
55  * \param[in] index     The index in the array
56  * \param[in] max_index The length of the array
57  * \param[in] names     The array
58  * \return the correct string or "no name defined"
59  */
60 const char *enum_name(int index, int max_index, const char *names[]);
61
62 //! Boolean strings no or yes
63 extern const char *yesno_names[BOOL_NR+1];
64
65 //! \brief The two compartments for CompEL setups.
66 enum eCompartment {
67     eCompA, eCompB, eCompNR
68 };
69
70 /*! \brief The channels that define with their COM the compartment boundaries in CompEL setups.
71  *
72  * In principle one could also use modified setups with more than two channels.
73  */
74 enum eChannel {
75     eChan0, eChan1, eChanNR
76 };
77
78 /*! \brief Temperature coupling type
79  *
80  * yes is an alias for berendsen
81  */
82 enum {
83     etcNO, etcBERENDSEN, etcNOSEHOOVER, etcYES, etcANDERSEN, etcANDERSENMASSIVE, etcVRESCALE, etcNR
84 };
85 //! Strings corresponding to temperatyre coupling types
86 extern const char *etcoupl_names[etcNR+1];
87 //! Macro for selecting t coupling string
88 #define ETCOUPLTYPE(e) enum_name(e, etcNR, etcoupl_names)
89 //! Return whether this is andersen coupling
90 #define ETC_ANDERSEN(e) (((e) == etcANDERSENMASSIVE) || ((e) == etcANDERSEN))
91
92 /*! \brief Pressure coupling types
93  *
94  * isotropic is an alias for berendsen
95  */
96 enum {
97     epcNO, epcBERENDSEN, epcPARRINELLORAHMAN, epcISOTROPIC, epcMTTK, epcNR
98 };
99 //! String corresponding to pressure coupling algorithm
100 extern const char *epcoupl_names[epcNR+1];
101 //! Macro to return the correct pcoupling string
102 #define EPCOUPLTYPE(e) enum_name(e, epcNR, epcoupl_names)
103
104 //! Flat-bottom posres geometries
105 enum {
106     efbposresZERO, efbposresSPHERE, efbposresCYLINDER, efbposresX, efbposresY, efbposresZ,
107     efbposresCYLINDERX, efbposresCYLINDERY, efbposresCYLINDERZ, efbposresNR
108 };
109
110 //! Relative coordinate scaling type for position restraints.
111 enum {
112     erscNO, erscALL, erscCOM, erscNR
113 };
114 //! String corresponding to relativ coordinate scaling.
115 extern const char *erefscaling_names[erscNR+1];
116 //! Macro to select correct coordinate scaling string.
117 #define EREFSCALINGTYPE(e) enum_name(e, erscNR, erefscaling_names)
118
119 //! Trotter decomposition extended variable parts.
120 enum {
121     etrtNONE, etrtNHC, etrtBAROV, etrtBARONHC, etrtNHC2, etrtBAROV2, etrtBARONHC2,
122     etrtVELOCITY1, etrtVELOCITY2, etrtPOSITION, etrtSKIPALL, etrtNR
123 };
124
125 //! Sequenced parts of the trotter decomposition.
126 enum {
127     ettTSEQ0,  ettTSEQ1,  ettTSEQ2,  ettTSEQ3,  ettTSEQ4, ettTSEQMAX
128 };
129
130 //! Pressure coupling type
131 enum {
132     epctISOTROPIC, epctSEMIISOTROPIC, epctANISOTROPIC,
133     epctSURFACETENSION, epctNR
134 };
135 //! String corresponding to pressure coupling type
136 extern const char *epcoupltype_names[epctNR+1];
137 //! Macro to select the right string for pcoupl type
138 #define EPCOUPLTYPETYPE(e) enum_name(e, epctNR, epcoupltype_names)
139
140 //! \\brief Cutoff scheme
141 enum {
142     ecutsVERLET, ecutsGROUP, ecutsNR
143 };
144 //! String corresponding to cutoff scheme
145 extern const char *ecutscheme_names[ecutsNR+1];
146 //! Macro to select the right string for cutoff scheme
147 #define ECUTSCHEME(e)  enum_name(e, ecutsNR, ecutscheme_names)
148
149 /*! \brief Coulomb / VdW interaction modifiers.
150  *
151  * grompp replaces eintmodPOTSHIFT_VERLET by eintmodPOTSHIFT or eintmodNONE.
152  * Exactcutoff is only used by Reaction-field-zero, and is not user-selectable.
153  */
154 enum eintmod {
155     eintmodPOTSHIFT_VERLET, eintmodPOTSHIFT, eintmodNONE, eintmodPOTSWITCH, eintmodEXACTCUTOFF, eintmodFORCESWITCH, eintmodNR
156 };
157 //! String corresponding to interaction modifiers
158 extern const char *eintmod_names[eintmodNR+1];
159 //! Macro to select the correct string for modifiers
160 #define INTMODIFIER(e) enum_name(e, eintmodNR, eintmod_names)
161
162 /*! \brief Cut-off treatment for Coulomb */
163 enum {
164     eelCUT,     eelRF,     eelGRF,   eelPME,  eelEWALD,  eelP3M_AD,
165     eelPOISSON, eelSWITCH, eelSHIFT, eelUSER, eelGB_NOTUSED, eelRF_NEC_UNSUPPORTED, eelENCADSHIFT,
166     eelPMEUSER, eelPMESWITCH, eelPMEUSERSWITCH, eelRF_ZERO, eelNR
167 };
168 //! String corresponding to Coulomb treatment
169 extern const char *eel_names[eelNR+1];
170 //! Macro for correct string for Coulomb treatment
171 #define EELTYPE(e)     enum_name(e, eelNR, eel_names)
172
173 //! Ewald geometry.
174 enum {
175     eewg3D, eewg3DC, eewgNR
176 };
177 //! String corresponding to Ewald geometry
178 extern const char *eewg_names[eewgNR+1];
179
180 //! Macro telling us whether we use reaction field
181 #define EEL_RF(e) ((e) == eelRF || (e) == eelGRF || (e) == eelRF_NEC_UNSUPPORTED || (e) == eelRF_ZERO )
182
183 //! Macro telling us whether we use PME
184 #define EEL_PME(e)  ((e) == eelPME || (e) == eelPMESWITCH || (e) == eelPMEUSER || (e) == eelPMEUSERSWITCH || (e) == eelP3M_AD)
185 //! Macro telling us whether we use PME or full Ewald
186 #define EEL_PME_EWALD(e) (EEL_PME(e) || (e) == eelEWALD)
187 //! Macro telling us whether we use full electrostatics of any sort
188 #define EEL_FULL(e) (EEL_PME_EWALD(e) || (e) == eelPOISSON)
189 //! Macro telling us whether we use user defined electrostatics
190 #define EEL_USER(e) ((e) == eelUSER || (e) == eelPMEUSER || (e) == (eelPMEUSERSWITCH))
191
192 //! Van der Waals interaction treatment
193 enum {
194     evdwCUT, evdwSWITCH, evdwSHIFT, evdwUSER, evdwENCADSHIFT,
195     evdwPME, evdwNR
196 };
197 //! String corresponding to Van der Waals treatment
198 extern const char *evdw_names[evdwNR+1];
199 //! Macro for selecting correct string for VdW treatment
200 #define EVDWTYPE(e)    enum_name(e, evdwNR, evdw_names)
201
202 //! Type of long-range VdW treatment of combination rules
203 enum {
204     eljpmeGEOM, eljpmeLB, eljpmeNR
205 };
206 //! String for LJPME combination rule treatment
207 extern const char *eljpme_names[eljpmeNR+1];
208 //! Macro for correct LJPME comb rule name
209 #define ELJPMECOMBNAMES(e) enum_name(e, eljpmeNR, eljpme_names)
210
211 //! Macro to tell us whether we use LJPME
212 #define EVDW_PME(e) ((e) == evdwPME)
213
214 //! Neighborsearching algorithm
215 enum {
216     ensGRID, ensSIMPLE, ensNR
217 };
218 //! String corresponding to neighborsearching
219 extern const char *ens_names[ensNR+1];
220 //! Macro for correct NS algorithm
221 #define ENS(e)         enum_name(e, ensNR, ens_names)
222
223 /*! \brief Integrator algorithm
224  *
225  * eiSD2 has been removed, but we keep a renamed enum entry,
226  * so we can refuse to do MD with such .tpr files.
227  * eiVV is normal velocity verlet
228  * eiVVAK uses 1/2*(KE(t-dt/2)+KE(t+dt/2)) as the kinetic energy,
229  * and the half step kinetic energy for temperature control
230  */
231 enum {
232     eiMD, eiSteep, eiCG, eiBD, eiSD2_REMOVED, eiNM, eiLBFGS, eiTPI, eiTPIC, eiSD1, eiVV, eiVVAK, eiMimic, eiNR
233 };
234 //! Name of the integrator algorithm
235 extern const char *ei_names[eiNR+1];
236 //! Macro returning integrator string
237 #define EI(e)          enum_name(e, eiNR, ei_names)
238 //! Do we use MiMiC QM/MM?
239 #define EI_MIMIC(e) ((e) == eiMimic)
240 //! Do we use velocity Verlet
241 #define EI_VV(e) ((e) == eiVV || (e) == eiVVAK)
242 //! Do we use molecular dynamics
243 #define EI_MD(e) ((e) == eiMD || EI_VV(e) || EI_MIMIC(e))
244 //! Do we use stochastic dynamics
245 #define EI_SD(e) ((e) == eiSD1)
246 //! Do we use any stochastic integrator
247 #define EI_RANDOM(e) (EI_SD(e) || (e) == eiBD)
248 /*above integrators may not conserve momenta*/
249 //! Do we use any type of dynamics
250 #define EI_DYNAMICS(e) (EI_MD(e) || EI_RANDOM(e))
251 //! Or do we use minimization
252 #define EI_ENERGY_MINIMIZATION(e) ((e) == eiSteep || (e) == eiCG || (e) == eiLBFGS)
253 //! Do we apply test particle insertion
254 #define EI_TPI(e) ((e) == eiTPI || (e) == eiTPIC)
255 //! Do we deal with particle velocities
256 #define EI_STATE_VELOCITY(e) (EI_MD(e) || EI_SD(e))
257
258 //! Constraint algorithm
259 enum {
260     econtLINCS, econtSHAKE, econtNR
261 };
262 //! String corresponding to constraint algorithm
263 extern const char *econstr_names[econtNR+1];
264 //! Macro to select the correct string
265 #define ECONSTRTYPE(e) enum_name(e, econtNR, econstr_names)
266
267 //! Distance restraint refinement algorithm
268 enum {
269     edrNone, edrSimple, edrEnsemble, edrNR
270 };
271 //! String corresponding to distance restraint algorithm
272 extern const char *edisre_names[edrNR+1];
273 //! Macro to select the right disre algorithm string
274 #define EDISRETYPE(e)  enum_name(e, edrNR, edisre_names)
275
276 //! Distance restraints weighting type
277 enum {
278     edrwConservative, edrwEqual, edrwNR
279 };
280 //! String corresponding to distance restraint weighting
281 extern const char *edisreweighting_names[edrwNR+1];
282 //! Macro corresponding to dr weighting
283 #define EDISREWEIGHTING(e)  enum_name(e, edrwNR, edisreweighting_names)
284
285 //! Combination rule algorithm.
286 enum {
287     eCOMB_NONE, eCOMB_GEOMETRIC, eCOMB_ARITHMETIC, eCOMB_GEOM_SIG_EPS, eCOMB_NR
288 };
289 //! String for combination rule algorithm
290 extern const char *ecomb_names[eCOMB_NR+1];
291 //! Macro to select the comb rule string
292 #define ECOMBNAME(e)   enum_name(e, eCOMB_NR, ecomb_names)
293
294 //! Van der Waals potential.
295 enum {
296     eNBF_NONE, eNBF_LJ, eNBF_BHAM, eNBF_NR
297 };
298 //! String corresponding to Van der Waals potential
299 extern const char *enbf_names[eNBF_NR+1];
300 //! Macro for correct VdW potential string
301 #define ENBFNAME(e)    enum_name(e, eNBF_NR, enbf_names)
302
303 //! Simulated tempering methods.
304 enum {
305     esimtempGEOMETRIC, esimtempEXPONENTIAL, esimtempLINEAR, esimtempNR
306 };
307 //! String corresponding to simulated tempering
308 extern const char *esimtemp_names[esimtempNR+1];
309 //! Macro for correct tempering string
310 #define ESIMTEMP(e)    enum_name(e, esimtempNR, esimtemp_names)
311
312 /*! \brief Free energy perturbation type
313  *
314  * efepNO, there are no evaluations at other states.
315  * efepYES, treated equivalently to efepSTATIC.
316  * efepSTATIC, then lambdas do not change during the simulation.
317  * efepSLOWGROWTH, then the states change monotonically
318  * throughout the simulation.
319  * efepEXPANDED, then expanded ensemble simulations are occuring.
320  */
321 enum {
322     efepNO, efepYES, efepSTATIC, efepSLOWGROWTH, efepEXPANDED, efepNR
323 };
324 //! String corresponding to FEP type.
325 extern const char *efep_names[efepNR+1];
326 //! Macro corresponding to FEP string.
327 #define EFEPTYPE(e)    enum_name(e, efepNR, efep_names)
328
329 //! Free energy pertubation coupling types.
330 enum {
331     efptFEP, efptMASS, efptCOUL, efptVDW, efptBONDED, efptRESTRAINT, efptTEMPERATURE, efptNR
332 };
333 //! String for FEP coupling type
334 extern const char *efpt_names[efptNR+1];
335 //! Long names for FEP coupling type
336 extern const char *efpt_singular_names[efptNR+1];
337
338 /*! \brief What to print for free energy calculations
339  *
340  * Printing the energy to the free energy dhdl file.
341  * YES is an alias to TOTAL, and
342  * will be converted in readir, so we never have to account for it in code.
343  */
344 enum {
345     edHdLPrintEnergyNO, edHdLPrintEnergyTOTAL, edHdLPrintEnergyPOTENTIAL, edHdLPrintEnergyYES, edHdLPrintEnergyNR
346 };
347 //! String corresponding to printing of free energy
348 extern const char *edHdLPrintEnergy_names[edHdLPrintEnergyNR+1];
349
350 /*! \brief How the lambda weights are calculated
351  *
352  * elamstatsMETROPOLIS - using the metropolis criteria
353  * elamstatsBARKER     - using the Barker critera for transition weights,
354  *                       also called unoptimized Bennett
355  * elamstatsMINVAR     - using Barker + minimum variance for weights
356  * elamstatsWL         - Wang-Landu (using visitation counts)
357  * elamstatsWWL        - Weighted Wang-Landau (using optimized Gibbs
358  *                       weighted visitation counts)
359  */
360 enum {
361     elamstatsNO, elamstatsMETROPOLIS, elamstatsBARKER, elamstatsMINVAR, elamstatsWL, elamstatsWWL, elamstatsNR
362 };
363 //! String corresponding to lambda weights
364 extern const char *elamstats_names[elamstatsNR+1];
365 //! Macro telling us whether we use expanded ensemble
366 #define ELAMSTATS_EXPANDED(e) ((e) > elamstatsNO)
367 //! Macro telling us whether we use some kind of Wang-Landau
368 #define EWL(e) ((e) == elamstatsWL || (e) == elamstatsWWL)
369
370 /*! \brief How moves in lambda are calculated
371  *
372  * elmovemcMETROPOLIS - using the Metropolis criteria, and 50% up and down
373  * elmovemcBARKER     - using the Barker criteria, and 50% up and down
374  * elmovemcGIBBS      - computing the transition using the marginalized
375  *                      probabilities of the lambdas
376  * elmovemcMETGIBBS   - computing the transition using the metropolized
377  *                      version of Gibbs (Monte Carlo Strategies in
378  *                      Scientific computing, Liu, p. 134)
379  */
380 enum {
381     elmcmoveNO, elmcmoveMETROPOLIS, elmcmoveBARKER, elmcmoveGIBBS, elmcmoveMETGIBBS, elmcmoveNR
382 };
383 //! String corresponding to lambda moves
384 extern const char *elmcmove_names[elmcmoveNR+1];
385
386 /*! \brief How we decide whether weights have reached equilibrium
387  *
388  * elmceqNO       - never stop, weights keep going
389  * elmceqYES      - fix the weights from the beginning; no movement
390  * elmceqWLDELTA  - stop when the WL-delta falls below a certain level
391  * elmceqNUMATLAM - stop when we have a certain number of samples at
392  *                  every step
393  * elmceqSTEPS    - stop when we've run a certain total number of steps
394  * elmceqSAMPLES  - stop when we've run a certain total number of samples
395  * elmceqRATIO    - stop when the ratio of samples (lowest to highest)
396  *                  is sufficiently large
397  */
398 enum {
399     elmceqNO, elmceqYES, elmceqWLDELTA, elmceqNUMATLAM, elmceqSTEPS, elmceqSAMPLES, elmceqRATIO, elmceqNR
400 };
401 //! String corresponding to equilibrium algorithm
402 extern const char *elmceq_names[elmceqNR+1];
403
404 /*! \brief separate_dhdl_file selection
405  *
406  * NOTE: YES is the first one. Do NOT interpret this one as a gmx_bool
407  */
408 enum
409 {
410     esepdhdlfileYES, esepdhdlfileNO, esepdhdlfileNR
411 };
412 //! String corresponding to separate DHDL file selection
413 extern const char *separate_dhdl_file_names[esepdhdlfileNR+1];
414 //! Monster macro for DHDL file selection
415 #define SEPDHDLFILETYPE(e) enum_name(e, esepdhdlfileNR, separate_dhdl_file_names)
416
417 /*! \brief dhdl_derivatives selection \
418  *
419  * NOTE: YES is the first one. Do NOT interpret this one as a gmx_bool
420  */
421 enum
422 {
423     edhdlderivativesYES, edhdlderivativesNO, edhdlderivativesNR
424 };
425 //! String for DHDL derivatives
426 extern const char *dhdl_derivatives_names[edhdlderivativesNR+1];
427 //! YAMM (Yet another monster macro)
428 #define DHDLDERIVATIVESTYPE(e) enum_name(e, edhdlderivativesNR, dhdl_derivatives_names)
429
430 /*! \brief Solvent model
431  *
432  * Distinguishes classical water types with 3 or 4 particles
433  */
434 enum {
435     esolNO, esolSPC, esolTIP4P, esolNR
436 };
437 //! String corresponding to solvent type
438 extern const char *esol_names[esolNR+1];
439 //! Macro lest we print the wrong solvent model string
440 #define ESOLTYPE(e)    enum_name(e, esolNR, esol_names)
441
442 //! Dispersion correction.
443 enum {
444     edispcNO, edispcEnerPres, edispcEner, edispcAllEnerPres, edispcAllEner, edispcNR
445 };
446 //! String corresponding to dispersion corrections
447 extern const char *edispc_names[edispcNR+1];
448 //! Macro for dispcorr string
449 #define EDISPCORR(e)   enum_name(e, edispcNR, edispc_names)
450
451 //! Center of mass motion removal algorithm.
452 enum {
453     ecmLINEAR, ecmANGULAR, ecmNO, ecmLINEAR_ACCELERATION_CORRECTION, ecmNR
454 };
455 //! String corresponding to COM removal
456 extern const char *ecm_names[ecmNR+1];
457 //! Macro for COM removal string
458 #define ECOM(e)        enum_name(e, ecmNR, ecm_names)
459
460 //! Algorithm for simulated annealing.
461 enum {
462     eannNO, eannSINGLE, eannPERIODIC, eannNR
463 };
464 //! String for simulated annealing
465 extern const char *eann_names[eannNR+1];
466 //! And macro for simulated annealing string
467 #define EANNEAL(e)      enum_name(e, eannNR, eann_names)
468
469 //! Wall types.
470 enum {
471     ewt93, ewt104, ewtTABLE, ewt126, ewtNR
472 };
473 //! String corresponding to wall type
474 extern const char *ewt_names[ewtNR+1];
475 //! Macro for wall type string
476 #define EWALLTYPE(e)   enum_name(e, ewtNR, ewt_names)
477
478 //! Pulling algorithm.
479 enum {
480     epullUMBRELLA, epullCONSTRAINT, epullCONST_F, epullFLATBOTTOM, epullFLATBOTTOMHIGH, epullEXTERNAL, epullNR
481 };
482 //! String for pulling algorithm
483 extern const char *epull_names[epullNR+1];
484 //! Macro for pulling string
485 #define EPULLTYPE(e)   enum_name(e, epullNR, epull_names)
486
487 //! Control of pull groups
488 enum {
489     epullgDIST, epullgDIR, epullgCYL, epullgDIRPBC, epullgDIRRELATIVE, epullgANGLE, epullgDIHEDRAL, epullgANGLEAXIS, epullgNR
490 };
491 //! String for pull groups
492 extern const char *epullg_names[epullgNR+1];
493 //! Macro for pull group string
494 #define EPULLGEOM(e)   enum_name(e, epullgNR, epullg_names)
495
496 //! Enforced rotation groups.
497 enum {
498     erotgISO, erotgISOPF,
499     erotgPM, erotgPMPF,
500     erotgRM, erotgRMPF,
501     erotgRM2, erotgRM2PF,
502     erotgFLEX, erotgFLEXT,
503     erotgFLEX2, erotgFLEX2T,
504     erotgNR
505 };
506 //! Rotation group names
507 extern const char *erotg_names[erotgNR+1];
508 //! Macro for rot group names
509 #define EROTGEOM(e)    enum_name(e, erotgNR, erotg_names)
510 //! String for rotation group origin names
511 extern const char *erotg_originnames[erotgNR+1];
512 //! Macro for rot group origin names
513 #define EROTORIGIN(e)  enum_name(e, erotgOriginNR, erotg_originnames)
514
515 //! Rotation group fitting type
516 enum {
517     erotgFitRMSD, erotgFitNORM, erotgFitPOT, erotgFitNR
518 };
519 //! String corresponding to rotation group fitting
520 extern const char *erotg_fitnames[erotgFitNR+1];
521 //! Macro for rot group fit names
522 #define EROTFIT(e)     enum_name(e, erotgFitNR, erotg_fitnames)
523
524 /*! \brief Direction along which ion/water swaps happen
525  *
526  * Part of "Computational Electrophysiology" (CompEL) setups
527  */
528 enum eSwaptype {
529     eswapNO, eswapX, eswapY, eswapZ, eSwapTypesNR
530 };
531 //! Names for swapping
532 extern const char *eSwapTypes_names[eSwapTypesNR+1];
533 //! Macro for swapping string
534 #define ESWAPTYPE(e)   enum_name(e, eSwapTypesNR, eSwapTypes_names)
535
536 /*! \brief Swap group splitting type
537  *
538  * These are just the fixed groups we need for any setup. In t_swap's grp
539  * entry after that follows the variable number of swap groups.
540  */
541 enum {
542     eGrpSplit0, eGrpSplit1, eGrpSolvent, eSwapFixedGrpNR
543 };
544 //! String for swap group splitting
545 extern const char *eSwapFixedGrp_names[eSwapFixedGrpNR+1];
546
547 //! QMMM methods.
548 enum {
549     eQMmethodAM1, eQMmethodPM3, eQMmethodRHF,
550     eQMmethodUHF, eQMmethodDFT, eQMmethodB3LYP, eQMmethodMP2, eQMmethodCASSCF, eQMmethodB3LYPLAN,
551     eQMmethodDIRECT, eQMmethodNR
552 };
553 //! String corresponding to QMMM methods
554 extern const char *eQMmethod_names[eQMmethodNR+1];
555 //! Macro to pick QMMM method name
556 #define EQMMETHOD(e)   enum_name(e, eQMmethodNR, eQMmethod_names)
557
558 //! QMMM basis function for QM part
559 enum {
560     eQMbasisSTO3G, eQMbasisSTO3G2, eQMbasis321G,
561     eQMbasis321Gp, eQMbasis321dGp, eQMbasis621G,
562     eQMbasis631G, eQMbasis631Gp, eQMbasis631dGp,
563     eQMbasis6311G, eQMbasisNR
564 };
565 //! Name for QMMM basis function
566 extern const char *eQMbasis_names[eQMbasisNR+1];
567 //! Macro to pick right basis function string
568 #define EQMBASIS(e)    enum_name(e, eQMbasisNR, eQMbasis_names)
569
570 //! QMMM scheme
571 enum {
572     eQMMMschemenormal, eQMMMschemeoniom, eQMMMschemeNR
573 };
574 //! QMMMM scheme names
575 extern const char *eQMMMscheme_names[eQMMMschemeNR+1];
576 //! Macro to pick QMMMM scheme name
577 #define EQMMMSCHEME(e) enum_name(e, eQMMMschemeNR, eQMMMscheme_names)
578
579 /*! \brief Neighborlist geometry type.
580  *
581  * Kernels will compute interactions between two particles,
582  * 3-center water, 4-center water or coarse-grained beads.
583  */
584 enum gmx_nblist_kernel_geometry
585 {
586     GMX_NBLIST_GEOMETRY_PARTICLE_PARTICLE,
587     GMX_NBLIST_GEOMETRY_WATER3_PARTICLE,
588     GMX_NBLIST_GEOMETRY_WATER3_WATER3,
589     GMX_NBLIST_GEOMETRY_WATER4_PARTICLE,
590     GMX_NBLIST_GEOMETRY_WATER4_WATER4,
591     GMX_NBLIST_GEOMETRY_CG_CG,
592     GMX_NBLIST_GEOMETRY_NR
593 };
594 //! String corresponding to nblist geometry names
595 extern const char *gmx_nblist_geometry_names[GMX_NBLIST_GEOMETRY_NR+1];
596
597 /*! \brief Types of electrostatics calculations
598  *
599  * Types of electrostatics calculations available inside nonbonded kernels.
600  * Note that these do NOT necessarily correspond to the user selections
601  * in the MDP file; many interactions for instance map to tabulated kernels.
602  */
603 enum gmx_nbkernel_elec
604 {
605     GMX_NBKERNEL_ELEC_NONE,
606     GMX_NBKERNEL_ELEC_COULOMB,
607     GMX_NBKERNEL_ELEC_REACTIONFIELD,
608     GMX_NBKERNEL_ELEC_CUBICSPLINETABLE,
609     GMX_NBKERNEL_ELEC_EWALD,
610     GMX_NBKERNEL_ELEC_NR
611 };
612 //! String corresponding to electrostatics kernels
613 extern const char *gmx_nbkernel_elec_names[GMX_NBKERNEL_ELEC_NR+1];
614
615 /*! \brief Types of vdw calculations available
616  *
617  * Types of vdw calculations available inside nonbonded kernels.
618  * Note that these do NOT necessarily correspond to the user selections
619  * in the MDP file; many interactions for instance map to tabulated kernels.
620  */
621 enum gmx_nbkernel_vdw
622 {
623     GMX_NBKERNEL_VDW_NONE,
624     GMX_NBKERNEL_VDW_LENNARDJONES,
625     GMX_NBKERNEL_VDW_BUCKINGHAM,
626     GMX_NBKERNEL_VDW_CUBICSPLINETABLE,
627     GMX_NBKERNEL_VDW_LJEWALD,
628     GMX_NBKERNEL_VDW_NR
629 };
630 //! String corresponding to VdW kernels
631 extern const char *gmx_nbkernel_vdw_names[GMX_NBKERNEL_VDW_NR+1];
632
633 //! \brief Types of interactions inside the neighborlist
634 enum gmx_nblist_interaction_type
635 {
636     GMX_NBLIST_INTERACTION_STANDARD,
637     GMX_NBLIST_INTERACTION_FREE_ENERGY,
638     GMX_NBLIST_INTERACTION_NR
639 };
640 //! String corresponding to interactions in neighborlist code
641 extern const char *gmx_nblist_interaction_names[GMX_NBLIST_INTERACTION_NR+1];
642
643
644 //! \brief QM/MM mode
645 enum struct GmxQmmmMode {
646     GMX_QMMM_ORIGINAL,
647     GMX_QMMM_MIMIC
648 };
649 #endif /* GMX_MDTYPES_MD_ENUMS_H */