Opm::WellConnectionAuxiliaryModule< TypeTag > Class Template Reference

#include <WellConnectionAuxiliaryModule.hpp>

Inheritance diagram for Opm::WellConnectionAuxiliaryModule< TypeTag >:

Public Types
using	NeighborSet = typename ::Opm::BaseAuxiliaryModule< TypeTag >::NeighborSet

Public Member Functions
	WellConnectionAuxiliaryModule (const Schedule &schedule, const Dune::CpGrid &grid)
unsigned	numDofs () const
	Returns the number of additional degrees of freedom required for the auxiliary module. More...
void	addNeighbors (std::vector< NeighborSet > &neighbors) const
	Specify the additional neighboring correlations caused by the auxiliary module. More...
void	applyInitial ()
	Set the initial condition of the auxiliary module in the solution vector. More...
void	linearize (SparseMatrixAdapter &, GlobalEqVector &)
	Linearize the auxiliary equation. 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 (unsigned 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	postSolve (GlobalEqVector &)
	This method is called after the linear solver has been called but before the solution is updated for the next iteration. More...

Member Typedef Documentation

NeighborSet

template<class TypeTag >

using Opm::WellConnectionAuxiliaryModule< TypeTag >::NeighborSet = typename ::Opm::BaseAuxiliaryModule<TypeTag>::NeighborSet

Constructor & Destructor Documentation

WellConnectionAuxiliaryModule()

template<class TypeTag >

Opm::WellConnectionAuxiliaryModule< TypeTag >::WellConnectionAuxiliaryModule ( const Schedule &  schedule, const Dune::CpGrid &  grid  )

inline

Member Function Documentation

addNeighbors()

template<class TypeTag >

void Opm::WellConnectionAuxiliaryModule< TypeTag >::addNeighbors ( std::vector< NeighborSet > &  neighbors ) const

inlinevirtual

Specify the additional neighboring correlations caused by the auxiliary module.

Implements Opm::BaseAuxiliaryModule< TypeTag >.

References Opm::WellConnectionAuxiliaryModuleGeneric::wells_.

applyInitial()

template<class TypeTag >

void Opm::WellConnectionAuxiliaryModule< TypeTag >::applyInitial ( )

inlinevirtual

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

Implements Opm::BaseAuxiliaryModule< TypeTag >.

dofOffset()

template<class TypeTag >

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

inlineinherited

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

linearize()

template<class TypeTag >

void Opm::WellConnectionAuxiliaryModule< TypeTag >::linearize ( SparseMatrixAdapter &  matrix, GlobalEqVector &  residual  )

inlinevirtual

Linearize the auxiliary equation.

Implements Opm::BaseAuxiliaryModule< TypeTag >.

localToGlobalDof()

template<class TypeTag >

int Opm::BaseAuxiliaryModule< TypeTag >::localToGlobalDof ( unsigned  localDofIdx ) const

inlineinherited

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

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

numDofs()

template<class TypeTag >

unsigned Opm::WellConnectionAuxiliaryModule< TypeTag >::numDofs ( ) const

inlinevirtual

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

Implements Opm::BaseAuxiliaryModule< TypeTag >.

postSolve()

template<class TypeTag >

virtual void Opm::BaseAuxiliaryModule< TypeTag >::postSolve ( GlobalEqVector &  )

inlinevirtualinherited

This method is called after the linear solver has been called but before the solution is updated for the next iteration.

It is intended to implement stuff like Schur complements.

Reimplemented in Opm::BlackoilWellModel< TypeTag >.

setDofOffset()

template<class TypeTag >

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

inlineinherited

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

Referenced by Opm::FvBaseDiscretization< TypeTag >::addAuxiliaryModule().

---

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

• WellConnectionAuxiliaryModule.hpp