Opm::PvsNewtonMethod< TypeTag > Class Template Reference

A newton solver which is specific to the compositional multi-phase PVS model. More...

#include <pvsnewtonmethod.hh>

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

Public Member Functions

 PvsNewtonMethod (Simulator &simulator)
 

Protected Member Functions

void updatePrimaryVariables_ (unsigned, PrimaryVariables &nextValue, const PrimaryVariables &currentValue, const EqVector &update, const EqVector &)
 Update a single primary variables object. More...
 
void endIteration_ (SolutionVector &uCurrentIter, const SolutionVector &uLastIter)
 Indicates that one Newton iteration was finished. More...
 
void clampValue_ (Scalar &val, Scalar minVal, Scalar maxVal) const
 

Protected Attributes

friend NewtonMethod< TypeTag >
 
friend ParentType
 

Detailed Description

template<class TypeTag>
class Opm::PvsNewtonMethod< TypeTag >

A newton solver which is specific to the compositional multi-phase PVS model.

Constructor & Destructor Documentation

◆ PvsNewtonMethod()

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

Member Function Documentation

◆ clampValue_()

template<class TypeTag >
void Opm::PvsNewtonMethod< TypeTag >::clampValue_ ( Scalar &  val,
Scalar  minVal,
Scalar  maxVal 
) const
inlineprotected

◆ endIteration_()

template<class TypeTag >
void Opm::PvsNewtonMethod< 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

◆ updatePrimaryVariables_()

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

Update a single primary variables object.

References Opm::PvsNewtonMethod< TypeTag >::clampValue_().

Member Data Documentation

◆ NewtonMethod< TypeTag >

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

◆ ParentType

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

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