src/gromacs/options/timeunitmanager.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2014,2015, 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.
   8  *
   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.
  13  *
  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.
  18  *
  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.
  23  *
  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.
  31  *
  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.
  34  */
  35 /*! \file
  36  * \brief
  37  * Declares gmx::TimeUnitManager.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_options
  42  */
  43 #ifndef GMX_OPTIONS_TIMEUNITMANAGER_H
  44 #define GMX_OPTIONS_TIMEUNITMANAGER_H
  45
  46 #include "gromacs/options/ioptionsbehavior.h"
  47 #include "gromacs/utility/classhelpers.h"
  48 #include "gromacs/utility/gmxassert.h"
  49
  50 namespace gmx
  51 {
  52
  53 class IOptionsContainer;
  54 class Options;
  55
  56 /*! \brief
  57  * Time values for TimeUnitManager.
  58  *
  59  * \if internal
  60  * Currently, this should match with the time_unit_t enum defined in oenv.h
  61  * except that there is no NULL first item in this enum.
  62  * \endif
  63  *
  64  * \inpublicapi
  65  */
  66 enum TimeUnit
  67 {
  68     TimeUnit_fs,                    //!< Femtoseconds.
  69     TimeUnit_ps,                    //!< Picoseconds.
  70     TimeUnit_ns,                    //!< Nanoseconds.
  71     TimeUnit_us,                    //!< Microseconds.
  72     TimeUnit_ms,                    //!< Milliseconds.
  73     TimeUnit_s,                     //!< Seconds.
  74     TimeUnit_Default = TimeUnit_ps  //!< Default time unit.
  75 };
  76
  77 /*! \brief
  78  * Provides common functionality for time unit conversions.
  79  *
  80  * Methods/objects that need to deal with time units can either take a
  81  * TimeUnitManager object, or they can take a TimeUnit value and construct a
  82  * TimeUnitManager object internally.
  83  *
  84  * Default copy constructor and assignment are used: the copy is an independent
  85  * object that is initialized with the same time unit as the original.
  86  *
  87  * \if internal
  88  * \todo
  89  * This class is independent of the options implementation.
  90  * To ease reuse, it could be moved to the utility module, and only
  91  * TimeUnitBehavior left here.
  92  * \endif
  93  *
  94  * \inpublicapi
  95  * \ingroup module_options
  96  */
  97 class TimeUnitManager
  98 {
  99     public:
 100         //! Creates a time unit manager with the default (ps) time unit.
 101         TimeUnitManager();
 102         //! Creates a time unit manager with the given time unit.
 103         explicit TimeUnitManager(TimeUnit unit);
 104
 105         //! Returns the currently selected time unit.
 106         TimeUnit timeUnit() const
 107         {
 108             GMX_ASSERT(timeUnit_ >= 0 && timeUnit_ <= TimeUnit_s,
 109                        "Time unit index has become out-of-range");
 110             return timeUnit_;
 111         }
 112         //! Set a new time unit for the manager.
 113         void setTimeUnit(TimeUnit unit);
 114
 115         //! Returns a string constant corresponding to the current time unit.
 116         const char *timeUnitAsString() const;
 117
 118         //! Returns the scaling factor to convert times to ps.
 119         double timeScaleFactor() const;
 120         //! Returns the scaling factor to convert times from ps.
 121         double inverseTimeScaleFactor() const;
 122
 123     private:
 124         //! Currently set time unit for this manager.
 125         TimeUnit                timeUnit_;
 126 };
 127
 128 /*! \brief
 129  * Options behavior to add a time unit option.
 130  *
 131  * This class provides functionality to add a time unit option that affects the
 132  * input unit for time options (specified with FloatOption::timeValue() or
 133  * DoubleOption::timeValue()).  When options are finished, it scales each time
 134  * option such that any user-given values are interpreted as given in the time
 135  * unit specified by the user, and scaled to picoseconds.  Programmatically
 136  * given values (e.g., as default values for the options) are not scaled.
 137  *
 138  * \inpublicapi
 139  * \ingroup module_options
 140  */
 141 class TimeUnitBehavior : public IOptionsBehavior
 142 {
 143     public:
 144         TimeUnitBehavior();
 145
 146         //! Returns the current time unit.
 147         TimeUnit timeUnit() const
 148         {
 149             GMX_ASSERT(timeUnit_ >= 0 && timeUnit_ <= TimeUnit_s,
 150                        "Time unit index has become out-of-range");
 151             return static_cast<TimeUnit>(timeUnit_);
 152         }
 153         //! Sets the time unit.
 154         void setTimeUnit(TimeUnit unit);
 155
 156         /*! \brief
 157          * Sets a storage location for the selected time unit.
 158          *
 159          * \param[in] store  Location that will receive the selected time unit.
 160          *
 161          * \p *store will be set to the time unit selected by the user (or
 162          * programmatically).  The value is guaranteed to be set once the
 163          * options have been finished.
 164          */
 165         void setTimeUnitStore(TimeUnit *store);
 166
 167         /*! \brief
 168          * Sets the default time unit from an environment variable.
 169          *
 170          * This should be called before addTimeUnitOption() for consistent
 171          * behavior.
 172          */
 173         void setTimeUnitFromEnvironment();
 174         /*! \brief
 175          * Adds a common option for selecting the time unit.
 176          *
 177          * \param[in,out] options Options to which the common option is added.
 178          * \param[in]     name    Name of the option to add.
 179          *
 180          * Adds an enum option to \p options to select the time unit for this
 181          * behavior.
 182          */
 183         void addTimeUnitOption(IOptionsContainer *options, const char *name);
 184
 185         // From IOptionsBehavior
 186         virtual void initBehavior(Options * /*options*/) {}
 187         virtual void optionsFinishing(Options *options);
 188         virtual void optionsFinished() {}
 189
 190     private:
 191         TimeUnit         timeUnit_;
 192         TimeUnit        *timeUnitStore_;
 193
 194         GMX_DISALLOW_COPY_AND_ASSIGN(TimeUnitBehavior);
 195 };
 196
 197 } // namespace gmx
 198
 199 #endif