src/gromacs/mdlib/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,2015,2016,2017,2018, 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 #ifndef GMX_MDLIB_TRAJECTORY_WRITING_H
  38 #define GMX_MDLIB_TRAJECTORY_WRITING_H
  39
  40 #include <stdio.h>
  41
  42 #include "gromacs/mdlib/mdebin.h"
  43 #include "gromacs/mdlib/mdoutf.h"
  44 #include "gromacs/timing/wallcycle.h"
  45
  46 struct gmx_ekindata_t;
  47 struct gmx_mtop_t;
  48 struct ObservablesHistory;
  49 struct t_commrec;
  50 struct t_filenm;
  51 struct t_forcerec;
  52
  53 #ifdef __cplusplus
  54 extern "C" {
  55 #endif
  56
  57 /*! \brief Wrapper routine for writing trajectories during mdrun
  58  *
  59  * This routine does communication (e.g. collecting distributed coordinates)
  60  */
  61 void
  62 do_md_trajectory_writing(FILE                     *fplog,
  63                          struct t_commrec         *cr,
  64                          int                       nfile,
  65                          const t_filenm            fnm[],
  66                          gmx_int64_t               step,
  67                          gmx_int64_t               step_rel,
  68                          double                    t,
  69                          t_inputrec               *ir,
  70                          t_state                  *state,
  71                          t_state                  *state_global,
  72                          ObservablesHistory       *observablesHistory,
  73                          struct gmx_mtop_t        *top_global,
  74                          t_forcerec               *fr,
  75                          gmx_mdoutf_t              outf,
  76                          t_mdebin                 *mdebin,
  77                          struct gmx_ekindata_t    *ekind,
  78                          gmx::ArrayRef<gmx::RVec>  f,
  79                          int                      *nchkpt,
  80                          gmx_bool                  bCPT,
  81                          gmx_bool                  bRerunMD,
  82                          gmx_bool                  bLastStep,
  83                          gmx_bool                  bDoConfOut,
  84                          gmx_bool                  bSumEkinhOld
  85                          );
  86
  87
  88 #ifdef __cplusplus
  89 }
  90 #endif
  91
  92 #endif