2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013, 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.
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.
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.
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.
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.
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.
37 * Implements gmx::TimeUnitManager.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_options
42 #include "gromacs/options/timeunitmanager.h"
44 #include "gromacs/options/basicoptions.h"
45 #include "gromacs/options/options.h"
46 #include "gromacs/options/optionsvisitor.h"
47 #include "gromacs/utility/gmxassert.h"
53 * Enum values for a time unit.
55 * These must correspond to the TimeUnit enum in the header!
57 const char *const g_timeUnits[] = {
58 "fs", "ps", "ns", "us", "ms", "s"
61 * Scaling factors from each time unit to internal units (=picoseconds).
63 * These must correspond to the TimeUnit enum in the header!
65 const double g_timeScaleFactors[] = {
66 1e-3, 1, 1e3, 1e6, 1e9, 1e12
74 TimeUnitManager::TimeUnitManager()
75 : timeUnit_(eTimeUnit_ps)
79 TimeUnitManager::TimeUnitManager(TimeUnit unit)
84 void TimeUnitManager::setTimeUnit(TimeUnit unit)
86 GMX_RELEASE_ASSERT(unit >= 0 && unit <= eTimeUnit_s,
91 const char *TimeUnitManager::timeUnitAsString() const
93 GMX_RELEASE_ASSERT(timeUnit_ >= 0 && timeUnit_ <= eTimeUnit_s,
95 return g_timeUnits[timeUnit_];
98 double TimeUnitManager::timeScaleFactor() const
100 GMX_RELEASE_ASSERT(timeUnit_ >= 0
101 && (size_t)timeUnit_ < sizeof(g_timeScaleFactors)/sizeof(g_timeScaleFactors[0]),
102 "Time unit index has become out-of-range");
103 return g_timeScaleFactors[timeUnit_];
106 double TimeUnitManager::inverseTimeScaleFactor() const
108 return 1.0 / timeScaleFactor();
111 void TimeUnitManager::addTimeUnitOption(Options *options, const char *name)
113 options->addOption(StringOption(name).enumValue(g_timeUnits)
114 .defaultValue(g_timeUnits[timeUnit()])
115 .storeEnumIndex(&timeUnit_)
116 .description("Unit for time values"));
123 * Option visitor that scales time options.
125 * \ingroup module_options
127 class TimeOptionScaler : public OptionsModifyingTypeVisitor<DoubleOptionInfo>
130 //! Initializes a scaler with the given factor.
131 explicit TimeOptionScaler(double factor) : factor_(factor) {}
133 void visitSubSection(Options *section)
135 OptionsModifyingIterator iterator(section);
136 iterator.acceptSubSections(this);
137 iterator.acceptOptions(this);
140 void visitOptionType(DoubleOptionInfo *option)
142 if (option->isTime())
144 option->setScaleFactor(factor_);
154 void TimeUnitManager::scaleTimeOptions(Options *options) const
156 double factor = timeScaleFactor();
157 TimeOptionScaler(factor).visitSubSection(options);