src/gromacs/restraint/restraintmdmodule.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019,2020, 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
  36 #ifndef GROMACS_RESTRAINTMDMODULE_H
  37 #define GROMACS_RESTRAINTMDMODULE_H
  38
  39 /*! \libinternal \file
  40  * \brief Library interface for RestraintMDModule
  41  *
  42  * \author M. Eric Irrgang <ericirrgang@gmail.com>
  43  *
  44  * \inlibraryapi
  45  * \ingroup module_restraint
  46  */
  47
  48 #include "gromacs/mdtypes/imdmodule.h"
  49 #include "gromacs/restraint/restraintpotential.h"
  50
  51 namespace gmx
  52 {
  53
  54 // Forward declaration to allow opaque pointer to library internal class.
  55 class RestraintMDModuleImpl;
  56 struct MdModulesNotifier;
  57
  58 /*! \libinternal \ingroup module_restraint
  59  * \brief MDModule wrapper for Restraint implementations.
  60  *
  61  * Shares ownership of an object implementing the IRestraintPotential interface.
  62  * Provides the IMDModule interfaces.
  63  */
  64 class RestraintMDModule final : public gmx::IMDModule
  65 {
  66 public:
  67     RestraintMDModule() = delete;
  68
  69     /*!
  70      * \brief Constructor used by static create() method.
  71      */
  72     explicit RestraintMDModule(std::unique_ptr<RestraintMDModuleImpl> restraint);
  73
  74     ~RestraintMDModule() override;
  75
  76     /*!
  77      * \brief Wrap a restraint potential as an MDModule
  78      *
  79      * \param restraint shared ownership of an object for calculating restraint forces.
  80      * \return new wrapper object sharing ownership of restraint.
  81      *
  82      * Consumers of the interfaces provided by an IMDModule do not extend the lifetime
  83      * of the interface objects returned by mdpOptionProvider(), outputProvider(), or
  84      * registered via initForceProviders(). Calling code must keep this object alive
  85      * as long as those interfaces are needed (probably the duration of an MD run).
  86      *
  87      * \param restraint handle to object to wrap
  88      * \param sites list of sites for the framework to pass to the restraint
  89      */
  90     static std::unique_ptr<RestraintMDModule> create(std::shared_ptr<gmx::IRestraintPotential> restraint,
  91                                                      const std::vector<int>& sites);
  92
  93     /*!
  94      * \brief Implement IMDModule interface
  95      *
  96      * Unused.
  97      *
  98      * \return nullptr.
  99      */
 100     IMdpOptionProvider* mdpOptionProvider() override;
 101
 102     /*!
 103      * \brief Implement IMDModule interface
 104      *
 105      * Unused.
 106      *
 107      * \return nullptr.
 108      */
 109     IMDOutputProvider* outputProvider() override;
 110
 111     /*!
 112      * \brief Implement IMDModule interface.
 113      *
 114      * See gmx::IMDModule::initForceProviders()
 115      * \param forceProviders manager in the force record.
 116      */
 117     void initForceProviders(ForceProviders* forceProviders) override;
 118
 119     //! Subscribe to simulation setup notifications
 120     void subscribeToSimulationSetupNotifications(MdModulesNotifier* notifier) override;
 121     //! Subscribe to pre processing notifications
 122     void subscribeToPreProcessingNotifications(MdModulesNotifier* notifier) override;
 123
 124 private:
 125     /*!
 126      * \brief Private implementation opaque pointer.
 127      */
 128     std::unique_ptr<RestraintMDModuleImpl> impl_;
 129 };
 130
 131 } // end namespace gmx
 132
 133 #endif // GROMACS_RESTRAINTMDMODULE_H