python_packaging/src/gmxapi/pycontext.cpp

   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 /*! \file
  36  * \brief Wrapper code for gmxapi::Context.
  37  *
  38  * \ingroup module_python
  39  * \author M. Eric Irrgang <ericirrgang@gmail.com>
  40  */
  41 #include "pycontext.h"
  42
  43 #include "gmxapi/gmxapi.h"
  44 #include "gmxapi/md.h"
  45
  46
  47 namespace py = pybind11;
  48
  49 namespace gmxpy
  50 {
  51
  52 void PyContext::setMDArgs(const MDArgs& mdArgs)
  53 {
  54     assert(context_);
  55     context_->setMDArgs(mdArgs);
  56 }
  57
  58 std::shared_ptr<gmxapi::Session> PyContext::launch(const gmxapi::Workflow& work)
  59 {
  60     assert(context_);
  61     return context_->launch(work);
  62 }
  63
  64 std::shared_ptr<gmxapi::MDWorkSpec> PyContext::getSpec() const
  65 {
  66     assert(workNodes_);
  67     return workNodes_;
  68 }
  69
  70 std::shared_ptr<gmxapi::Context> PyContext::get() const
  71 {
  72     assert(context_);
  73     return context_;
  74 }
  75
  76 PyContext::PyContext() :
  77     context_{ std::make_shared<gmxapi::Context>() },
  78     workNodes_{ std::make_shared<gmxapi::MDWorkSpec>() }
  79 {
  80     assert(context_);
  81     assert(workNodes_);
  82 }
  83
  84 void PyContext::addMDModule(pybind11::object force_object)
  85 {
  86     // If force_object has a bind method, give it a PyCapsule with a pointer
  87     // to our C++ object.
  88     if (py::hasattr(force_object, "bind"))
  89     {
  90         auto spec     = getSpec();
  91         auto holder   = new gmxapi::MDHolder(spec);
  92         holder->name_ = "pygmx holder";
  93         auto deleter  = [](PyObject* o) {
  94             if (PyCapsule_IsValid(o, gmxapi::MDHolder_Name))
  95             {
  96                 auto holder_ptr = (gmxapi::MDHolder*)PyCapsule_GetPointer(o, gmxapi::MDHolder_Name);
  97                 delete holder_ptr;
  98                 // \todo double-check whether there is something we should do to invalidate a PyCapsule.
  99             }
 100         };
 101     };
 102     auto       capsule = py::capsule(holder, gmxapi::MDHolder_Name, deleter);
 103     py::object bind    = force_object.attr("bind");
 104     // py::capsule does not have bindings and does not implicitly convert to py::object
 105     py::object obj = capsule;
 106     bind(obj);
 107 }
 108 else
 109 {
 110     // Note: Exception behavior is likely to change.
 111     // Ref: https://github.com/kassonlab/gmxapi/issues/125
 112     throw py::value_error("Argument must provide a `bind` method.");
 113 }
 114 } // namespace gmxpy
 115
 116 } // end namespace gmxpy