A newton solver which is specific to the black oil model. More...

#include <blackoilnewtonmethod.hh>

Inheritance diagram for Opm::BlackOilNewtonMethod< TypeTag >:
Inheritance graph

Public Member Functions

 BlackOilNewtonMethod (Simulator &simulator)
 
void finishInit ()
 Finialize the construction of the object. More...
 
unsigned numPriVarsSwitched () const
 Returns the number of degrees of freedom for which the interpretation has changed for the most recent iteration. More...
 
void update_ (SolutionVector &nextSolution, const SolutionVector &currentSolution, const GlobalEqVector &solutionUpdate, const GlobalEqVector &currentResidual)
 
template<class DofIndices >
void update_ (SolutionVector &nextSolution, const SolutionVector &currentSolution, const GlobalEqVector &solutionUpdate, const GlobalEqVector &currentResidual, const DofIndices &dofIndices)
 

Static Public Member Functions

static void registerParameters ()
 Register all run-time parameters for the immiscible model. More...
 

Protected Member Functions

void beginIteration_ ()
 Indicates the beginning of a Newton iteration. More...
 
void endIteration_ (SolutionVector &uCurrentIter, const SolutionVector &uLastIter)
 Indicates that one Newton iteration was finished. More...
 
void updatePrimaryVariables_ (unsigned globalDofIdx, PrimaryVariables &nextValue, const PrimaryVariables &currentValue, const EqVector &update, const EqVector &currentResidual)
 Update a single primary variables object. More...
 

Protected Attributes

friend NewtonMethod< TypeTag >
 
friend ParentType
 

Detailed Description

template<class TypeTag>
class Opm::BlackOilNewtonMethod< TypeTag >

A newton solver which is specific to the black oil model.

Constructor & Destructor Documentation

◆ BlackOilNewtonMethod()

template<class TypeTag >
Opm::BlackOilNewtonMethod< TypeTag >::BlackOilNewtonMethod ( Simulator &  simulator)
inline

Member Function Documentation

◆ beginIteration_()

template<class TypeTag >
void Opm::BlackOilNewtonMethod< TypeTag >::beginIteration_ ( )
inlineprotected

Indicates the beginning of a Newton iteration.

◆ endIteration_()

template<class TypeTag >
void Opm::BlackOilNewtonMethod< TypeTag >::endIteration_ ( SolutionVector &  uCurrentIter,
const SolutionVector &  uLastIter 
)
inlineprotected

Indicates that one Newton iteration was finished.

Parameters
nextSolutionThe solution after the current Newton iteration
currentSolutionThe solution at the beginning of the current Newton iteration

◆ finishInit()

template<class TypeTag >
void Opm::BlackOilNewtonMethod< TypeTag >::finishInit ( )
inline

Finialize the construction of the object.

At this point, it can be assumed that all objects featured by the simulator have been allocated. (But not that they have been fully initialized yet.)

◆ numPriVarsSwitched()

template<class TypeTag >
unsigned Opm::BlackOilNewtonMethod< TypeTag >::numPriVarsSwitched ( ) const
inline

Returns the number of degrees of freedom for which the interpretation has changed for the most recent iteration.

◆ registerParameters()

template<class TypeTag >
static void Opm::BlackOilNewtonMethod< TypeTag >::registerParameters ( )
inlinestatic

Register all run-time parameters for the immiscible model.

◆ update_() [1/2]

template<class TypeTag >
void Opm::BlackOilNewtonMethod< TypeTag >::update_ ( SolutionVector &  nextSolution,
const SolutionVector &  currentSolution,
const GlobalEqVector &  solutionUpdate,
const GlobalEqVector &  currentResidual 
)
inline

◆ update_() [2/2]

template<class TypeTag >
template<class DofIndices >
void Opm::BlackOilNewtonMethod< TypeTag >::update_ ( SolutionVector &  nextSolution,
const SolutionVector &  currentSolution,
const GlobalEqVector &  solutionUpdate,
const GlobalEqVector &  currentResidual,
const DofIndices &  dofIndices 
)
inline

◆ updatePrimaryVariables_()

template<class TypeTag >
void Opm::BlackOilNewtonMethod< TypeTag >::updatePrimaryVariables_ ( unsigned  globalDofIdx,
PrimaryVariables &  nextValue,
const PrimaryVariables &  currentValue,
const EqVector &  update,
const EqVector &  currentResidual 
)
inlineprotected

Member Data Documentation

◆ NewtonMethod< TypeTag >

template<class TypeTag >
friend Opm::BlackOilNewtonMethod< TypeTag >::NewtonMethod< TypeTag >
protected

◆ ParentType

template<class TypeTag >
friend Opm::BlackOilNewtonMethod< TypeTag >::ParentType
protected

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