OPM - Reference Documentation for opm-material

Specification of the material parameters for the van Genuchten constitutive relations. More...

#include <VanGenuchtenParams.hpp>

Inheritance diagram for Opm::VanGenuchtenParams< TraitsT >:

Inheritance graph

Public Types
typedef TraitsT	Traits

Public Member Functions
	VanGenuchtenParams ()

	VanGenuchtenParams (Scalar vgAlpha, Scalar vgN)

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

Scalar	vgAlpha () const
	Return the $\alpha$ shape parameter of van Genuchten's curve. More...

void	setVgAlpha (Scalar v)
	Set the $\alpha$ shape parameter of van Genuchten's curve. More...

Scalar	vgM () const
	Return the shape parameter of van Genuchten's curve. More...

void	setVgM (Scalar m)
	Set the shape parameter of van Genuchten's curve. More...

Scalar	vgN () const
	Return the shape parameter of van Genuchten's curve. More...

void	setVgN (Scalar n)
	Set the shape parameter of van Genuchten's curve. More...

Detailed Description

template<class TraitsT>
class Opm::VanGenuchtenParams< TraitsT >

Specification of the material parameters for the van Genuchten constitutive relations.

In this implementation setting either the $n$ or $m$ shape parameter automatically calculates the other. I.e. they cannot be set independently.

Member Typedef Documentation

template<class TraitsT >

typedef TraitsT Opm::VanGenuchtenParams< TraitsT >::Traits

Constructor & Destructor Documentation

template<class TraitsT >

Opm::VanGenuchtenParams< TraitsT >::VanGenuchtenParams ( )

inline

template<class TraitsT >

Opm::VanGenuchtenParams< TraitsT >::VanGenuchtenParams	(	Scalar	vgAlpha,
		Scalar	vgN
	)

inline

References Opm::VanGenuchtenParams< TraitsT >::finalize(), Opm::VanGenuchtenParams< TraitsT >::setVgAlpha(), and Opm::VanGenuchtenParams< TraitsT >::setVgN().

Member Function Documentation

template<class TraitsT >

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

inline

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

Referenced by Opm::RegularizedVanGenuchtenParams< TraitsT >::finalize(), and Opm::VanGenuchtenParams< TraitsT >::VanGenuchtenParams().

template<class TraitsT >

void Opm::VanGenuchtenParams< TraitsT >::setVgAlpha ( Scalar v )

inline

Set the $\alpha$ shape parameter of van Genuchten's curve.

Referenced by Opm::VanGenuchtenParams< TraitsT >::VanGenuchtenParams().

template<class TraitsT >

void Opm::VanGenuchtenParams< TraitsT >::setVgM ( Scalar m )

inline

Set the $m$ shape parameter of van Genuchten's curve.

The $n$ shape parameter is set to $n = \frac{1}{1 - m}$

template<class TraitsT >

void Opm::VanGenuchtenParams< TraitsT >::setVgN ( Scalar n )

inline

Set the $n$ shape parameter of van Genuchten's curve.

The $n$ shape parameter is set to $m = 1 - \frac{1}{n}$

Referenced by Opm::VanGenuchtenParams< TraitsT >::VanGenuchtenParams().

template<class TraitsT >

Scalar Opm::VanGenuchtenParams< TraitsT >::vgAlpha ( ) const

inline

Return the $\alpha$ shape parameter of van Genuchten's curve.

template<class TraitsT >

Scalar Opm::VanGenuchtenParams< TraitsT >::vgM ( ) const

inline

Return the $m$ shape parameter of van Genuchten's curve.

template<class TraitsT >

Scalar Opm::VanGenuchtenParams< TraitsT >::vgN ( ) const

inline

Return the $n$ shape parameter of van Genuchten's curve.

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

VanGenuchtenParams.hpp