simulationsupportpythonwrapper.h

/*******************************************************************************

Copyright (C) The University of Auckland

OpenCOR is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

OpenCOR is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

*******************************************************************************/

//==============================================================================
// Simulation support Python wrapper
//==============================================================================

#pragma once

//==============================================================================

#include <QList>
#include <QObject>

//==============================================================================

#include "pythonbegin.h"
    #include "PythonQt/PythonQtPythonInclude.h"
#include "pythonend.h"

//==============================================================================

namespace OpenCOR {

//==============================================================================

namespace DataStore {
    class DataStoreVariable;
} // namespace DataStore

//==============================================================================

namespace SimulationSupport {

//==============================================================================

class Simulation;
class SimulationData;
class SimulationResults;

//==============================================================================
// Note: we bind the SimulationData object to the the first parameter of
//       updateParameters() to create a function object to be called when
//       simulation parameters are updated...

#if defined(Q_OS_WIN)
    using SimulationDataUpdatedFunction = std::_Binder<std::_Unforced, void (*)(SimulationData *), SimulationData *>;
#elif defined(Q_OS_LINUX)
    using SimulationDataUpdatedFunction = std::_Bind_helper<false, void (*)(SimulationData *), SimulationData *>::type;
#else
    using SimulationDataUpdatedFunction = std::__bind<void (*)(SimulationData *), SimulationData *>;
#endif

//==============================================================================

class SimulationSupportPythonWrapper : public QObject
{
    Q_OBJECT

public:
    explicit SimulationSupportPythonWrapper(PyObject *pModule,
                                            QObject *pParent);

private:
    qint64 mElapsedTime;
    QString mErrorMessage;

public slots:
    bool valid(OpenCOR::SimulationSupport::Simulation *pSimulation);

    PyObject * issues(OpenCOR::SimulationSupport::Simulation *pSimulation) const;

    void clearResults(OpenCOR::SimulationSupport::Simulation *pSimulation);

    void resetParameters(OpenCOR::SimulationSupport::Simulation *pSimulation);

    bool run(OpenCOR::SimulationSupport::Simulation *pSimulation);

    // Set a simulation's point data

    void setStartingPoint(OpenCOR::SimulationSupport::SimulationData *pSimulationData,
                          const double &pStartingPoint,
                          const bool &pRecompute = true);
    void setEndingPoint(OpenCOR::SimulationSupport::SimulationData *pSimulationData,
                        const double &pEndingPoint);
    void setPointInterval(OpenCOR::SimulationSupport::SimulationData *pSimulationData,
                          const double &pPointInterval);

    // Assign a solver

    void setOdeSolver(OpenCOR::SimulationSupport::SimulationData *pSimulationData, const QString &pOdeSolverName);
    void setNlaSolver(OpenCOR::SimulationSupport::SimulationData *pSimulationData, const QString &pNlaSolverName);

    // Access a simulation's parameter data

    PyObject * algebraic(OpenCOR::SimulationSupport::SimulationData *pSimulationData) const;
    PyObject * constants(OpenCOR::SimulationSupport::SimulationData *pSimulationData) const;
    PyObject * rates(OpenCOR::SimulationSupport::SimulationData *pSimulationData) const;
    PyObject * states(OpenCOR::SimulationSupport::SimulationData *pSimulationData) const;

    // Access a simulation's result data

    const OpenCOR::DataStore::DataStoreVariable * points(OpenCOR::SimulationSupport::SimulationResults *pSimulationResults) const;

    PyObject * algebraic(OpenCOR::SimulationSupport::SimulationResults *pSimulationResults) const;
    PyObject * constants(OpenCOR::SimulationSupport::SimulationResults *pSimulationResults) const;
    PyObject * states(OpenCOR::SimulationSupport::SimulationResults *pSimulationResults) const;
    PyObject * rates(OpenCOR::SimulationSupport::SimulationResults *pSimulationResults) const;

private slots:
    void error(const QString &pErrorMessage);
    void simulationFinished(const qint64 &pElapsedTime);

signals:
    void gotElapsedTime();
};

//==============================================================================

} // namespace SimulationSupport
} // namespace OpenCOR

//==============================================================================
// End of file
//==============================================================================