src/gromacs/mdrun/integrator.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \internal
  36  * \brief Defines the dispatch function for the .mdp integrator field.
  37  *
  38  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
  39  * \author Mark Abraham <mark.j.abraham@gmail.com>
  40  * \ingroup module_mdrun
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "integrator.h"
  45
  46 #include "gromacs/mdtypes/md_enums.h"
  47 #include "gromacs/utility/exceptions.h"
  48
  49 namespace gmx
  50 {
  51
  52 //! \brief Run the correct integrator function.
  53 void Integrator::run(unsigned int ei)
  54 {
  55     switch (ei)
  56     {
  57         case eiMD:
  58         case eiBD:
  59         case eiSD1:
  60         case eiVV:
  61         case eiVVAK:
  62             if (!EI_DYNAMICS(ei))
  63             {
  64                 GMX_THROW(APIError("do_md integrator would be called for a non-dynamical integrator"));
  65             }
  66             do_md();
  67             break;
  68         case eiSteep:
  69             do_steep();
  70             break;
  71         case eiCG:
  72             do_cg();
  73             break;
  74         case eiNM:
  75             do_nm();
  76             break;
  77         case eiLBFGS:
  78             do_lbfgs();
  79             break;
  80         case eiTPI:
  81         case eiTPIC:
  82             if (!EI_TPI(ei))
  83             {
  84                 GMX_THROW(APIError("do_tpi integrator would be called for a non-TPI integrator"));
  85             }
  86             do_tpi();
  87             break;
  88         case eiSD2_REMOVED:
  89             GMX_THROW(NotImplementedError("SD2 integrator has been removed"));
  90         default:
  91             GMX_THROW(APIError("Non existing integrator selected"));
  92     }
  93 }
  94
  95 } // namespace