https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
PorousFlowFluidPropertiesBaseTempl< is_ad > Class Template Reference

Base class for fluid properties materials. More...

#include <PorousFlowFluidPropertiesBase.h>

Inheritance diagram for PorousFlowFluidPropertiesBaseTempl< is_ad >:
[legend]

Public Types

typedef DerivativeMaterialPropertyNameInterface::SymbolName SymbolName
 

Public Member Functions

 PorousFlowFluidPropertiesBaseTempl (const InputParameters &parameters)
 
const GenericMaterialProperty< U, is_ad > & getDefaultMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< U, is_ad > & getDefaultMaterialPropertyByName (const std::string &name)
 
void validateDerivativeMaterialPropertyBase (const std::string &base)
 
const MaterialPropertyName derivativePropertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
 
const MaterialPropertyName derivativePropertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
 
const MaterialPropertyName derivativePropertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
 
const MaterialPropertyName derivativePropertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
void validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)
 
void validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
 
void validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)
 
void validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
 
void validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
 
void validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
 
const MaterialPropertyName propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
 
const MaterialPropertyName propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
 
const MaterialPropertyName propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
 
const MaterialPropertyName propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
 
const MaterialPropertyName propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
 
const MaterialPropertyName propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
 
const MaterialPropertyName propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
 
const MaterialPropertyName propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Types

enum class  PressureUnitEnum { Pa , MPa }
 Unit used for porepressure. More...
 
enum class  TimeUnitEnum { seconds , hours , days , years }
 Unit used for time. More...
 

Protected Member Functions

virtual void computeQpProperties () override
 

Protected Attributes

const GenericMaterialProperty< std::vector< Real >, is_ad > & _porepressure
 Pore pressure at the nodes or quadpoints.
 
const GenericMaterialProperty< Real, is_ad > & _temperature
 Fluid temperature at the nodes or quadpoints.
 
const Real _t_c2k
 Conversion from degrees Celsius to degrees Kelvin.
 
const Real _R
 Universal gas constant.
 
enum PorousFlowFluidPropertiesBaseTempl::PressureUnitEnum _p_unit
 
const Real _pressure_to_Pascals
 convert porepressure to Pascals by multiplying by this quantity
 
enum PorousFlowFluidPropertiesBaseTempl::TimeUnitEnum _time_unit
 
const Real _time_to_seconds
 convert time to seconds by multiplying by this quantity
 
const bool _compute_rho_mu
 If true, this Material will compute density and viscosity, and their derivatives.
 
const bool _compute_internal_energy
 If true, this Material will compute internal energy and its derivatives.
 
const bool _compute_enthalpy
 If true, this Material will compute enthalpy and its derivatives.
 
GenericMaterialProperty< Real, is_ad > *const _density
 Fluid phase density at the qps or nodes.
 
MaterialProperty< Real > *const _ddensity_dp
 Derivative of fluid density wrt phase pore pressure at the qps or nodes.
 
MaterialProperty< Real > *const _ddensity_dT
 Derivative of fluid density wrt temperature at the qps or nodes.
 
GenericMaterialProperty< Real, is_ad > *const _viscosity
 Fluid phase viscosity at the nodes.
 
MaterialProperty< Real > *const _dviscosity_dp
 Derivative of fluid phase viscosity wrt pressure at the nodes.
 
MaterialProperty< Real > *const _dviscosity_dT
 Derivative of fluid phase viscosity wrt temperature at the nodes.
 
GenericMaterialProperty< Real, is_ad > *const _internal_energy
 Fluid phase internal_energy at the qps or nodes.
 
MaterialProperty< Real > *const _dinternal_energy_dp
 Derivative of fluid internal_energy wrt phase pore pressure at the qps or nodes.
 
MaterialProperty< Real > *const _dinternal_energy_dT
 Derivative of fluid internal_energy wrt temperature at the qps or nodes.
 
GenericMaterialProperty< Real, is_ad > *const _enthalpy
 Fluid phase enthalpy at the qps or nodes.
 
MaterialProperty< Real > *const _denthalpy_dp
 Derivative of fluid enthalpy wrt phase pore pressure at the qps or nodes.
 
MaterialProperty< Real > *const _denthalpy_dT
 Derivative of fluid enthalpy wrt temperature at the qps or nodes.
 
const unsigned int _phase_num
 Phase number of fluid.
 
const std::string _phase
 Stringified fluid phase number.
 

Private Member Functions

bool haveMaterialProperty (const std::string &prop_name)
 
std::vector< VariableName > buildVariableVector (const VariableName &c1, const VariableName &c2, const VariableName &c3)
 
void validateCouplingHelper (const MaterialPropertyName &base, const std::vector< VariableName > &c, const System &system, std::vector< VariableName > &missing)
 
bool isNotObjectVariable (const VariableName &name)
 

Private Attributes

FEProblemBase & _dmi_fe_problem
 

Detailed Description

template<bool is_ad>
class PorousFlowFluidPropertiesBaseTempl< is_ad >

Base class for fluid properties materials.

All PorousFlow fluid materials must override computeQpProperties()

Definition at line 20 of file PorousFlowFluidPropertiesBase.h.

Member Enumeration Documentation

◆ PressureUnitEnum

template<bool is_ad>
enum class PorousFlowFluidPropertiesBaseTempl::PressureUnitEnum
strongprotected

Unit used for porepressure.

Enumerator
Pa 
MPa 

Definition at line 43 of file PorousFlowFluidPropertiesBase.h.

43{ Pa, MPa } _p_unit;
PorousFlowFluidPropertiesBaseTempl::_p_unit
enum PorousFlowFluidPropertiesBaseTempl::PressureUnitEnum _p_unit

◆ TimeUnitEnum

template<bool is_ad>
enum class PorousFlowFluidPropertiesBaseTempl::TimeUnitEnum
strongprotected

Unit used for time.

Enumerator
seconds 
hours 
days 
years 

Definition at line 49 of file PorousFlowFluidPropertiesBase.h.

49{ seconds, hours, days, years } _time_unit;
PorousFlowFluidPropertiesBaseTempl::_time_unit
enum PorousFlowFluidPropertiesBaseTempl::TimeUnitEnum _time_unit

Constructor & Destructor Documentation

◆ PorousFlowFluidPropertiesBaseTempl()

template<bool is_ad>
PorousFlowFluidPropertiesBaseTempl< is_ad >::PorousFlowFluidPropertiesBaseTempl ( const InputParameters &  parameters)

Definition at line 41 of file PorousFlowFluidPropertiesBase.C.

43 : PorousFlowMaterialBase(parameters),
44 _porepressure(
45 _nodal_material
46 ? getGenericMaterialProperty<std::vector<Real>, is_ad>("PorousFlow_porepressure_nodal")
47 : getGenericMaterialProperty<std::vector<Real>, is_ad>("PorousFlow_porepressure_qp")),
48 _temperature(_nodal_material
49 ? getGenericMaterialProperty<Real, is_ad>("PorousFlow_temperature_nodal")
50 : getGenericMaterialProperty<Real, is_ad>("PorousFlow_temperature_qp")),
51 _t_c2k(getParam<MooseEnum>("temperature_unit") == 0 ? 0.0 : 273.15),
52 _R(8.3144598),
53 _p_unit(
54 this->template getParam<MooseEnum>("pressure_unit").template getEnum<PressureUnitEnum>()),
55 _pressure_to_Pascals(_p_unit == PressureUnitEnum::Pa ? 1.0 : 1.0E6),
56 _time_unit(this->template getParam<MooseEnum>("time_unit").template getEnum<TimeUnitEnum>()),
57 _time_to_seconds(_time_unit == TimeUnitEnum::seconds ? 1.0
58 : _time_unit == TimeUnitEnum::hours ? 3600.0
59 : _time_unit == TimeUnitEnum::days ? 3600.0 * 24
60 : 3600 * 24 * 365.25),
61 _compute_rho_mu(this->template getParam<bool>("compute_density_and_viscosity")),
62 _compute_internal_energy(this->template getParam<bool>("compute_internal_energy")),
63 _compute_enthalpy(this->template getParam<bool>("compute_enthalpy")),
64 _density(_compute_rho_mu
65 ? (_nodal_material ? &this->template declareGenericProperty<Real, is_ad>(
66 "PorousFlow_fluid_phase_density_nodal" + _phase)
67 : &this->template declareGenericProperty<Real, is_ad>(
68 "PorousFlow_fluid_phase_density_qp" + _phase))
69 : nullptr),
70 _ddensity_dp(
71 (_compute_rho_mu && !is_ad)
72 ? (_nodal_material
73 ? &this->template declarePropertyDerivative<Real>(
74 "PorousFlow_fluid_phase_density_nodal" + _phase, _pressure_variable_name)
75 : &this->template declarePropertyDerivative<Real>(
76 "PorousFlow_fluid_phase_density_qp" + _phase, _pressure_variable_name))
77 : nullptr),
78 _ddensity_dT((_compute_rho_mu && !is_ad)
79 ? (_nodal_material ? &this->template declarePropertyDerivative<Real>(
80 "PorousFlow_fluid_phase_density_nodal" + _phase,
81 _temperature_variable_name)
82 : &this->template declarePropertyDerivative<Real>(
83 "PorousFlow_fluid_phase_density_qp" + _phase,
84 _temperature_variable_name))
85 : nullptr),
86
87 _viscosity(_compute_rho_mu
88 ? (_nodal_material ? &this->template declareGenericProperty<Real, is_ad>(
89 "PorousFlow_viscosity_nodal" + _phase)
90 : &this->template declareGenericProperty<Real, is_ad>(
91 "PorousFlow_viscosity_qp" + _phase))
92 : nullptr),
93 _dviscosity_dp((_compute_rho_mu && !is_ad)
94 ? (_nodal_material
95 ? &this->template declarePropertyDerivative<Real>(
96 "PorousFlow_viscosity_nodal" + _phase, _pressure_variable_name)
97 : &this->template declarePropertyDerivative<Real>(
98 "PorousFlow_viscosity_qp" + _phase, _pressure_variable_name))
99 : nullptr),
100 _dviscosity_dT(
101 (_compute_rho_mu && !is_ad)
102 ? (_nodal_material
103 ? &this->template declarePropertyDerivative<Real>(
104 "PorousFlow_viscosity_nodal" + _phase, _temperature_variable_name)
105 : &this->template declarePropertyDerivative<Real>(
106 "PorousFlow_viscosity_qp" + _phase, _temperature_variable_name))
107 : nullptr),
108
109 _internal_energy(_compute_internal_energy
110 ? (_nodal_material
111 ? &this->template declareGenericProperty<Real, is_ad>(
112 "PorousFlow_fluid_phase_internal_energy_nodal" + _phase)
113 : &this->template declareGenericProperty<Real, is_ad>(
114 "PorousFlow_fluid_phase_internal_energy_qp" + _phase))
115 : nullptr),
116 _dinternal_energy_dp((_compute_internal_energy && !is_ad)
117 ? (_nodal_material
118 ? &this->template declarePropertyDerivative<Real>(
119 "PorousFlow_fluid_phase_internal_energy_nodal" + _phase,
120 _pressure_variable_name)
121 : &this->template declarePropertyDerivative<Real>(
122 "PorousFlow_fluid_phase_internal_energy_qp" + _phase,
123 _pressure_variable_name))
124 : nullptr),
125 _dinternal_energy_dT((_compute_internal_energy && !is_ad)
126 ? (_nodal_material
127 ? &this->template declarePropertyDerivative<Real>(
128 "PorousFlow_fluid_phase_internal_energy_nodal" + _phase,
129 _temperature_variable_name)
130 : &this->template declarePropertyDerivative<Real>(
131 "PorousFlow_fluid_phase_internal_energy_qp" + _phase,
132 _temperature_variable_name))
133 : nullptr),
134
135 _enthalpy(_compute_enthalpy
136 ? (_nodal_material ? &this->template declareGenericProperty<Real, is_ad>(
137 "PorousFlow_fluid_phase_enthalpy_nodal" + _phase)
138 : &this->template declareGenericProperty<Real, is_ad>(
139 "PorousFlow_fluid_phase_enthalpy_qp" + _phase))
140 : nullptr),
141 _denthalpy_dp(
142 (_compute_enthalpy && !is_ad)
143 ? (_nodal_material
144 ? &this->template declarePropertyDerivative<Real>(
145 "PorousFlow_fluid_phase_enthalpy_nodal" + _phase, _pressure_variable_name)
146 : &this->template declarePropertyDerivative<Real>(
147 "PorousFlow_fluid_phase_enthalpy_qp" + _phase, _pressure_variable_name))
148 : nullptr),
149 _denthalpy_dT((_compute_enthalpy && !is_ad)
150 ? (_nodal_material ? &this->template declarePropertyDerivative<Real>(
151 "PorousFlow_fluid_phase_enthalpy_nodal" + _phase,
152 _temperature_variable_name)
153 : &this->template declarePropertyDerivative<Real>(
154 "PorousFlow_fluid_phase_enthalpy_qp" + _phase,
155 _temperature_variable_name))
156 : nullptr)
157{
158}
DerivativeMaterialInterface< PorousFlowMaterial >::declarePropertyDerivative
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative(const std::string &base, const std::vector< VariableName > &c)
PorousFlowFluidPropertiesBaseTempl::_dinternal_energy_dp
MaterialProperty< Real > *const _dinternal_energy_dp
Derivative of fluid internal_energy wrt phase pore pressure at the qps or nodes.
Definition PorousFlowFluidPropertiesBase.h:85
PorousFlowFluidPropertiesBaseTempl::_dviscosity_dT
MaterialProperty< Real > *const _dviscosity_dT
Derivative of fluid phase viscosity wrt temperature at the nodes.
Definition PorousFlowFluidPropertiesBase.h:79
PorousFlowFluidPropertiesBaseTempl::_ddensity_dp
MaterialProperty< Real > *const _ddensity_dp
Derivative of fluid density wrt phase pore pressure at the qps or nodes.
Definition PorousFlowFluidPropertiesBase.h:67
PorousFlowFluidPropertiesBaseTempl::_ddensity_dT
MaterialProperty< Real > *const _ddensity_dT
Derivative of fluid density wrt temperature at the qps or nodes.
Definition PorousFlowFluidPropertiesBase.h:70
PorousFlowFluidPropertiesBaseTempl::_temperature
const GenericMaterialProperty< Real, is_ad > & _temperature
Fluid temperature at the nodes or quadpoints.
Definition PorousFlowFluidPropertiesBase.h:34
PorousFlowFluidPropertiesBaseTempl::_compute_rho_mu
const bool _compute_rho_mu
If true, this Material will compute density and viscosity, and their derivatives.
Definition PorousFlowFluidPropertiesBase.h:55
PorousFlowFluidPropertiesBaseTempl::_time_to_seconds
const Real _time_to_seconds
convert time to seconds by multiplying by this quantity
Definition PorousFlowFluidPropertiesBase.h:52
PorousFlowFluidPropertiesBaseTempl::_internal_energy
GenericMaterialProperty< Real, is_ad > *const _internal_energy
Fluid phase internal_energy at the qps or nodes.
Definition PorousFlowFluidPropertiesBase.h:82
PorousFlowFluidPropertiesBaseTempl::_compute_enthalpy
const bool _compute_enthalpy
If true, this Material will compute enthalpy and its derivatives.
Definition PorousFlowFluidPropertiesBase.h:61
PorousFlowFluidPropertiesBaseTempl::_dviscosity_dp
MaterialProperty< Real > *const _dviscosity_dp
Derivative of fluid phase viscosity wrt pressure at the nodes.
Definition PorousFlowFluidPropertiesBase.h:76
PorousFlowFluidPropertiesBaseTempl::_pressure_to_Pascals
const Real _pressure_to_Pascals
convert porepressure to Pascals by multiplying by this quantity
Definition PorousFlowFluidPropertiesBase.h:46
PorousFlowFluidPropertiesBaseTempl::_t_c2k
const Real _t_c2k
Conversion from degrees Celsius to degrees Kelvin.
Definition PorousFlowFluidPropertiesBase.h:37
PorousFlowFluidPropertiesBaseTempl::_denthalpy_dp
MaterialProperty< Real > *const _denthalpy_dp
Derivative of fluid enthalpy wrt phase pore pressure at the qps or nodes.
Definition PorousFlowFluidPropertiesBase.h:94
PorousFlowFluidPropertiesBaseTempl::_density
GenericMaterialProperty< Real, is_ad > *const _density
Fluid phase density at the qps or nodes.
Definition PorousFlowFluidPropertiesBase.h:64
PorousFlowFluidPropertiesBaseTempl::_enthalpy
GenericMaterialProperty< Real, is_ad > *const _enthalpy
Fluid phase enthalpy at the qps or nodes.
Definition PorousFlowFluidPropertiesBase.h:91
PorousFlowFluidPropertiesBaseTempl::_viscosity
GenericMaterialProperty< Real, is_ad > *const _viscosity
Fluid phase viscosity at the nodes.
Definition PorousFlowFluidPropertiesBase.h:73
PorousFlowFluidPropertiesBaseTempl::_porepressure
const GenericMaterialProperty< std::vector< Real >, is_ad > & _porepressure
Pore pressure at the nodes or quadpoints.
Definition PorousFlowFluidPropertiesBase.h:31
PorousFlowFluidPropertiesBaseTempl::_dinternal_energy_dT
MaterialProperty< Real > *const _dinternal_energy_dT
Derivative of fluid internal_energy wrt temperature at the qps or nodes.
Definition PorousFlowFluidPropertiesBase.h:88
PorousFlowFluidPropertiesBaseTempl::_compute_internal_energy
const bool _compute_internal_energy
If true, this Material will compute internal energy and its derivatives.
Definition PorousFlowFluidPropertiesBase.h:58
PorousFlowFluidPropertiesBaseTempl::_denthalpy_dT
MaterialProperty< Real > *const _denthalpy_dT
Derivative of fluid enthalpy wrt temperature at the qps or nodes.
Definition PorousFlowFluidPropertiesBase.h:97
PorousFlowMaterialBase
Base class for all PorousFlow materials that provide phase-dependent properties.
Definition PorousFlowMaterialBase.h:23
PorousFlowMaterialBase::_phase
const std::string _phase
Stringified fluid phase number.
Definition PorousFlowMaterialBase.h:34
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

Member Function Documentation

◆ computeQpProperties()

template<bool is_ad>
void PorousFlowFluidPropertiesBaseTempl< is_ad >::computeQpProperties ( )
overrideprotectedvirtual

Reimplemented in PorousFlowBrine, PorousFlowMultiComponentFluidTempl< is_ad >, and PorousFlowSingleComponentFluidTempl< is_ad >.

Definition at line 162 of file PorousFlowFluidPropertiesBase.C.

163{
164 mooseError("computeQpProperties() must be overriden in materials derived from "
165 "PorousFlowFluidPropertiesBase");
166}
mooseError
void mooseError(Args &&... args)

◆ validParams()

template<bool is_ad>
InputParameters PorousFlowFluidPropertiesBaseTempl< is_ad >::validParams ( )
static

Definition at line 14 of file PorousFlowFluidPropertiesBase.C.

15{
16 InputParameters params = PorousFlowMaterialBase::validParams();
17 MooseEnum unit_choice("Kelvin=0 Celsius=1", "Kelvin");
18 params.addParam<MooseEnum>(
19 "temperature_unit", unit_choice, "The unit of the temperature variable");
20 MooseEnum p_unit_choice("Pa MPa", "Pa");
21 params.addParam<MooseEnum>("pressure_unit",
22 p_unit_choice,
23 "The unit of the pressure variable used everywhere in the input file "
24 "except for in the FluidProperties-module objects");
25 MooseEnum time_unit_choice("seconds hours days years", "seconds");
26 params.addParam<MooseEnum>("time_unit",
27 time_unit_choice,
28 "The unit of time used everywhere in the input file except for in the "
29 "FluidProperties-module objects");
30 params.addParam<bool>(
31 "compute_density_and_viscosity", true, "Compute the fluid density and viscosity");
32 params.addParam<bool>("compute_internal_energy", true, "Compute the fluid internal energy");
33 params.addParam<bool>("compute_enthalpy", true, "Compute the fluid enthalpy");
34 params.addPrivateParam<std::string>("pf_material_type", "fluid_properties");
35 params.addPrivateParam<bool>("is_ad", is_ad);
36 params.addClassDescription("Base class for PorousFlow fluid materials");
37 return params;
38}
InputParameters::addPrivateParam
void addPrivateParam(const std::string &name, const T &value)
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
PorousFlowMaterialBase::validParams
static InputParameters validParams()
Definition PorousFlowMaterialBase.C:14

Referenced by PorousFlowBrine::validParams(), PorousFlowMultiComponentFluidTempl< is_ad >::validParams(), and PorousFlowSingleComponentFluidTempl< is_ad >::validParams().

Member Data Documentation

◆ _compute_enthalpy

template<bool is_ad>
const bool PorousFlowFluidPropertiesBaseTempl< is_ad >::_compute_enthalpy
protected

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

Definition at line 61 of file PorousFlowFluidPropertiesBase.h.

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

◆ _compute_internal_energy

template<bool is_ad>
const bool PorousFlowFluidPropertiesBaseTempl< is_ad >::_compute_internal_energy
protected

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

Definition at line 58 of file PorousFlowFluidPropertiesBase.h.

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

◆ _compute_rho_mu

template<bool is_ad>
const bool PorousFlowFluidPropertiesBaseTempl< is_ad >::_compute_rho_mu
protected

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

Definition at line 55 of file PorousFlowFluidPropertiesBase.h.

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

◆ _ddensity_dp

template<bool is_ad>
MaterialProperty<Real>* const PorousFlowFluidPropertiesBaseTempl< is_ad >::_ddensity_dp
protected

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

Definition at line 67 of file PorousFlowFluidPropertiesBase.h.

◆ _ddensity_dT

template<bool is_ad>
MaterialProperty<Real>* const PorousFlowFluidPropertiesBaseTempl< is_ad >::_ddensity_dT
protected

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

Definition at line 70 of file PorousFlowFluidPropertiesBase.h.

◆ _density

template<bool is_ad>
GenericMaterialProperty<Real, is_ad>* const PorousFlowFluidPropertiesBaseTempl< is_ad >::_density
protected

Fluid phase density at the qps or nodes.

Definition at line 64 of file PorousFlowFluidPropertiesBase.h.

◆ _denthalpy_dp

template<bool is_ad>
MaterialProperty<Real>* const PorousFlowFluidPropertiesBaseTempl< is_ad >::_denthalpy_dp
protected

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

Definition at line 94 of file PorousFlowFluidPropertiesBase.h.

◆ _denthalpy_dT

template<bool is_ad>
MaterialProperty<Real>* const PorousFlowFluidPropertiesBaseTempl< is_ad >::_denthalpy_dT
protected

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

Definition at line 97 of file PorousFlowFluidPropertiesBase.h.

◆ _dinternal_energy_dp

template<bool is_ad>
MaterialProperty<Real>* const PorousFlowFluidPropertiesBaseTempl< is_ad >::_dinternal_energy_dp
protected

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

Definition at line 85 of file PorousFlowFluidPropertiesBase.h.

◆ _dinternal_energy_dT

template<bool is_ad>
MaterialProperty<Real>* const PorousFlowFluidPropertiesBaseTempl< is_ad >::_dinternal_energy_dT
protected

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

Definition at line 88 of file PorousFlowFluidPropertiesBase.h.

◆ _dviscosity_dp

template<bool is_ad>
MaterialProperty<Real>* const PorousFlowFluidPropertiesBaseTempl< is_ad >::_dviscosity_dp
protected

Derivative of fluid phase viscosity wrt pressure at the nodes.

Definition at line 76 of file PorousFlowFluidPropertiesBase.h.

◆ _dviscosity_dT

template<bool is_ad>
MaterialProperty<Real>* const PorousFlowFluidPropertiesBaseTempl< is_ad >::_dviscosity_dT
protected

Derivative of fluid phase viscosity wrt temperature at the nodes.

Definition at line 79 of file PorousFlowFluidPropertiesBase.h.

◆ _enthalpy

template<bool is_ad>
GenericMaterialProperty<Real, is_ad>* const PorousFlowFluidPropertiesBaseTempl< is_ad >::_enthalpy
protected

Fluid phase enthalpy at the qps or nodes.

Definition at line 91 of file PorousFlowFluidPropertiesBase.h.

◆ _internal_energy

template<bool is_ad>
GenericMaterialProperty<Real, is_ad>* const PorousFlowFluidPropertiesBaseTempl< is_ad >::_internal_energy
protected

Fluid phase internal_energy at the qps or nodes.

Definition at line 82 of file PorousFlowFluidPropertiesBase.h.

◆ _p_unit

template<bool is_ad>
enum PorousFlowFluidPropertiesBaseTempl::PressureUnitEnum PorousFlowFluidPropertiesBaseTempl< is_ad >::_p_unit
protected

◆ _phase

const std::string PorousFlowMaterialBase::_phase
protectedinherited

Stringified fluid phase number.

Definition at line 34 of file PorousFlowMaterialBase.h.

◆ _phase_num

const unsigned int PorousFlowMaterialBase::_phase_num
protectedinherited

Phase number of fluid.

Definition at line 31 of file PorousFlowMaterialBase.h.

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

◆ _porepressure

template<bool is_ad>
const GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowFluidPropertiesBaseTempl< is_ad >::_porepressure
protected

Pore pressure at the nodes or quadpoints.

Definition at line 31 of file PorousFlowFluidPropertiesBase.h.

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

◆ _pressure_to_Pascals

template<bool is_ad>
const Real PorousFlowFluidPropertiesBaseTempl< is_ad >::_pressure_to_Pascals
protected

convert porepressure to Pascals by multiplying by this quantity

Definition at line 46 of file PorousFlowFluidPropertiesBase.h.

◆ _R

template<bool is_ad>
const Real PorousFlowFluidPropertiesBaseTempl< is_ad >::_R
protected

Universal gas constant.

Definition at line 40 of file PorousFlowFluidPropertiesBase.h.

◆ _t_c2k

template<bool is_ad>
const Real PorousFlowFluidPropertiesBaseTempl< is_ad >::_t_c2k
protected

Conversion from degrees Celsius to degrees Kelvin.

Definition at line 37 of file PorousFlowFluidPropertiesBase.h.

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

◆ _temperature

template<bool is_ad>
const GenericMaterialProperty<Real, is_ad>& PorousFlowFluidPropertiesBaseTempl< is_ad >::_temperature
protected

Fluid temperature at the nodes or quadpoints.

Definition at line 34 of file PorousFlowFluidPropertiesBase.h.

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

◆ _time_to_seconds

template<bool is_ad>
const Real PorousFlowFluidPropertiesBaseTempl< is_ad >::_time_to_seconds
protected

convert time to seconds by multiplying by this quantity

Definition at line 52 of file PorousFlowFluidPropertiesBase.h.

◆ _time_unit

template<bool is_ad>
enum PorousFlowFluidPropertiesBaseTempl::TimeUnitEnum PorousFlowFluidPropertiesBaseTempl< is_ad >::_time_unit
protected

◆ _viscosity

template<bool is_ad>
GenericMaterialProperty<Real, is_ad>* const PorousFlowFluidPropertiesBaseTempl< is_ad >::_viscosity
protected

Fluid phase viscosity at the nodes.

Definition at line 73 of file PorousFlowFluidPropertiesBase.h.

The documentation for this class was generated from the following files:
Generated on Fri Aug 21 2026 13:43:36 for https://mooseframework.inl.gov by doxygen 1.9.8