src/api/cpp/workflow-impl.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018, 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_WORKFLOW_IMPL_H
  37 #define GROMACS_WORKFLOW_IMPL_H
  38
  39 /*! \internal \file
  40  * \brief Implementation details for Workflow infrastructure.
  41  *
  42  * \author M. Eric Irrgang <ericirrgang@gmail.com>
  43  * \ingroup gmxapi
  44  */
  45
  46 #include "workflow.h"
  47
  48 #include <memory>
  49 #include <string>
  50
  51 #include "gmxapi/exceptions.h"
  52
  53 namespace gmxapi
  54 {
  55
  56 class WorkflowKeyError : public BasicException<WorkflowKeyError>
  57 {
  58     public:
  59         using BasicException::BasicException;
  60 };
  61
  62 /*!
  63  * \brief Work graph node for MD simulation.
  64  */
  65 class MDNodeSpecification : public NodeSpecification
  66 {
  67     public:
  68         //! Uses parameter type of base class.
  69         using NodeSpecification::paramsType;
  70
  71         /*!
  72          * \brief Simulation node from file input
  73          *
  74          * \param filename TPR input filename.
  75          */
  76         explicit MDNodeSpecification(const std::string &filename);
  77
  78         /*
  79          * \brief Implement NodeSpecification::clone()
  80          *
  81          * \returns a node to launch a simulation from the same input as this
  82          *
  83          * Returns nullptr if clone is not possible.
  84          */
  85         std::unique_ptr<NodeSpecification> clone() override;
  86
  87         /*! \brief Implement NodeSpecification::params()
  88          *
  89          * \return Copy of internal params value.
  90          */
  91         paramsType params() const noexcept override;
  92
  93     private:
  94         //! The TPR input filename, set during construction
  95         paramsType tprfilename_;
  96 };
  97
  98
  99 }      // end namespace gmxapi
 100
 101 #endif //GROMACS_WORKFLOW_IMPL_H