2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,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 * Tests handling of time units with gmx::TimeUnitManager.
39 * Also related functionality in gmx::DoubleOptionStorage is tested.
41 * \author Teemu Murtola <teemu.murtola@gmail.com>
42 * \ingroup module_options
44 #include <gtest/gtest.h>
46 #include "gromacs/options/basicoptions.h"
47 #include "gromacs/options/options.h"
48 #include "gromacs/options/optionsassigner.h"
49 #include "gromacs/options/timeunitmanager.h"
51 #include "testutils/testasserts.h"
56 TEST(TimeUnitManagerTest, BasicOperations)
58 gmx::TimeUnitManager manager;
59 EXPECT_EQ(gmx::eTimeUnit_ps, manager.timeUnit());
60 EXPECT_DOUBLE_EQ(1.0, manager.timeScaleFactor());
61 manager.setTimeUnit(gmx::eTimeUnit_ns);
62 EXPECT_EQ(gmx::eTimeUnit_ns, manager.timeUnit());
63 EXPECT_DOUBLE_EQ(1e3, manager.timeScaleFactor());
64 EXPECT_DOUBLE_EQ(1e-3, manager.inverseTimeScaleFactor());
67 TEST(TimeUnitManagerTest, ScalesAssignedOptionValue)
69 gmx::TimeUnitManager manager;
71 gmx::Options options(NULL, NULL);
73 using gmx::DoubleOption;
74 ASSERT_NO_THROW_GMX(options.addOption(DoubleOption("p").store(&value).timeValue()));
76 gmx::OptionsAssigner assigner(&options);
77 EXPECT_NO_THROW_GMX(assigner.start());
78 ASSERT_NO_THROW_GMX(assigner.startOption("p"));
79 ASSERT_NO_THROW_GMX(assigner.appendValue("1.5"));
80 EXPECT_NO_THROW_GMX(assigner.finishOption());
81 EXPECT_NO_THROW_GMX(assigner.finish());
83 EXPECT_DOUBLE_EQ(1.5, value);
84 manager.setTimeUnit(gmx::eTimeUnit_ns);
85 manager.scaleTimeOptions(&options);
86 EXPECT_DOUBLE_EQ(1500, value);
88 EXPECT_NO_THROW_GMX(options.finish());
90 manager.setTimeUnit(gmx::eTimeUnit_us);
91 manager.scaleTimeOptions(&options);
92 EXPECT_DOUBLE_EQ(1500000, value);
94 manager.setTimeUnit(gmx::eTimeUnit_fs);
95 manager.scaleTimeOptions(&options);
96 EXPECT_DOUBLE_EQ(0.0015, value);
98 manager.setTimeUnit(gmx::eTimeUnit_ps);
99 manager.scaleTimeOptions(&options);
100 EXPECT_DOUBLE_EQ(1.5, value);
103 TEST(TimeUnitManagerTest, DoesNotScaleDefaultValues)
105 gmx::TimeUnitManager manager;
107 gmx::Options options(NULL, NULL);
108 double value = 1.5, value2 = 0.0;
109 using gmx::DoubleOption;
110 ASSERT_NO_THROW_GMX(options.addOption(DoubleOption("p").store(&value).timeValue()));
111 ASSERT_NO_THROW_GMX(options.addOption(DoubleOption("q").store(&value2).timeValue()
112 .defaultValueIfSet(2.5)));
114 gmx::OptionsAssigner assigner(&options);
115 EXPECT_NO_THROW_GMX(assigner.start());
116 ASSERT_NO_THROW_GMX(assigner.startOption("q"));
117 EXPECT_NO_THROW_GMX(assigner.finishOption());
118 EXPECT_NO_THROW_GMX(assigner.finish());
119 EXPECT_NO_THROW_GMX(options.finish());
121 EXPECT_DOUBLE_EQ(2.5, value2);
122 manager.setTimeUnit(gmx::eTimeUnit_ns);
123 manager.scaleTimeOptions(&options);
124 EXPECT_DOUBLE_EQ(1.5, value);
125 EXPECT_DOUBLE_EQ(2.5, value2);
128 TEST(TimeUnitManagerTest, ScalesUserInputWithMultipleSources)
130 gmx::TimeUnitManager manager;
132 gmx::Options options(NULL, NULL);
134 using gmx::DoubleOption;
135 ASSERT_NO_THROW_GMX(options.addOption(DoubleOption("p").store(&value).timeValue()));
137 gmx::OptionsAssigner assigner(&options);
138 EXPECT_NO_THROW_GMX(assigner.start());
139 ASSERT_NO_THROW_GMX(assigner.startOption("p"));
140 ASSERT_NO_THROW_GMX(assigner.appendValue("1.5"));
141 EXPECT_NO_THROW_GMX(assigner.finishOption());
142 EXPECT_NO_THROW_GMX(assigner.finish());
143 gmx::OptionsAssigner assigner2(&options);
144 EXPECT_NO_THROW_GMX(assigner2.start());
145 EXPECT_NO_THROW_GMX(assigner2.finish());
146 EXPECT_NO_THROW_GMX(options.finish());
148 EXPECT_DOUBLE_EQ(1.5, value);
149 manager.setTimeUnit(gmx::eTimeUnit_ns);
150 manager.scaleTimeOptions(&options);
151 EXPECT_DOUBLE_EQ(1500, value);
154 TEST(TimeUnitManagerTest, TimeUnitOptionWorks)
156 gmx::TimeUnitManager manager;
158 gmx::Options options(NULL, NULL);
160 using gmx::DoubleOption;
161 ASSERT_NO_THROW_GMX(options.addOption(DoubleOption("p").store(&value).timeValue()));
162 ASSERT_NO_THROW_GMX(manager.addTimeUnitOption(&options, "tu"));
164 gmx::OptionsAssigner assigner(&options);
165 EXPECT_NO_THROW_GMX(assigner.start());
166 ASSERT_NO_THROW_GMX(assigner.startOption("p"));
167 ASSERT_NO_THROW_GMX(assigner.appendValue("1.5"));
168 EXPECT_NO_THROW_GMX(assigner.finishOption());
169 ASSERT_NO_THROW_GMX(assigner.startOption("tu"));
170 ASSERT_NO_THROW_GMX(assigner.appendValue("ns"));
171 EXPECT_NO_THROW_GMX(assigner.finishOption());
172 EXPECT_NO_THROW_GMX(assigner.finish());
174 EXPECT_DOUBLE_EQ(1.5, value);
175 EXPECT_EQ(gmx::eTimeUnit_ns, manager.timeUnit());
176 manager.scaleTimeOptions(&options);
177 EXPECT_DOUBLE_EQ(1500, value);
179 EXPECT_NO_THROW_GMX(options.finish());