Opm::RichardsPrimaryVariables< TypeTag > Class Template Reference

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

#include <richardsprimaryvariables.hh>

Inheritance diagram for Opm::RichardsPrimaryVariables< TypeTag >:

Public Member Functions
	RichardsPrimaryVariables (const RichardsPrimaryVariables &value)=default
RichardsPrimaryVariables &	operator= (const RichardsPrimaryVariables &value)=default
void	assignImmiscibleFromWetting (Scalar T, Scalar pw, Scalar Sw, const MaterialLawParams &matParams)
	< Import base class assignment operators.
void	assignImmiscibleFromNonWetting (Scalar T, Scalar pn, Scalar Sn, const MaterialLawParams &matParams)
	Set the primary variables with the non-wetting phase pressure, saturation and temperature.
template<class FluidState>
void	assignMassConservative (const FluidState &fluidState, const MaterialLawParams &matParams, bool=false)
	< Import base class assignment operators.
template<class FluidState>
void	assignNaive (const FluidState &fluidState)
	Directly retrieve the primary variables from an arbitrary fluid state.
FvBasePrimaryVariables &	operator= (const FvBasePrimaryVariables &value)=default
	Assignment from another primary variables object.
Public Member Functions inherited from Opm::FvBasePrimaryVariables< TypeTag, VectorType >
template<class OtherTypeTag, template< class, int > class OtherVectorType>
OPM_HOST_DEVICE	FvBasePrimaryVariables (const FvBasePrimaryVariables< OtherTypeTag, OtherVectorType > &other)
	Copy constructor from another primary variables object.
	FvBasePrimaryVariables (const FvBasePrimaryVariables &value)=default
	Assignment from another primary variables object.
FvBasePrimaryVariables &	operator= (const FvBasePrimaryVariables &value)=default
	Assignment from another primary variables object.
OPM_HOST_DEVICE Evaluation	makeEvaluation (unsigned varIdx, unsigned timeIdx, LinearizationType linearizationType=LinearizationType()) const
	Return a primary variable intensive evaluation.
template<class FluidState>
OPM_HOST_DEVICE void	assignNaive (const FluidState &)
	Assign the primary variables "somehow" from a fluid state.
OPM_HOST_DEVICE void	checkDefined () const
	Instruct valgrind to check the definedness of all attributes of this class.

Additional Inherited Members
Static Public Member Functions inherited from Opm::FvBasePrimaryVariables< TypeTag, VectorType >
static OPM_HOST_DEVICE void	init ()
	< Import base class assignment operators.
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()

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

assignImmiscibleFromWetting()

template<class TypeTag>

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

inline

< Import base class assignment operators.

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

assignMassConservative()

template<class TypeTag>

template<class FluidState>

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

inline

< Import base class assignment operators.

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.

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.

---

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

• opm/models/richards/richardsprimaryvariables.hh