Dumux::AwnSurfaceExpFctParams< ScalarT > Class Template Reference

implementation of interfacial area surface params More...

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

Description

template<class ScalarT>
class Dumux::AwnSurfaceExpFctParams< ScalarT >

implementation of interfacial area surface params

Public Types
using	Scalar = ScalarT

Public Member Functions
	AwnSurfaceExpFctParams ()
	AwnSurfaceExpFctParams (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	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...
void	setSwr (const Scalar v)
	Set the $\mathrm{S_{wr}}$ for the surface. More...

Member Typedef Documentation

Scalar

template<class ScalarT >

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

Constructor & Destructor Documentation

AwnSurfaceExpFctParams() [1/2]

template<class ScalarT >

Dumux::AwnSurfaceExpFctParams< ScalarT >::AwnSurfaceExpFctParams ( )

inline

AwnSurfaceExpFctParams() [2/2]

template<class ScalarT >

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

inline

Member Function Documentation

a1()

template<class ScalarT >

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

inline

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

a2()

template<class ScalarT >

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

inline

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

a3()

template<class ScalarT >

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

inline

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

setA1()

template<class ScalarT >

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

inline

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

setA2()

template<class ScalarT >

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

inline

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

setA3()

template<class ScalarT >

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

inline

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

setSwr()

template<class ScalarT >

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

inline

Set the $\mathrm{S_{wr}}$ for the surface.

Swr()

template<class ScalarT >

const Scalar Dumux::AwnSurfaceExpFctParams< 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:

• awnsurfaceexpfctparams.hh