General single component fluid material. More...

#include <PorousFlowSingleComponentFluid.h>

Inheritance diagram for PorousFlowSingleComponentFluid:

Public Member Functions
	PorousFlowSingleComponentFluid (const InputParameters &parameters)

Protected Types
enum	PressureUnitEnum { PressureUnitEnum::Pa, PressureUnitEnum::MPa }
	Unit used for porepressure. More...

enum	TimeUnitEnum { TimeUnitEnum::seconds, TimeUnitEnum::hours, TimeUnitEnum::days, TimeUnitEnum::years }
	Unit used for time. More...

Protected Member Functions
virtual void	initQpStatefulProperties () override

virtual void	computeQpProperties () override

Protected Attributes
enum PorousFlowSingleComponentFluid::PressureUnitEnum	_p_unit

const Real	_pressure_to_Pascals
	convert porepressure to Pascals by multiplying by this quantity More...

enum PorousFlowSingleComponentFluid::TimeUnitEnum	_time_unit

const Real	_time_to_seconds
	convert time to seconds by multiplying by this quantity More...

const bool	_compute_rho_mu
	If true, this Material will compute density and viscosity, and their derivatives. More...

const bool	_compute_internal_energy
	If true, this Material will compute internal energy and its derivatives. More...

const bool	_compute_enthalpy
	If true, this Material will compute enthalpy and its derivatives. More...

MaterialProperty< Real > *const	_density
	Fluid phase density at the qps or nodes. More...

MaterialProperty< Real > *const	_ddensity_dp
	Derivative of fluid density wrt phase pore pressure at the qps or nodes. More...

MaterialProperty< Real > *const	_ddensity_dT
	Derivative of fluid density wrt temperature at the qps or nodes. More...

MaterialProperty< Real > *const	_viscosity
	Fluid phase viscosity at the nodes. More...

MaterialProperty< Real > *const	_dviscosity_dp
	Derivative of fluid phase viscosity wrt pressure at the nodes. More...

MaterialProperty< Real > *const	_dviscosity_dT
	Derivative of fluid phase viscosity wrt temperature at the nodes. More...

MaterialProperty< Real > *const	_internal_energy
	Fluid phase internal_energy at the qps or nodes. More...

MaterialProperty< Real > *const	_dinternal_energy_dp
	Derivative of fluid internal_energy wrt phase pore pressure at the qps or nodes. More...

MaterialProperty< Real > *const	_dinternal_energy_dT
	Derivative of fluid internal_energy wrt temperature at the qps or nodes. More...

MaterialProperty< Real > *const	_enthalpy
	Fluid phase enthalpy at the qps or nodes. More...

MaterialProperty< Real > *const	_denthalpy_dp
	Derivative of fluid enthalpy wrt phase pore pressure at the qps or nodes. More...

MaterialProperty< Real > *const	_denthalpy_dT
	Derivative of fluid enthalpy wrt temperature at the qps or nodes. More...

const SinglePhaseFluidProperties &	_fp
	Fluid properties UserObject. More...

const MaterialProperty< std::vector< Real > > &	_porepressure
	Pore pressure at the nodes or quadpoints. More...

const MaterialProperty< Real > &	_temperature
	Fluid temperature at the nodes or quadpoints. More...

const Real	_t_c2k
	Conversion from degrees Celsius to degrees Kelvin. More...

const Real	_R
	Universal gas constant. More...

const unsigned int	_phase_num
	Phase number of fluid. More...

const std::string	_phase
	Stringified fluid phase number. More...

Detailed Description

General single component fluid material.

Provides quadpoint density, viscosity, internal energy, enthalpy and derivatives wrt pressure and temperature for a fluid defined in the FluidProperties module

Definition at line 25 of file PorousFlowSingleComponentFluid.h.

Member Enumeration Documentation

◆ PressureUnitEnum

enum PorousFlowSingleComponentFluid::PressureUnitEnum

strongprotected

Unit used for porepressure.

Enumerator
Pa
MPa

Definition at line 35 of file PorousFlowSingleComponentFluid.h.

35 { Pa, MPa } _p_unit;

◆ TimeUnitEnum

enum PorousFlowSingleComponentFluid::TimeUnitEnum

strongprotected

Unit used for time.

Enumerator
seconds
hours
days
years

Definition at line 41 of file PorousFlowSingleComponentFluid.h.

41 { seconds, hours, days, years } _time_unit;

Constructor & Destructor Documentation

◆ PorousFlowSingleComponentFluid()

PorousFlowSingleComponentFluid::PorousFlowSingleComponentFluid ( const InputParameters & parameters )

Definition at line 39 of file PorousFlowSingleComponentFluid.C.

   : PorousFlowFluidPropertiesBase(parameters),
     _p_unit(getParam<MooseEnum>("pressure_unit").getEnum<PressureUnitEnum>()),
     _pressure_to_Pascals(_p_unit == PressureUnitEnum::Pa ? 1.0 : 1.0E6),
     _time_unit(getParam<MooseEnum>("time_unit").getEnum<TimeUnitEnum>()),
     _time_to_seconds(_time_unit == TimeUnitEnum::seconds
                          ? 1.0
                          : _time_unit == TimeUnitEnum::hours
                                ? 3600.0
                                : _time_unit == TimeUnitEnum::days ? 3600.0 * 24
                                                                   : 3600 * 24 * 365.25),
     _compute_rho_mu(getParam<bool>("compute_density_and_viscosity")),
     _compute_internal_energy(getParam<bool>("compute_internal_energy")),
     _compute_enthalpy(getParam<bool>("compute_enthalpy")),
     _density(_compute_rho_mu
                  ? (_nodal_material
                         ? &declareProperty<Real>("PorousFlow_fluid_phase_density_nodal" + _phase)
                         : &declareProperty<Real>("PorousFlow_fluid_phase_density_qp" + _phase))
                  : nullptr),
     _ddensity_dp(
         _compute_rho_mu
             ? (_nodal_material
                    ? &declarePropertyDerivative<Real>(
                          "PorousFlow_fluid_phase_density_nodal" + _phase, _pressure_variable_name)
                    : &declarePropertyDerivative<Real>("PorousFlow_fluid_phase_density_qp" + _phase,
                                                       _pressure_variable_name))
             : nullptr),
     _ddensity_dT(_compute_rho_mu
                      ? (_nodal_material ? &declarePropertyDerivative<Real>(
                                               "PorousFlow_fluid_phase_density_nodal" + _phase,
                                               _temperature_variable_name)
                                         : &declarePropertyDerivative<Real>(
                                               "PorousFlow_fluid_phase_density_qp" + _phase,
                                               _temperature_variable_name))
                      : nullptr),
  
     _viscosity(_compute_rho_mu
                    ? (_nodal_material
                           ? &declareProperty<Real>("PorousFlow_viscosity_nodal" + _phase)
                           : &declareProperty<Real>("PorousFlow_viscosity_qp" + _phase))
                    : nullptr),
     _dviscosity_dp(_compute_rho_mu
                        ? (_nodal_material
                               ? &declarePropertyDerivative<Real>(
                                     "PorousFlow_viscosity_nodal" + _phase, _pressure_variable_name)
                               : &declarePropertyDerivative<Real>("PorousFlow_viscosity_qp" + _phase,
                                                                  _pressure_variable_name))
                        : nullptr),
     _dviscosity_dT(
         _compute_rho_mu
             ? (_nodal_material
                    ? &declarePropertyDerivative<Real>("PorousFlow_viscosity_nodal" + _phase,
                                                       _temperature_variable_name)
                    : &declarePropertyDerivative<Real>("PorousFlow_viscosity_qp" + _phase,
                                                       _temperature_variable_name))
             : nullptr),
  
     _internal_energy(
         _compute_internal_energy
             ? (_nodal_material
                    ? &declareProperty<Real>("PorousFlow_fluid_phase_internal_energy_nodal" + _phase)
                    : &declareProperty<Real>("PorousFlow_fluid_phase_internal_energy_qp" + _phase))
             : nullptr),
     _dinternal_energy_dp(_compute_internal_energy
                              ? (_nodal_material
                                     ? &declarePropertyDerivative<Real>(
                                           "PorousFlow_fluid_phase_internal_energy_nodal" + _phase,
                                           _pressure_variable_name)
                                     : &declarePropertyDerivative<Real>(
                                           "PorousFlow_fluid_phase_internal_energy_qp" + _phase,
                                           _pressure_variable_name))
                              : nullptr),
     _dinternal_energy_dT(_compute_internal_energy
                              ? (_nodal_material
                                     ? &declarePropertyDerivative<Real>(
                                           "PorousFlow_fluid_phase_internal_energy_nodal" + _phase,
                                           _temperature_variable_name)
                                     : &declarePropertyDerivative<Real>(
                                           "PorousFlow_fluid_phase_internal_energy_qp" + _phase,
                                           _temperature_variable_name))
                              : nullptr),
  
     _enthalpy(_compute_enthalpy
                   ? (_nodal_material
                          ? &declareProperty<Real>("PorousFlow_fluid_phase_enthalpy_nodal" + _phase)
                          : &declareProperty<Real>("PorousFlow_fluid_phase_enthalpy_qp" + _phase))
                   : nullptr),
     _denthalpy_dp(
         _compute_enthalpy
             ? (_nodal_material
                    ? &declarePropertyDerivative<Real>(
                          "PorousFlow_fluid_phase_enthalpy_nodal" + _phase, _pressure_variable_name)
                    : &declarePropertyDerivative<Real>("PorousFlow_fluid_phase_enthalpy_qp" + _phase,
                                                       _pressure_variable_name))
             : nullptr),
     _denthalpy_dT(_compute_enthalpy
                       ? (_nodal_material ? &declarePropertyDerivative<Real>(
                                                "PorousFlow_fluid_phase_enthalpy_nodal" + _phase,
                                                _temperature_variable_name)
                                          : &declarePropertyDerivative<Real>(
                                                "PorousFlow_fluid_phase_enthalpy_qp" + _phase,
                                                _temperature_variable_name))
                       : nullptr),
  
     _fp(getUserObject<SinglePhaseFluidProperties>("fp"))
 {
 }

Member Function Documentation

◆ computeQpProperties()

void PorousFlowSingleComponentFluid::computeQpProperties ( )

overrideprotectedvirtual

Reimplemented from PorousFlowFluidPropertiesBase.

Definition at line 162 of file PorousFlowSingleComponentFluid.C.

 {
   const Real Tk = _temperature[_qp] + _t_c2k;
  
   if (_compute_rho_mu)
   {
     // Density and viscosity, and derivatives wrt pressure and temperature
     Real rho, drho_dp, drho_dT, mu, dmu_dp, dmu_dT;
     _fp.rho_mu_from_p_T(_porepressure[_qp][_phase_num] * _pressure_to_Pascals,
                         Tk,
                         rho,
                         drho_dp,
                         drho_dT,
                         mu,
                         dmu_dp,
                         dmu_dT);
     (*_density)[_qp] = rho;
     (*_ddensity_dp)[_qp] = drho_dp * _pressure_to_Pascals;
     (*_ddensity_dT)[_qp] = drho_dT;
     (*_viscosity)[_qp] = mu / _pressure_to_Pascals / _time_to_seconds;
     (*_dviscosity_dp)[_qp] = dmu_dp / _time_to_seconds;
     (*_dviscosity_dT)[_qp] = dmu_dT / _pressure_to_Pascals / _time_to_seconds;
   }
  
   // Internal energy and derivatives wrt pressure and temperature at the qps
   if (_compute_internal_energy)
   {
     Real e, de_dp, de_dT;
     _fp.e_from_p_T(_porepressure[_qp][_phase_num] * _pressure_to_Pascals, Tk, e, de_dp, de_dT);
     (*_internal_energy)[_qp] = e;
     (*_dinternal_energy_dp)[_qp] = de_dp * _pressure_to_Pascals;
     (*_dinternal_energy_dT)[_qp] = de_dT;
   }
  
   // Enthalpy and derivatives wrt pressure and temperature at the qps
   if (_compute_enthalpy)
   {
     Real h, dh_dp, dh_dT;
     _fp.h_from_p_T(_porepressure[_qp][_phase_num] * _pressure_to_Pascals, Tk, h, dh_dp, dh_dT);
     (*_enthalpy)[_qp] = h;
     (*_denthalpy_dp)[_qp] = dh_dp * _pressure_to_Pascals;
     (*_denthalpy_dT)[_qp] = dh_dT;
   }
 }

◆ initQpStatefulProperties()

void PorousFlowSingleComponentFluid::initQpStatefulProperties ( )

overrideprotectedvirtual

Definition at line 148 of file PorousFlowSingleComponentFluid.C.

 {
   if (_compute_rho_mu)
     (*_density)[_qp] = _fp.rho_from_p_T(_porepressure[_qp][_phase_num] * _pressure_to_Pascals,
                                         _temperature[_qp] + _t_c2k);
   if (_compute_internal_energy)
     (*_internal_energy)[_qp] = _fp.e_from_p_T(_porepressure[_qp][_phase_num] * _pressure_to_Pascals,
                                               _temperature[_qp] + _t_c2k);
   if (_compute_enthalpy)
     (*_enthalpy)[_qp] = _fp.h_from_p_T(_porepressure[_qp][_phase_num] * _pressure_to_Pascals,
                                        _temperature[_qp] + _t_c2k);
 }

Member Data Documentation

◆ _compute_enthalpy

const bool PorousFlowSingleComponentFluid::_compute_enthalpy

protected

If true, this Material will compute enthalpy and its derivatives.

Definition at line 53 of file PorousFlowSingleComponentFluid.h.

Referenced by computeQpProperties(), and initQpStatefulProperties().

◆ _compute_internal_energy

const bool PorousFlowSingleComponentFluid::_compute_internal_energy

protected

If true, this Material will compute internal energy and its derivatives.

Definition at line 50 of file PorousFlowSingleComponentFluid.h.

Referenced by computeQpProperties(), and initQpStatefulProperties().

◆ _compute_rho_mu

const bool PorousFlowSingleComponentFluid::_compute_rho_mu

protected

If true, this Material will compute density and viscosity, and their derivatives.

Definition at line 47 of file PorousFlowSingleComponentFluid.h.

Referenced by computeQpProperties(), and initQpStatefulProperties().

◆ _ddensity_dp

MaterialProperty<Real>* const PorousFlowSingleComponentFluid::_ddensity_dp

protected

Derivative of fluid density wrt phase pore pressure at the qps or nodes.

Definition at line 59 of file PorousFlowSingleComponentFluid.h.

◆ _ddensity_dT

MaterialProperty<Real>* const PorousFlowSingleComponentFluid::_ddensity_dT

protected

Derivative of fluid density wrt temperature at the qps or nodes.

Definition at line 62 of file PorousFlowSingleComponentFluid.h.

◆ _density

MaterialProperty<Real>* const PorousFlowSingleComponentFluid::_density

protected

Fluid phase density at the qps or nodes.

Definition at line 56 of file PorousFlowSingleComponentFluid.h.

◆ _denthalpy_dp

MaterialProperty<Real>* const PorousFlowSingleComponentFluid::_denthalpy_dp

protected

Derivative of fluid enthalpy wrt phase pore pressure at the qps or nodes.

Definition at line 86 of file PorousFlowSingleComponentFluid.h.

◆ _denthalpy_dT

MaterialProperty<Real>* const PorousFlowSingleComponentFluid::_denthalpy_dT

protected

Derivative of fluid enthalpy wrt temperature at the qps or nodes.

Definition at line 89 of file PorousFlowSingleComponentFluid.h.

◆ _dinternal_energy_dp

MaterialProperty<Real>* const PorousFlowSingleComponentFluid::_dinternal_energy_dp

protected

Derivative of fluid internal_energy wrt phase pore pressure at the qps or nodes.

Definition at line 77 of file PorousFlowSingleComponentFluid.h.

◆ _dinternal_energy_dT

MaterialProperty<Real>* const PorousFlowSingleComponentFluid::_dinternal_energy_dT

protected

Derivative of fluid internal_energy wrt temperature at the qps or nodes.

Definition at line 80 of file PorousFlowSingleComponentFluid.h.

◆ _dviscosity_dp

MaterialProperty<Real>* const PorousFlowSingleComponentFluid::_dviscosity_dp

protected

Derivative of fluid phase viscosity wrt pressure at the nodes.

Definition at line 68 of file PorousFlowSingleComponentFluid.h.

◆ _dviscosity_dT

MaterialProperty<Real>* const PorousFlowSingleComponentFluid::_dviscosity_dT

protected

Derivative of fluid phase viscosity wrt temperature at the nodes.

Definition at line 71 of file PorousFlowSingleComponentFluid.h.

◆ _enthalpy

MaterialProperty<Real>* const PorousFlowSingleComponentFluid::_enthalpy

protected

Fluid phase enthalpy at the qps or nodes.

Definition at line 83 of file PorousFlowSingleComponentFluid.h.

◆ _fp

const SinglePhaseFluidProperties& PorousFlowSingleComponentFluid::_fp

protected

Fluid properties UserObject.

Definition at line 92 of file PorousFlowSingleComponentFluid.h.

Referenced by computeQpProperties(), and initQpStatefulProperties().

◆ _internal_energy

MaterialProperty<Real>* const PorousFlowSingleComponentFluid::_internal_energy

protected

Fluid phase internal_energy at the qps or nodes.

Definition at line 74 of file PorousFlowSingleComponentFluid.h.

◆ _p_unit

enum PorousFlowSingleComponentFluid::PressureUnitEnum PorousFlowSingleComponentFluid::_p_unit

protected

◆ _phase

const std::string PorousFlowMaterialBase::_phase

protectedinherited

Stringified fluid phase number.

Definition at line 37 of file PorousFlowMaterialBase.h.

◆ _phase_num

const unsigned int PorousFlowMaterialBase::_phase_num

protectedinherited

Phase number of fluid.

Definition at line 34 of file PorousFlowMaterialBase.h.

Referenced by PorousFlowRelativePermeabilityBase::computeQpProperties(), PorousFlowBrine::computeQpProperties(), computeQpProperties(), PorousFlowBrine::initQpStatefulProperties(), initQpStatefulProperties(), and PorousFlowMaterialBase::PorousFlowMaterialBase().

◆ _porepressure

const MaterialProperty<std::vector<Real> >& PorousFlowFluidPropertiesBase::_porepressure

protectedinherited

Pore pressure at the nodes or quadpoints.

Definition at line 33 of file PorousFlowFluidPropertiesBase.h.

Referenced by PorousFlowBrine::computeQpProperties(), computeQpProperties(), PorousFlowBrine::initQpStatefulProperties(), and initQpStatefulProperties().

◆ _pressure_to_Pascals

const Real PorousFlowSingleComponentFluid::_pressure_to_Pascals

protected

convert porepressure to Pascals by multiplying by this quantity

Definition at line 38 of file PorousFlowSingleComponentFluid.h.

Referenced by computeQpProperties(), and initQpStatefulProperties().

◆ _R

const Real PorousFlowFluidPropertiesBase::_R

protectedinherited

Universal gas constant.

Definition at line 42 of file PorousFlowFluidPropertiesBase.h.

◆ _t_c2k

const Real PorousFlowFluidPropertiesBase::_t_c2k

protectedinherited

Conversion from degrees Celsius to degrees Kelvin.

Definition at line 39 of file PorousFlowFluidPropertiesBase.h.

Referenced by PorousFlowBrine::computeQpProperties(), computeQpProperties(), PorousFlowBrine::initQpStatefulProperties(), and initQpStatefulProperties().

◆ _temperature

const MaterialProperty<Real>& PorousFlowFluidPropertiesBase::_temperature

protectedinherited

Fluid temperature at the nodes or quadpoints.

Definition at line 36 of file PorousFlowFluidPropertiesBase.h.

Referenced by PorousFlowBrine::computeQpProperties(), computeQpProperties(), PorousFlowBrine::initQpStatefulProperties(), and initQpStatefulProperties().

◆ _time_to_seconds

const Real PorousFlowSingleComponentFluid::_time_to_seconds

protected

convert time to seconds by multiplying by this quantity

Definition at line 44 of file PorousFlowSingleComponentFluid.h.

Referenced by computeQpProperties().

◆ _time_unit

enum PorousFlowSingleComponentFluid::TimeUnitEnum PorousFlowSingleComponentFluid::_time_unit

protected

◆ _viscosity

MaterialProperty<Real>* const PorousFlowSingleComponentFluid::_viscosity

protected

Fluid phase viscosity at the nodes.

Definition at line 65 of file PorousFlowSingleComponentFluid.h.

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

porous_flow/include/materials/PorousFlowSingleComponentFluid.h
porous_flow/src/materials/PorousFlowSingleComponentFluid.C

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ PressureUnitEnum

◆ TimeUnitEnum

Constructor & Destructor Documentation

◆ PorousFlowSingleComponentFluid()

Member Function Documentation

◆ computeQpProperties()

◆ initQpStatefulProperties()

Member Data Documentation

◆ _compute_enthalpy

◆ _compute_internal_energy

◆ _compute_rho_mu

◆ _ddensity_dp

◆ _ddensity_dT

◆ _density

◆ _denthalpy_dp

◆ _denthalpy_dT

◆ _dinternal_energy_dp

◆ _dinternal_energy_dT

◆ _dviscosity_dp

◆ _dviscosity_dT

◆ _enthalpy

◆ _fp

◆ _internal_energy

◆ _p_unit

◆ _phase

◆ _phase_num

◆ _porepressure

◆ _pressure_to_Pascals

◆ _R

◆ _t_c2k

◆ _temperature

◆ _time_to_seconds

◆ _time_unit

◆ _viscosity