src/programs/mdrun/tests/moduletest.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014, 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 \file
  36  * \brief
  37  * Implements classes in moduletest.h.
  38  *
  39  * \author Mark Abraham <mark.j.abraham@gmail.com>
  40  * \ingroup module_mdrun
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "moduletest.h"
  45
  46 #include "config.h"
  47
  48 #include "gromacs/gmxpreprocess/grompp.h"
  49 #include "gromacs/options/basicoptions.h"
  50 #include "gromacs/options/options.h"
  51 #include "gromacs/utility/basedefinitions.h"
  52 #include "gromacs/utility/basenetwork.h"
  53 #include "gromacs/utility/file.h"
  54 #include "programs/mdrun/mdrun_main.h"
  55
  56 #include "testutils/cmdlinetest.h"
  57 #include "testutils/integrationtests.h"
  58 #include "testutils/testoptions.h"
  59
  60 namespace gmx
  61 {
  62 namespace test
  63 {
  64
  65 /********************************************************************
  66  * MdrunTestFixture
  67  */
  68
  69 namespace
  70 {
  71
  72 #if defined(GMX_THREAD_MPI) || defined(DOXYGEN)
  73 //! Number of tMPI threads for child mdrun call.
  74 int g_numThreads = 1;
  75 #endif
  76 #if defined(GMX_OPENMP) || defined(DOXYGEN)
  77 //! Number of OpenMP threads for child mdrun call.
  78 int g_numOpenMPThreads = 1;
  79 #endif
  80 //! \cond
  81 GMX_TEST_OPTIONS(MdrunTestOptions, options)
  82 {
  83     GMX_UNUSED_VALUE(options);
  84 #ifdef GMX_THREAD_MPI
  85     options->addOption(IntegerOption("nt").store(&g_numThreads)
  86                            .description("Number of thread-MPI threads/ranks for child mdrun call"));
  87 #endif
  88 #ifdef GMX_OPENMP
  89     options->addOption(IntegerOption("nt_omp").store(&g_numOpenMPThreads)
  90                            .description("Number of OpenMP threads for child mdrun call"));
  91 #endif
  92 }
  93 //! \endcond
  94
  95 }
  96
  97 MdrunTestFixture::MdrunTestFixture() :
  98     topFileName(),
  99     groFileName(),
 100     fullPrecisionTrajectoryFileName(),
 101     ndxFileName(),
 102     mdpInputFileName(fileManager_.getTemporaryFilePath("input.mdp")),
 103     mdpOutputFileName(fileManager_.getTemporaryFilePath("output.mdp")),
 104     tprFileName(fileManager_.getTemporaryFilePath(".tpr")),
 105     logFileName(fileManager_.getTemporaryFilePath(".log")),
 106     edrFileName(fileManager_.getTemporaryFilePath(".edr")),
 107     nsteps(-2)
 108 {
 109 #ifdef GMX_LIB_MPI
 110     GMX_RELEASE_ASSERT(gmx_mpi_initialized(), "MPI system not initialized for mdrun tests");
 111 #endif
 112 }
 113
 114 MdrunTestFixture::~MdrunTestFixture()
 115 {
 116 }
 117
 118 // TODO The combination of defaulting to Verlet cut-off scheme, NVE,
 119 // and verlet-buffer-tolerance = -1 gives a grompp error. If we keep
 120 // things that way, this function should be renamed. For now,
 121 // force the use of the group scheme.
 122 void
 123 MdrunTestFixture::useEmptyMdpFile()
 124 {
 125     useStringAsMdpFile("cutoff-scheme = Group\n");
 126 }
 127
 128 void
 129 MdrunTestFixture::useStringAsMdpFile(const char *mdpString)
 130 {
 131     useStringAsMdpFile(std::string(mdpString));
 132 }
 133
 134 void
 135 MdrunTestFixture::useStringAsMdpFile(const std::string &mdpString)
 136 {
 137     gmx::File::writeFileFromString(mdpInputFileName, mdpString);
 138 }
 139
 140 void
 141 MdrunTestFixture::useStringAsNdxFile(const char *ndxString)
 142 {
 143     gmx::File::writeFileFromString(ndxFileName, ndxString);
 144 }
 145
 146 void
 147 MdrunTestFixture::useTopGroAndNdxFromDatabase(const char *name)
 148 {
 149     topFileName = fileManager_.getInputFilePath((std::string(name) + ".top").c_str());
 150     groFileName = fileManager_.getInputFilePath((std::string(name) + ".gro").c_str());
 151     ndxFileName = fileManager_.getInputFilePath((std::string(name) + ".ndx").c_str());
 152 }
 153
 154 int
 155 MdrunTestFixture::callGromppOnThisRank()
 156 {
 157     CommandLine caller;
 158     caller.append("grompp");
 159     caller.addOption("-f", mdpInputFileName);
 160     caller.addOption("-n", ndxFileName);
 161     caller.addOption("-p", topFileName);
 162     caller.addOption("-c", groFileName);
 163
 164     caller.addOption("-po", mdpOutputFileName);
 165     caller.addOption("-o", tprFileName);
 166
 167     return gmx_grompp(caller.argc(), caller.argv());
 168 }
 169
 170 int
 171 MdrunTestFixture::callGrompp()
 172 {
 173 #ifdef GMX_LIB_MPI
 174     // When compiled with external MPI, only call one instance of the
 175     // grompp function
 176     if (0 != gmx_node_rank())
 177     {
 178         return 0;
 179     }
 180 #endif
 181     return callGromppOnThisRank();
 182 }
 183
 184 int
 185 MdrunTestFixture::callMdrun(const CommandLine &callerRef)
 186 {
 187     /* Conforming to style guide by not passing a non-const reference
 188        to this function. Passing a non-const reference might make it
 189        easier to write code that incorrectly re-uses callerRef after
 190        the call to this function. */
 191     CommandLine caller(callerRef);
 192     caller.addOption("-s", tprFileName);
 193
 194     caller.addOption("-g", logFileName);
 195     caller.addOption("-e", edrFileName);
 196     caller.addOption("-o", fullPrecisionTrajectoryFileName);
 197     caller.addOption("-x", reducedPrecisionTrajectoryFileName);
 198
 199     caller.addOption("-deffnm", fileManager_.getTemporaryFilePath("state"));
 200
 201     if (nsteps > -2)
 202     {
 203         caller.addOption("-nsteps", nsteps);
 204     }
 205
 206 #ifdef GMX_THREAD_MPI
 207     caller.addOption("-nt", g_numThreads);
 208 #endif
 209 #ifdef GMX_OPENMP
 210     caller.addOption("-ntomp", g_numOpenMPThreads);
 211 #endif
 212
 213     return gmx_mdrun(caller.argc(), caller.argv());
 214 }
 215
 216 int
 217 MdrunTestFixture::callMdrun()
 218 {
 219     CommandLine caller;
 220     caller.append("mdrun");
 221     return callMdrun(caller);
 222 }
 223
 224 } // namespace test
 225 } // namespace gmx