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