Merge branch 'release-4-6'
[alexxy/gromacs.git] / src / gromacs / fileio / mdoutf.h
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2013, by the GROMACS development team, led by
5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6  * and including many others, as listed in the AUTHORS file in the
7  * top-level source directory and at http://www.gromacs.org.
8  *
9  * GROMACS is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public License
11  * as published by the Free Software Foundation; either version 2.1
12  * of the License, or (at your option) any later version.
13  *
14  * GROMACS is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with GROMACS; if not, see
21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
23  *
24  * If you want to redistribute modifications to GROMACS, please
25  * consider that scientific software is very special. Version
26  * control is crucial - bugs must be traceable. We will be happy to
27  * consider code for inclusion in the official distribution, but
28  * derived work must not be called official GROMACS. Details are found
29  * in the README & COPYING files - if they are missing, get the
30  * official version at http://www.gromacs.org.
31  *
32  * To help us fund GROMACS development, we humbly ask that you cite
33  * the research papers on the package. Check out http://www.gromacs.org.
34  */
35
36 #ifndef GMX_FILEIO_MDOUTF_H
37 #define GMX_FILEIO_MDOUTF_H
38
39 #include "filenm.h"
40 #include <stdio.h>
41 #include "../legacyheaders/types/simple.h"
42 #include "enxio.h"
43 #include "gmxfio.h"
44
45 typedef struct {
46     t_fileio   *fp_trn;
47     t_fileio   *fp_xtc;
48     int         xtc_prec;
49     ener_file_t fp_ene;
50     const char *fn_cpt;
51     gmx_bool    bKeepAndNumCPT;
52     int         eIntegrator;
53     gmx_bool    bExpanded;
54     int         elamstats;
55     int         simulation_part;
56     FILE       *fp_dhdl;
57     FILE       *fp_field;
58 } gmx_mdoutf_t;
59
60 gmx_mdoutf_t *init_mdoutf(int nfile, const t_filenm fnm[],
61                           int mdrun_flags,
62                           const t_commrec *cr, const t_inputrec *ir,
63                           const output_env_t oenv);
64 /* Returns a pointer to a data structure with all output file pointers
65  * and names required by mdrun.
66  */
67
68 void done_mdoutf(gmx_mdoutf_t *of);
69 /* Close all open output files and free the of pointer */
70
71 #define MDOF_X   (1<<0)
72 #define MDOF_V   (1<<1)
73 #define MDOF_F   (1<<2)
74 #define MDOF_XTC (1<<3)
75 #define MDOF_CPT (1<<4)
76
77 #endif /* GMX_FILEIO_MDOUTF_H */