src/gromacs/fileio/trajectory_writing.c

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014,2015, 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     rvec *x_for_confout = NULL;
  77
  78     mdof_flags = 0;
  79     if (do_per_step(step, ir->nstxout))
  80     {
  81         mdof_flags |= MDOF_X;
  82     }
  83     if (do_per_step(step, ir->nstvout))
  84     {
  85         mdof_flags |= MDOF_V;
  86     }
  87     if (do_per_step(step, ir->nstfout))
  88     {
  89         mdof_flags |= MDOF_F;
  90     }
  91     if (do_per_step(step, ir->nstxout_compressed))
  92     {
  93         mdof_flags |= MDOF_X_COMPRESSED;
  94     }
  95     if (bCPT)
  96     {
  97         mdof_flags |= MDOF_CPT;
  98     }
  99     ;
 100
 101 #if defined(GMX_FAHCORE)
 102     if (bLastStep)
 103     {
 104         /* Enforce writing positions and velocities at end of run */
 105         mdof_flags |= (MDOF_X | MDOF_V);
 106     }
 107     if (MASTER(cr))
 108     {
 109         fcReportProgress( ir->nsteps, step );
 110     }
 111
 112 #if defined(__native_client__)
 113     fcCheckin(MASTER(cr));
 114 #endif
 115
 116     /* sync bCPT and fc record-keeping */
 117     if (bCPT && MASTER(cr))
 118     {
 119         fcRequestCheckPoint();
 120     }
 121 #endif
 122
 123     if (mdof_flags != 0)
 124     {
 125         wallcycle_start(mdoutf_get_wcycle(outf), ewcTRAJ);
 126         if (bCPT)
 127         {
 128             if (MASTER(cr))
 129             {
 130                 if (bSumEkinhOld)
 131                 {
 132                     state_global->ekinstate.bUpToDate = FALSE;
 133                 }
 134                 else
 135                 {
 136                     update_ekinstate(&state_global->ekinstate, ekind);
 137                     state_global->ekinstate.bUpToDate = TRUE;
 138                 }
 139                 update_energyhistory(&state_global->enerhist, mdebin);
 140             }
 141         }
 142         mdoutf_write_to_trajectory_files(fplog, cr, outf, mdof_flags, top_global,
 143                                          step, t, state, state_global, f, f_global);
 144         if (bCPT)
 145         {
 146             (*nchkpt)++;
 147         }
 148         debug_gmx();
 149         if (bLastStep && step_rel == ir->nsteps &&
 150             bDoConfOut && MASTER(cr) &&
 151             !bRerunMD)
 152         {
 153             if (fr->bMolPBC && state->x == state_global->x)
 154             {
 155                 /* This (single-rank) run needs to allocate a
 156                    temporary array of size natoms so that any
 157                    periodicity removal for mdrun -confout does not
 158                    perturb the update and thus the final .edr
 159                    output. This makes .cpt restarts look binary
 160                    identical, and makes .edr restarts binary
 161                    identical. */
 162                 snew(x_for_confout, state_global->natoms);
 163                 copy_rvecn(state_global->x, x_for_confout, 0, state_global->natoms);
 164             }
 165             else
 166             {
 167                 /* With DD, or no bMolPBC, it doesn't matter if
 168                    we change state_global->x */
 169                 x_for_confout = state_global->x;
 170             }
 171
 172             /* x and v have been collected in mdoutf_write_to_trajectory_files,
 173              * because a checkpoint file will always be written
 174              * at the last step.
 175              */
 176             fprintf(stderr, "\nWriting final coordinates.\n");
 177             if (fr->bMolPBC)
 178             {
 179                 /* Make molecules whole only for confout writing */
 180                 do_pbc_mtop(fplog, ir->ePBC, state->box, top_global, x_for_confout);
 181             }
 182             write_sto_conf_mtop(ftp2fn(efSTO, nfile, fnm),
 183                                 *top_global->name, top_global,
 184                                 x_for_confout, state_global->v,
 185                                 ir->ePBC, state->box);
 186             if (fr->bMolPBC && state->x == state_global->x)
 187             {
 188                 sfree(x_for_confout);
 189             }
 190             debug_gmx();
 191         }
 192         wallcycle_stop(mdoutf_get_wcycle(outf), ewcTRAJ);
 193     }
 194 }