src/gromacs/options/timeunitmanager.cpp

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \internal \file
  32  * \brief
  33  * Implements gmx::TimeUnitManager.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \ingroup module_options
  37  */
  38 #include "gromacs/options/timeunitmanager.h"
  39
  40 #include "gromacs/options/basicoptioninfo.h"
  41 #include "gromacs/options/basicoptions.h"
  42 #include "gromacs/options/options.h"
  43 #include "gromacs/options/optionsvisitor.h"
  44 #include "gromacs/utility/gmxassert.h"
  45
  46 namespace
  47 {
  48
  49 /*! \brief
  50  * Enum values for a time unit.
  51  *
  52  * These must correspond to the TimeUnit enum in the header!
  53  */
  54 const char *const g_timeUnits[] = {
  55     "fs", "ps", "ns", "us", "ms",  "s", NULL
  56 };
  57 /*! \brief
  58  * Scaling factors from each time unit to internal units (=picoseconds).
  59  *
  60  * These must correspond to the TimeUnit enum in the header!
  61  */
  62 const double g_timeScaleFactors[] = {
  63     1e-3,    1,  1e3,  1e6,  1e9, 1e12
  64 };
  65
  66 } // namespace
  67
  68 namespace gmx
  69 {
  70
  71 TimeUnitManager::TimeUnitManager()
  72     : timeUnit_(eTimeUnit_ps)
  73 {
  74 }
  75
  76 TimeUnitManager::TimeUnitManager(TimeUnit unit)
  77 {
  78     setTimeUnit(unit);
  79 }
  80
  81 void TimeUnitManager::setTimeUnit(TimeUnit unit)
  82 {
  83     GMX_RELEASE_ASSERT(unit >= 0 && unit <= eTimeUnit_s,
  84                        "Invalid time unit");
  85     timeUnit_ = unit;
  86 }
  87
  88 const char *TimeUnitManager::timeUnitAsString() const
  89 {
  90     GMX_RELEASE_ASSERT(timeUnit_ >= 0 && timeUnit_ <= eTimeUnit_s,
  91                        "Invalid time unit");
  92     return g_timeUnits[timeUnit_];
  93 }
  94
  95 double TimeUnitManager::timeScaleFactor() const
  96 {
  97     GMX_RELEASE_ASSERT(timeUnit_ >= 0
  98         && (size_t)timeUnit_ < sizeof(g_timeScaleFactors)/sizeof(g_timeScaleFactors[0]),
  99         "Time unit index has become out-of-range");
 100     return g_timeScaleFactors[timeUnit_];
 101 }
 102
 103 double TimeUnitManager::inverseTimeScaleFactor() const
 104 {
 105     return 1.0 / timeScaleFactor();
 106 }
 107
 108 void TimeUnitManager::addTimeUnitOption(Options *options, const char *name)
 109 {
 110     options->addOption(StringOption(name).enumValue(g_timeUnits)
 111                            .defaultValue(g_timeUnits[timeUnit()])
 112                            .storeEnumIndex(&timeUnit_)
 113                            .description("Unit for time values"));
 114 }
 115
 116 namespace
 117 {
 118
 119 /*! \internal \brief
 120  * Option visitor that scales time options.
 121  *
 122  * \ingroup module_options
 123  */
 124 class TimeOptionScaler : public OptionsModifyingTypeVisitor<DoubleOptionInfo>
 125 {
 126     public:
 127         //! Initializes a scaler with the given factor.
 128         explicit TimeOptionScaler(double factor) : factor_(factor) {}
 129
 130         void visitSubSection(Options *section)
 131         {
 132             OptionsModifyingIterator iterator(section);
 133             iterator.acceptSubSections(this);
 134             iterator.acceptOptions(this);
 135         }
 136
 137         void visitOptionType(DoubleOptionInfo *option)
 138         {
 139             if (option->isTime())
 140             {
 141                 option->setScaleFactor(factor_);
 142             }
 143         }
 144
 145     private:
 146         double                  factor_;
 147 };
 148
 149 } // namespace
 150
 151 void TimeUnitManager::scaleTimeOptions(Options *options) const
 152 {
 153     double factor = timeScaleFactor();
 154     TimeOptionScaler(factor).visitSubSection(options);
 155 }
 156
 157 } // namespace gmx