Ewoms::FvBaseConstraints< TypeTag > Class Template Reference

Class to specify constraints for a finite volume spatial discretization. More...

#include <fvbaseconstraints.hh>

Inheritance diagram for Ewoms::FvBaseConstraints< TypeTag >:

Public Member Functions
	FvBaseConstraints ()
void	reset ()
	Reset the constraints types. More...
bool	isConstraint () const
	Returns true if constraints for any equation have been specified. More...
bool	isConstraint (int eqIdx) const
	Returns true if constraints for given equation have been specified. More...
void	setAllConstraint ()
	Set all to be constraint. More...
void	setConstraint (int eqIdx, int pvIdx, Scalar value)
	Set a constraint for single equation. More...
void	setConstraint (int eqIdx, int pvIdx)
	Set a constraint for single equation. More...
unsigned	pvToEqIndex (unsigned pvIdx) const
	Returns the index of the equation which should be used to constrain the pvIdx's primary variable. More...
unsigned	eqToPvIndex (unsigned eqIdx) const
	Returns the index of the primary variable for which a given equation should be used as a constraint. More...

Detailed Description

template<class TypeTag>
class Ewoms::FvBaseConstraints< TypeTag >

Class to specify constraints for a finite volume spatial discretization.

Constructor & Destructor Documentation

template<class TypeTag >

Ewoms::FvBaseConstraints< TypeTag >::FvBaseConstraints ( )

inline

References Ewoms::FvBaseConstraints< TypeTag >::reset().

Member Function Documentation

template<class TypeTag >

unsigned Ewoms::FvBaseConstraints< TypeTag >::eqToPvIndex ( unsigned  eqIdx ) const

inline

Returns the index of the primary variable for which a given equation should be used as a constraint.

Parameters

eqIdx

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

template<class TypeTag >

bool Ewoms::FvBaseConstraints< TypeTag >::isConstraint ( ) const

inline

Returns true if constraints for any equation have been specified.

template<class TypeTag >

bool Ewoms::FvBaseConstraints< TypeTag >::isConstraint ( int  eqIdx ) const

inline

Returns true if constraints for given equation have been specified.

Parameters

eqIdx

The index of the equation

template<class TypeTag >

unsigned Ewoms::FvBaseConstraints< TypeTag >::pvToEqIndex ( unsigned  pvIdx ) const

inline

Returns the index of the equation which should be used to constrain the pvIdx's primary variable.

Parameters

pvIdx

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

template<class TypeTag >

void Ewoms::FvBaseConstraints< TypeTag >::reset ( )

inline

Reset the constraints types.

If nothing is changed after this method has been called, no DOFs will be constraint.

Referenced by Ewoms::FvBaseConstraints< TypeTag >::FvBaseConstraints().

template<class TypeTag >

void Ewoms::FvBaseConstraints< TypeTag >::setAllConstraint ( )

inline

Set all to be constraint.

(with equation index == primary variable index)

template<class TypeTag >

void Ewoms::FvBaseConstraints< TypeTag >::setConstraint ( int  eqIdx, int  pvIdx, Scalar  value  )

inline

Set a constraint for single equation.

Parameters

eqIdx	The index of the equation which should used to set the constraint
pvIdx	The index of the primary variable which should be set.
value	The value of the constraint DOF

template<class TypeTag >

void Ewoms::FvBaseConstraints< TypeTag >::setConstraint ( int  eqIdx, int  pvIdx  )

inline

Set a constraint for single equation.

Parameters

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

---

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

• fvbaseconstraints.hh