2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2013, 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.
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.
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.
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.
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.
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.
37 * Implements classes in moduletest.h.
39 * \author Mark Abraham <mark.j.abraham@gmail.com>
40 * \ingroup module_mdrun
42 #include "moduletest.h"
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 "programs/mdrun/mdrun_main.h"
57 #include "programs/gmx/legacycmainfunctions.h"
64 /********************************************************************
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;
77 GMX_TEST_OPTIONS(MdrunTestOptions, options)
79 GMX_UNUSED_VALUE(options);
81 options->addOption(IntegerOption("nt").store(&numThreads)
82 .description("Number of thread-MPI threads/ranks for child mdrun call"));
85 options->addOption(IntegerOption("nt_omp").store(&numOpenMPThreads)
86 .description("Number of OpenMP threads for child mdrun call"));
92 MdrunTestFixture::MdrunTestFixture() :
96 mdpInputFileName(fileManager_.getTemporaryFilePath("input.mdp")),
97 mdpOutputFileName(fileManager_.getTemporaryFilePath("output.mdp")),
98 tprFileName(fileManager_.getTemporaryFilePath(".tpr")),
99 logFileName(fileManager_.getTemporaryFilePath(".log")),
100 edrFileName(fileManager_.getTemporaryFilePath(".edr"))
103 GMX_RELEASE_ASSERT(gmx_mpi_initialized(), "MPI system not initialized for mdrun tests");
107 MdrunTestFixture::~MdrunTestFixture()
111 // TODO The combination of defaulting to Verlet cut-off scheme, NVE,
112 // and verlet-buffer-tolerance = -1 gives a grompp error. If we keep
113 // things that way, this function should be renamed. For now,
114 // force the use of the group scheme.
116 MdrunTestFixture::useEmptyMdpFile()
118 useStringAsMdpFile("cutoff-scheme = Group\n");
122 MdrunTestFixture::useStringAsMdpFile(const char *mdpString)
124 gmx::File::writeFileFromString(mdpInputFileName, mdpString);
128 MdrunTestFixture::useTopAndGroFromDatabase(const char *name)
130 topFileName = fileManager_.getInputFilePath((std::string(name) + ".top").c_str());
131 groFileName = fileManager_.getInputFilePath((std::string(name) + ".gro").c_str());
135 MdrunTestFixture::callGrompp()
138 // When compiled with external MPI, only call one instance of the grompp function
139 if (0 != gmx_node_rank())
146 caller.append("grompp");
147 caller.addOption("-f", mdpInputFileName);
148 caller.addOption("-p", topFileName);
149 caller.addOption("-c", groFileName);
151 caller.addOption("-po", mdpOutputFileName);
152 caller.addOption("-o", tprFileName);
154 return gmx_grompp(caller.argc(), caller.argv());
158 MdrunTestFixture::callMdrun(const CommandLine &callerRef)
160 /* Conforming to style guide by not passing a non-const reference
161 to this function. Passing a non-const reference might make it
162 easier to write code that incorrectly re-uses callerRef after
163 the call to this function. */
164 CommandLine caller(callerRef);
165 caller.addOption("-s", tprFileName);
167 caller.addOption("-g", logFileName);
168 caller.addOption("-e", edrFileName);
169 caller.addOption("-o", trrFileName);
170 caller.addOption("-x", xtcFileName);
172 #ifdef GMX_THREAD_MPI
173 caller.addOption("-nt", numThreads);
176 caller.addOption("-ntomp", numOpenMPThreads);
179 return gmx_mdrun(caller.argc(), caller.argv());
183 MdrunTestFixture::callMdrun()
186 caller.append("mdrun");
187 return callMdrun(caller);