src/gmxlib/inputrec.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-2010, 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 #ifdef HAVE_CONFIG_H
  39 #include <config.h>
  40 #endif
  41
  42
  43 #include "typedefs.h"
  44 #include "macros.h"
  45 #include "inputrec.h"
  46 #include "gmx_fatal.h"
  47
  48
  49 /* The minimum number of integration steps required for reasonably accurate
  50  * integration of first and second order coupling algorithms.
  51  */
  52 const int nstmin_berendsen_tcouple =  5;
  53 const int nstmin_berendsen_pcouple = 10;
  54 const int nstmin_harmonic          = 20;
  55
  56 static int nst_wanted(const t_inputrec *ir)
  57 {
  58     if (ir->nstlist > 0)
  59     {
  60         return ir->nstlist;
  61     }
  62     else
  63     {
  64         return 10;
  65     }
  66 }
  67
  68 int ir_optimal_nstcalcenergy(const t_inputrec *ir)
  69 {
  70     return nst_wanted(ir);
  71 }
  72
  73 int tcouple_min_integration_steps(int etc)
  74 {
  75     int n;
  76
  77     switch (etc)
  78     {
  79     case etcNO:
  80         n = 0;
  81         break;
  82     case etcBERENDSEN:
  83     case etcYES:
  84         n = nstmin_berendsen_tcouple;
  85         break;
  86     case etcVRESCALE:
  87         /* V-rescale supports instantaneous rescaling */
  88         n = 0;
  89         break;
  90     case etcNOSEHOOVER:
  91         n = nstmin_harmonic;
  92         break;
  93     case etcANDERSEN:
  94     case etcANDERSENMASSIVE:
  95         n = 1;
  96         break;
  97     default:
  98         gmx_incons("Unknown etc value");
  99         n = 0;
 100     }
 101
 102     return n;
 103 }
 104
 105 int ir_optimal_nsttcouple(const t_inputrec *ir)
 106 {
 107     int  nmin,nwanted,n;
 108     real tau_min;
 109     int  g;
 110
 111     nmin = tcouple_min_integration_steps(ir->etc);
 112
 113     nwanted = nst_wanted(ir);
 114
 115     tau_min = 1e20;
 116     if (ir->etc != etcNO)
 117     {
 118         for(g=0; g<ir->opts.ngtc; g++)
 119         {
 120             if (ir->opts.tau_t[g] > 0)
 121             {
 122                 tau_min = min(tau_min,ir->opts.tau_t[g]);
 123             }
 124         }
 125     }
 126
 127     if (nmin == 0 || ir->delta_t*nwanted <= tau_min)
 128     {
 129         n = nwanted;
 130     }
 131     else
 132     {
 133         n = (int)(tau_min/(ir->delta_t*nmin) + 0.001);
 134         if (n < 1)
 135         {
 136             n = 1;
 137         }
 138         while (nwanted % n != 0)
 139         {
 140             n--;
 141         }
 142     }
 143
 144     return n;
 145 }
 146
 147 int pcouple_min_integration_steps(int epc)
 148 {
 149     int n;
 150
 151     switch (epc)
 152     {
 153     case epcNO:
 154         n = 0;
 155         break;
 156     case etcBERENDSEN:
 157     case epcISOTROPIC:
 158         n = nstmin_berendsen_pcouple;
 159         break;
 160     case epcPARRINELLORAHMAN:
 161     case epcMTTK:
 162         n = nstmin_harmonic;
 163         break;
 164     default:
 165         gmx_incons("Unknown epc value");
 166         n = 0;
 167     }
 168
 169     return n;
 170 }
 171
 172 int ir_optimal_nstpcouple(const t_inputrec *ir)
 173 {
 174     int  nmin,nwanted,n;
 175
 176     nmin = pcouple_min_integration_steps(ir->epc);
 177
 178     nwanted = nst_wanted(ir);
 179
 180     if (nmin == 0 || ir->delta_t*nwanted <= ir->tau_p)
 181     {
 182         n = nwanted;
 183     }
 184     else
 185     {
 186         n = (int)(ir->tau_p/(ir->delta_t*nmin) + 0.001);
 187         if (n < 1)
 188         {
 189             n = 1;
 190         }
 191         while (nwanted % n != 0)
 192         {
 193             n--;
 194         }
 195     }
 196
 197     return n;
 198 }