Ewoms::BaseAuxiliaryModule< TypeTag > Class Template Referenceabstract

Base class for specifying auxiliary equations. More...

#include <baseauxiliarymodule.hh>

Public Member Functions

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

Protected Types

typedef std::set< unsigned > 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.


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