Dumux::MpLinearMaterialParams< numPhasesV, ScalarT > Class Template Reference

Reference implementation of params for the linear M-phase material material. More...

#include <dumux/material/fluidmatrixinteractions/mp/mplinearmaterialparams.hh>

Description

template<int numPhasesV, class ScalarT>
class Dumux::MpLinearMaterialParams< numPhasesV, ScalarT >

Reference implementation of params for the linear M-phase material material.

Public Types
enum	{ numPhases = numPhasesV }
using	Scalar = ScalarT

Public Member Functions
	MpLinearMaterialParams ()
Scalar	sReg (int phaseIdx) const
	Return the threshold saturation at which the relative permeability starts to get regularized. More...
Scalar	pcMinSat (int phaseIdx) const
	Return the capillary pressure in \(\mathrm{[Pa]}\) for a phase \(\mathrm{\alpha}\) at \(\mathrm{S_\alpha=0}\). More...
void	setPcMinSat (int phaseIdx, Scalar val)
	Set the capillary pressure in \(\mathrm{[Pa]}\) for a phase \(\mathrm{\alpha}\) at \(\mathrm{S_\alpha=0}\). More...
Scalar	pcMaxSat (int phaseIdx) const
	Return the capillary pressure in \(\mathrm{[Pa]}\) for a phase \(\mathrm{\alpha}\) at \(\mathrm{S_\alpha=1}\). More...
void	setPcMaxSat (int phaseIdx, Scalar val)
	Set the capillary pressure in \(\mathrm{[Pa]}\) for a phase \(\mathrm{\alpha}\) at \(\mathrm{S_\alpha=1}\). More...
Scalar	krLowS (int phaseIdx) const
	Return the threshold saturation respective phase below which the relative permeability gets regularized. More...
Scalar	krHighS (int phaseIdx) const
	Return the threshold saturation of the respective phase above which the relative permeability gets regularized. More...

Member Typedef Documentation

Scalar

template<int numPhasesV, class ScalarT >

using Dumux::MpLinearMaterialParams< numPhasesV, ScalarT >::Scalar = ScalarT

Member Enumeration Documentation

anonymous enum

template<int numPhasesV, class ScalarT >

anonymous enum

Enumerator
numPhases

Constructor & Destructor Documentation

MpLinearMaterialParams()

template<int numPhasesV, class ScalarT >

Dumux::MpLinearMaterialParams< numPhasesV, ScalarT >::MpLinearMaterialParams ( )

inline

Member Function Documentation

krHighS()

template<int numPhasesV, class ScalarT >

Scalar Dumux::MpLinearMaterialParams< numPhasesV, ScalarT >::krHighS ( int  phaseIdx ) const

inline

Return the threshold saturation of the respective phase above which the relative permeability gets regularized.

This is just 95%. If you need a different value, write your own parameter class.

Parameters

phaseIdx

Index of the phase

krLowS()

template<int numPhasesV, class ScalarT >

Scalar Dumux::MpLinearMaterialParams< numPhasesV, ScalarT >::krLowS ( int  phaseIdx ) const

inline

Return the threshold saturation respective phase below which the relative permeability gets regularized.

This is just 5%. If you need a different value, write your own parameter class.

Parameters

phaseIdx

Index of the phase

pcMaxSat()

template<int numPhasesV, class ScalarT >

Scalar Dumux::MpLinearMaterialParams< numPhasesV, ScalarT >::pcMaxSat ( int  phaseIdx ) const

inline

Return the capillary pressure in \(\mathrm{[Pa]}\) for a phase \(\mathrm{\alpha}\) at \(\mathrm{S_\alpha=1}\).

Parameters

phaseIdx

Index of the phase

pcMinSat()

template<int numPhasesV, class ScalarT >

Scalar Dumux::MpLinearMaterialParams< numPhasesV, ScalarT >::pcMinSat ( int  phaseIdx ) const

inline

Return the capillary pressure in \(\mathrm{[Pa]}\) for a phase \(\mathrm{\alpha}\) at \(\mathrm{S_\alpha=0}\).

Parameters

phaseIdx

Index of the phase

setPcMaxSat()

template<int numPhasesV, class ScalarT >

void Dumux::MpLinearMaterialParams< numPhasesV, ScalarT >::setPcMaxSat ( int  phaseIdx, Scalar  val  )

inline

Set the capillary pressure in \(\mathrm{[Pa]}\) for a phase \(\mathrm{\alpha}\) at \(\mathrm{S_\alpha=1}\).

Parameters

phaseIdx	Index of the phase
val	Value of the capillary pressure

setPcMinSat()

template<int numPhasesV, class ScalarT >

void Dumux::MpLinearMaterialParams< numPhasesV, ScalarT >::setPcMinSat ( int  phaseIdx, Scalar  val  )

inline

Set the capillary pressure in \(\mathrm{[Pa]}\) for a phase \(\mathrm{\alpha}\) at \(\mathrm{S_\alpha=0}\).

Parameters

phaseIdx	Index of the phase
val	Value of the capillary pressure

sReg()

template<int numPhasesV, class ScalarT >

Scalar Dumux::MpLinearMaterialParams< numPhasesV, ScalarT >::sReg ( int  phaseIdx ) const

inline

Return the threshold saturation at which the relative permeability starts to get regularized.

Parameters

phaseIdx

Index of the phase

This is simply 10%

---

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

• mplinearmaterialparams.hh