src/gromacs/options/timeunitmanager.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   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.
   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  * Implements gmx::TimeUnitManager.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_options
  41  */
  42 #include "gromacs/options/timeunitmanager.h"
  43
  44 #include "gromacs/options/basicoptions.h"
  45 #include "gromacs/options/options.h"
  46 #include "gromacs/options/optionsvisitor.h"
  47 #include "gromacs/utility/gmxassert.h"
  48
  49 namespace
  50 {
  51
  52 /*! \brief
  53  * Enum values for a time unit.
  54  *
  55  * These must correspond to the TimeUnit enum in the header!
  56  */
  57 const char *const g_timeUnits[] = {
  58     "fs", "ps", "ns", "us", "ms",  "s"
  59 };
  60 /*! \brief
  61  * Scaling factors from each time unit to internal units (=picoseconds).
  62  *
  63  * These must correspond to the TimeUnit enum in the header!
  64  */
  65 const double g_timeScaleFactors[] = {
  66     1e-3,    1,  1e3,  1e6,  1e9, 1e12
  67 };
  68
  69 } // namespace
  70
  71 namespace gmx
  72 {
  73
  74 TimeUnitManager::TimeUnitManager()
  75     : timeUnit_(eTimeUnit_ps)
  76 {
  77 }
  78
  79 TimeUnitManager::TimeUnitManager(TimeUnit unit)
  80 {
  81     setTimeUnit(unit);
  82 }
  83
  84 void TimeUnitManager::setTimeUnit(TimeUnit unit)
  85 {
  86     GMX_RELEASE_ASSERT(unit >= 0 && unit <= eTimeUnit_s,
  87                        "Invalid time unit");
  88     timeUnit_ = unit;
  89 }
  90
  91 const char *TimeUnitManager::timeUnitAsString() const
  92 {
  93     GMX_RELEASE_ASSERT(timeUnit_ >= 0 && timeUnit_ <= eTimeUnit_s,
  94                        "Invalid time unit");
  95     return g_timeUnits[timeUnit_];
  96 }
  97
  98 double TimeUnitManager::timeScaleFactor() const
  99 {
 100     GMX_RELEASE_ASSERT(timeUnit_ >= 0
 101                        && (size_t)timeUnit_ < sizeof(g_timeScaleFactors)/sizeof(g_timeScaleFactors[0]),
 102                        "Time unit index has become out-of-range");
 103     return g_timeScaleFactors[timeUnit_];
 104 }
 105
 106 double TimeUnitManager::inverseTimeScaleFactor() const
 107 {
 108     return 1.0 / timeScaleFactor();
 109 }
 110
 111 void TimeUnitManager::addTimeUnitOption(Options *options, const char *name)
 112 {
 113     options->addOption(StringOption(name).enumValue(g_timeUnits)
 114                            .defaultValue(g_timeUnits[timeUnit()])
 115                            .storeEnumIndex(&timeUnit_)
 116                            .description("Unit for time values"));
 117 }
 118
 119 namespace
 120 {
 121
 122 /*! \internal \brief
 123  * Option visitor that scales time options.
 124  *
 125  * \tparam FloatingPointOptionInfo  OptionInfo type for an option that provides
 126  *     isTime() and setScaleFactor() methods.
 127  *
 128  * \ingroup module_options
 129  */
 130 template <class FloatingPointOptionInfo>
 131 class TimeOptionScaler : public OptionsModifyingTypeVisitor<FloatingPointOptionInfo>
 132 {
 133     public:
 134         //! Initializes a scaler with the given factor.
 135         explicit TimeOptionScaler(double factor) : factor_(factor) {}
 136
 137         void visitSubSection(Options *section)
 138         {
 139             OptionsModifyingIterator iterator(section);
 140             iterator.acceptSubSections(this);
 141             iterator.acceptOptions(this);
 142         }
 143
 144         void visitOptionType(FloatingPointOptionInfo *option)
 145         {
 146             if (option->isTime())
 147             {
 148                 option->setScaleFactor(factor_);
 149             }
 150         }
 151
 152     private:
 153         double                  factor_;
 154 };
 155
 156 }   // namespace
 157
 158 void TimeUnitManager::scaleTimeOptions(Options *options) const
 159 {
 160     double factor = timeScaleFactor();
 161     TimeOptionScaler<DoubleOptionInfo>(factor).visitSubSection(options);
 162     TimeOptionScaler<FloatOptionInfo>(factor).visitSubSection(options);
 163 }
 164
 165 } // namespace gmx