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