python_packaging/src/gmxapi/pycontext.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019,2021, 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 /*! \file
  36  * \brief Declarations for Context wrappers.
  37  *
  38  * \ingroup module_python
  39  * \author M. Eric Irrgang <ericirrgang@gmail.com>
  40  */
  41
  42 #ifndef GMXPY_PYCONTEXT_H
  43 #define GMXPY_PYCONTEXT_H
  44
  45 #include "pybind11/pybind11.h"
  46
  47 #include "gmxapi/context.h"
  48 #include "gmxapi/md.h"
  49
  50 namespace gmxpy
  51 {
  52
  53 using gmxapi::MDArgs;
  54
  55
  56 /*!
  57  * \brief Wrapper for gmxapi::Context
  58  *
  59  * Proxies gmxapi::Context methods and includes additions not yet provided by
  60  * by upstream library.
  61  */
  62 class PyContext
  63 {
  64 public:
  65     PyContext();
  66     void                             setMDArgs(const MDArgs& mdArgs);
  67     std::shared_ptr<gmxapi::Session> launch(const gmxapi::Workflow& work);
  68     std::shared_ptr<gmxapi::Context> get() const;
  69
  70     void addMDModule(const pybind11::object& forceProvider) const;
  71
  72     /*!
  73      * \brief Borrow shared ownership of the System's container of associated modules.
  74      *
  75      * Used with gmxapi::MDHolder to add MD Modules to the simulation to be run.
  76      *
  77      * \return handle to be passed to gmxapi::MDHolder
  78      *
  79      */
  80     std::shared_ptr<gmxapi::MDWorkSpec> getSpec() const;
  81
  82 private:
  83     std::shared_ptr<gmxapi::Context>    context_;
  84     std::shared_ptr<gmxapi::MDWorkSpec> workNodes_;
  85 };
  86
  87
  88 } // end namespace gmxpy
  89
  90 #endif // GMXPY_PYCONTEXT_H