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, 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.
41 #include "types/simple.h"
42 #include "types/oenv.h"
47 #if 0 /* avoid screwing up indentation */
52 /* output_env member functions */
54 /* The output_env structure holds information about program name, cmd line,
57 There are still legacy functions for the program name, and the command
58 line, but the output_env versions are now preferred.*/
62 timeNULL
, time_fs
, time_ps
, time_ns
, time_us
, time_ms
, time_s
64 /* the time units. For the time being, ps means no conversion. */
67 exvgNULL
, exvgXMGRACE
, exvgXMGR
, exvgNONE
69 /* the xvg output formattings */
72 void output_env_init_default(output_env_t
*oenvp
);
73 /* initialize an output_env structure, with reasonable default settings.
74 (the time unit is set to time_ps, which means no conversion). */
76 void output_env_done(output_env_t oenv
);
77 /* free memory allocated for an output_env structure. */
80 int output_env_get_verbosity(const output_env_t oenv
);
81 /* return the verbosity */
83 int output_env_get_debug_level(const output_env_t oenv
);
84 /* return the debug level */
86 const char *output_env_get_time_unit(const output_env_t oenv
);
87 /* return time unit (e.g. ps or ns) */
89 const char *output_env_get_time_label(const output_env_t oenv
);
90 /* return time unit label (e.g. "Time (ps)") */
92 const char *output_env_get_xvgr_tlabel(const output_env_t oenv
);
93 /* retrun x-axis time label for xmgr */
95 real
output_env_get_time_factor(const output_env_t oenv
);
96 /* return time conversion factor from ps (i.e. 1e-3 for ps->ns) */
98 real
output_env_get_time_invfactor(const output_env_t oenv
);
99 /* return inverse time conversion factor from ps (i.e. 1e3 for ps->ns) */
101 real
output_env_conv_time(const output_env_t oenv
, real time
);
102 /* return converted time */
104 void output_env_conv_times(const output_env_t oenv
, int n
, real
*time
);
105 /* convert array of times */
107 gmx_bool
output_env_get_view(const output_env_t oenv
);
108 /* Return TRUE when user requested viewing of the file */
110 xvg_format_t
output_env_get_xvg_format(const output_env_t oenv
);
111 /* Returns enum (see above) for xvg output formatting */
113 const char *output_env_get_program_name(const output_env_t oenv
);
114 /* return the program name */
116 const char *output_env_get_cmd_line(const output_env_t oenv
);
117 /* return the command line */
119 const char *output_env_get_short_program_name(const output_env_t oenv
);
120 /* get the short version (without path component) of the program name */
127 class ProgramContextInterface
;
130 void output_env_init(output_env_t
*oenvp
,
131 const gmx::ProgramContextInterface
&context
,
132 time_unit_t tmu
, gmx_bool view
, xvg_format_t xvg_format
,
133 int verbosity
, int debug_level
);
134 /* initialize an output_env structure, setting the command line,
135 the default time value a gmx_boolean view that is set to TRUE when the
136 user requests direct viewing of graphs,
137 the graph formatting type, the verbosity, and debug level */