3.6-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Types | Public Member Functions | List of all members
Dumux::ParameterCacheBase< Implementation > Class Template Reference

The base class of the parameter cache classes for fluid systems. More...

#include <dumux/material/fluidsystems/parametercachebase.hh>

Inheritance diagram for Dumux::ParameterCacheBase< Implementation >:

Description

template<class Implementation>
class Dumux::ParameterCacheBase< Implementation >

The base class of the parameter cache classes for fluid systems.

Public Types

enum  ExceptQuantities { None = 0 , Temperature = 1 , Pressure = 2 , Composition = 4 }
 

Public Member Functions

template<class FluidState >
void updateAll (const FluidState &fs, int exceptQuantities=None)
 Update all cached quantities for all phases. More...
 
template<class FluidState >
void updateAllPressures (const FluidState &fs)
 Update all cached quantities which depend on the pressure of any fluid phase. More...
 
template<class FluidState >
void updateAllTemperatures (const FluidState &fs)
 Update all cached quantities which depend on the temperature of any fluid phase. More...
 
template<class FluidState >
void updatePhase (const FluidState &fs, int phaseIdx, int exceptQuantities=None)
 Update all cached parameters of a specific fluid phase. More...
 
template<class FluidState >
void updateTemperature (const FluidState &fs, int phaseIdx)
 Update all cached parameters of a specific fluid phase which depend on temperature. More...
 
template<class FluidState >
void updatePressure (const FluidState &fs, int phaseIdx)
 Update all cached parameters of a specific fluid phase which depend on pressure. More...
 
template<class FluidState >
void updateComposition (const FluidState &fs, int phaseIdx)
 Update all cached parameters of a specific fluid phase which depend on composition. More...
 
template<class FluidState >
void updateSingleMoleFraction (const FluidState &fs, int phaseIdx, int compIdx)
 Update all cached parameters of a specific fluid phase which depend on the mole fraction of a single component. More...
 

Member Enumeration Documentation

◆ ExceptQuantities

template<class Implementation >
enum Dumux::ParameterCacheBase::ExceptQuantities
Enumerator
None 
Temperature 
Pressure 
Composition 

Member Function Documentation

◆ updateAll()

template<class Implementation >
template<class FluidState >
void Dumux::ParameterCacheBase< Implementation >::updateAll ( const FluidState &  fs,
int  exceptQuantities = None 
)
inline

Update all cached quantities for all phases.

The except argument contains a bit field of the quantities which have not been modified since the last call to an update() method.

◆ updateAllPressures()

template<class Implementation >
template<class FluidState >
void Dumux::ParameterCacheBase< Implementation >::updateAllPressures ( const FluidState &  fs)
inline

Update all cached quantities which depend on the pressure of any fluid phase.

◆ updateAllTemperatures()

template<class Implementation >
template<class FluidState >
void Dumux::ParameterCacheBase< Implementation >::updateAllTemperatures ( const FluidState &  fs)
inline

Update all cached quantities which depend on the temperature of any fluid phase.

◆ updateComposition()

template<class Implementation >
template<class FluidState >
void Dumux::ParameterCacheBase< Implementation >::updateComposition ( const FluidState &  fs,
int  phaseIdx 
)
inline

Update all cached parameters of a specific fluid phase which depend on composition.

Only use this method if neither the pressure nor the temperature of the phase changed between two update*() calls. If more changed, call updatePhase()!

◆ updatePhase()

template<class Implementation >
template<class FluidState >
void Dumux::ParameterCacheBase< Implementation >::updatePhase ( const FluidState &  fs,
int  phaseIdx,
int  exceptQuantities = None 
)
inline

Update all cached parameters of a specific fluid phase.

The quantities specified by the except bit field have not been modified since since the last call to an update() method.

◆ updatePressure()

template<class Implementation >
template<class FluidState >
void Dumux::ParameterCacheBase< Implementation >::updatePressure ( const FluidState &  fs,
int  phaseIdx 
)
inline

Update all cached parameters of a specific fluid phase which depend on pressure.

Only use this method if only the pressure of a phase changed between two update*() calls. If more changed, call updatePhase()!

◆ updateSingleMoleFraction()

template<class Implementation >
template<class FluidState >
void Dumux::ParameterCacheBase< Implementation >::updateSingleMoleFraction ( const FluidState &  fs,
int  phaseIdx,
int  compIdx 
)
inline

Update all cached parameters of a specific fluid phase which depend on the mole fraction of a single component.

Only use this method if just a single component's concentration changed between two update*() calls. If more than one concentration changed, call updatePhaseComposition() of updatePhase()!

◆ updateTemperature()

template<class Implementation >
template<class FluidState >
void Dumux::ParameterCacheBase< Implementation >::updateTemperature ( const FluidState &  fs,
int  phaseIdx 
)
inline

Update all cached parameters of a specific fluid phase which depend on temperature.

Only use this method if only the temperature of a phase changed between two update*() calls. If more changed, call updatePhase()!


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