Represents the primary variables used in the Richards model. More...

#include <richardsprimaryvariables.hh>

Inheritance diagram for Opm::RichardsPrimaryVariables< TypeTag >:

Public Member Functions
	RichardsPrimaryVariables ()

	RichardsPrimaryVariables (Scalar value)
	Constructor with assignment from scalar. More...

	RichardsPrimaryVariables (const RichardsPrimaryVariables &value)=default

RichardsPrimaryVariables &	operator= (const RichardsPrimaryVariables &value)=default

void	assignImmiscibleFromWetting (Scalar T, Scalar pw, Scalar Sw, const MaterialLawParams &matParams)
	Set the primary variables with the wetting phase pressure, saturation and temperature. More...

void	assignImmiscibleFromNonWetting (Scalar T, Scalar pn, Scalar Sn, const MaterialLawParams &matParams)
	Set the primary variables with the non-wetting phase pressure, saturation and temperature. More...

template<class FluidState >
void	assignMassConservative (const FluidState &fluidState, const MaterialLawParams &matParams, bool=false)
	Set the primary variables from an arbitrary fluid state in a mass conservative way. More...

template<class FluidState >
void	assignNaive (const FluidState &fluidState)
	Directly retrieve the primary variables from an arbitrary fluid state. More...

Evaluation	makeEvaluation (unsigned varIdx, unsigned timeIdx, LinearizationType linearizationType=LinearizationType()) const
	Return a primary variable intensive evaluation. More...

void	checkDefined () const
	Instruct valgrind to check the definedness of all attributes of this class. More...

Static Public Member Functions
static void	init ()

static void	registerParameters ()

Detailed Description

template<class TypeTag>
class Opm::RichardsPrimaryVariables< TypeTag >

Represents the primary variables used in the Richards model.

This class is basically a Dune::FieldVector which can retrieve its contents from an aribitatry fluid state.

Constructor & Destructor Documentation

◆ RichardsPrimaryVariables() [1/3]

template<class TypeTag >

Opm::RichardsPrimaryVariables< TypeTag >::RichardsPrimaryVariables ( )

inline

◆ RichardsPrimaryVariables() [2/3]

template<class TypeTag >

Opm::RichardsPrimaryVariables< TypeTag >::RichardsPrimaryVariables ( Scalar value )

inline

Constructor with assignment from scalar.

Parameters

value The scalar value to which all entries of the vector will be set.

◆ RichardsPrimaryVariables() [3/3]

template<class TypeTag >

Opm::RichardsPrimaryVariables< TypeTag >::RichardsPrimaryVariables ( const RichardsPrimaryVariables< TypeTag > & value )

default

Member Function Documentation

◆ assignImmiscibleFromNonWetting()

template<class TypeTag >

void Opm::RichardsPrimaryVariables< TypeTag >::assignImmiscibleFromNonWetting	(	Scalar	T,
		Scalar	pn,
		Scalar	Sn,
		const MaterialLawParams &	matParams
	)

inline

Set the primary variables with the non-wetting phase pressure, saturation and temperature.

Parameters

T	The temperature [K]
pn	The pressure of the non-wetting phase [Pa]
Sn	The saturation of the non-wetting phase []
matParams	The capillary pressure law parameters

References Opm::RichardsPrimaryVariables< TypeTag >::assignNaive().

◆ assignImmiscibleFromWetting()

template<class TypeTag >

void Opm::RichardsPrimaryVariables< TypeTag >::assignImmiscibleFromWetting	(	Scalar	T,
		Scalar	pw,
		Scalar	Sw,
		const MaterialLawParams &	matParams
	)

inline

Set the primary variables with the wetting phase pressure, saturation and temperature.

Parameters

T	The temperature [K]
pw	The pressure of the wetting phase [Pa]
Sw	The saturation of the wetting phase []
matParams	The capillary pressure law parameters

References Opm::RichardsPrimaryVariables< TypeTag >::assignNaive().

◆ assignMassConservative()

template<class TypeTag >

template<class FluidState >

void Opm::RichardsPrimaryVariables< TypeTag >::assignMassConservative	(	const FluidState &	fluidState,
		const MaterialLawParams &	matParams,
		bool	= `false`
	)

inline

Set the primary variables from an arbitrary fluid state in a mass conservative way.

If an energy equation is included, the fluid temperatures are the same as the one given in the fluid state, not the enthalpy.

Parameters

fluidState	The fluid state which should be represented by the primary variables. The temperatures, pressures, compositions and densities of all phases must be defined.
matParams	The capillary pressure law parameters
isInEquilibrium	If true, the fluid state expresses thermodynamic equilibrium assuming the relations expressed by the fluid system. This implies that in addition to the quantities mentioned above, the fugacities are also defined.

References Opm::RichardsPrimaryVariables< TypeTag >::assignNaive().

◆ assignNaive()

template<class TypeTag >

template<class FluidState >

void Opm::RichardsPrimaryVariables< TypeTag >::assignNaive ( const FluidState & fluidState )

inline

Directly retrieve the primary variables from an arbitrary fluid state.

This method retrieves all primary variables from an abitrary fluid state without careing whether the state which is represented by the resulting primary variables features the equivalent mass as the given fluid state. This method is massively cheaper and simpler than assignMassConservative() but it should be used with care!

Parameters

fluidState The fluid state which should be represented by the primary variables. The temperatures, pressures, compositions and densities of all phases must be defined.

Referenced by Opm::RichardsPrimaryVariables< TypeTag >::assignImmiscibleFromNonWetting(), Opm::RichardsPrimaryVariables< TypeTag >::assignImmiscibleFromWetting(), and Opm::RichardsPrimaryVariables< TypeTag >::assignMassConservative().

◆ checkDefined()

template<class TypeTag >

void Opm::FvBasePrimaryVariables< TypeTag >::checkDefined ( ) const

inlineinherited

Instruct valgrind to check the definedness of all attributes of this class.

◆ init()

template<class TypeTag >

static void Opm::FvBasePrimaryVariables< TypeTag >::init ( )

inlinestaticinherited

◆ makeEvaluation()

template<class TypeTag >

Evaluation Opm::FvBasePrimaryVariables< TypeTag >::makeEvaluation	(	unsigned	varIdx,
		unsigned	timeIdx,
		LinearizationType	linearizationType = `LinearizationType()`
	)		const

inlineinherited

Return a primary variable intensive evaluation.

i.e., the result represents the function f = x_i if the time index is zero, else it represents the a constant f = x_i. (the difference is that in the first case, the derivative w.r.t. x_i is 1, while it is 0 in the second case.

◆ operator=()

template<class TypeTag >

RichardsPrimaryVariables & Opm::RichardsPrimaryVariables< TypeTag >::operator= ( const RichardsPrimaryVariables< TypeTag > & value )

default

◆ registerParameters()

template<class TypeTag >

static void Opm::FvBasePrimaryVariables< TypeTag >::registerParameters ( )

inlinestaticinherited

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

richardsprimaryvariables.hh

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RichardsPrimaryVariables() [1/3]

◆ RichardsPrimaryVariables() [2/3]

◆ RichardsPrimaryVariables() [3/3]

Member Function Documentation

◆ assignImmiscibleFromNonWetting()

◆ assignImmiscibleFromWetting()

◆ assignMassConservative()

◆ assignNaive()

◆ checkDefined()

◆ init()

◆ makeEvaluation()

◆ operator=()

◆ registerParameters()