Module for the modular fluid state which stores the phase compositions explicitly in terms of mole fractions. More...

#include <FluidStateCompositionModules.hpp>

Inheritance diagram for Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >:

Public Member Functions
	FluidStateExplicitCompositionModule ()

const Scalar &	moleFraction (unsigned phaseIdx, unsigned compIdx) const
	The mole fraction of a component in a phase []. More...

Scalar	massFraction (unsigned phaseIdx, unsigned compIdx) const
	The mass fraction of a component in a phase []. More...

const Scalar &	averageMolarMass (unsigned phaseIdx) const
	The mean molar mass of a fluid phase [kg/mol]. More...

Scalar	molarity (unsigned phaseIdx, unsigned compIdx) const
	The concentration of a component in a phase [mol/m^3]. More...

void	setMoleFraction (unsigned phaseIdx, unsigned compIdx, const Scalar &value)
	Set the mole fraction of a component in a phase [] and update the average molar mass [kg/mol] according to the current composition of the phase. More...

void	setCompressFactor (unsigned phaseIdx, const Scalar &value)

Scalar	compressFactor (unsigned phaseIdx) const

template<class FluidState >
void	assign (const FluidState &fs)
	Retrieve all parameters from an arbitrary fluid state. More...

void	checkDefined () const
	Make sure that all attributes are defined. More...

const Scalar &	K (unsigned compIdx) const

void	setKvalue (unsigned compIdx, const Scalar &value)
	Set the K value of a component [-]. More...

const Scalar &	L () const
	The L value of a composition [-]. More...

void	setLvalue (const Scalar &value)
	Set the L value [-]. More...

Scalar	wilsonK_ (unsigned compIdx) const
	Wilson formula to calculate K. More...

Protected Member Functions
const Implementation &	asImp_ () const

Protected Attributes
std::array< std::array< Scalar, numComponents >, numPhases >	moleFraction_

std::array< Scalar, numPhases >	averageMolarMass_

std::array< Scalar, numPhases >	sumMoleFractions_

std::array< Scalar, numPhases >	Z_

std::array< Scalar, numComponents >	K_

Scalar	L_

Detailed Description

template<class Scalar, class FluidSystem, class Implementation>
class Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >

Module for the modular fluid state which stores the phase compositions explicitly in terms of mole fractions.

Constructor & Destructor Documentation

◆ FluidStateExplicitCompositionModule()

template<class Scalar , class FluidSystem , class Implementation >

Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::FluidStateExplicitCompositionModule ( )

inline

References Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::averageMolarMass_, Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::moleFraction_, Opm::Valgrind::SetDefined(), Opm::Valgrind::SetUndefined(), and Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::sumMoleFractions_.

Member Function Documentation

◆ asImp_()

template<class Scalar , class FluidSystem , class Implementation >

const Implementation & Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::asImp_ ( ) const

inlineprotected

Referenced by Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::molarity(), and Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::wilsonK_().

◆ assign()

template<class Scalar , class FluidSystem , class Implementation >

template<class FluidState >

void Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::assign ( const FluidState & fs )

inline

Retrieve all parameters from an arbitrary fluid state.

References Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::averageMolarMass_, Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::moleFraction_, and Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::sumMoleFractions_.

◆ averageMolarMass()

template<class Scalar , class FluidSystem , class Implementation >

const Scalar & Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::averageMolarMass ( unsigned phaseIdx ) const

inline

The mean molar mass of a fluid phase [kg/mol].

The average molar mass is the mean mass of one mole of the fluid at current composition. It is defined as the sum of the component's molar masses weighted by the current mole fraction:

$\bar M_\alpha = \sum_\kappa M^\kappa x_\alpha^\kappa$

References Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::averageMolarMass_.

◆ checkDefined()

template<class Scalar , class FluidSystem , class Implementation >

void Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::checkDefined ( ) const

inline

Make sure that all attributes are defined.

This method does not do anything if the program is not run under valgrind. If it is, then valgrind will print an error message if some attributes of the object have not been properly defined.

References Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::averageMolarMass_, Opm::Valgrind::CheckDefined(), Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::K_, Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::L_, Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::moleFraction_, and Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::sumMoleFractions_.

◆ compressFactor()

template<class Scalar , class FluidSystem , class Implementation >

Scalar Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::compressFactor ( unsigned phaseIdx ) const

inline

References Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::Z_.

◆ K()

template<class Scalar , class FluidSystem , class Implementation >

const Scalar & Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::K ( unsigned compIdx ) const

inline

References Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::K_.

◆ L()

template<class Scalar , class FluidSystem , class Implementation >

const Scalar & Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::L ( ) const

inline

The L value of a composition [-].

References Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::L_.

◆ massFraction()

template<class Scalar , class FluidSystem , class Implementation >

Scalar Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::massFraction	(	unsigned	phaseIdx,
		unsigned	compIdx
	)		const

inline

The mass fraction of a component in a phase [].

References Opm::abs(), Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::averageMolarMass_, Opm::max(), Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::moleFraction_, and Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::sumMoleFractions_.

◆ molarity()

template<class Scalar , class FluidSystem , class Implementation >

Scalar Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::molarity	(	unsigned	phaseIdx,
		unsigned	compIdx
	)		const

inline

The concentration of a component in a phase [mol/m^3].

This quantity is often called "molar concentration" or just "concentration", but there are many other (though less common) measures for concentration.

http://en.wikipedia.org/wiki/Concentration

References Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::asImp_(), and Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::moleFraction().

◆ moleFraction()

template<class Scalar , class FluidSystem , class Implementation >

const Scalar & Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::moleFraction	(	unsigned	phaseIdx,
		unsigned	compIdx
	)		const

inline

The mole fraction of a component in a phase [].

References Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::moleFraction_.

Referenced by Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::molarity().

◆ setCompressFactor()

template<class Scalar , class FluidSystem , class Implementation >

void Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::setCompressFactor	(	unsigned	phaseIdx,
		const Scalar &	value
	)

inline

References Opm::Valgrind::CheckDefined(), and Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::Z_.

◆ setKvalue()

template<class Scalar , class FluidSystem , class Implementation >

void Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::setKvalue	(	unsigned	compIdx,
		const Scalar &	value
	)

inline

Set the K value of a component [-].

References Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::K_.

◆ setLvalue()

template<class Scalar , class FluidSystem , class Implementation >

void Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::setLvalue ( const Scalar & value )

inline

Set the L value [-].

References Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::L_.

◆ setMoleFraction()

template<class Scalar , class FluidSystem , class Implementation >

void Opm::FluidStateExplicitCompositionModule< Scalar, FluidSystem, Implementation >::setMoleFraction	(	unsigned	phaseIdx,
		unsigned	compIdx,
		const Scalar &	value
	)