Ewoms::BaseAuxiliaryModule< TypeTag > Class Template Reference

Base class for specifying auxiliary equations. More...

#include <baseauxiliarymodule.hh>

Public Member Functions
virtual int	numDofs () const =0
	Returns the number of additional degrees of freedom required for the auxiliary module. More...
void	setDofOffset (int value)
	Set the offset in the global system of equations for the first degree of freedom of this auxiliary module. More...
int	dofOffset ()
	Return the offset in the global system of equations for the first degree of freedom of this auxiliary module. More...
int	localToGlobalDof (int localDofIdx) const
	Given a degree of freedom relative to the current auxiliary equation, return the corresponding index in the global system of equations. More...
virtual void	addNeighbors (std::vector< NeighborSet > &neighbors) const =0
	Specify the additional neighboring correlations caused by the auxiliary module. More...
virtual void	applyInitial ()=0
	Set the initial condition of the auxiliary module in the solution vector. More...
virtual void	linearize (JacobianMatrix &matrix, GlobalEqVector &residual)=0
	Linearize the auxiliary equation. More...

Protected Types
typedef std::set< int >	NeighborSet

Detailed Description

template<class TypeTag>
class Ewoms::BaseAuxiliaryModule< TypeTag >

Base class for specifying auxiliary equations.

For example, these equations can be wells, non-neighboring connections, interfaces between model domains, etc.

Member Typedef Documentation

template<class TypeTag >

typedef std::set<int> Ewoms::BaseAuxiliaryModule< TypeTag >::NeighborSet

protected

Member Function Documentation

template<class TypeTag >

virtual void Ewoms::BaseAuxiliaryModule< TypeTag >::addNeighbors ( std::vector< NeighborSet > &  neighbors ) const

pure virtual

Specify the additional neighboring correlations caused by the auxiliary module.

template<class TypeTag >

virtual void Ewoms::BaseAuxiliaryModule< TypeTag >::applyInitial ( )

pure virtual

Set the initial condition of the auxiliary module in the solution vector.

template<class TypeTag >

int Ewoms::BaseAuxiliaryModule< TypeTag >::dofOffset ( )

inline

Return the offset in the global system of equations for the first degree of freedom of this auxiliary module.

template<class TypeTag >

virtual void Ewoms::BaseAuxiliaryModule< TypeTag >::linearize ( JacobianMatrix &  matrix, GlobalEqVector &  residual  )

pure virtual

Linearize the auxiliary equation.

template<class TypeTag >

int Ewoms::BaseAuxiliaryModule< TypeTag >::localToGlobalDof ( int  localDofIdx ) const

inline

Given a degree of freedom relative to the current auxiliary equation, return the corresponding index in the global system of equations.

References Ewoms::BaseAuxiliaryModule< TypeTag >::numDofs().

template<class TypeTag >

virtual int Ewoms::BaseAuxiliaryModule< TypeTag >::numDofs ( ) const

pure virtual

Returns the number of additional degrees of freedom required for the auxiliary module.

Referenced by Ewoms::BaseAuxiliaryModule< TypeTag >::localToGlobalDof().

template<class TypeTag >

void Ewoms::BaseAuxiliaryModule< TypeTag >::setDofOffset ( int  value )

inline

Set the offset in the global system of equations for the first degree of freedom of this auxiliary module.

---

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

• baseauxiliarymodule.hh