Opm::BrooksCoreyParams< TraitsT > Class Template Reference

Specification of the material parameters for the Brooks-Corey constitutive relations. More...

#include <BrooksCoreyParams.hpp>

Inheritance diagram for Opm::BrooksCoreyParams< TraitsT >:

Public Types
typedef TraitsT	Traits

Public Member Functions
	BrooksCoreyParams ()
	BrooksCoreyParams (Scalar entryPressure, Scalar lambda)
void	finalize ()
	Calculate all dependent quantities once the independent quantities of the parameter object have been set. More...
Scalar	entryPressure () const
	Returns the entry pressure [Pa]. More...
void	setEntryPressure (Scalar v)
	Set the entry pressure [Pa]. More...
Scalar	lambda () const
	Returns the lambda shape parameter. More...
void	setLambda (Scalar v)
	Set the lambda shape parameter. More...

Detailed Description

template<class TraitsT>
class Opm::BrooksCoreyParams< TraitsT >

Specification of the material parameters for the Brooks-Corey constitutive relations.

See also

BrooksCorey

Member Typedef Documentation

template<class TraitsT >

typedef TraitsT Opm::BrooksCoreyParams< TraitsT >::Traits

Constructor & Destructor Documentation

template<class TraitsT >

Opm::BrooksCoreyParams< TraitsT >::BrooksCoreyParams ( )

inline

References Valgrind::SetUndefined().

template<class TraitsT >

Opm::BrooksCoreyParams< TraitsT >::BrooksCoreyParams ( Scalar  entryPressure, Scalar  lambda  )

inline

References Opm::BrooksCoreyParams< TraitsT >::finalize().

Member Function Documentation

template<class TraitsT >

Scalar Opm::BrooksCoreyParams< TraitsT >::entryPressure ( ) const

inline

Returns the entry pressure [Pa].

template<class TraitsT >

void Opm::BrooksCoreyParams< TraitsT >::finalize ( )

inline

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

Referenced by Opm::BrooksCoreyParams< TraitsT >::BrooksCoreyParams(), and Opm::RegularizedBrooksCoreyParams< TraitsT >::finalize().

template<class TraitsT >

Scalar Opm::BrooksCoreyParams< TraitsT >::lambda ( ) const

inline

Returns the lambda shape parameter.

template<class TraitsT >

void Opm::BrooksCoreyParams< TraitsT >::setEntryPressure ( Scalar  v )

inline

Set the entry pressure [Pa].

template<class TraitsT >

void Opm::BrooksCoreyParams< TraitsT >::setLambda ( Scalar  v )

inline

Set the lambda shape parameter.

---

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

• BrooksCoreyParams.hpp