src/programs/mdrun/tests/interactiveMD.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014,2015,2016,2018,2019, 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
  36 /*! \internal \file
  37  * \brief
  38  * Tests utilities for interactive molecular dynamics (IMD) setups.
  39  *
  40  * \author Carsten Kutzner <ckutzne@gwdg.de>
  41  * \ingroup module_mdrun_integration_tests
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "gromacs/utility/stringutil.h"
  46
  47 #include "moduletest.h"
  48
  49 namespace gmx
  50 {
  51 namespace test
  52 {
  53
  54 class ImdTestFixture : public MdrunTestFixture, public ::testing::WithParamInterface<const char*>
  55 {
  56 protected:
  57     ImdTestFixture();
  58     ~ImdTestFixture() override;
  59 };
  60
  61
  62 ImdTestFixture::ImdTestFixture() {}
  63
  64 ImdTestFixture::~ImdTestFixture() {}
  65
  66
  67 //! Test fixture for mdrun with IMD settings
  68 typedef gmx::test::ImdTestFixture ImdTest;
  69
  70 /* This test checks
  71  * - whether the IMD-group parameter from the .mdp file is understood,
  72  * - whether mdrun understands the IMD-related command line parameters
  73      -imdpull, -imdwait, -imdterm,
  74  * - whether or not GROMACS was compiled with IMD support, that mdrun finishes
  75      without error when IMD is enabled in the TPR.
  76  *
  77  * TODO In future, consider checking that mdrun does not start IMD
  78  * when it should/can not.
  79  */
  80 TEST_P(ImdTest, ImdCanRun)
  81 {
  82     runner_.useTopGroAndNdxFromDatabase("glycine_vacuo");
  83     const std::string mdpContents = R"(
  84         dt            = 0.002
  85         nsteps        = 2
  86         tcoupl        = v-rescale
  87         tc-grps       = System
  88         tau-t         = 0.5
  89         ref-t         = 300
  90         cutoff-scheme = Verlet
  91         IMD-group     = Heavy_Atoms
  92         integrator    = %s
  93     )";
  94     // Interpolate the integrator selection into the .mdp file
  95     runner_.useStringAsMdpFile(formatString(mdpContents.c_str(), GetParam()));
  96
  97     EXPECT_EQ(0, runner_.callGrompp());
  98
  99     ::gmx::test::CommandLine imdCaller;
 100     imdCaller.addOption("-imdport", 0); // automatically assign a free port
 101     imdCaller.append("-imdpull");
 102     imdCaller.append("-noimdwait"); // cannot use -imdwait: then mdrun would not return control ...
 103     imdCaller.append("-noimdterm");
 104
 105     // Do an mdrun with IMD enabled
 106     ASSERT_EQ(0, runner_.callMdrun(imdCaller));
 107 }
 108
 109 // Check a dynamical integrator and an energy minimizer. No need to
 110 // cover the whole space.
 111 INSTANTIATE_TEST_CASE_P(WithIntegrator, ImdTest, ::testing::Values("md", "steep"));
 112
 113 } // namespace test
 114 } // namespace gmx