OPM - Reference Documentation for opm-material

A default implementation of the parameters for the adapter class to convert material laws from effective to absolute saturations. More...

#include <EffToAbsLawParams.hpp>

Inheritance diagram for Opm::EffToAbsLawParams< EffLawParamsT, numPhases >:

Inheritance graph

Public Types
typedef EffLawParams::Traits	Traits

Public Member Functions
	EffToAbsLawParams ()

void	finalize ()
	Calculate all dependent quantities once the independent quantities of the parameter object have been set. More...

Scalar	residualSaturation (unsigned phaseIdx) const
	Return the residual saturation of a phase. More...

Scalar	sumResidualSaturations () const
	Return the sum of the residual saturations. More...

void	setResidualSaturation (unsigned phaseIdx, Scalar value)
	Set the residual saturation of a phase. More...

Detailed Description

template<class EffLawParamsT, int numPhases>
class Opm::EffToAbsLawParams< EffLawParamsT, numPhases >

A default implementation of the parameters for the adapter class to convert material laws from effective to absolute saturations.

Member Typedef Documentation

◆ Traits

template<class EffLawParamsT , int numPhases>

typedef EffLawParams::Traits Opm::EffToAbsLawParams< EffLawParamsT, numPhases >::Traits

Constructor & Destructor Documentation

◆ EffToAbsLawParams()

template<class EffLawParamsT , int numPhases>

Opm::EffToAbsLawParams< EffLawParamsT, numPhases >::EffToAbsLawParams ( )

inline

Member Function Documentation

◆ finalize()

template<class EffLawParamsT , int numPhases>

void Opm::EffToAbsLawParams< EffLawParamsT, numPhases >::finalize ( )

inline

Calculate all dependent quantities once the independent quantities of the parameter object have been set.

◆ residualSaturation()

template<class EffLawParamsT , int numPhases>

Scalar Opm::EffToAbsLawParams< EffLawParamsT, numPhases >::residualSaturation ( unsigned phaseIdx ) const

inline

Return the residual saturation of a phase.

References Opm::EnsureFinalized::check().

◆ setResidualSaturation()

template<class EffLawParamsT , int numPhases>

void Opm::EffToAbsLawParams< EffLawParamsT, numPhases >::setResidualSaturation	(	unsigned	phaseIdx,
		Scalar	value
	)

inline

Set the residual saturation of a phase.

◆ sumResidualSaturations()

template<class EffLawParamsT , int numPhases>

Scalar Opm::EffToAbsLawParams< EffLawParamsT, numPhases >::sumResidualSaturations ( ) const

inline

Return the sum of the residual saturations.

References Opm::EnsureFinalized::check().

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

EffToAbsLawParams.hpp