3 * This source code is part of
7 * GROningen MAchine for Chemical Simulations
10 * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
11 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
12 * Copyright (c) 2001-2004, The GROMACS development team,
13 * check out http://www.gromacs.org for more information.
15 * This program is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU General Public License
17 * as published by the Free Software Foundation; either version 2
18 * of the License, or (at your option) any later version.
20 * If you want to redistribute modifications, please consider that
21 * scientific software is very special. Version control is crucial -
22 * bugs must be traceable. We will be happy to consider code for
23 * inclusion in the official distribution, but derived work must not
24 * be called official GROMACS. Details are found in the README & COPYING
25 * files - if they are missing, get the official version at www.gromacs.org.
27 * To help us fund GROMACS development, we humbly ask that you cite
28 * the papers on the package - you can find them in the top README file.
30 * For more info, check our website at http://www.gromacs.org
33 * Gromacs Runs On Most of All Computer Systems
39 #include "types/simple.h"
40 #include "types/oenv.h"
45 #if 0 /* avoid screwing up indentation */
50 /* output_env member functions */
52 /* The output_env structure holds information about program name, cmd line,
55 There are still legacy functions for the program name, and the command
56 line, but the output_env versions are now preferred.*/
60 timeNULL, time_fs, time_ps, time_ns, time_us, time_ms, time_s
62 /* the time units. For the time being, ps means no conversion. */
65 exvgNULL, exvgXMGRACE, exvgXMGR, exvgNONE
67 /* the xvg output formattings */
70 void output_env_init(output_env_t *oenvp, int argc, char *argv[],
71 time_unit_t tmu, gmx_bool view, xvg_format_t xvg_format,
72 int verbosity, int debug_level);
73 /* initialize an output_env structure, setting the command line,
74 the default time value a gmx_boolean view that is set to TRUE when the
75 user requests direct viewing of graphs,
76 the graph formatting type, the verbosity, and debug level */
78 void output_env_init_default(output_env_t *oenvp);
79 /* initialize an output_env structure, with reasonable default settings.
80 (the time unit is set to time_ps, which means no conversion). */
82 void output_env_done(output_env_t oenv);
83 /* free memory allocated for an output_env structure. */
86 int output_env_get_verbosity(const output_env_t oenv);
87 /* return the verbosity */
89 int output_env_get_debug_level(const output_env_t oenv);
90 /* return the debug level */
92 const char *output_env_get_time_unit(const output_env_t oenv);
93 /* return time unit (e.g. ps or ns) */
95 const char *output_env_get_time_label(const output_env_t oenv);
96 /* return time unit label (e.g. "Time (ps)") */
98 const char *output_env_get_xvgr_tlabel(const output_env_t oenv);
99 /* retrun x-axis time label for xmgr */
101 real output_env_get_time_factor(const output_env_t oenv);
102 /* return time conversion factor from ps (i.e. 1e-3 for ps->ns) */
104 real output_env_get_time_invfactor(const output_env_t oenv);
105 /* return inverse time conversion factor from ps (i.e. 1e3 for ps->ns) */
107 real output_env_conv_time(const output_env_t oenv, real time);
108 /* return converted time */
110 void output_env_conv_times(const output_env_t oenv, int n, real *time);
111 /* convert array of times */
113 gmx_bool output_env_get_view(const output_env_t oenv);
114 /* Return TRUE when user requested viewing of the file */
116 xvg_format_t output_env_get_xvg_format(const output_env_t oenv);
117 /* Returns enum (see above) for xvg output formatting */
119 const char *output_env_get_program_name(const output_env_t oenv);
120 /* return the program name */
122 const char *output_env_get_cmd_line(const output_env_t oenv);
123 /* return the command line */
125 const char *output_env_get_short_program_name(const output_env_t oenv);
126 /* get the short version (without path component) of the program name */