src/gromacs/gmxlib/oenv.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, 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/legacyheaders/oenv.h"
  40
  41 #include "gromacs/utility/smalloc.h"
  42
  43 #include "gromacs/utility/programcontext.h"
  44 #include "gromacs/utility/exceptions.h"
  45
  46 struct output_env
  47 {
  48     explicit output_env(const gmx::ProgramContextInterface &context)
  49         : programContext(context)
  50     {
  51         time_unit   = time_ps;
  52         view        = FALSE;
  53         xvg_format  = exvgNONE;
  54         verbosity   = 0;
  55     }
  56
  57     const gmx::ProgramContextInterface  &programContext;
  58
  59     /* the time unit, enum defined in oenv.h */
  60     time_unit_t                          time_unit;
  61     /* view of file requested */
  62     gmx_bool                             view;
  63     /* xvg output format, enum defined in oenv.h */
  64     xvg_format_t                         xvg_format;
  65     /* The level of verbosity for this program */
  66     int                                  verbosity;
  67 };
  68
  69 /* The source code in this file should be thread-safe.
  70       Please keep it that way. */
  71
  72 /******************************************************************
  73  *
  74  *             T R A J E C T O R Y   S T U F F
  75  *
  76  ******************************************************************/
  77
  78 /* read only time names */
  79 /* These must correspond to the time units type time_unit_t in oenv.h */
  80 static const real  timefactors[] =   { 0,  1e3,  1, 1e-3, 1e-6, 1e-9, 1e-12, 0 };
  81 static const real  timeinvfactors[] = { 0, 1e-3,  1,  1e3,  1e6,  1e9,  1e12, 0 };
  82 static const char *time_units_str[] = {
  83     NULL, "fs", "ps", "ns", "us",
  84     "\\mus", "ms", "s"
  85 };
  86 static const char *time_units_xvgr[] = {
  87     NULL, "fs", "ps", "ns",
  88     "ms", "s", NULL
  89 };
  90
  91
  92 /***** OUTPUT_ENV MEMBER FUNCTIONS ******/
  93
  94 void output_env_init(output_env_t *oenvp,
  95                      const gmx::ProgramContextInterface &context,
  96                      time_unit_t tmu, gmx_bool view, xvg_format_t xvg_format,
  97                      int verbosity)
  98 {
  99     try
 100     {
 101         output_env_t oenv = new output_env(context);
 102         *oenvp            = oenv;
 103         oenv->time_unit   = tmu;
 104         oenv->view        = view;
 105         oenv->xvg_format  = xvg_format;
 106         oenv->verbosity   = verbosity;
 107     }
 108     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
 109 }
 110
 111 void output_env_init_default(output_env_t *oenvp)
 112 {
 113     try
 114     {
 115         output_env_t oenv = new output_env(gmx::getProgramContext());
 116         *oenvp = oenv;
 117     }
 118     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
 119 }
 120
 121 void output_env_done(output_env_t oenv)
 122 {
 123     delete oenv;
 124 }
 125
 126
 127 int output_env_get_verbosity(const output_env_t oenv)
 128 {
 129     return oenv->verbosity;
 130 }
 131
 132 const char *output_env_get_time_unit(const output_env_t oenv)
 133 {
 134     return time_units_str[oenv->time_unit];
 135 }
 136
 137 const char *output_env_get_time_label(const output_env_t oenv)
 138 {
 139     char *label;
 140     snew(label, 20);
 141
 142     sprintf(label, "Time (%s)", time_units_str[oenv->time_unit] ?
 143             time_units_str[oenv->time_unit] : "ps");
 144
 145     return label;
 146 }
 147
 148 const char *output_env_get_xvgr_tlabel(const output_env_t oenv)
 149 {
 150     char *label;
 151     snew(label, 20);
 152
 153     sprintf(label, "Time (%s)", time_units_xvgr[oenv->time_unit] ?
 154             time_units_xvgr[oenv->time_unit] : "ps");
 155
 156     return label;
 157 }
 158
 159 real output_env_get_time_factor(const output_env_t oenv)
 160 {
 161     return timefactors[oenv->time_unit];
 162 }
 163
 164 real output_env_get_time_invfactor(const output_env_t oenv)
 165 {
 166     return timeinvfactors[oenv->time_unit];
 167 }
 168
 169 real output_env_conv_time(const output_env_t oenv, real time)
 170 {
 171     return time*timefactors[oenv->time_unit];
 172 }
 173
 174 void output_env_conv_times(const output_env_t oenv, int n, real *time)
 175 {
 176     int    i;
 177     double fact = timefactors[oenv->time_unit];
 178
 179     if (fact != 1.)
 180     {
 181         for (i = 0; i < n; i++)
 182         {
 183             time[i] *= fact;
 184         }
 185     }
 186 }
 187
 188 gmx_bool output_env_get_view(const output_env_t oenv)
 189 {
 190     return oenv->view;
 191 }
 192
 193 xvg_format_t output_env_get_xvg_format(const output_env_t oenv)
 194 {
 195     return oenv->xvg_format;
 196 }
 197
 198 const char *output_env_get_program_display_name(const output_env_t oenv)
 199 {
 200     try
 201     {
 202         return oenv->programContext.displayName();
 203     }
 204     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
 205 }
 206
 207 const gmx::ProgramContextInterface &
 208 output_env_get_program_context(const output_env_t oenv)
 209 {
 210     return oenv->programContext;
 211 }