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