src/gromacs/mdlib/mdoutf.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014,2015,2016,2017,2018,2019, 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 #ifndef GMX_MDLIB_MDOUTF_H
  36 #define GMX_MDLIB_MDOUTF_H
  37
  38 #include <stdio.h>
  39
  40 #include "gromacs/fileio/enxio.h"
  41 #include "gromacs/math/vectypes.h"
  42 #include "gromacs/timing/wallcycle.h"
  43 #include "gromacs/utility/arrayref.h"
  44 #include "gromacs/utility/basedefinitions.h"
  45
  46 class energyhistory_t;
  47 struct gmx_mtop_t;
  48 struct gmx_output_env_t;
  49 struct ObservablesHistory;
  50 struct t_commrec;
  51 struct t_filenm;
  52 struct t_inputrec;
  53
  54 namespace gmx
  55 {
  56 class IMDOutputProvider;
  57 struct MdrunOptions;
  58 }
  59
  60 typedef struct gmx_mdoutf *gmx_mdoutf_t;
  61
  62 /*! \brief Allocate and initialize object to manager trajectory writing output
  63  *
  64  * Returns a pointer to a data structure with all output file pointers
  65  * and names required by mdrun.
  66  */
  67 gmx_mdoutf_t init_mdoutf(FILE                    *fplog,
  68                          int                      nfile,
  69                          const t_filenm           fnm[],
  70                          const gmx::MdrunOptions &mdrunOptions,
  71                          const t_commrec         *cr,
  72                          gmx::IMDOutputProvider  *outputProvider,
  73                          const t_inputrec        *ir,
  74                          gmx_mtop_t              *mtop,
  75                          const gmx_output_env_t  *oenv,
  76                          gmx_wallcycle_t          wcycle);
  77
  78 /*! \brief Getter for file pointer */
  79 ener_file_t mdoutf_get_fp_ene(gmx_mdoutf_t of);
  80
  81 /*! \brief Getter for file pointer */
  82 FILE *mdoutf_get_fp_dhdl(gmx_mdoutf_t of);
  83
  84 /*! \brief Getter for wallcycle timer */
  85 gmx_wallcycle_t mdoutf_get_wcycle(gmx_mdoutf_t of);
  86
  87 /*! \brief Close TNG files if they are open.
  88  *
  89  * This also measures the time it takes to close the TNG
  90  * files.
  91  */
  92 void mdoutf_tng_close(gmx_mdoutf_t of);
  93
  94 /*! \brief Close all open output files and free the of pointer */
  95 void done_mdoutf(gmx_mdoutf_t of);
  96
  97 /*! \brief Routine that writes trajectory-like frames.
  98  *
  99  * Writes data to trn, xtc and/or checkpoint. What is written is
 100  * determined by the mdof_flags defined below. Data is collected to
 101  * the master node only when necessary. Without domain decomposition
 102  * only data from state_local is used and state_global is ignored.
 103  */
 104 void mdoutf_write_to_trajectory_files(FILE *fplog, const t_commrec *cr,
 105                                       gmx_mdoutf_t of,
 106                                       int mdof_flags,
 107                                       gmx_mtop_t *top_global,
 108                                       int64_t step, double t,
 109                                       t_state *state_local, t_state *state_global,
 110                                       ObservablesHistory *observablesHistory,
 111                                       gmx::ArrayRef<gmx::RVec> f_local);
 112
 113 /*! \brief Get the output interval of box size of uncompressed TNG output.
 114  * Returns 0 if no uncompressed TNG file is open.
 115  */
 116 int mdoutf_get_tng_box_output_interval(gmx_mdoutf_t of);
 117
 118 /*! \brief Get the output interval of lambda of uncompressed TNG output.
 119  * Returns 0 if no uncompressed TNG file is open.
 120  */
 121 int mdoutf_get_tng_lambda_output_interval(gmx_mdoutf_t of);
 122
 123 /*! \brief Get the output interval of box size of compressed TNG output.
 124  * Returns 0 if no compressed TNG file is open.
 125  */
 126 int mdoutf_get_tng_compressed_box_output_interval(gmx_mdoutf_t of);
 127
 128 /*! \brief Get the output interval of lambda of compressed TNG output.
 129  * Returns 0 if no compressed TNG file is open.
 130  */
 131 int mdoutf_get_tng_compressed_lambda_output_interval(gmx_mdoutf_t of);
 132
 133 #define MDOF_X                 (1<<0)
 134 #define MDOF_V                 (1<<1)
 135 #define MDOF_F                 (1<<2)
 136 #define MDOF_X_COMPRESSED      (1<<3)
 137 #define MDOF_CPT               (1<<4)
 138 #define MDOF_IMD               (1<<5)
 139 #define MDOF_BOX               (1<<6)
 140 #define MDOF_LAMBDA            (1<<7)
 141 #define MDOF_BOX_COMPRESSED    (1<<8)
 142 #define MDOF_LAMBDA_COMPRESSED (1<<9)
 143
 144 #endif