Dumux::DirichletConstraintInfo< numEq > Class Template Reference

Class to specify information related to Dirichlet constraints.

#include <dumux/common/constraintinfo.hh>

Inheritance diagram for Dumux::DirichletConstraintInfo< numEq >:

Public Member Functions
	DirichletConstraintInfo ()
void	reset ()
	Reset for all equations. More...
void	resetEq (int eqIdx)
	Reset for one equation. More...
void	setAll ()
	Set all as constraints. More...
void	set (int pvIdx, int eqIdx)
	Set a constraint condition for a single primary variable. More...
void	set (int pvIdx)
	Set a constraint condition for a single primary variable. More...
int	priVarToEqIndex (int pvIdx) const
	Returns the index of the equation which should be used for the constraint condition of the pvIdx's primary variable. More...
int	eqToPriVarIndex (int eqIdx) const
	Returns the index of the primary variable which should be used for the constraint condition given an equation index. More...
bool	isConstraintEquation (int eqIdx) const
	Returns true if an equation is used to specify a constraint condition. More...

Static Public Member Functions
static constexpr int	size ()
	we might have a constraint for each equation More...

Protected Attributes
std::array< bool, numEq >	isConstraint_

Constructor & Destructor Documentation

DirichletConstraintInfo()

template<int numEq>

Dumux::DirichletConstraintInfo< numEq >::DirichletConstraintInfo ( )

inline

Member Function Documentation

eqToPriVarIndex()

template<int numEq>

int Dumux::DirichletConstraintInfo< numEq >::eqToPriVarIndex ( int  eqIdx ) const

inline

Parameters

eqIdx

The index of the equation which is used to set the constraint condition.

isConstraintEquation()

template<int numEq>

bool Dumux::ConstraintInfo< numEq >::isConstraintEquation ( int  eqIdx ) const

inlineinherited

Parameters

eqIdx

The index of the equation

priVarToEqIndex()

template<int numEq>

int Dumux::DirichletConstraintInfo< numEq >::priVarToEqIndex ( int  pvIdx ) const

inline

Parameters

pvIdx

The index of the primary variable which is be set by the constraint condition.

reset()

template<int numEq>

void Dumux::DirichletConstraintInfo< numEq >::reset ( )

inline

resetEq()

template<int numEq>

void Dumux::DirichletConstraintInfo< numEq >::resetEq ( int  eqIdx )

inline

set() [1/2]

template<int numEq>

void Dumux::DirichletConstraintInfo< numEq >::set ( int  pvIdx )

inline

Parameters

pvIdx

The index of the primary variable inside a PrimaryVariables object.

set() [2/2]

template<int numEq>

void Dumux::DirichletConstraintInfo< numEq >::set ( int  pvIdx, int  eqIdx  )

inline

Parameters

pvIdx	The index of the primary variable for which the constraint condition should apply.
eqIdx	The index of the equation which should be used to set the constraint condition

setAll()

template<int numEq>

void Dumux::DirichletConstraintInfo< numEq >::setAll ( )

inline

size()

template<int numEq>

static constexpr int Dumux::ConstraintInfo< numEq >::size ( )

inlinestaticconstexprinherited

Member Data Documentation

isConstraint_

template<int numEq>

std::array<bool, numEq> Dumux::ConstraintInfo< numEq >::isConstraint_

protectedinherited

---

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

• constraintinfo.hh