2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2015,2016,2017, 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.
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.
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.
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.
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.
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.
35 /*! \brief Declares the integrator type for mdrun
37 * \author David van der Spoel <david.vanderspoel@icm.uu.se>
38 * \ingroup module_mdlib
40 #ifndef GMX_MDLIB_INTEGRATOR_H
41 #define GMX_MDLIB_INTEGRATOR_H
45 #include "gromacs/gmxlib/nrnb.h"
46 #include "gromacs/mdlib/constr.h"
47 #include "gromacs/mdlib/vsite.h"
48 #include "gromacs/mdtypes/fcdata.h"
49 #include "gromacs/mdtypes/forcerec.h"
50 #include "gromacs/timing/wallcycle.h"
51 #include "gromacs/timing/walltime_accounting.h"
52 #include "gromacs/utility/basedefinitions.h"
53 #include "gromacs/utility/real.h"
55 class energyhistory_t
;
58 struct gmx_output_env_t
;
60 struct ObservablesHistory
;
61 struct ReplicaExchangeParameters
;
70 class IMDOutputProvider
;
74 /*! \brief Integrator algorithm implementation.
76 * \param[in] fplog Log file for output
77 * \param[in] cr Communication record
78 * \param[in] mdlog Log writer for important output
79 * \param[in] nfile Number of files
80 * \param[in] fnm Filename structure array
81 * \param[in] oenv Output information
82 * \param[in] mdrunOptions Options for mdrun
83 * \param[in] vsite Virtual site information
84 * \param[in] constr Constraint information
85 * \param[in] outputProvider Additional output provider
86 * \param[in] inputrec Input record with mdp options
87 * \param[in] top_global Molecular topology for the whole system
88 * \param[in] fcd Force and constraint data
89 * \param[in] state_global The state (x, v, f, box etc.) of the whole system
90 * \param[in] observablesHistory The observables statistics history
91 * \param[in] mdAtoms Atom information
92 * \param[in] nrnb Accounting for floating point operations
93 * \param[in] wcycle Wall cycle timing information
94 * \param[in] fr Force record with cut-off information and more
95 * \param[in] replExParams Parameters for the replica exchange algorithm
96 * \param[in] membed Membrane embedding data structure
97 * \param[in] walltime_accounting More timing information
99 typedef double integrator_t (FILE *fplog
, t_commrec
*cr
, const gmx::MDLogger
&mdlog
,
100 int nfile
, const t_filenm fnm
[],
101 const gmx_output_env_t
*oenv
,
102 const MdrunOptions
&mdrunOptions
,
103 gmx_vsite_t
*vsite
, gmx_constr_t constr
,
104 gmx::IMDOutputProvider
*outputProvider
,
105 t_inputrec
*inputrec
,
106 gmx_mtop_t
*top_global
, t_fcdata
*fcd
,
107 t_state
*state_global
,
108 ObservablesHistory
*observablesHistory
,
110 t_nrnb
*nrnb
, gmx_wallcycle_t wcycle
,
112 const ReplicaExchangeParameters
&replExParams
,
113 gmx_membed_t gmx_unused
* membed
,
114 gmx_walltime_accounting_t walltime_accounting
);
118 #endif // GMX_MDLIB_INTEGRATOR_H