2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 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.
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.
36 * \brief Declares the general simulator interface
38 * \author Pascal Merz <pascal.merz@me.com>
39 * \ingroup module_mdrun
41 #ifndef GMX_MDRUN_ISIMULATOR_H
42 #define GMX_MDRUN_ISIMULATOR_H
44 #include "gromacs/mdlib/stophandler.h"
46 class energyhistory_t;
47 struct gmx_ekindata_t;
48 struct gmx_enerdata_t;
52 struct gmx_multisim_t;
53 struct gmx_output_env_t;
56 struct gmx_walltime_accounting;
57 struct ObservablesHistory;
59 struct ReplicaExchangeParameters;
71 enum class StartingBehavior;
74 class MdrunScheduleWorkload;
75 class IMDOutputProvider;
76 struct MdModulesNotifier;
80 class StopHandlerBuilder;
84 * \brief The Simulator interface
86 * This is the general interface for any type of simulation type
87 * ran with GROMACS. This allows having a builder return different
88 * Simulator objects based on user input.
93 /*! \brief The simulation run
95 * This will be called by the owner of the simulator object. To be redefined
96 * by the child classes. This function is expected to run the simulation.
98 virtual void run() = 0;
99 //! Standard destructor
100 virtual ~ISimulator() = default;
105 const gmx_multisim_t *ms,
106 const MDLogger &mdlog,
109 const gmx_output_env_t *oenv,
110 const MdrunOptions &mdrunOptions,
111 StartingBehavior startingBehavior,
114 gmx_enfrot *enforcedRotation,
115 BoxDeformation *deform,
116 IMDOutputProvider *outputProvider,
117 const MdModulesNotifier &mdModulesNotifier,
118 t_inputrec *inputrec,
119 ImdSession *imdSession,
122 gmx_mtop_t *top_global,
124 t_state *state_global,
125 ObservablesHistory *observablesHistory,
128 gmx_wallcycle *wcycle,
130 gmx_enerdata_t *enerd,
131 gmx_ekindata_t *ekind,
132 MdrunScheduleWorkload *runScheduleWork,
133 const ReplicaExchangeParameters &replExParams,
134 gmx_membed_t *membed,
135 gmx_walltime_accounting *walltime_accounting,
136 std::unique_ptr<StopHandlerBuilder> stopHandlerBuilder,
145 mdrunOptions(mdrunOptions),
146 startingBehavior(startingBehavior),
149 enforcedRotation(enforcedRotation),
151 outputProvider(outputProvider),
152 mdModulesNotifier(mdModulesNotifier),
154 imdSession(imdSession),
155 pull_work(pull_work),
157 top_global(top_global),
159 state_global(state_global),
160 observablesHistory(observablesHistory),
167 runScheduleWork(runScheduleWork),
168 replExParams(replExParams),
170 walltime_accounting(walltime_accounting),
171 stopHandlerBuilder(std::move(stopHandlerBuilder)),
178 //! Handles communication.
180 //! Coordinates multi-simulations.
181 const gmx_multisim_t *ms;
183 const MDLogger &mdlog;
184 //! Count of input file options.
186 //! Content of input file options.
188 //! Handles writing text output.
189 const gmx_output_env_t *oenv;
190 //! Contains command-line options to mdrun.
191 const MdrunOptions &mdrunOptions;
192 //! Whether the simulation will start afresh, or restart with/without appending.
193 StartingBehavior startingBehavior;
194 //! Handles virtual sites.
196 //! Handles constraints.
198 //! Handles enforced rotation.
199 gmx_enfrot *enforcedRotation;
200 //! Handles box deformation.
201 BoxDeformation *deform;
202 //! Handles writing output files.
203 IMDOutputProvider *outputProvider;
204 //! Handles notifications to MdModules for checkpoint writing
205 const MdModulesNotifier &mdModulesNotifier;
206 //! Contains user input mdp options.
207 t_inputrec *inputrec;
208 //! The Interactive Molecular Dynamics session.
209 ImdSession *imdSession;
210 //! The pull work object.
212 //! The coordinate-swapping session.
214 //! Full system topology.
215 gmx_mtop_t *top_global;
216 //! Helper struct for force calculations.
218 //! Full simulation state (only non-nullptr on master rank).
219 t_state *state_global;
220 //! History of simulation observables.
221 ObservablesHistory *observablesHistory;
222 //! Atom parameters for this domain.
224 //! Manages flop accounting.
226 //! Manages wall cycle accounting.
227 gmx_wallcycle *wcycle;
228 //! Parameters for force calculations.
230 //! Data for energy output.
231 gmx_enerdata_t *enerd;
232 //! Kinetic energy data.
233 gmx_ekindata_t *ekind;
234 //! Schedule of work for each MD step for this task.
235 MdrunScheduleWorkload *runScheduleWork;
236 //! Parameters for replica exchange algorihtms.
237 const ReplicaExchangeParameters &replExParams;
238 //! Parameters for membrane embedding.
239 gmx_membed_t *membed;
240 //! Manages wall time accounting.
241 gmx_walltime_accounting *walltime_accounting;
242 //! Registers stop conditions
243 std::unique_ptr<StopHandlerBuilder> stopHandlerBuilder;
244 //! Whether we're doing a rerun.
251 #endif //GMX_MDRUN_ISIMULATOR_H