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