Loading...
Searching...
No Matches
Opm::BaseFluidSystem< ScalarT, Implementation > Class Template Reference

The base class for all fluid systems. More...

`#include <BaseFluidSystem.hpp>`

Inheritance diagram for Opm::BaseFluidSystem< ScalarT, Implementation >:

## Classes

struct | ParameterCache
| The type of the fluid system's parameter cache. More...

## Public Types

typedef ScalarT | Scalar
| The type used for scalar quantities.

## Static Public Member Functions

static std::string_view | phaseName (unsigned)
| Return the human readable name of a fluid phase.
static bool | isLiquid (unsigned)
| Return whether a phase is liquid.
static bool | isIdealMixture (unsigned)
| Returns true if and only if a fluid phase is assumed to be an ideal mixture.
static bool | isCompressible (unsigned)
| Returns true if and only if a fluid phase is assumed to be compressible.
static bool | isIdealGas (unsigned)
| Returns true if and only if a fluid phase is assumed to be an ideal gas.
static std::string_view | componentName (unsigned)
| Return the human readable name of a component.
static Scalar | molarMass (unsigned)
| Return the molar mass of a component in [kg/mol].
static Scalar | acentricFactor (unsigned)
| Return the acetntric factor of a component.
static void | init ()
| Initialize the fluid system's static parameters.
template<class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>
static LhsEval | density (const FluidState &, const ParamCache &, unsigned)
| Calculate the density [kg/m^3] of a fluid phase.
template<class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>
static LhsEval | fugacityCoefficient (const FluidState &, ParamCache &, unsigned, unsigned)
| Calculate the fugacity coefficient [Pa] of an individual component in a fluid phase.
template<class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>
static LhsEval | viscosity (const FluidState &, ParamCache &, unsigned)
| Calculate the dynamic viscosity of a fluid phase [Pa*s].
template<class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>
static LhsEval | diffusionCoefficient (const FluidState &, ParamCache &, unsigned, unsigned)
| Calculate the binary molecular diffusion coefficient for a component in a fluid phase [mol^2 * s / (kg*m^3)].
template<class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>
static LhsEval | enthalpy (const FluidState &, ParamCache &, unsigned)
| Given a phase's composition, temperature, pressure and density, calculate its specific enthalpy [J/kg].
template<class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>
static LhsEval | thermalConductivity (const FluidState &, ParamCache &, unsigned)
| Thermal conductivity of a fluid phase [W/(m K)].
template<class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>
static LhsEval | heatCapacity (const FluidState &, ParamCache &, unsigned)
| Specific isobaric heat capacity of a fluid phase [J/kg].
static bool | phaseIsActive (unsigned)
| Returns whether a fluid phase is active.

## Static Public Attributes

static const int | numComponents = -1000
| Number of chemical species in the fluid system.
static const int | numPhases = -2000
| Number of fluid phases in the fluid system.

## Detailed Description

template<class ScalarT, class Implementation>
class Opm::BaseFluidSystem< ScalarT, Implementation >

The base class for all fluid systems.

## Member Function Documentation

## acentricFactor()

template<class ScalarT, class Implementation>

Scalar Opm::BaseFluidSystem< ScalarT, Implementation >::acentricFactor | ( | unsigned |  | ) |

inline static

Return the acetntric factor of a component.

## componentName()

template<class ScalarT, class Implementation>

std::string_view Opm::BaseFluidSystem< ScalarT, Implementation >::componentName | ( | unsigned |  | ) |

inline static

Return the human readable name of a component.

## density()

template<class ScalarT, class Implementation>
template<class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>

LhsEval Opm::BaseFluidSystem< ScalarT, Implementation >::density | ( | const FluidState & | ,
|  | const ParamCache & | ,
|  | unsigned | )

inline static

Calculate the density [kg/m^3] of a fluid phase.

## diffusionCoefficient()

template<class ScalarT, class Implementation>
template<class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>

LhsEval Opm::BaseFluidSystem< ScalarT, Implementation >::diffusionCoefficient | ( | const FluidState & | ,
|  | ParamCache & | ,
|  | unsigned | ,
|  | unsigned | )

inline static

Calculate the binary molecular diffusion coefficient for a component in a fluid phase [mol^2 * s / (kg*m^3)].

Molecular diffusion of a compoent is caused by a gradient of the mole fraction and follows the law

where is the component's mole fraction in phase , is the diffusion coefficient and is the diffusive flux.

## enthalpy()

template<class ScalarT, class Implementation>
template<class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>

LhsEval Opm::BaseFluidSystem< ScalarT, Implementation >::enthalpy | ( | const FluidState & | ,
|  | ParamCache & | ,
|  | unsigned | )

inline static

Given a phase's composition, temperature, pressure and density, calculate its specific enthalpy [J/kg].

## fugacityCoefficient()

template<class ScalarT, class Implementation>
template<class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>

LhsEval Opm::BaseFluidSystem< ScalarT, Implementation >::fugacityCoefficient | ( | const FluidState & | ,
|  | ParamCache & | ,
|  | unsigned | ,
|  | unsigned | )

inline static

Calculate the fugacity coefficient [Pa] of an individual component in a fluid phase.

The fugacity coefficient is connected to the fugacity and the component's molarity by means of the relation

## heatCapacity()

template<class ScalarT, class Implementation>
template<class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>

LhsEval Opm::BaseFluidSystem< ScalarT, Implementation >::heatCapacity | ( | const FluidState & | ,
|  | ParamCache & | ,
|  | unsigned | )

inline static

Specific isobaric heat capacity of a fluid phase [J/kg].

## isCompressible()

template<class ScalarT, class Implementation>

bool Opm::BaseFluidSystem< ScalarT, Implementation >::isCompressible | ( | unsigned |  | ) |

inline static

Returns true if and only if a fluid phase is assumed to be compressible.

Compressible means that the partial derivative of the density to the fluid pressure is always larger than zero.

## isIdealGas()

template<class ScalarT, class Implementation>

bool Opm::BaseFluidSystem< ScalarT, Implementation >::isIdealGas | ( | unsigned |  | ) |

inline static

Returns true if and only if a fluid phase is assumed to be an ideal gas.

## isIdealMixture()

template<class ScalarT, class Implementation>

bool Opm::BaseFluidSystem< ScalarT, Implementation >::isIdealMixture | ( | unsigned |  | ) |

inline static

Returns true if and only if a fluid phase is assumed to be an ideal mixture.

We define an ideal mixture as a fluid phase where the fugacity coefficients of all components times the pressure of the phase are independent on the fluid composition. This assumption is true if Henry's law and Rault's law apply. If you are unsure what this function should return, it is safe to return false. The only damage done will be (slightly) increased computation times in some cases.

## isLiquid()

template<class ScalarT, class Implementation>

bool Opm::BaseFluidSystem< ScalarT, Implementation >::isLiquid | ( | unsigned |  | ) |

inline static

Return whether a phase is liquid.

## molarMass()

template<class ScalarT, class Implementation>

Scalar Opm::BaseFluidSystem< ScalarT, Implementation >::molarMass | ( | unsigned |  | ) |

inline static

Return the molar mass of a component in [kg/mol].

## phaseName()

template<class ScalarT, class Implementation>

std::string_view Opm::BaseFluidSystem< ScalarT, Implementation >::phaseName | ( | unsigned |  | ) |

inline static

Return the human readable name of a fluid phase.

## thermalConductivity()

template<class ScalarT, class Implementation>
template<class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>

LhsEval Opm::BaseFluidSystem< ScalarT, Implementation >::thermalConductivity | ( | const FluidState & | ,
|  | ParamCache & | ,
|  | unsigned | )

inline static

Thermal conductivity of a fluid phase [W/(m K)].

## viscosity()

template<class ScalarT, class Implementation>
template<class FluidState, class LhsEval = typename FluidState::Scalar, class ParamCache>

LhsEval Opm::BaseFluidSystem< ScalarT, Implementation >::viscosity | ( | const FluidState & | ,
|  | ParamCache & | ,
|  | unsigned | )

inline static

Calculate the dynamic viscosity of a fluid phase [Pa*s].

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

- opm/material/fluidsystems/BaseFluidSystem.hpp