Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation > Class Template Reference

Module for the modular fluid state which stores the phase fugacity coefficients explicitly. More...

#include <FluidStateFugacityModules.hpp>

Inheritance diagram for Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >:
Inheritance graph

Public Member Functions

 FluidStateExplicitFugacityModule ()
 
const Scalar & fugacityCoefficient (unsigned phaseIdx, unsigned compIdx) const
 The fugacity coefficient of a component in a phase []. More...
 
Scalar fugacity (unsigned phaseIdx, unsigned compIdx) const
 The fugacity of a component in a phase [Pa]. More...
 
void setFugacityCoefficient (unsigned phaseIdx, unsigned compIdx, const Scalar &value)
 Set the fugacity of a component in a phase []. More...
 
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...
 

Protected Member Functions

const Implementation & asImp_ () const
 

Protected Attributes

Scalar fugacityCoefficient_ [numPhases][numComponents]
 

Detailed Description

template<class Scalar, unsigned numPhases, unsigned numComponents, class Implementation>
class Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >

Module for the modular fluid state which stores the phase fugacity coefficients explicitly.

Constructor & Destructor Documentation

◆ FluidStateExplicitFugacityModule()

template<class Scalar , unsigned numPhases, unsigned numComponents, class Implementation >
Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::FluidStateExplicitFugacityModule ( )
inline

References Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::fugacityCoefficient_, and Opm::Valgrind::SetUndefined().

Member Function Documentation

◆ asImp_()

template<class Scalar , unsigned numPhases, unsigned numComponents, class Implementation >
const Implementation & Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::asImp_ ( ) const
inlineprotected

Referenced by Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::fugacity().

◆ assign()

template<class Scalar , unsigned numPhases, unsigned numComponents, class Implementation >
template<class FluidState >
void Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::assign ( const FluidState &  fs)
inline

Retrieve all parameters from an arbitrary fluid state.

References Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::fugacityCoefficient_.

◆ checkDefined()

template<class Scalar , unsigned numPhases, unsigned numComponents, class Implementation >
void Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, 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::Valgrind::CheckDefined(), and Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::fugacityCoefficient_.

◆ fugacity()

template<class Scalar , unsigned numPhases, unsigned numComponents, class Implementation >
Scalar Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::fugacity ( unsigned  phaseIdx,
unsigned  compIdx 
) const
inline

The fugacity of a component in a phase [Pa].

References Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::asImp_(), and Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::fugacityCoefficient_.

◆ fugacityCoefficient()

template<class Scalar , unsigned numPhases, unsigned numComponents, class Implementation >
const Scalar & Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::fugacityCoefficient ( unsigned  phaseIdx,
unsigned  compIdx 
) const
inline

The fugacity coefficient of a component in a phase [].

References Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::fugacityCoefficient_.

◆ setFugacityCoefficient()

template<class Scalar , unsigned numPhases, unsigned numComponents, class Implementation >
void Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::setFugacityCoefficient ( unsigned  phaseIdx,
unsigned  compIdx,
const Scalar &  value 
)
inline

Set the fugacity of a component in a phase [].

References Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::fugacityCoefficient_.

Member Data Documentation

◆ fugacityCoefficient_

template<class Scalar , unsigned numPhases, unsigned numComponents, class Implementation >
Scalar Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::fugacityCoefficient_[numPhases][numComponents]
protected

Referenced by Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::assign(), Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::checkDefined(), Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::FluidStateExplicitFugacityModule(), Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::fugacity(), Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::fugacityCoefficient(), and Opm::FluidStateExplicitFugacityModule< Scalar, numPhases, numComponents, Implementation >::setFugacityCoefficient().

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