src/gmxlib/ifunc.c

   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  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 /* This file is completely threadsafe - keep it that way! */
  39 #ifdef HAVE_CONFIG_H
  40 #include <config.h>
  41 #endif
  42
  43
  44 #include "typedefs.h"
  45 #include "bondf.h"
  46 #include "disre.h"
  47 #include "orires.h"
  48 #include "genborn.h"
  49
  50
  51 #define  def_bonded(str,lstr,nra,nrpa,nrpb,ind,func)\
  52    {str,lstr,(nra),(nrpa),(nrpb),IF_BOND,                        (ind),(func)}
  53
  54 #define  def_bondedz(str,lstr,nra,nrpa,nrpb,ind,func)\
  55    {str,lstr,(nra),(nrpa),(nrpb),IF_BOND | IF_LIMZERO,           (ind),(func)}
  56
  57 #define  def_bondedt(str,lstr,nra,nrpa,nrpb,ind,func)\
  58    {str,lstr,(nra),(nrpa),(nrpb),IF_BOND | IF_TABULATED,         (ind),(func)}
  59
  60 #define  def_bondedtz(str,lstr,nra,nrpa,nrpb,ind,func)\
  61    {str,lstr,(nra),(nrpa),(nrpb),IF_BOND | IF_TABULATED | IF_LIMZERO,(ind),(func)}
  62
  63 #define   def_angle(str,lstr,nra,nrpa,nrpb,ind,func)\
  64    {str,lstr,(nra),(nrpa),(nrpb),IF_BOND | IF_ATYPE,(ind),(func)}
  65
  66 #define    def_bond(str,lstr,nra,nrpa,nrpb,ind,func)\
  67    {str,lstr,(nra),(nrpa),(nrpb),IF_BOND | IF_CHEMBOND | IF_BTYPE,(ind),(func)}
  68
  69 #define    def_bondt(str,lstr,nra,nrpa,nrpb,ind,func)\
  70    {str,lstr,(nra),(nrpa),(nrpb),IF_BOND | IF_CHEMBOND | IF_TABULATED,(ind),(func)}
  71
  72 #define  def_bondnb(str,lstr,nra,nrpa,nrpb,ind,func)\
  73    {str,lstr,(nra),(nrpa),(nrpb),IF_BOND | IF_CHEMBOND,(ind),(func)}
  74
  75 #define   def_vsite(str,lstr,nra,nrpa)\
  76    {str,lstr,(nra),(nrpa),     0,IF_VSITE,                  -1, unimplemented}
  77
  78 #define     def_shk(str,lstr,nra,nrpa,nrpb)\
  79    {str,lstr,(nra),(nrpa),(nrpb),IF_CONSTRAINT,             -1, unimplemented}
  80
  81 #define   def_shkcb(str,lstr,nra,nrpa,nrpb)\
  82    {str,lstr,(nra),(nrpa),(nrpb),IF_CONSTRAINT | IF_CHEMBOND,-1, unimplemented}
  83
  84 #define      def_nb(str,lstr,nra, nrp)\
  85    {str,lstr,(nra), (nrp),     0,IF_NULL,                    -1,unimplemented}
  86
  87 #define    def_nofc(str,lstr)\
  88    {str,lstr,    0,     0,     0,IF_NULL,                    -1,unimplemented}
  89
  90 /* this MUST correspond to the enum in include/types/idef.h */
  91 const t_interaction_function interaction_function[F_NRE]=
  92 {
  93   def_bond    ("BONDS",    "Bond",            2, 2, 2,  eNR_BONDS,  bonds         ),
  94   def_bond    ("G96BONDS", "G96Bond",         2, 2, 2,  eNR_BONDS,  g96bonds      ),
  95   def_bond    ("MORSE",    "Morse",           2, 3, 3,  eNR_MORSE,  morse_bonds   ),
  96   def_bond    ("CUBICBONDS","Cubic Bonds",    2, 3, 0,  eNR_CUBICBONDS, cubic_bonds),
  97   def_bondnb  ("CONNBONDS","Connect Bonds",   2, 0, 0,  0,      unimplemented     ),
  98   def_bonded  ("HARMONIC", "Harmonic Pot.",   2, 2, 2,  eNR_BONDS,  bonds         ),
  99   def_bondnb  ("FENEBONDS", "FENE Bonds",     2, 2, 0,  eNR_FENEBONDS, FENE_bonds ),
 100   def_bondt   ("TABBONDS", "Tab. Bonds",      2, 2, 2,  eNR_TABBONDS, tab_bonds   ),
 101   def_bondedtz("TABBONDSNC", "Tab. Bonds NC", 2, 2, 2,  eNR_TABBONDS, tab_bonds   ),
 102   def_bonded  ("RESTRAINTPOT", "Restraint Pot.", 2, 4, 4,  eNR_RESTRBONDS,  restraint_bonds ),
 103   def_angle   ("ANGLES",   "Angle",           3, 2, 2,  eNR_ANGLES, angles        ),
 104   def_angle   ("G96ANGLES","G96Angle",        3, 2, 2,  eNR_ANGLES, g96angles     ),
 105   def_angle   ("LINEAR_ANGLES", "Lin. Angle", 3, 2, 2,  eNR_LINEAR_ANGLES, linear_angles ),
 106   def_bonded  ("CROSS_BOND_BOND", "Bond-Cross", 3, 3, 0,0,          cross_bond_bond ),
 107   def_bonded  ("CROSS_BOND_ANGLE","BA-Cross",   3, 4, 0,0,          cross_bond_angle ),
 108   def_angle   ("UREY_BRADLEY","U-B",          3, 4, 4,  0,          urey_bradley ),
 109   def_angle   ("QANGLES","Quartic Angles",    3, 6, 0,  eNR_QANGLES, quartic_angles ),
 110   def_bondedt ("TABANGLES", "Tab. Angles",    3, 2, 2,  eNR_TABANGLES, tab_angles ),
 111   def_bonded  ("PDIHS",    "Proper Dih.",     4, 3, 3,  eNR_PROPER, pdihs         ),
 112   def_bonded  ("RBDIHS",   "Ryckaert-Bell.",  4, 6, 6,  eNR_RB, rbdihs            ),
 113   def_bonded  ("FOURDIHS", "Fourier Dih.",    4, 4, 4,  eNR_FOURDIH, rbdihs       ),
 114   def_bonded  ("IDIHS",    "Improper Dih.",   4, 2, 2,  eNR_IMPROPER,idihs        ),
 115   def_bonded  ("PIDIHS",   "Improper Dih.",   4, 3, 3,  eNR_PROPER, pdihs         ),
 116   def_bondedt ("TABDIHS", "Tab. Dih.",        4, 2, 2,  eNR_TABDIHS, tab_dihs     ),
 117   def_bonded  ("CMAP",  "CMAP Dih.",          5, -1, -1,  eNR_CMAP,   unimplemented ),
 118   def_bonded  ("GB12",     "GB 1-2 Pol.",     2, 4, 0,  eNR_GB,     unimplemented ),
 119   def_bonded  ("GB13",     "GB 1-3 Pol.",     2, 4, 0,  eNR_GB,     unimplemented ),
 120   def_bonded  ("GB14",     "GB 1-4 Pol.",     2, 4, 0,  eNR_GB,     unimplemented ),
 121   def_nofc    ("GBPOL",    "GB Polarization" ),
 122   def_nofc    ("NPSOLVATION", "Nonpolar Sol." ),
 123   def_bondedz ("LJ14",     "LJ-14",           2, 2, 2,  eNR_NB14,   unimplemented ),
 124   def_nofc    ("COUL14",   "Coulomb-14"                                           ),
 125   def_bondedz ("LJC14_Q",  "LJC-14 q",        2, 5, 0,  eNR_NB14,   unimplemented ),
 126   def_bondedz ("LJC_NB",   "LJC Pairs NB",    2, 4, 0,  eNR_NB14,   unimplemented ),
 127   def_nb      ("LJ_SR",    "LJ (SR)",         2, 2                                ),
 128   def_nb      ("BHAM",     "Buck.ham (SR)",   2, 3                                ),
 129   def_nofc    ("LJ_LR",    "LJ (LR)"                                              ),
 130   def_nofc    ("BHAM_LR",  "Buck.ham (LR)"                                        ),
 131   def_nofc    ("DISPCORR", "Disper. corr."                                        ),
 132   def_nofc    ("COUL_SR",  "Coulomb (SR)"                                         ),
 133   def_nofc    ("COUL_LR",  "Coulomb (LR)"                                         ),
 134   def_nofc    ("RF_EXCL",  "RF excl."                                             ),
 135   def_nofc    ("COUL_RECIP", "Coul. recip."                                       ),
 136   def_nofc    ("DPD",      "DPD"                                                  ),
 137   def_bondnb  ("POLARIZATION", "Polarization",2, 1, 0,  0,          polarize      ),
 138   def_bonded  ("WATERPOL", "Water Pol.",      5, 6, 0,  eNR_WPOL,   water_pol     ),
 139   def_bonded  ("THOLE",    "Thole Pol.",      4, 3, 0,  eNR_THOLE,  thole_pol     ),
 140   def_bondnb  ("ANHARM_POL", "Anharm. Pol.",2, 3, 0, 0,          anharm_polarize      ),
 141   def_bonded  ("POSRES",   "Position Rest.",  1, 3, 3,  eNR_POSRES, unimplemented ),
 142   def_bonded  ("DISRES",   "Dis. Rest.",      2, 6, 0,  eNR_DISRES, ta_disres     ),
 143   def_nofc    ("DISRESVIOL",   "D.R.Viol. (nm)"                                       ),
 144   def_bonded  ("ORIRES",   "Orient. Rest.",   2, 6, 0,  eNR_ORIRES, orires        ),
 145   def_nofc    ("ORDEV",    "Ori. R. RMSD"                                         ),
 146   def_bonded  ("ANGRES",   "Angle Rest.",     4, 3, 3,  eNR_ANGRES, angres        ),
 147   def_bonded  ("ANGRESZ",  "Angle Rest. Z",   2, 3, 3,  eNR_ANGRESZ,angresz       ),
 148   def_bonded  ("DIHRES",   "Dih. Rest.",      4, 3, 3,  eNR_DIHRES, dihres        ),
 149   def_nofc    ("DIHRESVIOL",  "Dih. Rest. Viol."                                     ), /* obsolete */
 150   def_shkcb   ("CONSTR",   "Constraint",      2, 1, 1                             ),
 151   def_shk     ("CONSTRNC", "Constr. No Conn.",2, 1, 1                             ),
 152   def_shkcb   ("SETTLE",   "Settle",          3, 2, 0                             ),
 153   def_vsite   ("VSITE2",   "Virtual site 2",  3, 1                                ),
 154   def_vsite   ("VSITE3",   "Virtual site 3",  4, 2                                ),
 155   def_vsite   ("VSITE3FD", "Virtual site 3fd",4, 2                                ),
 156   def_vsite   ("VSITE3FAD","Virtual site 3fad",4, 2                               ),
 157   def_vsite   ("VSITE3OUT","Virtual site 3out",4, 3                               ),
 158   def_vsite   ("VSITE4FD", "Virtual site 4fd", 5, 3                               ),
 159   def_vsite   ("VSITE4FDN","Virtual site 4fdn",5, 3                               ),
 160   def_vsite   ("VSITEN",   "Virtual site N",   2, 2                               ),
 161   def_nofc    ("COM_PULL", "COM Pull En."     ),
 162   def_nofc    ("EQM",      "Quantum En."      ),
 163   def_nofc    ("EPOT",     "Potential"        ),
 164   def_nofc    ("EKIN",     "Kinetic En."      ),
 165   def_nofc    ("ETOT",     "Total Energy"     ),
 166   def_nofc    ("ECONS",    "Conserved En."    ),
 167   def_nofc    ("TEMP",     "Temperature"      ),
 168   def_nofc    ("VTEMP",    "Vir. Temp."       ),
 169   /* Note that pressure names can not be more than 8 char's,
 170    * because " (bar)" is appended to them.
 171    */
 172   def_nofc    ("PDISPCORR","Pres. DC"         ),
 173   def_nofc    ("PRES",     "Pressure"         ),
 174   def_nofc    ("DH/DL_CON","dH/dl constr."    ), /* obsolete */
 175   def_nofc    ("DV/DL",    "dVremain/dl"      ),
 176   def_nofc    ("DK/DL",    "dEkin/dl"         ),
 177   def_nofc    ("DVC/DL",   "dVcoul/dl"        ),
 178   def_nofc    ("DVV/DL",   "dVvdw/dl"         ),
 179   def_nofc    ("DVB/DL",   "dVbonded/dl"      ),
 180   def_nofc    ("DVR/DL",   "dVrestraint/dl"   ),
 181   def_nofc    ("DVT/DL",   "dVtemperature/dl" )
 182 };