Opm::FluidStateExplicitViscosityModule< Scalar, numPhases, Implementation > Class Template Reference

Module for the modular fluid state which stores the viscosities explicitly. More...

#include <FluidStateViscosityModules.hpp>

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

Public Member Functions

 FluidStateExplicitViscosityModule ()
 
const Scalar & viscosity (unsigned phaseIdx) const
 The viscosity of a fluid phase [-]. More...
 
void setViscosity (unsigned phaseIdx, Scalar value)
 Set the dynamic viscosity of a phase [Pa s]. 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 Attributes

Scalar viscosity_ [numPhases]
 

Detailed Description

template<class Scalar, unsigned numPhases, class Implementation>
class Opm::FluidStateExplicitViscosityModule< Scalar, numPhases, Implementation >

Module for the modular fluid state which stores the viscosities explicitly.

Constructor & Destructor Documentation

◆ FluidStateExplicitViscosityModule()

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

Member Function Documentation

◆ assign()

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

Retrieve all parameters from an arbitrary fluid state.

References Opm::FluidStateExplicitViscosityModule< Scalar, numPhases, Implementation >::viscosity_.

◆ checkDefined()

template<class Scalar , unsigned numPhases, class Implementation >
void Opm::FluidStateExplicitViscosityModule< Scalar, numPhases, 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::FluidStateExplicitViscosityModule< Scalar, numPhases, Implementation >::viscosity_.

◆ setViscosity()

template<class Scalar , unsigned numPhases, class Implementation >
void Opm::FluidStateExplicitViscosityModule< Scalar, numPhases, Implementation >::setViscosity ( unsigned  phaseIdx,
Scalar  value 
)
inline

Set the dynamic viscosity of a phase [Pa s].

References Opm::FluidStateExplicitViscosityModule< Scalar, numPhases, Implementation >::viscosity_.

◆ viscosity()

template<class Scalar , unsigned numPhases, class Implementation >
const Scalar & Opm::FluidStateExplicitViscosityModule< Scalar, numPhases, Implementation >::viscosity ( unsigned  phaseIdx) const
inline

Member Data Documentation

◆ viscosity_


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