src/gromacs/options/timeunitmanager.cpp

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