src/gromacs/mdrun/simulatorbuilder.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   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.
   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 /*! \internal
  36  * \brief Declares the simulator builder for mdrun
  37  *
  38  * \author Pascal Merz <pascal.merz@me.com>
  39  * \ingroup module_mdrun
  40  */
  41 #ifndef GMX_MDRUN_SIMULATORBUILDER_H
  42 #define GMX_MDRUN_SIMULATORBUILDER_H
  43
  44 #include <memory>
  45
  46 #include "gromacs/modularsimulator/modularsimulator.h"
  47
  48 #include "legacysimulator.h"
  49
  50 class energyhistory_t;
  51 struct gmx_enerdata_t;
  52 struct gmx_enfrot;
  53 struct gmx_mtop_t;
  54 struct gmx_membed_t;
  55 struct gmx_multisim_t;
  56 struct gmx_output_env_t;
  57 struct gmx_vsite_t;
  58 struct gmx_wallcycle;
  59 struct gmx_walltime_accounting;
  60 struct ObservablesHistory;
  61 struct pull_t;
  62 struct ReplicaExchangeParameters;
  63 struct t_commrec;
  64 struct t_fcdata;
  65 struct t_forcerec;
  66 struct t_filenm;
  67 struct t_inputrec;
  68 struct t_nrnb;
  69 struct t_swap;
  70 class t_state;
  71
  72 namespace gmx
  73 {
  74 enum class StartingBehavior;
  75 class BoxDeformation;
  76 class Constraints;
  77 class MdScheduleWorkload;
  78 class IMDOutputProvider;
  79 class ImdSession;
  80 class MDLogger;
  81 class MDAtoms;
  82 class ISimulator;
  83 class StopHandlerBuilder;
  84 struct MdrunOptions;
  85
  86 /*! \libinternal
  87  * \brief Class preparing the creation of Simulator objects
  88  *
  89  * Objects of this class build Simulator objects, which in turn are used to
  90  * run molecular simulations. Currently, this only has a single public
  91  * `build` function which takes all arguments needed to build the
  92  * `LegacySimulator`.
  93  */
  94 class SimulatorBuilder
  95 {
  96     public:
  97         /*! \brief Build a Simulator object based on input data
  98          *
  99          * Return a pointer to a simulation object. The use of a parameter
 100          * pack insulates the builder from changes to the arguments of the
 101          * Simulator objects.
 102          *
 103          * @return  Unique pointer to a Simulator object
 104          */
 105         template<typename ... Args>
 106         std::unique_ptr<ISimulator> build(
 107             bool        inputIsCompatibleWithModularSimulator,
 108             Args && ... args);
 109 };
 110
 111
 112 //! Build a Simulator object
 113 template<typename ... Args>
 114 std::unique_ptr<ISimulator> SimulatorBuilder::build(
 115         bool        inputIsCompatibleWithModularSimulator,
 116         Args && ... args)
 117 {
 118     // GMX_DISABLE_MODULAR_SIMULATOR allows to disable modular simulator for all uses
 119     const auto disableModularSimulator = (getenv("GMX_DISABLE_MODULAR_SIMULATOR") != nullptr);
 120
 121     if (!disableModularSimulator && inputIsCompatibleWithModularSimulator)
 122     {
 123         // NOLINTNEXTLINE(modernize-make-unique): make_unique does not work with private constructor
 124         return std::unique_ptr<ModularSimulator>(
 125                 new ModularSimulator(
 126                         std::forward<Args>(args) ...));
 127     }
 128     // NOLINTNEXTLINE(modernize-make-unique): make_unique does not work with private constructor
 129     return std::unique_ptr<LegacySimulator>(
 130             new LegacySimulator(
 131                     std::forward<Args>(args) ...));
 132 }
 133
 134 }      // namespace gmx
 135
 136 #endif // GMX_MDRUN_SIMULATORBUILDER_SIMULATORBUILDER_H