File: testingconfiguration.h

package info (click to toggle)
gromacs 2025.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 287,236 kB
  • sloc: xml: 3,718,478; cpp: 654,820; ansic: 75,282; python: 20,471; sh: 3,471; perl: 2,218; yacc: 644; fortran: 397; lisp: 265; makefile: 171; lex: 125; awk: 68; csh: 39
file content (198 lines) | stat: -rw-r--r-- 7,561 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
/*
 * This file is part of the GROMACS molecular simulation package.
 *
 * Copyright 2018- The GROMACS Authors
 * and the project initiators Erik Lindahl, Berk Hess and David van der Spoel.
 * Consult the AUTHORS/COPYING files and https://www.gromacs.org for details.
 *
 * GROMACS is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 *
 * GROMACS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with GROMACS; if not, see
 * https://www.gnu.org/licenses, or write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
 *
 * If you want to redistribute modifications to GROMACS, please
 * consider that scientific software is very special. Version
 * control is crucial - bugs must be traceable. We will be happy to
 * consider code for inclusion in the official distribution, but
 * derived work must not be called official GROMACS. Details are found
 * in the README & COPYING files - if they are missing, get the
 * official version at https://www.gromacs.org.
 *
 * To help us fund GROMACS development, we humbly ask that you cite
 * the research papers on the package. Check out https://www.gromacs.org.
 */

#ifndef GROMACS_TESTINGCONFIGURATION_H
#define GROMACS_TESTINGCONFIGURATION_H

#include "config.h"

#include <algorithm>
#include <string>
#include <vector>

#include "gromacs/gmxpreprocess/grompp.h"
#include "gromacs/math/vec.h"
#include "gromacs/utility/stringutil.h"
#include "gromacs/utility/textwriter.h"

#include "testutils/cmdlinetest.h"
#include "testutils/testfilemanager.h"

#include "programs/mdrun/tests/moduletest.h"
#if GMX_THREAD_MPI
#    include "testutils/mpitest.h"
#endif

namespace gmxapi
{

namespace testing
{

/*! \brief Helper function to get step size as floating point number.
 *
 * A step size of 0.002ps is suitable for the simulation.
 * We prefer to guarantee that the testing tools easily anticipate TPR time step size
 * and time value in trajectory outputs, so we explicitly choose a time step that is
 * exactly representable in binary. 2^-9 is just smaller than 0.002 and requires very
 * little floating point precision (mantissa == 0). This means that sums and multiples
 * of the timestep are also exactly representable, and thus particularly convenient for tests."
 *
 * For human readability we use the decimal representation, 1.0 x 2^-9 = 0.001953125.
 *
 * \returns Step size for tests.
 */
inline real getTestStepSize()
{
    return 0.001953125;
}

//! Provide command-line infrastructure for gmxapi tests.
class GmxApiTest : public gmx::test::MdrunTestFixture
{
public:
    GmxApiTest()
    {
        // For files that will always be generated, let's explicitly set the names so that
        // TestFileManager will clean them up properly.
        runner_.groOutputFileName_ = fileManager_.getTemporaryFilePath("confout.gro");
        runner_.cptOutputFileName_ = fileManager_.getTemporaryFilePath("state.cpt");
        runner_.reducedPrecisionTrajectoryFileName_ =
                fileManager_.getTemporaryFilePath("traj_comp.xtc");
    }

    /* \brief
     * Prepare a tpr to run the test with.
     *
     * Sets up the TPR to run a test of the GMXAPI with a set number of \p steps
     * defined in the test.
     *
     * \param[in] steps Number of steps for test to run.
     */
    void makeTprFile(int steps)
    {
        runner_.useTopGroAndNdxFromDatabase("spc_and_methane");
        runner_.useStringAsMdpFile(
                gmx::formatString("integrator = md\n"
                                  "cutoff-scheme = Verlet\n"
                                  "nsteps = %d\n"
                                  "dt = %11.9f\n"
                                  "nstxout = 2\n"
                                  "nstvout = 2\n"
                                  "nstfout = 4\n"
                                  "nstxout-compressed = 2\n"
                                  "tcoupl = v-rescale\n"
                                  "tc-grps = System\n"
                                  "tau-t = 1\n"
                                  "ref-t = 298\n"
                                  "compressed-x-grps = Sol\n",
                                  steps,
                                  getTestStepSize()));

        EXPECT_EQ(0, runner_.callGromppOnThisRank());
    }

    //! Make the md arguments to work with
    std::vector<std::string> makeMdArgs() const
    {
        std::vector<std::string> mdArgs;

        if (!runner_.fullPrecisionTrajectoryFileName_.empty())
        {
            EXPECT_TRUE(std::none_of(mdArgs.cbegin(),
                                     mdArgs.cend(),
                                     [](const std::string& arg) { return arg == "-o"; }));
            mdArgs.emplace_back("-o");
            mdArgs.emplace_back(runner_.fullPrecisionTrajectoryFileName_);
        }
        if (!runner_.reducedPrecisionTrajectoryFileName_.empty())
        {
            EXPECT_TRUE(std::none_of(mdArgs.cbegin(),
                                     mdArgs.cend(),
                                     [](const std::string& arg) { return arg == "-x"; }));
            mdArgs.emplace_back("-x");
            mdArgs.emplace_back(runner_.reducedPrecisionTrajectoryFileName_);
        }
        if (!runner_.groOutputFileName_.empty())
        {
            EXPECT_TRUE(std::none_of(mdArgs.cbegin(),
                                     mdArgs.cend(),
                                     [](const std::string& arg) { return arg == "-c"; }));
            mdArgs.emplace_back("-c");
            mdArgs.emplace_back(runner_.groOutputFileName_);
        }
        if (!runner_.logFileName_.empty())
        {
            EXPECT_TRUE(std::none_of(mdArgs.cbegin(),
                                     mdArgs.cend(),
                                     [](const std::string& arg) { return arg == "-g"; }));
            mdArgs.emplace_back("-g");
            mdArgs.emplace_back(runner_.logFileName_);
        }
        if (!runner_.edrFileName_.empty())
        {
            EXPECT_TRUE(std::none_of(mdArgs.cbegin(),
                                     mdArgs.cend(),
                                     [](const std::string& arg) { return arg == "-e"; }));
            mdArgs.emplace_back("-e");
            mdArgs.emplace_back(runner_.edrFileName_);
        }
        if (!runner_.cptOutputFileName_.empty())
        {
            EXPECT_TRUE(std::none_of(mdArgs.cbegin(),
                                     mdArgs.cend(),
                                     [](const std::string& arg) { return arg == "-cpo"; }));
            mdArgs.emplace_back("-cpo");
            mdArgs.emplace_back(runner_.cptOutputFileName_);
        }
#if GMX_THREAD_MPI
        mdArgs.emplace_back("-ntmpi");
        mdArgs.emplace_back(std::to_string(gmx::test::getNumberOfTestMpiRanks()));
#endif

#if GMX_OPENMP
        mdArgs.emplace_back("-ntomp");
        mdArgs.emplace_back(std::to_string(gmx::test::getNumberOfTestOpenMPThreads()));
#endif

        return mdArgs;
    }
};

} // namespace testing

} // end namespace gmxapi


#endif // GROMACS_TESTINGCONFIGURATION_H