Loading...
Searching...
No Matches
Opm::SinglePhaseFluidSystem< Scalar, Fluid > Class Template Reference

A fluid system for single phase models. More...

`#include <SinglePhaseFluidSystem.hpp>`

Inheritance diagram for Opm::SinglePhaseFluidSystem< Scalar, Fluid >:

## Classes

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

## Static Public Member Functions

static std::string_view | phaseName (unsigned phaseIdx)
| Return the human readable name of a fluid phase.
static bool | isLiquid (unsigned)
| Return whether a phase is liquid.
static bool | isCompressible (unsigned)
| Returns true if and only if a fluid phase is assumed to be compressible.
static bool | isIdealMixture (unsigned)
| Returns true if and only if a fluid phase is assumed to be an ideal gas.
static bool | isIdealGas (unsigned)
| Returns true if and only if a fluid phase is assumed to be an ideal mixture.
static std::string_view | componentName (unsigned compIdx)
| Return the human readable name of a component.
static Scalar | molarMass (unsigned)
| Return the molar mass of a component in [kg/mol].
static Scalar | criticalTemperature (unsigned)
| Critical temperature of a component [K].
static Scalar | criticalPressure (unsigned)
| Critical pressure of a component [Pa].
static Scalar | acentricFactor (unsigned)
| The acentric factor of a component [].
static void | init ()
| Initialize the fluid system's static parameters.
template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>
static LhsEval | density (const FluidState &fluidState, const ParameterCache< ParamCacheEval > &, unsigned phaseIdx)
| Calculate the density [kg/m^3] of a fluid phase.
template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>
static LhsEval | viscosity (const FluidState &fluidState, const ParameterCache< ParamCacheEval > &, unsigned phaseIdx)
| Calculate the dynamic viscosity of a fluid phase [Pa*s].
template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>
static LhsEval | fugacityCoefficient (const FluidState &, const ParameterCache< ParamCacheEval > &, unsigned phaseIdx, unsigned compIdx)
| Calculate the fugacity coefficient [Pa] of an individual component in a fluid phase.
template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>
static LhsEval | enthalpy (const FluidState &fluidState, const ParameterCache< ParamCacheEval > &, unsigned phaseIdx)
| Given a phase's composition, temperature, pressure and density, calculate its specific enthalpy [J/kg].
template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>
static LhsEval | thermalConductivity (const FluidState &fluidState, const ParameterCache< ParamCacheEval > &, unsigned phaseIdx)
| Thermal conductivity of a fluid phase [W/(m K)].
template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>
static LhsEval | heatCapacity (const FluidState &fluidState, const ParameterCache< ParamCacheEval > &, unsigned phaseIdx)
| Specific isobaric heat capacity of a fluid phase [J/kg].
Static Public Member Functions inherited from Opm::BaseFluidSystem< Scalar, SinglePhaseFluidSystem< Scalar, Fluid > >
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.
static LhsEval | density (const FluidState &, const ParamCache &, unsigned)
| Calculate the density [kg/m^3] of a fluid phase.
static LhsEval | fugacityCoefficient (const FluidState &, ParamCache &, unsigned, unsigned)
| Calculate the fugacity coefficient [Pa] of an individual component in a fluid phase.
static LhsEval | viscosity (const FluidState &, ParamCache &, unsigned)
| Calculate the dynamic viscosity of a fluid phase [Pa*s].
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)].
static LhsEval | enthalpy (const FluidState &, ParamCache &, unsigned)
| Given a phase's composition, temperature, pressure and density, calculate its specific enthalpy [J/kg].
static LhsEval | thermalConductivity (const FluidState &, ParamCache &, unsigned)
| Thermal conductivity of a fluid phase [W/(m K)].
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 | numPhases = 1
| Number of fluid phases in the fluid system.
static const int | numComponents = 1
| Number of chemical species in the fluid system.
Static Public Attributes inherited from Opm::BaseFluidSystem< Scalar, SinglePhaseFluidSystem< Scalar, Fluid > >
static const int | numComponents
| Number of chemical species in the fluid system.
static const int | numPhases
| Number of fluid phases in the fluid system.

## Additional Inherited Members

Public Types inherited from Opm::BaseFluidSystem< Scalar, SinglePhaseFluidSystem< Scalar, Fluid > >
typedef Scalar | Scalar
| The type used for scalar quantities.

## Detailed Description

template<class Scalar, class Fluid>
class Opm::SinglePhaseFluidSystem< Scalar, Fluid >

A fluid system for single phase models.

The fluid is defined as a template parameter. For existing components the Opm::LiquidPhase<Component> and Opm::GasPhase<Component> may be used.

## Member Function Documentation

## acentricFactor()

template<class Scalar , class Fluid >

static Scalar Opm::SinglePhaseFluidSystem< Scalar, Fluid >::acentricFactor | ( | unsigned |  | ) |

inline static

The acentric factor of a component [].

Parameters

  compIdx | The index of the component to consider

## componentName()

template<class Scalar , class Fluid >

static std::string_view Opm::SinglePhaseFluidSystem< Scalar, Fluid >::componentName | ( | unsigned | compIdx | ) |

inline static

Return the human readable name of a component.

## criticalPressure()

template<class Scalar , class Fluid >

static Scalar Opm::SinglePhaseFluidSystem< Scalar, Fluid >::criticalPressure | ( | unsigned |  | ) |

inline static

Critical pressure of a component [Pa].

Parameters

  compIdx | The index of the component to consider

## criticalTemperature()

template<class Scalar , class Fluid >

static Scalar Opm::SinglePhaseFluidSystem< Scalar, Fluid >::criticalTemperature | ( | unsigned |  | ) |

inline static

Critical temperature of a component [K].

Parameters

  compIdx | The index of the component to consider

## density()

template<class Scalar , class Fluid >
template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>

static LhsEval Opm::SinglePhaseFluidSystem< Scalar, Fluid >::density | ( | const FluidState & | fluidState,
|  | const ParameterCache< ParamCacheEval > & | ,
|  | unsigned | phaseIdx
| ) |  |

inline static

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

## enthalpy()

template<class Scalar , class Fluid >
template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>

static LhsEval Opm::SinglePhaseFluidSystem< Scalar, Fluid >::enthalpy | ( | const FluidState & | fluidState,
|  | const ParameterCache< ParamCacheEval > & | ,
|  | unsigned | phaseIdx
| ) |  |

inline static

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

## fugacityCoefficient()

template<class Scalar , class Fluid >
template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>

static LhsEval Opm::SinglePhaseFluidSystem< Scalar, Fluid >::fugacityCoefficient | ( | const FluidState & | ,
|  | const ParameterCache< ParamCacheEval > & | ,
|  | unsigned | phaseIdx,
|  | unsigned | compIdx
| ) |  |

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 Scalar , class Fluid >
template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>

static LhsEval Opm::SinglePhaseFluidSystem< Scalar, Fluid >::heatCapacity | ( | const FluidState & | fluidState,
|  | const ParameterCache< ParamCacheEval > & | ,
|  | unsigned | phaseIdx
| ) |  |

inline static

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

## init()

template<class Scalar , class Fluid >

static void Opm::SinglePhaseFluidSystem< Scalar, Fluid >::init | ( |  | ) |

inline static

Initialize the fluid system's static parameters.

## isCompressible()

template<class Scalar , class Fluid >

static bool Opm::SinglePhaseFluidSystem< Scalar, Fluid >::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 Scalar , class Fluid >

static bool Opm::SinglePhaseFluidSystem< Scalar, Fluid >::isIdealGas | ( | 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.

## isIdealMixture()

template<class Scalar , class Fluid >

static bool Opm::SinglePhaseFluidSystem< Scalar, Fluid >::isIdealMixture | ( | unsigned |  | ) |

inline static

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

## isLiquid()

template<class Scalar , class Fluid >

static bool Opm::SinglePhaseFluidSystem< Scalar, Fluid >::isLiquid | ( | unsigned |  | ) |

inline static

Return whether a phase is liquid.

## molarMass()

template<class Scalar , class Fluid >

static Scalar Opm::SinglePhaseFluidSystem< Scalar, Fluid >::molarMass | ( | unsigned |  | ) |

inline static

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

## phaseName()

template<class Scalar , class Fluid >

static std::string_view Opm::SinglePhaseFluidSystem< Scalar, Fluid >::phaseName | ( | unsigned | phaseIdx | ) |

inline static

Return the human readable name of a fluid phase.

## thermalConductivity()

template<class Scalar , class Fluid >
template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>

static LhsEval Opm::SinglePhaseFluidSystem< Scalar, Fluid >::thermalConductivity | ( | const FluidState & | fluidState,
|  | const ParameterCache< ParamCacheEval > & | ,
|  | unsigned | phaseIdx
| ) |  |

inline static

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

## viscosity()

template<class Scalar , class Fluid >
template<class FluidState , class LhsEval = typename FluidState::Scalar, class ParamCacheEval = LhsEval>

static LhsEval Opm::SinglePhaseFluidSystem< Scalar, Fluid >::viscosity | ( | const FluidState & | fluidState,
|  | const ParameterCache< ParamCacheEval > & | ,
|  | unsigned | phaseIdx
| ) |  |

inline static

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

## Member Data Documentation

## numComponents

template<class Scalar , class Fluid >

const int Opm::SinglePhaseFluidSystem< Scalar, Fluid >::numComponents = 1

static

Number of chemical species in the fluid system.

## numPhases

template<class Scalar , class Fluid >

const int Opm::SinglePhaseFluidSystem< Scalar, Fluid >::numPhases = 1

static

Number of fluid phases in the fluid system.

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

- opm/material/fluidsystems/SinglePhaseFluidSystem.hpp