Opm::VanGenuchtenParams< TraitsT > Class Template Reference

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

#include <VanGenuchtenParams.hpp>

Inheritance diagram for Opm::VanGenuchtenParams< TraitsT >:
Opm::EnsureFinalized Opm::RegularizedVanGenuchtenParams< TraitsT >

List of all members.

Public Types

typedef TraitsT Traits

Public Member Functions

 VanGenuchtenParams (Scalar alphaParam, Scalar nParam)
Scalar vgAlpha () const
 Return the $\alpha$ shape parameter of van Genuchten's curve.
void setVgAlpha (Scalar v)
 Set the $\alpha$ shape parameter of van Genuchten's curve.
Scalar vgM () const
 Return the $m$ shape parameter of van Genuchten's curve.
void setVgM (Scalar m)
 Set the $m$ shape parameter of van Genuchten's curve.
Scalar vgN () const
 Return the $n$ shape parameter of van Genuchten's curve.
void setVgN (Scalar n)
 Set the $n$ shape parameter of van Genuchten's curve.

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 Function Documentation

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}$


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

Generated on 25 Mar 2018 by  doxygen 1.6.1