api/cpp/gmxapi/createsession.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 GMXAPI_LIBRARY_SESSION_H
  37 #define GMXAPI_LIBRARY_SESSION_H
  38 /*! \file
  39  * \brief Library internal details for Session API class(es).
  40  *
  41  * \ingroup gmxapi
  42  */
  43
  44 #include "gromacs/mdrunutility/logging.h"
  45
  46 // Above are headers for dependencies.
  47 // Following are public headers for the current module.
  48 #include "gmxapi/context.h"
  49 #include "gmxapi/session.h"
  50
  51 namespace gmx
  52 {
  53 class MdrunnerBuilder;
  54 class SimulationContext;
  55 } // end namespace gmx
  56
  57 namespace gmxapi
  58 {
  59
  60 /*!
  61  * \brief Factory free function for creating new Session objects.
  62  *
  63  * \param context Shared ownership of a Context implementation instance.
  64  * \param runnerBuilder MD simulation builder to take ownership of.
  65  * \param simulationContext Take ownership of the simulation resources.
  66  * \param logFilehandle Take ownership of filehandle for MD logging
  67  * \param multiSim Take ownership of resources for Mdrunner multi-sim.
  68  *
  69  * \todo Log file management will be updated soon.
  70  *
  71  * \return Ownership of new Session implementation instance.
  72  */
  73 std::shared_ptr<Session> createSession(std::shared_ptr<ContextImpl> context,
  74                                        gmx::MdrunnerBuilder&&       runnerBuilder,
  75                                        gmx::SimulationContext&&     simulationContext,
  76                                        gmx::LogFilePtr              logFilehandle);
  77
  78
  79 } // end namespace gmxapi
  80
  81 #endif // GMXAPI_LIBRARY_SESSION_H