Detailed Description

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

Definition at line 18 of file PythonBoundaryConditionPythonSideInterface.h.

#include <PythonBoundaryConditionPythonSideInterface.h>

Inheritance diagram for ProcessLib::PythonBoundaryConditionPythonSideInterface:

Public Member Functions
virtual std::pair< bool, double >	getDirichletBCValue (double, std::array< double, 3 >, std::size_t, std::vector< double > const &) const

virtual std::tuple< bool, double, std::vector< double > >	getFlux (double, std::array< double, 3 >, std::vector< double > const &) const

bool	isOverriddenEssential () const

bool	isOverriddenNatural () const

virtual	~PythonBoundaryConditionPythonSideInterface ()=default

Private Attributes
bool	_overridden_essential = true

bool	_overridden_natural = true
	Tells if getFlux() has been overridden in the derived class in Python.

Constructor & Destructor Documentation

◆ ~PythonBoundaryConditionPythonSideInterface()

virtual ProcessLib::PythonBoundaryConditionPythonSideInterface::~PythonBoundaryConditionPythonSideInterface ( )

virtualdefault

Member Function Documentation

◆ getDirichletBCValue()

virtual std::pair< bool, double > ProcessLib::PythonBoundaryConditionPythonSideInterface::getDirichletBCValue	(	double	,
		std::array< double, 3 >	,
		std::size_t	,
		std::vector< double > const &	) const

inlinevirtual

Computes Dirichlet boundary condition values for the provided arguments (time, position of the node, node id, primary variables at the node).

Returns: a pair (is_dirichlet, value) indicating if a Dirichlet BC shall be set at that node and (if so) the value of the Dirichlet BC at that node.

Reimplemented in ProcessLib::PythonBoundaryConditionPythonSideInterfaceTrampoline.

Definition at line 29 of file PythonBoundaryConditionPythonSideInterface.h.

    {
        _overridden_essential = false;
        return {false, std::numeric_limits<double>::quiet_NaN()};
    }

References _overridden_essential.

Referenced by ProcessLib::pythonBindBoundaryCondition().

◆ getFlux()

virtual std::tuple< bool, double, std::vector< double > > ProcessLib::PythonBoundaryConditionPythonSideInterface::getFlux	(	double	,
		std::array< double, 3 >	,
		std::vector< double > const &	) const

inlinevirtual

Computes the flux for the provided arguments (time, position, primary variables at that position).

Returns: a pair (is_natural, flux, flux_jacobian) indicating if a natural BC shall be set at that position and (if so) the flux at that node and the derivative of the flux w.r.t. all primary variables.

Reimplemented in ProcessLib::PythonBoundaryConditionPythonSideInterfaceTrampoline.

Definition at line 45 of file PythonBoundaryConditionPythonSideInterface.h.

    {
        _overridden_natural = false;
        return std::tuple<bool, double, std::vector<double>>{
            false, std::numeric_limits<double>::quiet_NaN(), {}};
    }