Dumux::ConstraintInfo< numEq > Class Template Reference

Class to specify information related to constraints.

#include <dumux/common/constraintinfo.hh>

Inheritance diagram for Dumux::ConstraintInfo< numEq >:

Public Member Functions
	ConstraintInfo ()
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 eqIdx)
	Set a constraint condition for a single equation. 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

ConstraintInfo()

template<int numEq>

Dumux::ConstraintInfo< numEq >::ConstraintInfo ( )

inline

Member Function Documentation

isConstraintEquation()

template<int numEq>

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

inline

Parameters

eqIdx

The index of the equation

reset()

template<int numEq>

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

inline

resetEq()

template<int numEq>

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

inline

set()

template<int numEq>

void Dumux::ConstraintInfo< numEq >::set ( int  eqIdx )

inline

Parameters

eqIdx

The index of the equation for which constraint is set

setAll()

template<int numEq>

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

inline

size()

template<int numEq>

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

inlinestaticconstexpr

Member Data Documentation

isConstraint_

template<int numEq>

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

protected

---

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

• constraintinfo.hh