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