Merge branch release-4-6
[alexxy/gromacs.git] / src / gromacs / fileio / trajectory_writing.h
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
38 #ifndef GMX_FILEIO_TRAJECTORY_WRITING_H
39 #define GMX_FILEIO_TRAJECTORY_WRITING_H
40
41 #include <stdio.h>
42 #include "filenm.h"
43 #include "mdoutf.h"
44 #include "../legacyheaders/types/simple.h"
45 #include "../legacyheaders/types/commrec.h"
46 #include "../legacyheaders/mdebin.h"
47
48 /*! \brief Wrapper routine for writing trajectories during mdrun
49  *
50  * This routine does communication (e.g. collecting distributed coordinates)
51  */
52 void
53 do_md_trajectory_writing(FILE           *fplog,
54                          t_commrec      *cr,
55                          int             nfile,
56                          const t_filenm  fnm[],
57                          gmx_int64_t     step,
58                          gmx_int64_t     step_rel,
59                          double          t,
60                          t_inputrec     *ir,
61                          t_state        *state,
62                          t_state        *state_global,
63                          gmx_mtop_t     *top_global,
64                          t_forcerec     *fr,
65                          gmx_mdoutf_t    outf,
66                          t_mdebin       *mdebin,
67                          gmx_ekindata_t *ekind,
68                          rvec           *f,
69                          rvec           *f_global,
70                          gmx_wallcycle_t wcycle,
71                          int            *nchkpt,
72                          gmx_bool        bCPT,
73                          gmx_bool        bRerunMD,
74                          gmx_bool        bLastStep,
75                          gmx_bool        bDoConfOut,
76                          gmx_bool        bSumEkinhOld
77                          );
78
79
80 #endif /* GMX_FILEIO_TRAJECTORY_WRITING_H */