src/programs/mdrun/tests/swapcoords.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 "Computational Electrophysiology" setups.
  39  *
  40  * \author Carsten Kutzner <ckutzne@gwdg.de>
  41  * \ingroup module_mdrun_integration_tests
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "moduletest.h"
  46
  47 namespace gmx
  48 {
  49 namespace test
  50 {
  51
  52 class SwapTestFixture : public MdrunTestFixture
  53 {
  54 protected:
  55     SwapTestFixture();
  56     ~SwapTestFixture() override;
  57 };
  58
  59
  60 SwapTestFixture::SwapTestFixture() {}
  61
  62 SwapTestFixture::~SwapTestFixture() {}
  63
  64
  65 //! Test fixture for mdrun with "Computational Electrophysiology" settings,
  66 // i.e. double membrane sandwich with ion/water exchange protocol
  67 typedef gmx::test::SwapTestFixture CompelTest;
  68
  69 /* This test ensures that the compel protocol can be run, that all of
  70  * the swapcoords parameters from the .mdp file are understood, and that
  71  * the swap state variables can be written to and read from checkpoint. */
  72 TEST_F(CompelTest, SwapCanRun)
  73 {
  74     runner_.useTopGroAndNdxFromDatabase("OctaneSandwich");
  75     const std::string mdpContents = R"(
  76         dt                       = 0.005
  77         nsteps                   = 2
  78         tcoupl                   = Berendsen
  79         tc-grps                  = System
  80         tau-t                    = 0.5
  81         ref-t                    = 300
  82         constraints              = all-bonds
  83         cutoff-scheme            = Verlet
  84         swapcoords               = Z
  85         swap_frequency           = 1
  86         split_group0             = Ch0
  87         split_group1             = Ch1
  88         massw_split0             = yes
  89         massw_split1             = no
  90         solvent_group            = SOL
  91         cyl0_r                   = 1
  92         cyl0_up                  = 0.5
  93         cyl0_down                = 0.5
  94         cyl1_r                   = 1
  95         cyl1_up                  = 0.5
  96         cyl1_down                = 0.5
  97         coupl_steps              = 5
  98         iontypes                 = 2
  99         iontype0-name            = NA+
 100         iontype0-in-A            = 8
 101         iontype0-in-B            = 11
 102         iontype1-name            = CL-
 103         iontype1-in-A            = -1
 104         iontype1-in-B            = -1
 105         threshold                = 1
 106      )";
 107
 108     runner_.useStringAsMdpFile(mdpContents);
 109
 110     EXPECT_EQ(0, runner_.callGrompp());
 111
 112     runner_.cptFileName_       = fileManager_.getTemporaryFilePath(".cpt");
 113     runner_.groOutputFileName_ = fileManager_.getTemporaryFilePath(".gro");
 114     runner_.swapFileName_      = fileManager_.getTemporaryFilePath("swap.xvg");
 115
 116     ::gmx::test::CommandLine swapCaller;
 117     swapCaller.addOption("-c", runner_.groOutputFileName_);
 118     swapCaller.addOption("-swap", runner_.swapFileName_);
 119
 120     // Do an initial mdrun that writes a checkpoint file
 121     ::gmx::test::CommandLine firstCaller(swapCaller);
 122     firstCaller.addOption("-cpo", runner_.cptFileName_);
 123     ASSERT_EQ(0, runner_.callMdrun(firstCaller));
 124     // Continue mdrun from that checkpoint file
 125     ::gmx::test::CommandLine secondCaller(swapCaller);
 126     secondCaller.addOption("-cpi", runner_.cptFileName_);
 127     runner_.nsteps_ = 2;
 128     ASSERT_EQ(0, runner_.callMdrun(secondCaller));
 129 }
 130
 131
 132 /*! \todo Add other tests for the compel module, e.g.
 133  *
 134  *  - a test that checks that actually ion/water swaps have been done, by
 135  *    calling gmxcheck on the swap output file and a reference file
 136  */
 137
 138
 139 } // namespace test
 140 } // namespace gmx