src/gromacs/fileio/timecontrol.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2018,2019,2021, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 #include "gmxpre.h"
  38
  39 #include "gromacs/utility/enumerationhelpers.h"
  40 #include "timecontrol.h"
  41
  42 #include <mutex>
  43
  44 #include "gromacs/utility/basedefinitions.h"
  45 #include "gromacs/utility/fatalerror.h"
  46 #include "gromacs/utility/real.h"
  47
  48 /* The source code in this file should be thread-safe.
  49          Please keep it that way. */
  50
  51 /* Globals for trajectory input */
  52 struct t_timecontrol
  53 {
  54     t_timecontrol(real inputT, bool inputSet) : t(inputT), bSet(inputSet) {}
  55     real t;
  56     bool bSet;
  57 };
  58
  59 // NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables)
  60 static gmx::EnumerationArray<TimeControl, t_timecontrol> timecontrol = { t_timecontrol(0, false),
  61                                                                          t_timecontrol(0, false),
  62                                                                          t_timecontrol(0, false) };
  63
  64 // NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables)
  65 static std::mutex g_timeControlMutex;
  66
  67 gmx_bool bTimeSet(TimeControl tcontrol)
  68 {
  69     gmx_bool ret;
  70
  71     const std::lock_guard<std::mutex> lock(g_timeControlMutex);
  72     ret = timecontrol[tcontrol].bSet;
  73
  74     return ret;
  75 }
  76
  77 real rTimeValue(TimeControl tcontrol)
  78 {
  79     real ret;
  80
  81     const std::lock_guard<std::mutex> lock(g_timeControlMutex);
  82     ret = timecontrol[tcontrol].t;
  83     return ret;
  84 }
  85
  86 void setTimeValue(TimeControl tcontrol, real value)
  87 {
  88     const std::lock_guard<std::mutex> lock(g_timeControlMutex);
  89     timecontrol[tcontrol].t    = value;
  90     timecontrol[tcontrol].bSet = TRUE;
  91 }