PorousFlowFluidStateBase Class Reference

Base class for fluid states for miscible multiphase flow in porous media. More...

#include <PorousFlowFluidStateBase.h>

Inheritance diagram for PorousFlowFluidStateBase:

Public Member Functions
	PorousFlowFluidStateBase (const InputParameters &parameters)
void	initialize () final
void	execute () final
void	finalize () final
unsigned int	numPhases () const
	The maximum number of phases in this model. More...
unsigned int	numComponents () const
	The maximum number of components in this model. More...
unsigned int	aqueousPhaseIndex () const
	The index of the aqueous phase. More...
unsigned int	gasPhaseIndex () const
	The index of the gas phase. More...
unsigned int	aqueousComponentIndex () const
	The index of the aqueous fluid component. More...
unsigned int	gasComponentIndex () const
	The index of the gas fluid component. More...
unsigned int	saltComponentIndex () const
	The index of the salt component. More...
virtual std::string	fluidStateName () const =0
	Name of FluidState. More...
void	clearFluidStateProperties (std::vector< FluidStateProperties > &fsp) const
	Clears the contents of the FluidStateProperties data structure. More...

Protected Attributes
unsigned int	_num_phases
	Number of phases. More...
unsigned int	_num_components
	Number of components. More...
const unsigned int	_aqueous_phase_number
	Phase number of the aqueous phase. More...
unsigned int	_gas_phase_number
	Phase number of the gas phase. More...
const unsigned int	_aqueous_fluid_component
	Fluid component number of the aqueous component. More...
unsigned int	_gas_fluid_component
	Fluid component number of the gas phase. More...
const unsigned int	_salt_component
	Salt component index. More...
const Real	_R
	Universal gas constant (J/mol/K) More...
const Real	_T_c2k
	Conversion from C to K. More...
const PorousFlowCapillaryPressure &	_pc
	Capillary pressure UserObject. More...
FluidStateProperties	_empty_fsp
	Empty FluidStateProperties object. More...

Detailed Description

Base class for fluid states for miscible multiphase flow in porous media.

Definition at line 55 of file PorousFlowFluidStateBase.h.

Constructor & Destructor Documentation

PorousFlowFluidStateBase()

PorousFlowFluidStateBase::PorousFlowFluidStateBase

(

const InputParameters &

parameters

)

Definition at line 27 of file PorousFlowFluidStateBase.C.

  : GeneralUserObject(parameters),
    _aqueous_phase_number(getParam<unsigned int>("liquid_phase_number")),
    _aqueous_fluid_component(getParam<unsigned int>("liquid_fluid_component")),
    _salt_component(getParam<unsigned int>("salt_component")),
    _R(8.3144598),
    _T_c2k(273.15),
    _pc(getUserObject<PorousFlowCapillaryPressure>("capillary_pressure"))
{
}

Member Function Documentation

aqueousComponentIndex()

unsigned int PorousFlowFluidStateBase::aqueousComponentIndex ( ) const

inline

The index of the aqueous fluid component.

Returns

aqueous fluid component number

Definition at line 92 of file PorousFlowFluidStateBase.h.

{ return _aqueous_fluid_component; };

aqueousPhaseIndex()

unsigned int PorousFlowFluidStateBase::aqueousPhaseIndex ( ) const

inline

The index of the aqueous phase.

Returns

aqueous phase number

Definition at line 80 of file PorousFlowFluidStateBase.h.

{ return _aqueous_phase_number; };

clearFluidStateProperties()

void PorousFlowFluidStateBase::clearFluidStateProperties

(

std::vector< FluidStateProperties > &

fsp

)

const

Clears the contents of the FluidStateProperties data structure.

Parameters

[out]

fsp

FluidStateProperties data structure with all data initialized to 0

Definition at line 39 of file PorousFlowFluidStateBase.C.

{
  std::fill(fsp.begin(), fsp.end(), _empty_fsp);
}

Referenced by PorousFlowWaterNCG::thermophysicalProperties(), PorousFlowFluidStateSingleComponent::thermophysicalProperties(), and PorousFlowBrineCO2::thermophysicalProperties().

execute()

void PorousFlowFluidStateBase::execute ( )

inlinefinal

Definition at line 61 of file PorousFlowFluidStateBase.h.

{};

finalize()

void PorousFlowFluidStateBase::finalize ( )

inlinefinal

Definition at line 62 of file PorousFlowFluidStateBase.h.

{};

fluidStateName()

virtual std::string PorousFlowFluidStateBase::fluidStateName ( ) const

pure virtual

Name of FluidState.

Implemented in PorousFlowBrineCO2, PorousFlowWaterNCG, and PorousFlowWaterVapor.

gasComponentIndex()

unsigned int PorousFlowFluidStateBase::gasComponentIndex ( ) const

inline

The index of the gas fluid component.

Returns

gas fluid component number

Definition at line 98 of file PorousFlowFluidStateBase.h.

{ return _gas_fluid_component; };

gasPhaseIndex()

unsigned int PorousFlowFluidStateBase::gasPhaseIndex ( ) const

inline

The index of the gas phase.

Returns

gas phase number

Definition at line 86 of file PorousFlowFluidStateBase.h.

{ return _gas_phase_number; };

initialize()

void PorousFlowFluidStateBase::initialize ( )

inlinefinal

Definition at line 60 of file PorousFlowFluidStateBase.h.

{};

numComponents()

unsigned int PorousFlowFluidStateBase::numComponents ( ) const

inline

The maximum number of components in this model.

Returns

number of components

Definition at line 74 of file PorousFlowFluidStateBase.h.

{ return _num_components; };

numPhases()

unsigned int PorousFlowFluidStateBase::numPhases ( ) const

inline

The maximum number of phases in this model.

Returns

number of phases

Definition at line 68 of file PorousFlowFluidStateBase.h.

{ return _num_phases; };

Referenced by PorousFlowFluidState::PorousFlowFluidState(), and PorousFlowFluidStateSingleComponent::PorousFlowFluidStateSingleComponent().

saltComponentIndex()

unsigned int PorousFlowFluidStateBase::saltComponentIndex ( ) const

inline

The index of the salt component.

Returns

salt component number

Definition at line 104 of file PorousFlowFluidStateBase.h.

{ return _salt_component; };

Member Data Documentation

_aqueous_fluid_component

const unsigned int PorousFlowFluidStateBase::_aqueous_fluid_component

protected

Fluid component number of the aqueous component.

Definition at line 127 of file PorousFlowFluidStateBase.h.

Referenced by aqueousComponentIndex(), PorousFlowWaterNCG::massFractions(), PorousFlowBrineCO2::massFractions(), PorousFlowBrineCO2::PorousFlowBrineCO2(), PorousFlowWaterNCG::PorousFlowWaterNCG(), PorousFlowWaterVapor::PorousFlowWaterVapor(), PorousFlowWaterNCG::saturation(), PorousFlowBrineCO2::saturation(), PorousFlowWaterNCG::totalMassFraction(), and PorousFlowBrineCO2::totalMassFraction().

_aqueous_phase_number

const unsigned int PorousFlowFluidStateBase::_aqueous_phase_number

protected

Phase number of the aqueous phase.

Definition at line 123 of file PorousFlowFluidStateBase.h.

Referenced by aqueousPhaseIndex(), PorousFlowWaterNCG::gasDensity(), PorousFlowWaterNCG::gasProperties(), PorousFlowWaterNCG::liquidProperties(), PorousFlowBrineCO2::liquidProperties(), PorousFlowWaterNCG::massFractions(), PorousFlowBrineCO2::massFractions(), PorousFlowBrineCO2::PorousFlowBrineCO2(), PorousFlowWaterNCG::PorousFlowWaterNCG(), PorousFlowWaterVapor::PorousFlowWaterVapor(), PorousFlowWaterVapor::thermophysicalProperties(), PorousFlowWaterNCG::thermophysicalProperties(), PorousFlowBrineCO2::thermophysicalProperties(), PorousFlowWaterNCG::totalMassFraction(), and PorousFlowBrineCO2::totalMassFraction().

_empty_fsp

FluidStateProperties PorousFlowFluidStateBase::_empty_fsp

protected

Empty FluidStateProperties object.

Definition at line 139 of file PorousFlowFluidStateBase.h.

Referenced by clearFluidStateProperties(), PorousFlowBrineCO2::PorousFlowBrineCO2(), PorousFlowWaterNCG::PorousFlowWaterNCG(), and PorousFlowWaterVapor::PorousFlowWaterVapor().

_gas_fluid_component

unsigned int PorousFlowFluidStateBase::_gas_fluid_component

protected

Fluid component number of the gas phase.

Definition at line 129 of file PorousFlowFluidStateBase.h.

Referenced by gasComponentIndex(), PorousFlowWaterNCG::gasDensity(), PorousFlowWaterNCG::gasProperties(), PorousFlowWaterNCG::liquidProperties(), PorousFlowBrineCO2::liquidProperties(), PorousFlowWaterNCG::massFractions(), PorousFlowBrineCO2::massFractions(), PorousFlowBrineCO2::PorousFlowBrineCO2(), PorousFlowWaterNCG::PorousFlowWaterNCG(), PorousFlowWaterVapor::PorousFlowWaterVapor(), PorousFlowWaterNCG::saturation(), PorousFlowBrineCO2::saturation(), PorousFlowWaterNCG::totalMassFraction(), and PorousFlowBrineCO2::totalMassFraction().

_gas_phase_number

unsigned int PorousFlowFluidStateBase::_gas_phase_number

protected

Phase number of the gas phase.

Definition at line 125 of file PorousFlowFluidStateBase.h.

Referenced by PorousFlowWaterNCG::gasDensity(), gasPhaseIndex(), PorousFlowWaterNCG::gasProperties(), PorousFlowBrineCO2::gasProperties(), PorousFlowWaterNCG::massFractions(), PorousFlowBrineCO2::massFractions(), PorousFlowBrineCO2::PorousFlowBrineCO2(), PorousFlowWaterNCG::PorousFlowWaterNCG(), PorousFlowWaterVapor::PorousFlowWaterVapor(), PorousFlowWaterNCG::saturation(), PorousFlowBrineCO2::saturation(), PorousFlowWaterVapor::thermophysicalProperties(), PorousFlowWaterNCG::thermophysicalProperties(), PorousFlowBrineCO2::thermophysicalProperties(), PorousFlowWaterNCG::totalMassFraction(), PorousFlowBrineCO2::totalMassFraction(), PorousFlowWaterNCG::twoPhaseProperties(), and PorousFlowBrineCO2::twoPhaseProperties().

_num_components

unsigned int PorousFlowFluidStateBase::_num_components

protected

Number of components.

Definition at line 121 of file PorousFlowFluidStateBase.h.

Referenced by numComponents(), PorousFlowBrineCO2::PorousFlowBrineCO2(), PorousFlowWaterNCG::PorousFlowWaterNCG(), PorousFlowWaterVapor::PorousFlowWaterVapor(), PorousFlowWaterNCG::totalMassFraction(), and PorousFlowBrineCO2::totalMassFraction().

_num_phases

unsigned int PorousFlowFluidStateBase::_num_phases

protected

Number of phases.

Definition at line 119 of file PorousFlowFluidStateBase.h.

Referenced by numPhases(), PorousFlowBrineCO2::PorousFlowBrineCO2(), PorousFlowWaterNCG::PorousFlowWaterNCG(), PorousFlowWaterVapor::PorousFlowWaterVapor(), PorousFlowWaterNCG::totalMassFraction(), and PorousFlowBrineCO2::totalMassFraction().

_pc

const PorousFlowCapillaryPressure& PorousFlowFluidStateBase::_pc

protected

Capillary pressure UserObject.

Definition at line 137 of file PorousFlowFluidStateBase.h.

Referenced by PorousFlowWaterVapor::thermophysicalProperties(), PorousFlowWaterNCG::thermophysicalProperties(), PorousFlowBrineCO2::thermophysicalProperties(), PorousFlowWaterNCG::totalMassFraction(), PorousFlowBrineCO2::totalMassFraction(), PorousFlowWaterNCG::twoPhaseProperties(), and PorousFlowBrineCO2::twoPhaseProperties().

_R

const Real PorousFlowFluidStateBase::_R

protected

Universal gas constant (J/mol/K)

Definition at line 133 of file PorousFlowFluidStateBase.h.

Referenced by PorousFlowWaterNCG::enthalpyOfDissolution(), and PorousFlowBrineCO2::enthalpyOfDissolutionGas().

_salt_component

const unsigned int PorousFlowFluidStateBase::_salt_component

protected

Salt component index.

Definition at line 131 of file PorousFlowFluidStateBase.h.

Referenced by saltComponentIndex().

_T_c2k

const Real PorousFlowFluidStateBase::_T_c2k

protected

Conversion from C to K.

Definition at line 135 of file PorousFlowFluidStateBase.h.

Referenced by PorousFlowBrineCO2::equilibriumConstantCO2(), PorousFlowBrineCO2::equilibriumConstantH2O(), PorousFlowBrineCO2::funcABHighTemp(), PorousFlowBrineCO2::henryConstant(), and PorousFlowBrineCO2::partialDensityCO2().

---

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

• porous_flow/include/userobjects/PorousFlowFluidStateBase.h
• porous_flow/src/userobjects/PorousFlowFluidStateBase.C