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,2014, 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
  43 #include "gromacs/fileio/filenm.h"
  44 #include "gromacs/fileio/mdoutf.h"
  45 #include "gromacs/legacyheaders/mdebin.h"
  46 #include "gromacs/legacyheaders/types/commrec_fwd.h"
  47 #include "gromacs/timing/wallcycle.h"
  48
  49 #ifdef __cplusplus
  50 extern "C" {
  51 #endif
  52
  53 /*! \brief Wrapper routine for writing trajectories during mdrun
  54  *
  55  * This routine does communication (e.g. collecting distributed coordinates)
  56  */
  57 void
  58 do_md_trajectory_writing(FILE           *fplog,
  59                          t_commrec      *cr,
  60                          int             nfile,
  61                          const t_filenm  fnm[],
  62                          gmx_int64_t     step,
  63                          gmx_int64_t     step_rel,
  64                          double          t,
  65                          t_inputrec     *ir,
  66                          t_state        *state,
  67                          t_state        *state_global,
  68                          gmx_mtop_t     *top_global,
  69                          t_forcerec     *fr,
  70                          gmx_mdoutf_t    outf,
  71                          t_mdebin       *mdebin,
  72                          gmx_ekindata_t *ekind,
  73                          rvec           *f,
  74                          rvec           *f_global,
  75                          int            *nchkpt,
  76                          gmx_bool        bCPT,
  77                          gmx_bool        bRerunMD,
  78                          gmx_bool        bLastStep,
  79                          gmx_bool        bDoConfOut,
  80                          gmx_bool        bSumEkinhOld
  81                          );
  82
  83
  84 #ifdef __cplusplus
  85 }
  86 #endif
  87
  88 #endif /* GMX_FILEIO_TRAJECTORY_WRITING_H */