Dumux::AwnSurfacePolynomialEdgeZero2ndOrderParams< ScalarT > Class Template Reference

Implementation of interfacial area surface params. More...

#include <dumux/material/fluidmatrixinteractions/2pia/awnsurfacepolynomialedgezero2ndorderparams.hh>

Description

template<class ScalarT>
class Dumux::AwnSurfacePolynomialEdgeZero2ndOrderParams< ScalarT >

Implementation of interfacial area surface params.

Public Types
using	Scalar = ScalarT

Public Member Functions
	AwnSurfacePolynomialEdgeZero2ndOrderParams ()
	AwnSurfacePolynomialEdgeZero2ndOrderParams (const Scalar a1, const Scalar a2, const Scalar a3)
const Scalar	a1 () const
	Return the $\mathrm{a_{1}}$ shape parameter of awn surface. More...
const Scalar	a2 () const
	Return the $\mathrm{a_{2}}$ shape parameter of awn surface. More...
const Scalar	a3 () const
	Return the $\mathrm{a_{3}}$ shape parameter of awn surface. More...
const Scalar	Swr () const
	Return the $\mathrm{S_{wr}}$ shape parameter of awn surface. More...
void	setSwr (const Scalar v)
	Set the residual water saturation $\mathrm{S_{wr}}$. More...
void	setA1 (const Scalar v)
	Set the $\mathrm{a_{1}}$ shape parameter. More...
void	setA2 (const Scalar v)
	Set the $\mathrm{a_{2}}$ shape parameter. More...
void	setA3 (const Scalar v)
	Set the $\mathrm{a_{3}}$ shape parameter. More...

Member Typedef Documentation

Scalar

template<class ScalarT >

using Dumux::AwnSurfacePolynomialEdgeZero2ndOrderParams< ScalarT >::Scalar = ScalarT

Constructor & Destructor Documentation

AwnSurfacePolynomialEdgeZero2ndOrderParams() [1/2]

template<class ScalarT >

Dumux::AwnSurfacePolynomialEdgeZero2ndOrderParams< ScalarT >::AwnSurfacePolynomialEdgeZero2ndOrderParams ( )

inline

AwnSurfacePolynomialEdgeZero2ndOrderParams() [2/2]

template<class ScalarT >

Dumux::AwnSurfacePolynomialEdgeZero2ndOrderParams< ScalarT >::AwnSurfacePolynomialEdgeZero2ndOrderParams ( const Scalar  a1, const Scalar  a2, const Scalar  a3  )

inline

Member Function Documentation

a1()

template<class ScalarT >

const Scalar Dumux::AwnSurfacePolynomialEdgeZero2ndOrderParams< ScalarT >::a1 ( ) const

inline

Return the $\mathrm{a_{1}}$ shape parameter of awn surface.

a2()

template<class ScalarT >

const Scalar Dumux::AwnSurfacePolynomialEdgeZero2ndOrderParams< ScalarT >::a2 ( ) const

inline

Return the $\mathrm{a_{2}}$ shape parameter of awn surface.

a3()

template<class ScalarT >

const Scalar Dumux::AwnSurfacePolynomialEdgeZero2ndOrderParams< ScalarT >::a3 ( ) const

inline

Return the $\mathrm{a_{3}}$ shape parameter of awn surface.

setA1()

template<class ScalarT >

void Dumux::AwnSurfacePolynomialEdgeZero2ndOrderParams< ScalarT >::setA1 ( const Scalar  v )

inline

Set the $\mathrm{a_{1}}$ shape parameter.

setA2()

template<class ScalarT >

void Dumux::AwnSurfacePolynomialEdgeZero2ndOrderParams< ScalarT >::setA2 ( const Scalar  v )

inline

Set the $\mathrm{a_{2}}$ shape parameter.

setA3()

template<class ScalarT >

void Dumux::AwnSurfacePolynomialEdgeZero2ndOrderParams< ScalarT >::setA3 ( const Scalar  v )

inline

Set the $\mathrm{a_{3}}$ shape parameter.

setSwr()

template<class ScalarT >

void Dumux::AwnSurfacePolynomialEdgeZero2ndOrderParams< ScalarT >::setSwr ( const Scalar  v )

inline

Set the residual water saturation $\mathrm{S_{wr}}$.

Swr()

template<class ScalarT >

const Scalar Dumux::AwnSurfacePolynomialEdgeZero2ndOrderParams< ScalarT >::Swr ( ) const

inline

Return the $\mathrm{S_{wr}}$ shape parameter of awn surface.

---

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

• awnsurfacepolynomialedgezero2ndorderparams.hh