ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterfaceTrampoline Class Reference

Detailed Description

Trampoline class allowing methods of class PythonBoundaryConditionPythonSideInterface to be overridden on the Python side. Cf. https://pybind11.readthedocs.io/en/stable/advanced/classes.html

Definition at line 22 of file BHEInflowPythonBoundaryConditionModule.cpp.

Inheritance diagram for ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterfaceTrampoline:

Collaboration diagram for ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterfaceTrampoline:

Public Member Functions
std::tuple< double, std::vector< double >, std::vector< double >, std::vector< int >, std::vector< double > >	initializeDataContainer () const override
std::tuple< bool, bool, std::vector< double >, std::vector< double > >	tespySolver (double t, std::vector< double > const &Tin_val, std::vector< double > const &Tout_val) const override
std::tuple< std::vector< double >, std::vector< double > >	serverCommunicationPreTimestep (double const t, double const dt, std::vector< double > const &Tin_val, std::vector< double > const &Tout_val, std::vector< double > const &flowrate) const override
void	serverCommunicationPostTimestep (double const t, double const dt, std::vector< double > const &Tin_val, std::vector< double > const &Tout_val, std::vector< double > const &flowrate) const override
Public Member Functions inherited from ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface
bool	isOverriddenEssential () const
bool	isOverriddenTespy () const
bool	isOverriddenServerCommunicationPreTimestep () const
bool	isOverriddenServerCommunicationPostTimestep () const
virtual	~BHEInflowPythonBoundaryConditionPythonSideInterface ()=default

Additional Inherited Members
Public Attributes inherited from ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface
std::tuple< double, std::vector< double >, std::vector< double >, std::vector< int >, std::vector< double > >	dataframe_network

Member Function Documentation

initializeDataContainer()

std::tuple< double, std::vector< double >, std::vector< double >, std::vector< int >, std::vector< double > > ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterfaceTrampoline::initializeDataContainer ( ) const

inlineoverridevirtual

Initialize network dataframe return a tuple (time, BHE inflow temperature, BHE outflow temperature, BHE outflow bc node id, BHE flowrate) set at that position and the parameters of the BHE network.

Reimplemented from ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface.

Definition at line 31 of file BHEInflowPythonBoundaryConditionModule.cpp.

    {
        using Ret = std::tuple<double, std::vector<double>, std::vector<double>,
                               std::vector<int>, std::vector<double>>;
        PYBIND11_OVERLOAD(Ret,
                          BHEInflowPythonBoundaryConditionPythonSideInterface,
                          initializeDataContainer);
    }

References initializeDataContainer().

Referenced by initializeDataContainer().

serverCommunicationPostTimestep()

void ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterfaceTrampoline::serverCommunicationPostTimestep ( double const t, double const dt, std::vector< double > const & Tin_val, std::vector< double > const & Tout_val, std::vector< double > const & flowrate ) const

inlineoverridevirtual

Reimplemented from ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface.

Definition at line 64 of file BHEInflowPythonBoundaryConditionModule.cpp.

    {
        PYBIND11_OVERLOAD(void,
                          BHEInflowPythonBoundaryConditionPythonSideInterface,
                          serverCommunicationPostTimestep, t, dt, Tin_val,
                          Tout_val, flowrate);
    }

References serverCommunicationPostTimestep().

Referenced by serverCommunicationPostTimestep().

serverCommunicationPreTimestep()

std::tuple< std::vector< double >, std::vector< double > > ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterfaceTrampoline::serverCommunicationPreTimestep ( double const , double const , std::vector< double > const & , std::vector< double > const & , std::vector< double > const &  ) const

inlineoverridevirtual

Transfer BHE network dataframe to python script where function serverCommunication takes t, dt, Tin_val, Tout_val, BHE_flowrate as arguments and returns updated Tin_val and flowrate which will be used as (python) boundary conditions for the next time step. The communication happens in preTimestep so that the updated values are used in the current time step. Specific use case: Interface between OGS and SimulationX via TCP/IP where OGS is connected as one client

Returns

a tuple (BHE Tin value, BHE flow rate for all BHEs from serverCommunication)

Reimplemented from ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface.

Definition at line 53 of file BHEInflowPythonBoundaryConditionModule.cpp.

    {
        using Ret = std::tuple<std::vector<double>, std::vector<double>>;
        PYBIND11_OVERLOAD(
            Ret, BHEInflowPythonBoundaryConditionPythonSideInterface,
            serverCommunicationPreTimestep, t, dt, Tin_val, Tout_val, flowrate);
    }

References serverCommunicationPreTimestep().

Referenced by serverCommunicationPreTimestep().

tespySolver()

std::tuple< bool, bool, std::vector< double >, std::vector< double > > ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterfaceTrampoline::tespySolver ( double , std::vector< double > const & , std::vector< double > const &  ) const

inlineoverridevirtual

transfer BHE network dataframe to TESPy and get Tin and flow rate from TESPy

Returns

a tuple (if use tespyThermalSolver, if convergence achieved in tespy, BHE Tin value, BHE flow rate from TESPy) indicating if tespyThermalSolver shall be used at that position, if themal convergence has been achieved in the tespy, the new inflow temperature and flow rate for all BHEs.

Reimplemented from ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface.

Definition at line 41 of file BHEInflowPythonBoundaryConditionModule.cpp.

    {
        using Ret =
            std::tuple<bool, bool, std::vector<double>, std::vector<double>>;
        PYBIND11_OVERLOAD(Ret,
                          BHEInflowPythonBoundaryConditionPythonSideInterface,
                          tespySolver, t, Tin_val, Tout_val);
    }

References tespySolver().

Referenced by tespySolver().

---

The documentation for this class was generated from the following file:

• ProcessLib/BoundaryConditionAndSourceTerm/Python/BHEInflowPythonBoundaryConditionModule.cpp