2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2004, The GROMACS development team.
6 * Copyright (c) 2012,2014,2015,2017, 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.
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.
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.
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.
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.
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.
37 #ifndef GMX_FILEIO_OENV_H
38 #define GMX_FILEIO_OENV_H
42 #include "gromacs/utility/basedefinitions.h"
43 #include "gromacs/utility/real.h"
45 struct gmx_output_env_t;
47 /* output_env member functions */
49 /* The output_env structure holds information about program name, cmd line,
52 There are still legacy functions for the program name, and the command
53 line, but the output_env versions are now preferred.*/
57 timeNULL, time_fs, time_ps, time_ns, time_us, time_ms, time_s
59 /* the time units. For the time being, ps means no conversion. */
62 exvgNULL, exvgXMGRACE, exvgXMGR, exvgNONE
64 /* the xvg output formattings */
67 void output_env_init_default(gmx_output_env_t **oenvp);
68 /* initialize an output_env structure, with reasonable default settings.
69 (the time unit is set to time_ps, which means no conversion). */
71 void output_env_done(gmx_output_env_t *oenv);
72 /* free memory allocated for an output_env structure. */
75 int output_env_get_verbosity(const gmx_output_env_t *oenv);
76 /* return the verbosity */
78 std::string output_env_get_time_unit(const gmx_output_env_t *oenv);
79 /* return time unit (e.g. ps or ns) */
81 std::string output_env_get_time_label(const gmx_output_env_t *oenv);
82 /* return time unit label (e.g. "Time (ps)") */
84 std::string output_env_get_xvgr_tlabel(const gmx_output_env_t *oenv);
85 /* return x-axis time label for xmgr */
87 real output_env_get_time_factor(const gmx_output_env_t *oenv);
88 /* return time conversion factor from ps (i.e. 1e-3 for ps->ns) */
90 real output_env_get_time_invfactor(const gmx_output_env_t *oenv);
91 /* return inverse time conversion factor to ps (i.e. 1e3 for ns->ps) */
93 real output_env_conv_time(const gmx_output_env_t *oenv, real time);
94 /* return converted time */
96 void output_env_conv_times(const gmx_output_env_t *oenv, int n, real *time);
97 /* convert array of times */
99 gmx_bool output_env_get_view(const gmx_output_env_t *oenv);
100 /* Return TRUE when user requested viewing of the file */
102 xvg_format_t output_env_get_xvg_format(const gmx_output_env_t *oenv);
103 /* Returns enum (see above) for xvg output formatting */
106 * Returns display name for the currently running program.
108 const char *output_env_get_program_display_name(const gmx_output_env_t *oenv);
112 class IProgramContext;
115 void output_env_init(gmx_output_env_t **oenvp,
116 const gmx::IProgramContext &context,
117 time_unit_t tmu, gmx_bool view, xvg_format_t xvg_format,
119 /* initialize an output_env structure, setting the command line,
120 the default time value a gmx_boolean view that is set to TRUE when the
121 user requests direct viewing of graphs,
122 the graph formatting type, the verbosity, and debug level */
125 * Returns gmx::IProgramContext from an output_env structure.
127 const gmx::IProgramContext &
128 output_env_get_program_context(const gmx_output_env_t *oenv);