src/gromacs/modularsimulator/compositesimulatorelement.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 /*! \libinternal \file
  36  * \brief Declares the composite element for the modular simulator
  37  *
  38  * \author Pascal Merz <pascal.merz@me.com>
  39  * \ingroup module_modularsimulator
  40  */
  41 #ifndef GROMACS_MDTYPES_COMPOSITESIMULATORELEMENT_H
  42 #define GROMACS_MDTYPES_COMPOSITESIMULATORELEMENT_H
  43
  44 #include <vector>
  45
  46 #include "gromacs/compat/pointers.h"
  47
  48 #include "modularsimulatorinterfaces.h"
  49
  50 namespace gmx
  51 {
  52
  53 /*! \libinternal
  54  * \ingroup module_modularsimulator
  55  * \brief Composite simulator element
  56  *
  57  * The composite simulator element takes a call list of elements and implements
  58  * the ISimulatorElement interface, making a group of elements effectively
  59  * behave as one. This simplifies building algorithms.
  60  *
  61  * The CompositeSimulatorElement can optionally also own the elements, but does
  62  * not require this. The owner of a CompositeSimulatorElement object can hence
  63  * decide to either pass the ownership to CompositeSimulatorElement, or keep
  64  * the ownership (and guarantee that they remain valid during the life time
  65  * of the CompositeSimulatorElement object). CompositeSimulatorElement will only
  66  * call the setup and teardown methods on the owned elements, thereby avoiding
  67  * to call them more than once. Consequently, the owner of the elements not
  68  * owned by CompositeSimulatorElement is responsible to call setup and teardown
  69  * methods on these elements.
  70  */
  71 class CompositeSimulatorElement final : public ISimulatorElement
  72 {
  73 public:
  74     //! Constructor
  75     explicit CompositeSimulatorElement(std::vector<compat::not_null<ISimulatorElement*>> elementCallList,
  76                                        std::vector<std::unique_ptr<ISimulatorElement>> elements);
  77
  78     /*! \brief Register run function for step / time
  79      *
  80      * Lets every member of the composite simulator register run functions
  81      * for the given step.
  82      *
  83      * @param step                 The step number
  84      * @param time                 The time
  85      * @param registerRunFunction  Function allowing to register a run function
  86      */
  87     void scheduleTask(Step step, Time time, const RegisterRunFunctionPtr& registerRunFunction) override;
  88
  89     /*! \brief Element setup
  90      *
  91      * Calls the setup functions of the single elements.
  92      */
  93     void elementSetup() override;
  94
  95     /*! \brief Element teardown
  96      *
  97      * Calls the teardown functions of the single elements.
  98      */
  99     void elementTeardown() override;
 100
 101 private:
 102     //! The call list of elements forming the composite element
 103     std::vector<compat::not_null<ISimulatorElement*>> elementCallList_;
 104     //! List of elements owned by composite element
 105     std::vector<std::unique_ptr<ISimulatorElement>> elementOwnershipList_;
 106 };
 107
 108 } // namespace gmx
 109
 110 #endif // GROMACS_MDTYPES_COMPOSITESIMULATORELEMENT_H