Introduce SimulatorBuilder
[gromacs.git] / src / gromacs / mdrun / simulationcontext.cpp
blob19420dfb51f6d283854591efba614434b8d3b598
1 /*
2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 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.
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 #include "gmxpre.h"
38 #include "simulationcontext.h"
40 #include <cassert>
42 #include <memory>
44 #include "gromacs/commandline/filenm.h"
45 #include "gromacs/domdec/domdec.h"
46 #include "gromacs/fileio/oenv.h"
47 #include "gromacs/hardware/hw_info.h"
48 #include "gromacs/utility/gmxassert.h"
50 #include "runner.h"
52 namespace gmx
54 //! \cond libapi
55 SimulationContext::SimulationContext(t_commrec* communicationRecord) :
56 communicationRecord_(communicationRecord)
58 // SimulationContext receives a valid, initialized communications record.
59 // \todo Initialization of the communications record is an implementation detail
60 // dependent on the build configuration of the GROMACS installation and on
61 // the run time computing context, not the client code that owns this Context.
62 GMX_RELEASE_ASSERT(communicationRecord_, "SimulationContext constructor needs initialized communicationRecord");
65 SimulationContext
66 createSimulationContext(t_commrec* simulationCommunicator)
68 auto context = SimulationContext(simulationCommunicator);
69 return context;
71 //! \endcond
72 } // end namespace gmx