Merge release-4-6 into release-5-0
[alexxy/gromacs.git] / src / gromacs / fileio / trajectory_writing.c
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2013,2014, 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 #ifdef HAVE_CONFIG_H
36 #include <config.h>
37 #endif
38
39 #include "typedefs.h"
40 #include "gromacs/utility/smalloc.h"
41 #include "sysstuff.h"
42 #include "vec.h"
43 #include "sim_util.h"
44 #include "mdrun.h"
45 #include "confio.h"
46 #include "trajectory_writing.h"
47 #include "mdoutf.h"
48
49 #include "gromacs/timing/wallcycle.h"
50
51 void
52 do_md_trajectory_writing(FILE           *fplog,
53                          t_commrec      *cr,
54                          int             nfile,
55                          const t_filenm  fnm[],
56                          gmx_int64_t     step,
57                          gmx_int64_t     step_rel,
58                          double          t,
59                          t_inputrec     *ir,
60                          t_state        *state,
61                          t_state        *state_global,
62                          gmx_mtop_t     *top_global,
63                          t_forcerec     *fr,
64                          gmx_mdoutf_t    outf,
65                          t_mdebin       *mdebin,
66                          gmx_ekindata_t *ekind,
67                          rvec           *f,
68                          rvec           *f_global,
69                          gmx_wallcycle_t wcycle,
70                          int            *nchkpt,
71                          gmx_bool        bCPT,
72                          gmx_bool        bRerunMD,
73                          gmx_bool        bLastStep,
74                          gmx_bool        bDoConfOut,
75                          gmx_bool        bSumEkinhOld
76                          )
77 {
78     int   mdof_flags;
79
80     mdof_flags = 0;
81     if (do_per_step(step, ir->nstxout))
82     {
83         mdof_flags |= MDOF_X;
84     }
85     if (do_per_step(step, ir->nstvout))
86     {
87         mdof_flags |= MDOF_V;
88     }
89     if (do_per_step(step, ir->nstfout))
90     {
91         mdof_flags |= MDOF_F;
92     }
93     if (do_per_step(step, ir->nstxout_compressed))
94     {
95         mdof_flags |= MDOF_X_COMPRESSED;
96     }
97     if (bCPT)
98     {
99         mdof_flags |= MDOF_CPT;
100     }
101     ;
102
103 #if defined(GMX_FAHCORE) || defined(GMX_WRITELASTSTEP)
104     if (bLastStep)
105     {
106         /* Enforce writing positions and velocities at end of run */
107         mdof_flags |= (MDOF_X | MDOF_V);
108     }
109 #endif
110 #ifdef GMX_FAHCORE
111     if (MASTER(cr))
112     {
113         fcReportProgress( ir->nsteps, step );
114     }
115
116 #if defined(__native_client__)
117     fcCheckin(MASTER(cr));
118 #endif
119
120     /* sync bCPT and fc record-keeping */
121     if (bCPT && MASTER(cr))
122     {
123         fcRequestCheckPoint();
124     }
125 #endif
126
127     if (mdof_flags != 0)
128     {
129         wallcycle_start(wcycle, ewcTRAJ);
130         if (bCPT)
131         {
132             if (MASTER(cr))
133             {
134                 if (bSumEkinhOld)
135                 {
136                     state_global->ekinstate.bUpToDate = FALSE;
137                 }
138                 else
139                 {
140                     update_ekinstate(&state_global->ekinstate, ekind);
141                     state_global->ekinstate.bUpToDate = TRUE;
142                 }
143                 update_energyhistory(&state_global->enerhist, mdebin);
144             }
145         }
146         mdoutf_write_to_trajectory_files(fplog, cr, outf, mdof_flags, top_global,
147                                          step, t, state, state_global, f, f_global);
148         if (bCPT)
149         {
150             (*nchkpt)++;
151             bCPT = FALSE;
152         }
153         debug_gmx();
154         if (bLastStep && step_rel == ir->nsteps &&
155             bDoConfOut && MASTER(cr) &&
156             !bRerunMD)
157         {
158             /* x and v have been collected in mdoutf_write_to_trajectory_files,
159              * because a checkpoint file will always be written
160              * at the last step.
161              */
162             fprintf(stderr, "\nWriting final coordinates.\n");
163             if (fr->bMolPBC)
164             {
165                 /* Make molecules whole only for confout writing */
166                 do_pbc_mtop(fplog, ir->ePBC, state->box, top_global, state_global->x);
167             }
168             write_sto_conf_mtop(ftp2fn(efSTO, nfile, fnm),
169                                 *top_global->name, top_global,
170                                 state_global->x, state_global->v,
171                                 ir->ePBC, state->box);
172             debug_gmx();
173         }
174         wallcycle_stop(wcycle, ewcTRAJ);
175     }
176 }