Merge release-4-6 into master
[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 "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_update_t    upd,
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                          gmx_rng_t       mcrng,
72                          int            *nchkpt,
73                          gmx_bool        bCPT,
74                          gmx_bool        bRerunMD,
75                          gmx_bool        bLastStep,
76                          gmx_bool        bDoConfOut,
77                          gmx_bool        bSumEkinhOld
78                          )
79 {
80     int   mdof_flags;
81
82     mdof_flags = 0;
83     if (do_per_step(step, ir->nstxout))
84     {
85         mdof_flags |= MDOF_X;
86     }
87     if (do_per_step(step, ir->nstvout))
88     {
89         mdof_flags |= MDOF_V;
90     }
91     if (do_per_step(step, ir->nstfout))
92     {
93         mdof_flags |= MDOF_F;
94     }
95     if (do_per_step(step, ir->nstxout_compressed))
96     {
97         mdof_flags |= MDOF_X_COMPRESSED;
98     }
99     if (bCPT)
100     {
101         mdof_flags |= MDOF_CPT;
102     }
103     ;
104
105 #if defined(GMX_FAHCORE) || defined(GMX_WRITELASTSTEP)
106     if (bLastStep)
107     {
108         /* Enforce writing positions and velocities at end of run */
109         mdof_flags |= (MDOF_X | MDOF_V);
110     }
111 #endif
112 #ifdef GMX_FAHCORE
113     if (MASTER(cr))
114     {
115         fcReportProgress( ir->nsteps, step );
116     }
117
118 #if defined(__native_client__)
119     fcCheckin(MASTER(cr));
120 #endif
121
122     /* sync bCPT and fc record-keeping */
123     if (bCPT && MASTER(cr))
124     {
125         fcRequestCheckPoint();
126     }
127 #endif
128
129     if (mdof_flags != 0)
130     {
131         wallcycle_start(wcycle, ewcTRAJ);
132         if (bCPT)
133         {
134             if (state->flags & (1<<estLD_RNG))
135             {
136                 get_stochd_state(upd, state);
137             }
138             if (state->flags  & (1<<estMC_RNG))
139             {
140                 get_mc_state(mcrng, state);
141             }
142             if (MASTER(cr))
143             {
144                 if (bSumEkinhOld)
145                 {
146                     state_global->ekinstate.bUpToDate = FALSE;
147                 }
148                 else
149                 {
150                     update_ekinstate(&state_global->ekinstate, ekind);
151                     state_global->ekinstate.bUpToDate = TRUE;
152                 }
153                 update_energyhistory(&state_global->enerhist, mdebin);
154             }
155         }
156         mdoutf_write_to_trajectory_files(fplog, cr, outf, mdof_flags, top_global,
157                                          step, t, state, state_global, f, f_global);
158         if (bCPT)
159         {
160             (*nchkpt)++;
161             bCPT = FALSE;
162         }
163         debug_gmx();
164         if (bLastStep && step_rel == ir->nsteps &&
165             bDoConfOut && MASTER(cr) &&
166             !bRerunMD)
167         {
168             /* x and v have been collected in mdoutf_write_to_trajectory_files,
169              * because a checkpoint file will always be written
170              * at the last step.
171              */
172             fprintf(stderr, "\nWriting final coordinates.\n");
173             if (fr->bMolPBC)
174             {
175                 /* Make molecules whole only for confout writing */
176                 do_pbc_mtop(fplog, ir->ePBC, state->box, top_global, state_global->x);
177             }
178             write_sto_conf_mtop(ftp2fn(efSTO, nfile, fnm),
179                                 *top_global->name, top_global,
180                                 state_global->x, state_global->v,
181                                 ir->ePBC, state->box);
182             debug_gmx();
183         }
184         wallcycle_stop(wcycle, ewcTRAJ);
185     }
186 }