src/gromacs/options/tests/timeunitmanager.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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 <gtest/gtest.h>
  45
  46 #include "gromacs/options/basicoptions.h"
  47 #include "gromacs/options/options.h"
  48 #include "gromacs/options/optionsassigner.h"
  49 #include "gromacs/options/timeunitmanager.h"
  50
  51 namespace
  52 {
  53
  54 TEST(TimeUnitManagerTest, BasicOperations)
  55 {
  56     gmx::TimeUnitManager manager;
  57     EXPECT_EQ(gmx::eTimeUnit_ps, manager.timeUnit());
  58     EXPECT_DOUBLE_EQ(1.0, manager.timeScaleFactor());
  59     manager.setTimeUnit(gmx::eTimeUnit_ns);
  60     EXPECT_EQ(gmx::eTimeUnit_ns, manager.timeUnit());
  61     EXPECT_DOUBLE_EQ(1e3, manager.timeScaleFactor());
  62     EXPECT_DOUBLE_EQ(1e-3, manager.inverseTimeScaleFactor());
  63 }
  64
  65 TEST(TimeUnitManagerTest, ScalesAssignedOptionValue)
  66 {
  67     gmx::TimeUnitManager manager;
  68
  69     gmx::Options         options(NULL, NULL);
  70     double               value = 0.0;
  71     using gmx::DoubleOption;
  72     ASSERT_NO_THROW(options.addOption(DoubleOption("p").store(&value).timeValue()));
  73
  74     gmx::OptionsAssigner assigner(&options);
  75     EXPECT_NO_THROW(assigner.start());
  76     ASSERT_NO_THROW(assigner.startOption("p"));
  77     ASSERT_NO_THROW(assigner.appendValue("1.5"));
  78     EXPECT_NO_THROW(assigner.finishOption());
  79     EXPECT_NO_THROW(assigner.finish());
  80
  81     EXPECT_DOUBLE_EQ(1.5, value);
  82     manager.setTimeUnit(gmx::eTimeUnit_ns);
  83     manager.scaleTimeOptions(&options);
  84     EXPECT_DOUBLE_EQ(1500, value);
  85
  86     EXPECT_NO_THROW(options.finish());
  87
  88     manager.setTimeUnit(gmx::eTimeUnit_us);
  89     manager.scaleTimeOptions(&options);
  90     EXPECT_DOUBLE_EQ(1500000, value);
  91
  92     manager.setTimeUnit(gmx::eTimeUnit_fs);
  93     manager.scaleTimeOptions(&options);
  94     EXPECT_DOUBLE_EQ(0.0015, value);
  95
  96     manager.setTimeUnit(gmx::eTimeUnit_ps);
  97     manager.scaleTimeOptions(&options);
  98     EXPECT_DOUBLE_EQ(1.5, value);
  99 }
 100
 101 TEST(TimeUnitManagerTest, DoesNotScaleDefaultValues)
 102 {
 103     gmx::TimeUnitManager manager;
 104
 105     gmx::Options         options(NULL, NULL);
 106     double               value = 1.5, value2 = 0.0;
 107     using gmx::DoubleOption;
 108     ASSERT_NO_THROW(options.addOption(DoubleOption("p").store(&value).timeValue()));
 109     ASSERT_NO_THROW(options.addOption(DoubleOption("q").store(&value2).timeValue()
 110                                           .defaultValueIfSet(2.5)));
 111
 112     gmx::OptionsAssigner assigner(&options);
 113     EXPECT_NO_THROW(assigner.start());
 114     ASSERT_NO_THROW(assigner.startOption("q"));
 115     EXPECT_NO_THROW(assigner.finishOption());
 116     EXPECT_NO_THROW(assigner.finish());
 117     EXPECT_NO_THROW(options.finish());
 118
 119     EXPECT_DOUBLE_EQ(2.5, value2);
 120     manager.setTimeUnit(gmx::eTimeUnit_ns);
 121     manager.scaleTimeOptions(&options);
 122     EXPECT_DOUBLE_EQ(1.5, value);
 123     EXPECT_DOUBLE_EQ(2.5, value2);
 124 }
 125
 126 TEST(TimeUnitManagerTest, ScalesUserInputWithMultipleSources)
 127 {
 128     gmx::TimeUnitManager manager;
 129
 130     gmx::Options         options(NULL, NULL);
 131     double               value = 0.0;
 132     using gmx::DoubleOption;
 133     ASSERT_NO_THROW(options.addOption(DoubleOption("p").store(&value).timeValue()));
 134
 135     gmx::OptionsAssigner assigner(&options);
 136     EXPECT_NO_THROW(assigner.start());
 137     ASSERT_NO_THROW(assigner.startOption("p"));
 138     ASSERT_NO_THROW(assigner.appendValue("1.5"));
 139     EXPECT_NO_THROW(assigner.finishOption());
 140     EXPECT_NO_THROW(assigner.finish());
 141     gmx::OptionsAssigner assigner2(&options);
 142     EXPECT_NO_THROW(assigner2.start());
 143     EXPECT_NO_THROW(assigner2.finish());
 144     EXPECT_NO_THROW(options.finish());
 145
 146     EXPECT_DOUBLE_EQ(1.5, value);
 147     manager.setTimeUnit(gmx::eTimeUnit_ns);
 148     manager.scaleTimeOptions(&options);
 149     EXPECT_DOUBLE_EQ(1500, value);
 150 }
 151
 152 TEST(TimeUnitManagerTest, TimeUnitOptionWorks)
 153 {
 154     gmx::TimeUnitManager manager;
 155
 156     gmx::Options         options(NULL, NULL);
 157     double               value = 0.0;
 158     using gmx::DoubleOption;
 159     ASSERT_NO_THROW(options.addOption(DoubleOption("p").store(&value).timeValue()));
 160     ASSERT_NO_THROW(manager.addTimeUnitOption(&options, "tu"));
 161
 162     gmx::OptionsAssigner assigner(&options);
 163     EXPECT_NO_THROW(assigner.start());
 164     ASSERT_NO_THROW(assigner.startOption("p"));
 165     ASSERT_NO_THROW(assigner.appendValue("1.5"));
 166     EXPECT_NO_THROW(assigner.finishOption());
 167     ASSERT_NO_THROW(assigner.startOption("tu"));
 168     ASSERT_NO_THROW(assigner.appendValue("ns"));
 169     EXPECT_NO_THROW(assigner.finishOption());
 170     EXPECT_NO_THROW(assigner.finish());
 171
 172     EXPECT_DOUBLE_EQ(1.5, value);
 173     EXPECT_EQ(gmx::eTimeUnit_ns, manager.timeUnit());
 174     manager.scaleTimeOptions(&options);
 175     EXPECT_DOUBLE_EQ(1500, value);
 176
 177     EXPECT_NO_THROW(options.finish());
 178 }
 179
 180 } // namespace