src/gromacs/mdtypes/multipletimestepping.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2020, 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 #include "gmxpre.h"
  36
  37 #include "multipletimestepping.h"
  38
  39 #include "gromacs/mdtypes/inputrec.h"
  40 #include "gromacs/utility/gmxassert.h"
  41
  42 namespace gmx
  43 {
  44
  45 int nonbondedMtsFactor(const t_inputrec& ir)
  46 {
  47     GMX_RELEASE_ASSERT(!ir.useMts || ir.mtsLevels.size() == 2, "Only 2 MTS levels supported here");
  48
  49     if (ir.useMts && ir.mtsLevels[1].forceGroups[static_cast<int>(MtsForceGroups::Nonbonded)])
  50     {
  51         return ir.mtsLevels[1].stepFactor;
  52     }
  53     else
  54     {
  55         return 1;
  56     }
  57 }
  58
  59 void assertMtsRequirements(const t_inputrec& ir)
  60 {
  61     if (!ir.useMts)
  62     {
  63         return;
  64     }
  65
  66     GMX_RELEASE_ASSERT(ir.mtsLevels.size() >= 2, "Need at least two levels for MTS");
  67
  68     GMX_RELEASE_ASSERT(ir.mtsLevels[0].stepFactor == 1, "Base MTS step should be 1");
  69
  70     GMX_RELEASE_ASSERT(
  71             (!EEL_FULL(ir.coulombtype) && !EVDW_PME(ir.vdwtype))
  72                     || ir.mtsLevels.back().forceGroups[static_cast<int>(MtsForceGroups::LongrangeNonbonded)],
  73             "Long-range nonbondeds should be in the highest MTS level");
  74
  75     for (const auto& mtsLevel : ir.mtsLevels)
  76     {
  77         const int mtsFactor = mtsLevel.stepFactor;
  78         GMX_RELEASE_ASSERT(ir.nstcalcenergy % mtsFactor == 0,
  79                            "nstcalcenergy should be a multiple of mtsFactor");
  80         GMX_RELEASE_ASSERT(ir.nstenergy % mtsFactor == 0,
  81                            "nstenergy should be a multiple of mtsFactor");
  82         GMX_RELEASE_ASSERT(ir.nstlog % mtsFactor == 0, "nstlog should be a multiple of mtsFactor");
  83         GMX_RELEASE_ASSERT(ir.epc == epcNO || ir.nstpcouple % mtsFactor == 0,
  84                            "nstpcouple should be a multiple of mtsFactor");
  85         GMX_RELEASE_ASSERT(ir.efep == efepNO || ir.fepvals->nstdhdl % mtsFactor == 0,
  86                            "nstdhdl should be a multiple of mtsFactor");
  87         if (ir.mtsLevels.back().forceGroups[static_cast<int>(gmx::MtsForceGroups::Nonbonded)])
  88         {
  89             GMX_RELEASE_ASSERT(ir.nstlist % ir.mtsLevels.back().stepFactor == 0,
  90                                "With multiple time stepping for the non-bonded pair interactions, "
  91                                "nstlist should be a "
  92                                "multiple of mtsFactor");
  93         }
  94     }
  95 }
  96
  97 } // namespace gmx