358a9f42a28a5902b6fb5ca71a68735e606a3c6b
[alexxy/gromacs.git] / src / gromacs / applied_forces / tests / densityfittingoptions.cpp
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 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 /*! \internal \file
36  * \brief
37  * Tests for density fitting module options.
38  *
39  * \author Christian Blau <blau@kth.se>
40  * \ingroup module_applied_forces
41  */
42 #include "gmxpre.h"
43
44 #include "gromacs/applied_forces/densityfittingoptions.h"
45
46 #include <gtest/gtest.h>
47
48 #include "gromacs/options/options.h"
49 #include "gromacs/options/treesupport.h"
50 #include "gromacs/utility/keyvaluetreebuilder.h"
51 #include "gromacs/utility/keyvaluetreemdpwriter.h"
52 #include "gromacs/utility/keyvaluetreetransform.h"
53 #include "gromacs/utility/stringcompare.h"
54 #include "gromacs/utility/stringstream.h"
55 #include "gromacs/utility/textwriter.h"
56
57 #include "testutils/testasserts.h"
58 #include "testutils/testmatchers.h"
59
60
61 namespace gmx
62 {
63
64 namespace
65 {
66
67 TEST(DensityFittingOptionsTest, DefaultParameters)
68 {
69     DensityFittingOptions densityFittingOptions;
70     EXPECT_FALSE(densityFittingOptions.buildParameters().active_);
71 }
72
73 TEST(DensityFittingOptionsTest, OptionSetsActive)
74 {
75     DensityFittingOptions densityFittingOptions;
76     EXPECT_FALSE(densityFittingOptions.buildParameters().active_);
77
78     // Prepare MDP inputs
79     KeyValueTreeBuilder mdpValueBuilder;
80     mdpValueBuilder.rootObject().addValue("density-guided-simulation-active",
81                                           std::string("yes"));
82     KeyValueTreeObject  densityFittingMdpValues = mdpValueBuilder.build();
83
84     // set up options
85     Options densityFittingModuleOptions;
86     densityFittingOptions.initMdpOptions(&densityFittingModuleOptions);
87
88     // Add rules to transform mdp inputs to densityFittingModule data
89     KeyValueTreeTransformer transform;
90     transform.rules()->addRule().keyMatchType("/", StringCompareType::CaseAndDashInsensitive);
91
92     densityFittingOptions.initMdpTransform(transform.rules());
93
94     // Execute the transform on the mdpValues
95     auto transformedMdpValues = transform.transform(densityFittingMdpValues, nullptr);
96     assignOptionsFromKeyValueTree(&densityFittingModuleOptions, transformedMdpValues.object(), nullptr);
97
98     EXPECT_TRUE(densityFittingOptions.buildParameters().active_);
99 }
100
101 TEST(DensityFittingOptionsTest, OutputDefaultValues)
102 {
103     // Transform module data into a flat key-value tree for output.
104
105     StringOutputStream        stream;
106     KeyValueTreeBuilder       builder;
107     KeyValueTreeObjectBuilder builderObject = builder.rootObject();
108
109     DensityFittingOptions     densityFittingOptions;
110     densityFittingOptions.buildMdpOutput(&builderObject);
111
112     {
113         TextWriter writer(&stream);
114         writeKeyValueTreeAsMdp(&writer, builder.build());
115     }
116     stream.close();
117
118     EXPECT_EQ(stream.toString(), std::string("density-guided-simulation-active = false\n"));
119 }
120
121 } // namespace
122
123 } // namespace gmx