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