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