2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2014,2015,2018,2019,2020, 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 * Declares gmx::TimeUnitManager.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
41 * \ingroup module_options
43 #ifndef GMX_OPTIONS_TIMEUNITMANAGER_H
44 #define GMX_OPTIONS_TIMEUNITMANAGER_H
46 #include "gromacs/fileio/oenv.h"
47 #include "gromacs/options/ioptionsbehavior.h"
48 #include "gromacs/utility/classhelpers.h"
53 class IOptionsContainer;
57 * Provides common functionality for time unit conversions.
59 * Methods/objects that need to deal with time units can either take a
60 * TimeUnitManager object, or they can take a TimeUnit value and construct a
61 * TimeUnitManager object internally.
63 * Default copy constructor and assignment are used: the copy is an independent
64 * object that is initialized with the same time unit as the original.
68 * This class is independent of the options implementation.
69 * To ease reuse, it could be moved to the utility module, and only
70 * TimeUnitBehavior left here.
74 * \ingroup module_options
79 //! Creates a time unit manager with the default (ps) time unit.
81 //! Creates a time unit manager with the given time unit.
82 explicit TimeUnitManager(TimeUnit unit);
84 //! Returns the currently selected time unit.
85 TimeUnit timeUnit() const { return timeUnit_; }
86 //! Set a new time unit for the manager.
87 void setTimeUnit(TimeUnit unit);
89 //! Returns a string constant corresponding to the current time unit.
90 const char* timeUnitAsString() const;
92 //! Returns the scaling factor to convert times to ps.
93 double timeScaleFactor() const;
94 //! Returns the scaling factor to convert times from ps.
95 double inverseTimeScaleFactor() const;
98 //! Currently set time unit for this manager.
103 * Options behavior to add a time unit option.
105 * This class provides functionality to add a time unit option that affects the
106 * input unit for time options (specified with FloatOption::timeValue() or
107 * DoubleOption::timeValue()). When options are finished, it scales each time
108 * option such that any user-given values are interpreted as given in the time
109 * unit specified by the user, and scaled to picoseconds. Programmatically
110 * given values (e.g., as default values for the options) are not scaled.
113 * \ingroup module_options
115 class TimeUnitBehavior : public IOptionsBehavior
120 //! Returns the current time unit.
121 TimeUnit timeUnit() const { return timeUnit_; }
122 //! Sets the time unit.
123 void setTimeUnit(TimeUnit unit);
126 * Sets a storage location for the selected time unit.
128 * \param[in] store Location that will receive the selected time unit.
130 * \p *store will be set to the time unit selected by the user (or
131 * programmatically). The value is guaranteed to be set once the
132 * options have been finished.
134 void setTimeUnitStore(TimeUnit* store);
137 * Sets the default time unit from an environment variable.
139 * This should be called before addTimeUnitOption() for consistent
142 void setTimeUnitFromEnvironment();
144 * Adds a common option for selecting the time unit.
146 * \param[in,out] options Options to which the common option is added.
147 * \param[in] name Name of the option to add.
149 * Adds an enum option to \p options to select the time unit for this
152 void addTimeUnitOption(IOptionsContainer* options, const char* name);
154 // From IOptionsBehavior
155 void initBehavior(Options* /*options*/) override {}
156 void optionsFinishing(Options* options) override;
157 void optionsFinished() override {}
161 TimeUnit* timeUnitStore_;
163 GMX_DISALLOW_COPY_AND_ASSIGN(TimeUnitBehavior);