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