src/gromacs/options/tests/timeunitmanager.cpp

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