src/gromacs/options/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  * 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 <cstdlib>
  45
  46 #include <algorithm>
  47
  48 #include "gromacs/options/basicoptions.h"
  49 #include "gromacs/options/options.h"
  50 #include "gromacs/options/optionsvisitor.h"
  51 #include "gromacs/utility/arrayref.h"
  52 #include "gromacs/utility/exceptions.h"
  53 #include "gromacs/utility/gmxassert.h"
  54 #include "gromacs/utility/stringutil.h"
  55
  56 namespace
  57 {
  58
  59 /*! \brief
  60  * Enum values for a time unit.
  61  *
  62  * These must correspond to the TimeUnit enum in the header!
  63  */
  64 const char *const g_timeUnits[] = {
  65     "fs", "ps", "ns", "us", "ms",  "s"
  66 };
  67 /*! \brief
  68  * Scaling factors from each time unit to internal units (=picoseconds).
  69  *
  70  * These must correspond to the TimeUnit enum in the header!
  71  */
  72 const double g_timeScaleFactors[] = {
  73     1e-3,    1,  1e3,  1e6,  1e9, 1e12
  74 };
  75
  76 } // namespace
  77
  78 namespace gmx
  79 {
  80
  81 TimeUnitManager::TimeUnitManager()
  82     : timeUnit_(eTimeUnit_ps)
  83 {
  84 }
  85
  86 TimeUnitManager::TimeUnitManager(TimeUnit unit)
  87 {
  88     setTimeUnit(unit);
  89 }
  90
  91 void TimeUnitManager::setTimeUnit(TimeUnit unit)
  92 {
  93     GMX_RELEASE_ASSERT(unit >= 0 && unit <= eTimeUnit_s,
  94                        "Invalid time unit");
  95     timeUnit_ = unit;
  96 }
  97
  98 const char *TimeUnitManager::timeUnitAsString() const
  99 {
 100     GMX_RELEASE_ASSERT(timeUnit_ >= 0 && timeUnit_ <= eTimeUnit_s,
 101                        "Invalid time unit");
 102     return g_timeUnits[timeUnit_];
 103 }
 104
 105 double TimeUnitManager::timeScaleFactor() const
 106 {
 107     GMX_RELEASE_ASSERT(timeUnit_ >= 0
 108                        && (size_t)timeUnit_ < sizeof(g_timeScaleFactors)/sizeof(g_timeScaleFactors[0]),
 109                        "Time unit index has become out-of-range");
 110     return g_timeScaleFactors[timeUnit_];
 111 }
 112
 113 double TimeUnitManager::inverseTimeScaleFactor() const
 114 {
 115     return 1.0 / timeScaleFactor();
 116 }
 117
 118 void TimeUnitManager::setTimeUnitFromEnvironment()
 119 {
 120     const char *const value = std::getenv("GMXTIMEUNIT");
 121     if (value != NULL)
 122     {
 123         ConstArrayRef<const char *>                 timeUnits(g_timeUnits);
 124         ConstArrayRef<const char *>::const_iterator i =
 125             std::find(timeUnits.begin(), timeUnits.end(), std::string(value));
 126         if (i == timeUnits.end())
 127         {
 128             std::string message = formatString(
 129                         "Time unit provided with environment variable GMXTIMEUNIT=%s "
 130                         "is not recognized as a valid time unit.\n"
 131                         "Possible values are: %s",
 132                         value, joinStrings(timeUnits, ", ").c_str());
 133             GMX_THROW(InvalidInputError(message));
 134         }
 135         timeUnit_ = i - timeUnits.begin();
 136     }
 137 }
 138
 139 void TimeUnitManager::addTimeUnitOption(Options *options, const char *name)
 140 {
 141     options->addOption(StringOption(name).enumValue(g_timeUnits)
 142                            .defaultValue(g_timeUnits[timeUnit()])
 143                            .storeEnumIndex(&timeUnit_)
 144                            .description("Unit for time values"));
 145 }
 146
 147 namespace
 148 {
 149
 150 /*! \internal \brief
 151  * Option visitor that scales time options.
 152  *
 153  * \tparam FloatingPointOptionInfo  OptionInfo type for an option that provides
 154  *     isTime() and setScaleFactor() methods.
 155  *
 156  * \ingroup module_options
 157  */
 158 template <class FloatingPointOptionInfo>
 159 class TimeOptionScaler : public OptionsModifyingTypeVisitor<FloatingPointOptionInfo>
 160 {
 161     public:
 162         //! Initializes a scaler with the given factor.
 163         explicit TimeOptionScaler(double factor) : factor_(factor) {}
 164
 165         void visitSubSection(Options *section)
 166         {
 167             OptionsModifyingIterator iterator(section);
 168             iterator.acceptSubSections(this);
 169             iterator.acceptOptions(this);
 170         }
 171
 172         void visitOptionType(FloatingPointOptionInfo *option)
 173         {
 174             if (option->isTime())
 175             {
 176                 option->setScaleFactor(factor_);
 177             }
 178         }
 179
 180     private:
 181         double                  factor_;
 182 };
 183
 184 }   // namespace
 185
 186 void TimeUnitManager::scaleTimeOptions(Options *options) const
 187 {
 188     double factor = timeScaleFactor();
 189     TimeOptionScaler<DoubleOptionInfo>(factor).visitSubSection(options);
 190     TimeOptionScaler<FloatOptionInfo>(factor).visitSubSection(options);
 191 }
 192
 193 } // namespace gmx