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/basicoptions.h"
  41 #include "gromacs/options/options.h"
  42 #include "gromacs/options/optionsvisitor.h"
  43 #include "gromacs/utility/gmxassert.h"
  44
  45 namespace
  46 {
  47
  48 /*! \brief
  49  * Enum values for a time unit.
  50  *
  51  * These must correspond to the TimeUnit enum in the header!
  52  */
  53 const char *const g_timeUnits[] = {
  54     "fs", "ps", "ns", "us", "ms",  "s", NULL
  55 };
  56 /*! \brief
  57  * Scaling factors from each time unit to internal units (=picoseconds).
  58  *
  59  * These must correspond to the TimeUnit enum in the header!
  60  */
  61 const double g_timeScaleFactors[] = {
  62     1e-3,    1,  1e3,  1e6,  1e9, 1e12
  63 };
  64
  65 } // namespace
  66
  67 namespace gmx
  68 {
  69
  70 TimeUnitManager::TimeUnitManager()
  71     : timeUnit_(eTimeUnit_ps)
  72 {
  73 }
  74
  75 TimeUnitManager::TimeUnitManager(TimeUnit unit)
  76 {
  77     setTimeUnit(unit);
  78 }
  79
  80 void TimeUnitManager::setTimeUnit(TimeUnit unit)
  81 {
  82     GMX_RELEASE_ASSERT(unit >= 0 && unit <= eTimeUnit_s,
  83                        "Invalid time unit");
  84     timeUnit_ = unit;
  85 }
  86
  87 const char *TimeUnitManager::timeUnitAsString() const
  88 {
  89     GMX_RELEASE_ASSERT(timeUnit_ >= 0 && timeUnit_ <= eTimeUnit_s,
  90                        "Invalid time unit");
  91     return g_timeUnits[timeUnit_];
  92 }
  93
  94 double TimeUnitManager::timeScaleFactor() const
  95 {
  96     GMX_RELEASE_ASSERT(timeUnit_ >= 0
  97         && (size_t)timeUnit_ < sizeof(g_timeScaleFactors)/sizeof(g_timeScaleFactors[0]),
  98         "Time unit index has become out-of-range");
  99     return g_timeScaleFactors[timeUnit_];
 100 }
 101
 102 double TimeUnitManager::inverseTimeScaleFactor() const
 103 {
 104     return 1.0 / timeScaleFactor();
 105 }
 106
 107 void TimeUnitManager::addTimeUnitOption(Options *options, const char *name)
 108 {
 109     options->addOption(StringOption(name).enumValue(g_timeUnits)
 110                            .defaultValue(g_timeUnits[timeUnit()])
 111                            .storeEnumIndex(&timeUnit_)
 112                            .description("Unit for time values"));
 113 }
 114
 115 namespace
 116 {
 117
 118 /*! \internal \brief
 119  * Option visitor that scales time options.
 120  *
 121  * \ingroup module_options
 122  */
 123 class TimeOptionScaler : public OptionsModifyingTypeVisitor<DoubleOptionInfo>
 124 {
 125     public:
 126         //! Initializes a scaler with the given factor.
 127         explicit TimeOptionScaler(double factor) : factor_(factor) {}
 128
 129         void visitSubSection(Options *section)
 130         {
 131             OptionsModifyingIterator iterator(section);
 132             iterator.acceptSubSections(this);
 133             iterator.acceptOptions(this);
 134         }
 135
 136         void visitOptionType(DoubleOptionInfo *option)
 137         {
 138             if (option->isTime())
 139             {
 140                 option->setScaleFactor(factor_);
 141             }
 142         }
 143
 144     private:
 145         double                  factor_;
 146 };
 147
 148 } // namespace
 149
 150 void TimeUnitManager::scaleTimeOptions(Options *options) const
 151 {
 152     double factor = timeScaleFactor();
 153     TimeOptionScaler(factor).visitSubSection(options);
 154 }
 155
 156 } // namespace gmx