My Project
Loading...
Searching...
No Matches
Opm::WellConnectionAuxiliaryModule< TypeTag > Class Template Reference
Inheritance diagram for Opm::WellConnectionAuxiliaryModule< TypeTag >:
Opm::BaseAuxiliaryModule< TypeTag > Opm::WellConnectionAuxiliaryModuleGeneric

Public Types

using 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.
 
void addNeighbors (std::vector< NeighborSet > &neighbors) const
 Specify the additional neighboring correlations caused by the auxiliary module.
 
void applyInitial ()
 Set the initial condition of the auxiliary module in the solution vector.
 
void linearize (SparseMatrixAdapter &, GlobalEqVector &)
 Linearize the auxiliary equation.
 
- Public Member Functions inherited from Opm::BaseAuxiliaryModule< TypeTag >
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 postSolve (GlobalEqVector &)
 This method is called after the linear solver has been called but before the solution is updated for the next iteration.
 

Additional Inherited Members

- Protected Types inherited from Opm::BaseAuxiliaryModule< TypeTag >
using NeighborSet = std::set<unsigned>
 

Member Typedef Documentation

◆ NeighborSet

template<class TypeTag >
using Opm::WellConnectionAuxiliaryModule< TypeTag >::NeighborSet
Initial value:
typename
::Opm::BaseAuxiliaryModule<TypeTag>::NeighborSet

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 >.

◆ 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 >.

◆ linearize()

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

Linearize the auxiliary equation.

Implements Opm::BaseAuxiliaryModule< TypeTag >.

◆ 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 >.


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