OGS
ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface Class Reference

Detailed Description

Base class for BHENetwork. This class will get Python bindings and is intended to be to be derived in Python.

Definition at line 11 of file BHEInflowPythonBoundaryConditionPythonSideInterface.h.

#include <BHEInflowPythonBoundaryConditionPythonSideInterface.h>

Inheritance diagram for ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface:
[legend]

Public Member Functions

virtual std::tuple< double, std::vector< double >, std::vector< double >, std::vector< int >, std::vector< double > > initializeDataContainer () const
virtual std::tuple< bool, bool, std::vector< double >, std::vector< double > > tespySolver (double, std::vector< double > const &, std::vector< double > const &) const
virtual std::tuple< std::vector< double >, std::vector< double > > serverCommunicationPreTimestep (double, double, std::vector< double > const &, std::vector< double > const &, std::vector< double > const &) const
virtual void serverCommunicationPostTimestep (double, double, std::vector< double > const &, std::vector< double > const &, std::vector< double > const &) const
bool isOverriddenEssential () const
bool isOverriddenTespy () const
bool isOverriddenServerCommunicationPreTimestep () const
bool isOverriddenServerCommunicationPostTimestep () const
virtual ~BHEInflowPythonBoundaryConditionPythonSideInterface ()=default

Public Attributes

std::tuple< double, std::vector< double >, std::vector< double >, std::vector< int >, std::vector< double > > dataframe_network

Private Attributes

bool _overridden_essential = true
bool _overridden_tespy = true
bool _overridden_server_communication_pre = true
bool _overridden_server_communication_post = true

Constructor & Destructor Documentation

◆ ~BHEInflowPythonBoundaryConditionPythonSideInterface()

virtual ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface::~BHEInflowPythonBoundaryConditionPythonSideInterface ( )
virtualdefault

Member Function Documentation

◆ initializeDataContainer()

virtual std::tuple< double, std::vector< double >, std::vector< double >, std::vector< int >, std::vector< double > > ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface::initializeDataContainer ( ) const
inlinevirtual

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 in ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterfaceTrampoline.

Definition at line 25 of file BHEInflowPythonBoundaryConditionPythonSideInterface.h.

26 {
27 _overridden_essential = false;
28 return std::tuple<double,
29 std::vector<double>,
30 std::vector<double>,
31 std::vector<int>,
32 std::vector<double>>{
33 std::numeric_limits<double>::quiet_NaN(), {}, {}, {}, {}};
34 }

References _overridden_essential.

◆ isOverriddenEssential()

bool ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface::isOverriddenEssential ( ) const
inline

Tells if initializeDataContainer() has been overridden in the derived class in Python.

Precondition
initializeDataContainer() must already have been called once.

Definition at line 94 of file BHEInflowPythonBoundaryConditionPythonSideInterface.h.

94{ return _overridden_essential; }

References _overridden_essential.

◆ isOverriddenServerCommunicationPostTimestep()

bool ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface::isOverriddenServerCommunicationPostTimestep ( ) const
inline

Definition at line 111 of file BHEInflowPythonBoundaryConditionPythonSideInterface.h.

112 {
113 return _overridden_server_communication_post;
114 }

References _overridden_server_communication_post.

◆ isOverriddenServerCommunicationPreTimestep()

bool ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface::isOverriddenServerCommunicationPreTimestep ( ) const
inline

Tells if serverCommunication() has been overridden in the derived class in Python.

Precondition
serverCommunication() must already have been called once.

Definition at line 106 of file BHEInflowPythonBoundaryConditionPythonSideInterface.h.

107 {
108 return _overridden_server_communication_pre;
109 }

References _overridden_server_communication_pre.

◆ isOverriddenTespy()

bool ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface::isOverriddenTespy ( ) const
inline

Tells if tespySolver() has been overridden in the derived class in Python.

Precondition
tespySolver() must already have been called once.

Definition at line 100 of file BHEInflowPythonBoundaryConditionPythonSideInterface.h.

100{ return _overridden_tespy; }

References _overridden_tespy.

◆ serverCommunicationPostTimestep()

virtual void ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface::serverCommunicationPostTimestep ( double ,
double ,
std::vector< double > const & ,
std::vector< double > const & ,
std::vector< double > const &  ) const
inlinevirtual

Reimplemented in ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterfaceTrampoline.

Definition at line 80 of file BHEInflowPythonBoundaryConditionPythonSideInterface.h.

85 {
86 _overridden_server_communication_post = false;
87 }

References _overridden_server_communication_post.

◆ serverCommunicationPreTimestep()

virtual std::tuple< std::vector< double >, std::vector< double > > ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface::serverCommunicationPreTimestep ( double ,
double ,
std::vector< double > const & ,
std::vector< double > const & ,
std::vector< double > const &  ) const
inlinevirtual

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 in ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterfaceTrampoline.

Definition at line 70 of file BHEInflowPythonBoundaryConditionPythonSideInterface.h.

75 {
76 _overridden_server_communication_pre = false;
77 return {};
78 }

References _overridden_server_communication_pre.

◆ tespySolver()

virtual std::tuple< bool, bool, std::vector< double >, std::vector< double > > ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface::tespySolver ( double ,
std::vector< double > const & ,
std::vector< double > const &  ) const
inlinevirtual

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 in ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterfaceTrampoline.

Definition at line 47 of file BHEInflowPythonBoundaryConditionPythonSideInterface.h.

50 {
51 _overridden_tespy = false;
52 return std::tuple<bool, bool, std::vector<double>, std::vector<double>>{
53 false, false, {}, {}};
54 }

References _overridden_tespy.

Referenced by ProcessLib::bheInflowpythonBindBoundaryCondition().

Member Data Documentation

◆ _overridden_essential

bool ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface::_overridden_essential = true
mutableprivate

Tells if initializeDataContainer() has been overridden in the derived class in Python.

Definition at line 129 of file BHEInflowPythonBoundaryConditionPythonSideInterface.h.

Referenced by initializeDataContainer(), and isOverriddenEssential().

◆ _overridden_server_communication_post

bool ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface::_overridden_server_communication_post = true
mutableprivate

Definition at line 137 of file BHEInflowPythonBoundaryConditionPythonSideInterface.h.

Referenced by isOverriddenServerCommunicationPostTimestep(), and serverCommunicationPostTimestep().

◆ _overridden_server_communication_pre

bool ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface::_overridden_server_communication_pre = true
mutableprivate

Tells if serverCommunication() has been overridden in the derived class in Python.

Definition at line 135 of file BHEInflowPythonBoundaryConditionPythonSideInterface.h.

Referenced by isOverriddenServerCommunicationPreTimestep(), and serverCommunicationPreTimestep().

◆ _overridden_tespy

bool ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface::_overridden_tespy = true
mutableprivate

Tells if tespySolver() has been overridden in the derived class in Python.

Definition at line 132 of file BHEInflowPythonBoundaryConditionPythonSideInterface.h.

Referenced by isOverriddenTespy(), and tespySolver().

◆ dataframe_network

std::tuple<double, std::vector<double>, std::vector<double>, std::vector<int>, std::vector<double> > ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface::dataframe_network

Definition at line 122 of file BHEInflowPythonBoundaryConditionPythonSideInterface.h.

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