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, 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/update.h"
  47 #include "../legacyheaders/mdebin.h"
  48
  49 void
  50 do_trajectory_writing(FILE           *fplog,
  51                       t_commrec      *cr,
  52                       int             nfile,
  53                       const t_filenm  fnm[],
  54                       gmx_large_int_t step,
  55                       gmx_large_int_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_update_t    upd,
  63                       gmx_mdoutf_t   *outf,
  64                       t_mdebin       *mdebin,
  65                       gmx_ekindata_t *ekind,
  66                       rvec           *f,
  67                       rvec           *f_global,
  68                       gmx_wallcycle_t wcycle,
  69                       gmx_rng_t       mcrng,
  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 /* Wrapper routine for trajectory writing */
  78
  79 void write_traj(FILE *fplog, t_commrec *cr,
  80                 gmx_mdoutf_t *of,
  81                 int mdof_flags,
  82                 gmx_mtop_t *top_global,
  83                 gmx_large_int_t step, double t,
  84                 t_state *state_local, t_state *state_global,
  85                 rvec *f_local, rvec *f_global,
  86                 int *n_xtc, rvec **x_xtc);
  87 /* Routine that writes frames to trn, xtc and/or checkpoint.
  88  * What is written is determined by the mdof_flags defined above.
  89  * Data is collected to the master node only when necessary.
  90  */
  91
  92 #endif /* GMX_FILEIO_TRAJECTORY_WRITING_H */