Represents the primary variables used by the black-oil model. More...

#include <blackoilprimaryvariables.hh>

Inheritance diagram for Opm::BlackOilPrimaryVariables< TypeTag, VectorType >:

Public Types
using	WaterMeaning = ::Opm::BlackOil::WaterMeaning

using	PressureMeaning = ::Opm::BlackOil::PressureMeaning

using	GasMeaning = ::Opm::BlackOil::GasMeaning

using	BrineMeaning = ::Opm::BlackOil::BrineMeaning

using	SolventMeaning = ::Opm::BlackOil::SolventMeaning

Public Member Functions
template<class OtherTypeTag , template< class, int > class OtherVectorType>
OPM_HOST_DEVICE	BlackOilPrimaryVariables (const BlackOilPrimaryVariables< OtherTypeTag, OtherVectorType > &other)
	Assignment from another primary variables object. More...

	BlackOilPrimaryVariables (const BlackOilPrimaryVariables &value)=default
	Copy constructor. More...

OPM_HOST_DEVICE Evaluation	makeEvaluation (unsigned varIdx, unsigned timeIdx, LinearizationType linearizationType=LinearizationType()) const

OPM_HOST_DEVICE void	setPvtRegionIndex (unsigned value)
	Set the index of the region which should be used for PVT properties. More...

OPM_HOST_DEVICE unsigned	pvtRegionIndex () const
	Return the index of the region which should be used for PVT properties.

OPM_HOST_DEVICE WaterMeaning	primaryVarsMeaningWater () const
	Return the interpretation which should be applied to the switching primary variables.

OPM_HOST_DEVICE void	setPrimaryVarsMeaningWater (WaterMeaning newMeaning)
	Set the interpretation which should be applied to the switching primary variables.

OPM_HOST_DEVICE PressureMeaning	primaryVarsMeaningPressure () const
	Return the interpretation which should be applied to the switching primary variables.

OPM_HOST_DEVICE void	setPrimaryVarsMeaningPressure (PressureMeaning newMeaning)
	Set the interpretation which should be applied to the switching primary variables.

OPM_HOST_DEVICE GasMeaning	primaryVarsMeaningGas () const
	Return the interpretation which should be applied to the switching primary variables.

OPM_HOST_DEVICE void	setPrimaryVarsMeaningGas (GasMeaning newMeaning)
	Set the interpretation which should be applied to the switching primary variables.

OPM_HOST_DEVICE BrineMeaning	primaryVarsMeaningBrine () const

OPM_HOST_DEVICE void	setPrimaryVarsMeaningBrine (BrineMeaning newMeaning)
	Set the interpretation which should be applied to the switching primary variables.

OPM_HOST_DEVICE SolventMeaning	primaryVarsMeaningSolvent () const

OPM_HOST_DEVICE void	setPrimaryVarsMeaningSolvent (SolventMeaning newMeaning)
	Set the interpretation which should be applied to the switching primary variables.

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

bool	adaptPrimaryVariables (const Problem &problem, unsigned globalDofIdx, [[maybe_unused]] Scalar swMaximum, Scalar thresholdWaterFilledCell, Scalar eps=0.0)
	Adapt the interpretation of the switching variables to be physically meaningful. More...

OPM_HOST_DEVICE bool	chopAndNormalizeSaturations ()

BlackOilPrimaryVariables &	operator= (const BlackOilPrimaryVariables &other)=default

OPM_HOST_DEVICE void	checkDefined () const
	< Import base class assignment operators. More...

template<class Serializer >
void	serializeOp (Serializer &serializer)

OPM_HOST_DEVICE bool	operator== (const BlackOilPrimaryVariables &rhs) const

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. More...

	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. More...

template<class FluidState >
OPM_HOST_DEVICE void	assignNaive (const FluidState &)
	Assign the primary variables "somehow" from a fluid state. More...

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

Static Public Member Functions
static BlackOilPrimaryVariables	serializationTestObject ()

static void	init ()

static void	registerParameters ()

Static Public Member Functions inherited from Opm::FvBasePrimaryVariables< TypeTag, VectorType >
static OPM_HOST_DEVICE void	init ()
	< Import base class assignment operators.

static void	registerParameters ()

Friends
template<class OtherTypeTag , template< class, int > class OtherVectorType>
class	BlackOilPrimaryVariables

Detailed Description

template<class TypeTag, template< class, int > class VectorType = Dune::FieldVector>
class Opm::BlackOilPrimaryVariables< TypeTag, VectorType >

Represents the primary variables used by the black-oil model.

Constructor & Destructor Documentation

◆ BlackOilPrimaryVariables() [1/2]

template<class TypeTag, template< class, int > class VectorType = Dune::FieldVector>

template<class OtherTypeTag , template< class, int > class OtherVectorType>

OPM_HOST_DEVICE Opm::BlackOilPrimaryVariables< TypeTag, VectorType >::BlackOilPrimaryVariables ( const BlackOilPrimaryVariables< OtherTypeTag, OtherVectorType > & other )

inlineexplicit

Assignment from another primary variables object.

◆ BlackOilPrimaryVariables() [2/2]

template<class TypeTag, template< class, int > class VectorType = Dune::FieldVector>

Opm::BlackOilPrimaryVariables< TypeTag, VectorType >::BlackOilPrimaryVariables ( const BlackOilPrimaryVariables< TypeTag, VectorType > & value )

default

Copy constructor.

Parameters

value The primary variables that will be duplicated.

Member Function Documentation

◆ adaptPrimaryVariables()

template<class TypeTag, template< class, int > class VectorType = Dune::FieldVector>

bool Opm::BlackOilPrimaryVariables< TypeTag, VectorType >::adaptPrimaryVariables	(	const Problem &	problem,
		unsigned	globalDofIdx,
		[[maybe_unused] ] Scalar	swMaximum,
		Scalar	thresholdWaterFilledCell,
		Scalar	eps = `0.0`
	)

inline

Adapt the interpretation of the switching variables to be physically meaningful.

If the meaning of the primary variables changes, their values are also adapted in a meaningful manner. A Scalar eps can be passed to make the switching condition more strict. Useful for avoiding ocsilation in the primaryVarsMeaning.

Returns: true Iff the interpretation of one of the switching variables was changed

◆ assignNaive()

template<class TypeTag, template< class, int > class VectorType = Dune::FieldVector>

template<class FluidState >

OPM_HOST_DEVICE void Opm::BlackOilPrimaryVariables< TypeTag, VectorType >::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.

◆ checkDefined()

template<class TypeTag, template< class, int > class VectorType = Dune::FieldVector>

OPM_HOST_DEVICE void Opm::BlackOilPrimaryVariables< TypeTag, VectorType >::checkDefined ( ) const

inline

< Import base class assignment operators.

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

We cannot simply check the definedness of the whole object because there might be "alignedness holes" in the memory layout which are caused by the pseudo primary variables.

◆ setPvtRegionIndex()

template<class TypeTag, template< class, int > class VectorType = Dune::FieldVector>

OPM_HOST_DEVICE void Opm::BlackOilPrimaryVariables< TypeTag, VectorType >::setPvtRegionIndex ( unsigned value )

inline

Set the index of the region which should be used for PVT properties.

PVT regions represent spatial variation of the composition decribed by the pseudo-components used by the black oil model (i.e., oil, gas and water). This introduce spatially varying pvt behaviour.

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

opm/models/blackoil/blackoilprimaryvariables.hh

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

template<class TypeTag, template< class, int > class VectorType = Dune::FieldVector> class Opm::BlackOilPrimaryVariables< TypeTag, VectorType >

Constructor & Destructor Documentation

◆ BlackOilPrimaryVariables() [1/2]

◆ BlackOilPrimaryVariables() [2/2]

Member Function Documentation

◆ adaptPrimaryVariables()

◆ assignNaive()

◆ checkDefined()

◆ setPvtRegionIndex()

template<class TypeTag, template< class, int > class VectorType = Dune::FieldVector>
class Opm::BlackOilPrimaryVariables< TypeTag, VectorType >