Opm::NcpPrimaryVariables< TypeTag > Class Template Reference

Represents the primary variables used by the compositional multi-phase NCP model. More...

#include <ncpprimaryvariables.hh>

Inheritance diagram for Opm::NcpPrimaryVariables< TypeTag >:

Public Member Functions
	NcpPrimaryVariables ()
	NcpPrimaryVariables (Scalar value)
	Constructor with assignment from scalar. More...
	NcpPrimaryVariables (const NcpPrimaryVariables &value)=default
NcpPrimaryVariables &	operator= (const NcpPrimaryVariables &value)=default
template<class FluidState >
void	assignMassConservative (const FluidState &fluidState, const MaterialLawParams &matParams, bool isInEquilibrium=false)
	Set the primary variables from an arbitrary fluid state in a mass conservative way. More...
template<class FluidState >
void	assignNaive (const FluidState &fluidState, unsigned refPhaseIdx=0)
	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...
template<class FluidState >
void	assignNaive (const FluidState &)
	Assign the primary variables "somehow" from a fluid state. 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::NcpPrimaryVariables< TypeTag >

Represents the primary variables used by the compositional multi-phase NCP model.

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

Constructor & Destructor Documentation

NcpPrimaryVariables() [1/3]

template<class TypeTag >

Opm::NcpPrimaryVariables< TypeTag >::NcpPrimaryVariables ( )

inline

NcpPrimaryVariables() [2/3]

template<class TypeTag >

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

inline

Constructor with assignment from scalar.

Parameters

value

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

NcpPrimaryVariables() [3/3]

template<class TypeTag >

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

default

Member Function Documentation

assignMassConservative()

template<class TypeTag >

template<class FluidState >

void Opm::NcpPrimaryVariables< TypeTag >::assignMassConservative ( const FluidState &  fluidState, const MaterialLawParams &  matParams, bool  isInEquilibrium = 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::NcpPrimaryVariables< TypeTag >::assignNaive().

assignNaive() [1/2]

template<class TypeTag >

template<class FluidState >

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

inlineinherited

Assign the primary variables "somehow" from a fluid state.

That is without considering any consistency issues which the fluid state might have. This method is guaranteed to produce consistent results if the fluid state is consistent to the properties at a given spatial location. (Where "consistent results" means that the same fluid state can be reconstructed from the primary variables.)

assignNaive() [2/2]

template<class TypeTag >

template<class FluidState >

void Opm::NcpPrimaryVariables< TypeTag >::assignNaive ( const FluidState &  fluidState, unsigned  refPhaseIdx = 0  )

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::NcpPrimaryVariables< 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 >

NcpPrimaryVariables & Opm::NcpPrimaryVariables< TypeTag >::operator= ( const NcpPrimaryVariables< 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:

• ncpprimaryvariables.hh