Fluid state class using a persistent set of primary variables for the mutliphase, multicomponent case. More...

#include <PorousFlowFluidState.h>

Inheritance diagram for PorousFlowFluidStateTempl< is_ad >:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	PorousFlowFluidStateTempl (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 Member Functions
virtual void	initQpStatefulProperties () override

virtual void	computeQpProperties () override

virtual void	thermophysicalProperties () override
	Calculates all required thermophysical properties and derivatives for each phase and fluid component.

virtual void	setMaterialVectorSize () const
	Size material property vectors and initialise with zeros.

GenericReal< is_ad >	genericValue (const ADReal &value)
	Templated method that takes an ADReal value, and returns the raw value when is_ad = false, and the AD value when is_ad = true.

GenericReal< false >	genericValue (const ADReal &value)

GenericReal< true >	genericValue (const ADReal &value)

Protected Attributes
const GenericVariableValue< is_ad > &	_gas_porepressure
	Porepressure.

const GenericVariableGradient< is_ad > &	_gas_gradp_qp
	Gradient of porepressure (only defined at the qps)

const unsigned int	_gas_porepressure_varnum
	Moose variable number of the gas porepressure.

const unsigned int	_pvar
	PorousFlow variable number of the gas porepressure.

std::vector< const GenericVariableValue< is_ad > * >	_Z
	Total mass fraction(s) of the gas component(s) summed over all phases.

std::vector< const GenericVariableGradient< is_ad > * >	_gradZ_qp
	Gradient(s) of total mass fraction(s) of the gas component(s) (only defined at the qps)

std::vector< unsigned int >	_Z_varnum
	Moose variable number of Z.

std::vector< unsigned int >	_Zvar
	PorousFlow variable number of Z.

const unsigned int	_num_Z_vars
	Number of coupled total mass fractions. Should be _num_phases - 1.

const bool	_is_Xnacl_nodal
	Flag for nodal NaCl mass fraction.

const GenericVariableValue< is_ad > &	_Xnacl
	Salt mass fraction (kg/kg)

const GenericVariableGradient< is_ad > &	_grad_Xnacl_qp
	Gradient of salt mass fraction (only defined at the qps)

const unsigned int	_Xnacl_varnum
	Salt mass fraction variable number.

const unsigned int	_Xvar
	Salt mass fraction PorousFlow variable number.

const PorousFlowFluidStateMultiComponentBase &	_fs
	FluidState UserObject.

const unsigned int	_aqueous_phase_number
	Phase number of the aqueous phase.

const unsigned int	_gas_phase_number
	Phase number of the gas phase.

const unsigned int	_aqueous_fluid_component
	Fluid component number of the aqueous component.

const unsigned int	_gas_fluid_component
	Fluid component number of the gas phase.

const unsigned int	_salt_component
	Salt component index.

const GenericMaterialProperty< Real, is_ad > &	_temperature
	Temperature.

const GenericMaterialProperty< RealGradient, is_ad > *const	_gradT_qp
	Gradient of temperature (only defined at the qps)

const MaterialProperty< std::vector< Real > > *const	_dtemperature_dvar
	Derivative of temperature wrt PorousFlow variables.

const unsigned int	_temperature_varnum
	Moose variable number of the temperature.

const unsigned int	_Tvar
	PorousFlow variable number of the temperature.

const unsigned int	_pidx
	Index of derivative wrt pressure.

const unsigned int	_Tidx
	Index of derivative wrt temperature.

const unsigned int	_Zidx
	Index of derivative wrt total mass fraction Z.

const unsigned int	_Xidx
	Index of derivative wrt salt mass fraction X.

	usingPorousFlowFluidStateBaseMaterialMembers

	usingPorousFlowFluidStateBaseMaterialDerivativeMembers

const Real	_T_c2k
	Conversion from degrees Celsius to degrees Kelvin.

bool	_is_initqp
	Flag to indicate whether stateful properties should be computed.

std::vector< FluidStateProperties >	_fsp
	FluidStateProperties data for each fluid component in each fluid phase.

const PorousFlowCapillaryPressure &	_pc
	Capillary pressure UserObject.

const std::string	_sfx
	Suffix to append to material property names (either qp or nodal as required)

GenericMaterialProperty< std::vector< std::vector< Real > >, is_ad > &	_mass_frac
	Mass fraction matrix (indexing is fluid component in fluid phase)

GenericMaterialProperty< std::vector< std::vector< RealGradient > >, is_ad > *const	_grad_mass_frac_qp
	Gradient of the mass fraction matrix (only defined at the qps)

MaterialProperty< std::vector< std::vector< std::vector< Real > > > > *const	_dmass_frac_dvar
	Derivative of the mass fraction matrix with respect to the Porous Flow variables.

GenericMaterialProperty< std::vector< Real >, is_ad > &	_fluid_density
	Fluid density of each phase.

MaterialProperty< std::vector< std::vector< Real > > > *const	_dfluid_density_dvar
	Derivative of the fluid density for each phase wrt PorousFlow variables.

GenericMaterialProperty< std::vector< Real >, is_ad > &	_fluid_viscosity
	Viscosity of each phase.

MaterialProperty< std::vector< std::vector< Real > > > *const	_dfluid_viscosity_dvar
	Derivative of the fluid viscosity for each phase wrt PorousFlow variables.

GenericMaterialProperty< std::vector< Real >, is_ad > &	_fluid_enthalpy
	Enthalpy of each phase.

MaterialProperty< std::vector< std::vector< Real > > > *const	_dfluid_enthalpy_dvar
	Derivative of the fluid enthalpy for each phase wrt PorousFlow variables.

GenericMaterialProperty< std::vector< Real >, is_ad > &	_fluid_internal_energy
	Internal energy of each phase.

MaterialProperty< std::vector< std::vector< Real > > > *const	_dfluid_internal_energy_dvar
	Derivative of the fluid internal energy for each phase wrt PorousFlow variables.

	usingPorousFlowVariableBaseMembers

const unsigned int	_num_phases
	Number of phases.

const unsigned int	_num_components
	Number of components.

const unsigned int	_num_pf_vars
	Number of PorousFlow variables.

GenericMaterialProperty< std::vector< Real >, is_ad > &	_porepressure
	Computed nodal or quadpoint values of porepressure of the phases.

MaterialProperty< std::vector< std::vector< Real > > > *const	_dporepressure_dvar
	d(porepressure)/d(PorousFlow variable)

GenericMaterialProperty< std::vector< RealGradient >, is_ad > *const	_gradp_qp
	Grad(p) at the quadpoints.

MaterialProperty< std::vector< std::vector< Real > > > *const	_dgradp_qp_dgradv
	d(grad porepressure)/d(grad PorousFlow variable) at the quadpoints

MaterialProperty< std::vector< std::vector< RealGradient > > > *const	_dgradp_qp_dv
	d(grad porepressure)/d(PorousFlow variable) at the quadpoints

GenericMaterialProperty< std::vector< Real >, is_ad > &	_saturation
	Computed nodal or qp saturation of the phases.

MaterialProperty< std::vector< std::vector< Real > > > *const	_dsaturation_dvar
	d(saturation)/d(PorousFlow variable)

GenericMaterialProperty< std::vector< RealGradient >, is_ad > *const	_grads_qp
	Grad(s) at the quadpoints.

MaterialProperty< std::vector< std::vector< Real > > > *const	_dgrads_qp_dgradv
	d(grad saturation)/d(grad PorousFlow variable) at the quadpoints

MaterialProperty< std::vector< std::vector< RealGradient > > > *const	_dgrads_qp_dv
	d(grad saturation)/d(PorousFlow variable) at the quadpoints

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 PorousFlowFluidStateTempl< is_ad >

Fluid state class using a persistent set of primary variables for the mutliphase, multicomponent case.

Primary variables are: gas pressure, total mass fraction of a component summed over all phases (and optionally temperature in a non-isothermal case).

The total mass fraction of component i summed over all phases, Z_i, is defined as (for two phases)

Z_i = (S_g rho_g Y_i + S_l rho_l X_i) / (S_g rho_g + S_l rho_l)

where S is saturation, rho is density, and the subscripts correspond to gas and liquid phases, respectively, and Y_i and X_i are the mass fractions of the ith component in the gas and liquid phase, respectively.

Depending on the phase conditions, the primary variable Z_i can represent either a mass fraction (when only a single phase is present), or a saturation when two phases are present, and hence it is a persistent variable.

The PorousFlow kernels expect saturation and mass fractions (as well as pressure and temperature), so these must be calculated from Z_i once the state of the system is determined.

A compositional flash calculation using the Rachford-Rice equation is solved to determine vapor fraction (gas saturation), and subsequently the composition of each phase.

Definition at line 47 of file PorousFlowFluidState.h.

Constructor & Destructor Documentation

◆ PorousFlowFluidStateTempl()

template<bool is_ad>

PorousFlowFluidStateTempl< is_ad >::PorousFlowFluidStateTempl ( const InputParameters & parameters )

Definition at line 33 of file PorousFlowFluidState.C.

  : PorousFlowFluidStateBaseMaterialTempl<is_ad>(parameters),
    _gas_porepressure(_nodal_material
                          ? this->template coupledGenericDofValue<is_ad>("gas_porepressure")
                          : this->template coupledGenericValue<is_ad>("gas_porepressure")),
    _gas_gradp_qp(this->template coupledGenericGradient<is_ad>("gas_porepressure")),
    _gas_porepressure_varnum(coupled("gas_porepressure")),
    _pvar(_dictator.isPorousFlowVariable(_gas_porepressure_varnum)
              ? _dictator.porousFlowVariableNum(_gas_porepressure_varnum)
              : 0),
    _num_Z_vars(coupledComponents("z")),
    _is_Xnacl_nodal(isCoupled("xnacl") ? getFieldVar("xnacl", 0)->isNodal() : false),
    _Xnacl(_nodal_material && _is_Xnacl_nodal
               ? this->template coupledGenericDofValue<is_ad>("xnacl")
               : this->template coupledGenericValue<is_ad>("xnacl")),
    _grad_Xnacl_qp(this->template coupledGenericGradient<is_ad>("xnacl")),
    _Xnacl_varnum(coupled("xnacl")),
    _Xvar(_dictator.isPorousFlowVariable(_Xnacl_varnum)
              ? _dictator.porousFlowVariableNum(_Xnacl_varnum)
              : 0),
    _fs(this->template getUserObject<PorousFlowFluidStateMultiComponentBase>("fluid_state")),
    _aqueous_phase_number(_fs.aqueousPhaseIndex()),
    _gas_phase_number(_fs.gasPhaseIndex()),
    _aqueous_fluid_component(_fs.aqueousComponentIndex()),
    _gas_fluid_component(_fs.gasComponentIndex()),
    _salt_component(_fs.saltComponentIndex()),
    _temperature(
        this->template getGenericMaterialProperty<Real, is_ad>("PorousFlow_temperature" + _sfx)),
    _gradT_qp(_nodal_material ? nullptr
                              : &this->template getGenericMaterialProperty<RealGradient, is_ad>(
                                    "PorousFlow_grad_temperature" + _sfx)),
    _dtemperature_dvar(is_ad ? nullptr
                             : &this->template getMaterialProperty<std::vector<Real>>(
                                   "dPorousFlow_temperature" + _sfx + "_dvar")),
    _temperature_varnum(coupled("temperature")),
    _Tvar(_dictator.isPorousFlowVariable(_temperature_varnum)
              ? _dictator.porousFlowVariableNum(_temperature_varnum)
              : 0),
    _pidx(_fs.getPressureIndex()),
    _Tidx(_fs.getTemperatureIndex()),
    _Zidx(_fs.getZIndex()),
    _Xidx(_fs.getXIndex())
{
  // Check that the number of phases in the fluidstate class is also provided in the Dictator
  if (_fs.numPhases() != _num_phases)
    mooseError(name(),
               ": only ",
               _fs.numPhases(),
               " phases are allowed. Please check the number of phases entered in the dictator is "
               "correct");
 
  // Store all total mass fractions and associated variable numbers
  _Z.resize(_num_Z_vars);
  _gradZ_qp.resize(_num_Z_vars);
  _Z_varnum.resize(_num_Z_vars);
  _Zvar.resize(_num_Z_vars);
 
  for (unsigned int i = 0; i < _num_Z_vars; ++i)
  {
    _Z[i] = (_nodal_material ? &this->template coupledGenericDofValue<is_ad>("z", i)
                             : &this->template coupledGenericValue<is_ad>("z", i));
    _gradZ_qp[i] = &this->template coupledGenericGradient<is_ad>("z", i);
    _Z_varnum[i] = coupled("z", i);
    _Zvar[i] = (_dictator.isPorousFlowVariable(_Z_varnum[i])
                    ? _dictator.porousFlowVariableNum(_Z_varnum[i])
                    : 0);
  }
}

Member Function Documentation

◆ computeQpProperties()

template<bool is_ad>

void PorousFlowFluidStateTempl< is_ad >::computeQpProperties ( )

overrideprotectedvirtual

Reimplemented from PorousFlowFluidStateBaseMaterialTempl< is_ad >.

Definition at line 122 of file PorousFlowFluidState.C.

{
  PorousFlowFluidStateBaseMaterialTempl<is_ad>::computeQpProperties();
 
  // If the material isn't AD, we need to compute the derivatives
  if (!is_ad)
  {
    // Derivative of properties wrt variables (calculated in fluid state class)
    for (unsigned int ph = 0; ph < _num_phases; ++ph)
    {
      // If porepressure is a PorousFlow variable (it usually is), add derivatives wrt
      // porepressure
      if (_dictator.isPorousFlowVariable(_gas_porepressure_varnum))
      {
        (*_dporepressure_dvar)[_qp][ph][_pvar] = _fsp[ph].pressure.derivatives()[_pidx];
        (*_dsaturation_dvar)[_qp][ph][_pvar] = _fsp[ph].saturation.derivatives()[_pidx];
        (*_dfluid_density_dvar)[_qp][ph][_pvar] = _fsp[ph].density.derivatives()[_pidx];
        (*_dfluid_viscosity_dvar)[_qp][ph][_pvar] = _fsp[ph].viscosity.derivatives()[_pidx];
        (*_dfluid_enthalpy_dvar)[_qp][ph][_pvar] = _fsp[ph].enthalpy.derivatives()[_pidx];
        (*_dfluid_internal_energy_dvar)[_qp][ph][_pvar] =
            _fsp[ph].internal_energy.derivatives()[_pidx];
 
        for (unsigned int comp = 0; comp < _num_components; ++comp)
          (*_dmass_frac_dvar)[_qp][ph][comp][_pvar] =
              _fsp[ph].mass_fraction[comp].derivatives()[_pidx];
      }
 
      // If Z is a PorousFlow variable (it usually is), add derivatives wrt Z
      if (_dictator.isPorousFlowVariable(_Z_varnum[0]))
      {
        (*_dporepressure_dvar)[_qp][ph][_Zvar[0]] = _fsp[ph].pressure.derivatives()[_Zidx];
        (*_dsaturation_dvar)[_qp][ph][_Zvar[0]] = _fsp[ph].saturation.derivatives()[_Zidx];
        (*_dfluid_density_dvar)[_qp][ph][_Zvar[0]] = _fsp[ph].density.derivatives()[_Zidx];
        (*_dfluid_viscosity_dvar)[_qp][ph][_Zvar[0]] = _fsp[ph].viscosity.derivatives()[_Zidx];
        (*_dfluid_enthalpy_dvar)[_qp][ph][_Zvar[0]] = _fsp[ph].enthalpy.derivatives()[_Zidx];
        (*_dfluid_internal_energy_dvar)[_qp][ph][_Zvar[0]] =
            _fsp[ph].internal_energy.derivatives()[_Zidx];
 
        for (unsigned int comp = 0; comp < _num_components; ++comp)
          (*_dmass_frac_dvar)[_qp][ph][comp][_Zvar[0]] =
              _fsp[ph].mass_fraction[comp].derivatives()[_Zidx];
      }
 
      // If temperature is a PorousFlow variable (nonisothermal case), add derivatives wrt
      // temperature
      if (_dictator.isPorousFlowVariable(_temperature_varnum))
      {
        (*_dporepressure_dvar)[_qp][ph][_Tvar] = _fsp[ph].pressure.derivatives()[_Tidx];
        (*_dsaturation_dvar)[_qp][ph][_Tvar] = _fsp[ph].saturation.derivatives()[_Tidx];
        (*_dfluid_density_dvar)[_qp][ph][_Tvar] = _fsp[ph].density.derivatives()[_Tidx];
        (*_dfluid_viscosity_dvar)[_qp][ph][_Tvar] = _fsp[ph].viscosity.derivatives()[_Tidx];
        (*_dfluid_enthalpy_dvar)[_qp][ph][_Tvar] = _fsp[ph].enthalpy.derivatives()[_Tidx];
        (*_dfluid_internal_energy_dvar)[_qp][ph][_Tvar] =
            _fsp[ph].internal_energy.derivatives()[_Tidx];
 
        for (unsigned int comp = 0; comp < _num_components; ++comp)
          (*_dmass_frac_dvar)[_qp][ph][comp][_Tvar] =
              _fsp[ph].mass_fraction[comp].derivatives()[_Tidx];
      }
 
      // If Xnacl is a PorousFlow variable, add derivatives wrt Xnacl
      if (_dictator.isPorousFlowVariable(_Xnacl_varnum))
      {
        (*_dporepressure_dvar)[_qp][ph][_Xvar] = _fsp[ph].pressure.derivatives()[_Xidx];
        (*_dsaturation_dvar)[_qp][ph][_Xvar] = _fsp[ph].saturation.derivatives()[_Xidx];
        (*_dfluid_density_dvar)[_qp][ph][_Xvar] += _fsp[ph].density.derivatives()[_Xidx];
        (*_dfluid_viscosity_dvar)[_qp][ph][_Xvar] += _fsp[ph].viscosity.derivatives()[_Xidx];
        (*_dfluid_enthalpy_dvar)[_qp][ph][_Xvar] = _fsp[ph].enthalpy.derivatives()[_Xidx];
        (*_dfluid_internal_energy_dvar)[_qp][ph][_Xvar] =
            _fsp[ph].internal_energy.derivatives()[_Xidx];
 
        for (unsigned int comp = 0; comp < _num_components; ++comp)
          (*_dmass_frac_dvar)[_qp][ph][comp][_Xvar] =
              _fsp[ph].mass_fraction[comp].derivatives()[_Xidx];
      }
    }
  }
 
  // If the material properties are being evaluated at the qps, calculate the gradients as well
  // Note: only nodal properties are evaluated in initQpStatefulProperties(), so no need to check
  // _is_initqp flag for qp properties
  if (!_nodal_material)
    if constexpr (!is_ad)
    {
      // Derivatives of capillary pressure
      const Real dpc = _pc.dCapillaryPressure(_fsp[_aqueous_phase_number].saturation.value(), _qp);
      const Real d2pc =
          _pc.d2CapillaryPressure(_fsp[_aqueous_phase_number].saturation.value(), _qp);
 
      // Gradients of saturation and porepressure in all phases
      (*_grads_qp)[_qp][_gas_phase_number] =
          (*_dsaturation_dvar)[_qp][_gas_phase_number][_pvar] * _gas_gradp_qp[_qp] +
          (*_dsaturation_dvar)[_qp][_gas_phase_number][_Zvar[0]] * (*_gradZ_qp[0])[_qp] +
          (*_dsaturation_dvar)[_qp][_gas_phase_number][_Tvar] * (*_gradT_qp)[_qp];
      (*_grads_qp)[_qp][_aqueous_phase_number] = -(*_grads_qp)[_qp][_gas_phase_number];
 
      (*_gradp_qp)[_qp][_gas_phase_number] = _gas_gradp_qp[_qp];
      (*_gradp_qp)[_qp][_aqueous_phase_number] =
          _gas_gradp_qp[_qp] - dpc * (*_grads_qp)[_qp][_aqueous_phase_number];
 
      // Gradients of mass fractions for each component in each phase
      (*_grad_mass_frac_qp)[_qp][_aqueous_phase_number][_aqueous_fluid_component] =
          _fsp[_aqueous_phase_number].mass_fraction[_aqueous_fluid_component].derivatives()[_pidx] *
              _gas_gradp_qp[_qp] +
          _fsp[_aqueous_phase_number].mass_fraction[_aqueous_fluid_component].derivatives()[_Zidx] *
              (*_gradZ_qp[0])[_qp] +
          _fsp[_aqueous_phase_number].mass_fraction[_aqueous_fluid_component].derivatives()[_Tidx] *
              (*_gradT_qp)[_qp];
      (*_grad_mass_frac_qp)[_qp][_aqueous_phase_number][_gas_fluid_component] =
          -(*_grad_mass_frac_qp)[_qp][_aqueous_phase_number][_aqueous_fluid_component];
 
      (*_grad_mass_frac_qp)[_qp][_gas_phase_number][_aqueous_fluid_component] =
          _fsp[_gas_phase_number].mass_fraction[_aqueous_fluid_component].derivatives()[_pidx] *
              _gas_gradp_qp[_qp] +
          _fsp[_gas_phase_number].mass_fraction[_aqueous_fluid_component].derivatives()[_Zidx] *
              (*_gradZ_qp[0])[_qp] +
          _fsp[_gas_phase_number].mass_fraction[_aqueous_fluid_component].derivatives()[_Tidx] *
              (*_gradT_qp)[_qp];
      (*_grad_mass_frac_qp)[_qp][_gas_phase_number][_gas_fluid_component] =
          -(*_grad_mass_frac_qp)[_qp][_gas_phase_number][_aqueous_fluid_component];
 
      // Derivatives of gradients wrt variables
      if (_dictator.isPorousFlowVariable(_gas_porepressure_varnum))
      {
        for (unsigned int ph = 0; ph < _num_phases; ++ph)
          (*_dgradp_qp_dgradv)[_qp][ph][_pvar] = 1.0;
 
        (*_dgradp_qp_dgradv)[_qp][_aqueous_phase_number][_pvar] +=
            -dpc * (*_dsaturation_dvar)[_qp][_aqueous_phase_number][_pvar];
 
        (*_dgradp_qp_dv)[_qp][_aqueous_phase_number][_pvar] =
            -d2pc * (*_grads_qp)[_qp][_aqueous_phase_number] *
            (*_dsaturation_dvar)[_qp][_aqueous_phase_number][_pvar];
      }
 
      if (_dictator.isPorousFlowVariable(_Z_varnum[0]))
      {
        (*_dgradp_qp_dgradv)[_qp][_aqueous_phase_number][_Zvar[0]] =
            -dpc * (*_dsaturation_dvar)[_qp][_aqueous_phase_number][_Zvar[0]];
 
        (*_dgradp_qp_dv)[_qp][_aqueous_phase_number][_Zvar[0]] =
            -d2pc * (*_grads_qp)[_qp][_aqueous_phase_number] *
            (*_dsaturation_dvar)[_qp][_aqueous_phase_number][_Zvar[0]];
      }
 
      if (_dictator.isPorousFlowVariable(_temperature_varnum))
      {
        (*_dgradp_qp_dgradv)[_qp][_aqueous_phase_number][_Tvar] =
            -dpc * (*_dsaturation_dvar)[_qp][_aqueous_phase_number][_Tvar];
 
        (*_dgradp_qp_dv)[_qp][_aqueous_phase_number][_Tvar] =
            -d2pc * (*_grads_qp)[_qp][_aqueous_phase_number] *
            (*_dsaturation_dvar)[_qp][_aqueous_phase_number][_Tvar];
      }
 
      // If Xnacl is a PorousFlow variable, add gradients and derivatives wrt Xnacl
      if (_dictator.isPorousFlowVariable(_Xnacl_varnum))
      {
        (*_dgradp_qp_dgradv)[_qp][_aqueous_phase_number][_Xvar] =
            -dpc * (*_dsaturation_dvar)[_qp][_aqueous_phase_number][_Xvar];
 
        (*_grads_qp)[_qp][_aqueous_phase_number] +=
            (*_dsaturation_dvar)[_qp][_aqueous_phase_number][_Xvar] * _grad_Xnacl_qp[_qp];
 
        (*_grads_qp)[_qp][_gas_phase_number] -=
            (*_dsaturation_dvar)[_qp][_aqueous_phase_number][_Xvar] * _grad_Xnacl_qp[_qp];
 
        (*_gradp_qp)[_qp][_aqueous_phase_number] -=
            dpc * (*_dsaturation_dvar)[_qp][_aqueous_phase_number][_Xvar] * _grad_Xnacl_qp[_qp];
 
        (*_dgradp_qp_dv)[_qp][_aqueous_phase_number][_Xvar] =
            -d2pc * (*_grads_qp)[_qp][_aqueous_phase_number] *
            (*_dsaturation_dvar)[_qp][_aqueous_phase_number][_Xvar];
 
        (*_grad_mass_frac_qp)[_qp][_aqueous_phase_number][_salt_component] = _grad_Xnacl_qp[_qp];
        (*_grad_mass_frac_qp)[_qp][_aqueous_phase_number][_aqueous_fluid_component] +=
            _fsp[_aqueous_phase_number]
                .mass_fraction[_aqueous_fluid_component]
                .derivatives()[_Xidx] *
            _grad_Xnacl_qp[_qp];
        (*_grad_mass_frac_qp)[_qp][_aqueous_phase_number][_gas_fluid_component] -=
            _fsp[_aqueous_phase_number]
                .mass_fraction[_aqueous_fluid_component]
                .derivatives()[_Xidx] *
            _grad_Xnacl_qp[_qp];
        (*_grad_mass_frac_qp)[_qp][_gas_phase_number][_aqueous_fluid_component] +=
            _fsp[_gas_phase_number].mass_fraction[_aqueous_fluid_component].derivatives()[_Xidx] *
            _grad_Xnacl_qp[_qp];
        (*_grad_mass_frac_qp)[_qp][_gas_phase_number][_gas_fluid_component] -=
            _fsp[_gas_phase_number].mass_fraction[_aqueous_fluid_component].derivatives()[_Xidx] *
            _grad_Xnacl_qp[_qp];
      }
    }
}

◆ genericValue() [1/3]

template<bool is_ad>

GenericReal< is_ad > PorousFlowFluidStateBaseMaterialTempl< is_ad >::genericValue ( const ADReal & value )

protectedinherited

Templated method that takes an ADReal value, and returns the raw value when is_ad = false, and the AD value when is_ad = true.

Parameters

value AD value

Returns: raw or AD value depending on is_ad

◆ genericValue() [2/3]

GenericReal< false > PorousFlowFluidStateBaseMaterialTempl< false >::genericValue ( const ADReal & value )

protectedinherited

Definition at line 76 of file PorousFlowFluidStateBaseMaterial.C.

{
  return MetaPhysicL::raw_value(value);
}

◆ genericValue() [3/3]

GenericReal< true > PorousFlowFluidStateBaseMaterialTempl< true >::genericValue ( const ADReal & value )

protectedinherited

Definition at line 83 of file PorousFlowFluidStateBaseMaterial.C.

{
  return value;
}

◆ initQpStatefulProperties()

template<bool is_ad>

void PorousFlowFluidStateTempl< is_ad >::initQpStatefulProperties ( )

overrideprotectedvirtual

Reimplemented from PorousFlowFluidStateBaseMaterialTempl< is_ad >.

Definition at line 115 of file PorousFlowFluidState.C.

{
  PorousFlowFluidStateBaseMaterialTempl<is_ad>::initQpStatefulProperties();
}

◆ setMaterialVectorSize()

template<bool is_ad>

void PorousFlowFluidStateBaseMaterialTempl< is_ad >::setMaterialVectorSize ( ) const

protectedvirtualinherited

Size material property vectors and initialise with zeros.

Reimplemented in PorousFlowFluidStateSingleComponentTempl< is_ad >.

Definition at line 149 of file PorousFlowFluidStateBaseMaterial.C.

{
  _fluid_density[_qp].resize(_num_phases, 0.0);
  _fluid_viscosity[_qp].resize(_num_phases, 0.0);
  _fluid_enthalpy[_qp].resize(_num_phases, 0.0);
  _fluid_internal_energy[_qp].resize(_num_phases, 0.0);
  _mass_frac[_qp].resize(_num_phases);
 
  for (unsigned int ph = 0; ph < _num_phases; ++ph)
    _mass_frac[_qp][ph].resize(_num_components);
 
  // Derivatives and gradients are not required in initQpStatefulProperties
  if (!_is_initqp)
  {
    // The gradient of the mass fractions are needed for qp materials and AD materials
    if (!_nodal_material || is_ad)
    {
      (*_grad_mass_frac_qp)[_qp].resize(_num_phases);
 
      for (unsigned int ph = 0; ph < _num_phases; ++ph)
        (*_grad_mass_frac_qp)[_qp][ph].assign(_num_components, RealGradient());
    }
 
    // No derivatives are required for AD materials
    if (!is_ad)
    {
      (*_dfluid_density_dvar)[_qp].resize(_num_phases);
      (*_dfluid_viscosity_dvar)[_qp].resize(_num_phases);
      (*_dfluid_enthalpy_dvar)[_qp].resize(_num_phases);
      (*_dfluid_internal_energy_dvar)[_qp].resize(_num_phases);
      (*_dmass_frac_dvar)[_qp].resize(_num_phases);
 
      for (unsigned int ph = 0; ph < _num_phases; ++ph)
      {
        (*_dfluid_density_dvar)[_qp][ph].assign(_num_pf_vars, 0.0);
        (*_dfluid_viscosity_dvar)[_qp][ph].assign(_num_pf_vars, 0.0);
        (*_dfluid_enthalpy_dvar)[_qp][ph].assign(_num_pf_vars, 0.0);
        (*_dfluid_internal_energy_dvar)[_qp][ph].assign(_num_pf_vars, 0.0);
        (*_dmass_frac_dvar)[_qp][ph].resize(_num_components);
 
        for (unsigned int comp = 0; comp < _num_components; ++comp)
          (*_dmass_frac_dvar)[_qp][ph][comp].assign(_num_pf_vars, 0.0);
      }
    }
  }
}

Referenced by PorousFlowFluidStateSingleComponentTempl< is_ad >::setMaterialVectorSize().

◆ thermophysicalProperties()

template<bool is_ad>

void PorousFlowFluidStateTempl< is_ad >::thermophysicalProperties ( )

overrideprotectedvirtual

Calculates all required thermophysical properties and derivatives for each phase and fluid component.

Implements PorousFlowFluidStateBaseMaterialTempl< is_ad >.

Definition at line 104 of file PorousFlowFluidState.C.

{
  // The FluidProperty objects use temperature in K
  const GenericReal<is_ad> Tk = _temperature[_qp] + _T_c2k;
 
  _fs.clearFluidStateProperties(_fsp);
  _fs.thermophysicalProperties(_gas_porepressure[_qp], Tk, _Xnacl[_qp], (*_Z[0])[_qp], _qp, _fsp);
}

◆ validParams()

template<bool is_ad>

InputParameters PorousFlowFluidStateTempl< is_ad >::validParams ( )

static

Definition at line 17 of file PorousFlowFluidState.C.

{
  InputParameters params = PorousFlowFluidStateBaseMaterialTempl<is_ad>::validParams();
  params.addRequiredCoupledVar("gas_porepressure",
                               "Variable that is the porepressure of the gas phase");
  params.addRequiredCoupledVar("z", "Total mass fraction of component i summed over all phases");
  params.addCoupledVar(
      "temperature", 20, "The fluid temperature (C or K, depending on temperature_unit)");
  params.addCoupledVar("xnacl", 0, "The salt mass fraction in the brine (kg/kg)");
  params.addRequiredParam<UserObjectName>("fluid_state", "Name of the FluidState UserObject");
  params.addClassDescription("Class for fluid state calculations using persistent primary "
                             "variables and a vapor-liquid flash");
  return params;
}

Member Data Documentation

◆ _aqueous_fluid_component

template<bool is_ad>

const unsigned int PorousFlowFluidStateTempl< is_ad >::_aqueous_fluid_component

protected

Fluid component number of the aqueous component.

Definition at line 94 of file PorousFlowFluidState.h.

◆ _aqueous_phase_number

template<bool is_ad>

const unsigned int PorousFlowFluidStateTempl< is_ad >::_aqueous_phase_number

protected

Phase number of the aqueous phase.

Definition at line 90 of file PorousFlowFluidState.h.

◆ _dfluid_density_dvar

template<bool is_ad>

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowFluidStateBaseMaterialTempl< is_ad >::_dfluid_density_dvar

protectedinherited

Derivative of the fluid density for each phase wrt PorousFlow variables.

Definition at line 70 of file PorousFlowFluidStateBaseMaterial.h.

◆ _dfluid_enthalpy_dvar

template<bool is_ad>

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowFluidStateBaseMaterialTempl< is_ad >::_dfluid_enthalpy_dvar

protectedinherited

Derivative of the fluid enthalpy for each phase wrt PorousFlow variables.

Definition at line 78 of file PorousFlowFluidStateBaseMaterial.h.

◆ _dfluid_internal_energy_dvar

template<bool is_ad>

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowFluidStateBaseMaterialTempl< is_ad >::_dfluid_internal_energy_dvar

protectedinherited

Derivative of the fluid internal energy for each phase wrt PorousFlow variables.

Definition at line 82 of file PorousFlowFluidStateBaseMaterial.h.

◆ _dfluid_viscosity_dvar

template<bool is_ad>

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowFluidStateBaseMaterialTempl< is_ad >::_dfluid_viscosity_dvar

protectedinherited

Derivative of the fluid viscosity for each phase wrt PorousFlow variables.

Definition at line 74 of file PorousFlowFluidStateBaseMaterial.h.

◆ _dgradp_qp_dgradv

template<bool is_ad>

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBaseTempl< is_ad >::_dgradp_qp_dgradv

protectedinherited

d(grad porepressure)/d(grad PorousFlow variable) at the quadpoints

Definition at line 51 of file PorousFlowVariableBase.h.

◆ _dgradp_qp_dv

template<bool is_ad>

MaterialProperty<std::vector<std::vector<RealGradient> > >* const PorousFlowVariableBaseTempl< is_ad >::_dgradp_qp_dv

protectedinherited

d(grad porepressure)/d(PorousFlow variable) at the quadpoints

Definition at line 54 of file PorousFlowVariableBase.h.

◆ _dgrads_qp_dgradv

template<bool is_ad>

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBaseTempl< is_ad >::_dgrads_qp_dgradv

protectedinherited

d(grad saturation)/d(grad PorousFlow variable) at the quadpoints

Definition at line 66 of file PorousFlowVariableBase.h.

◆ _dgrads_qp_dv

template<bool is_ad>

MaterialProperty<std::vector<std::vector<RealGradient> > >* const PorousFlowVariableBaseTempl< is_ad >::_dgrads_qp_dv

protectedinherited

d(grad saturation)/d(PorousFlow variable) at the quadpoints

Definition at line 69 of file PorousFlowVariableBase.h.

◆ _dmass_frac_dvar

template<bool is_ad>

MaterialProperty<std::vector<std::vector<std::vector<Real> > > >* const PorousFlowFluidStateBaseMaterialTempl< is_ad >::_dmass_frac_dvar

protectedinherited

Derivative of the mass fraction matrix with respect to the Porous Flow variables.

Definition at line 66 of file PorousFlowFluidStateBaseMaterial.h.

◆ _dporepressure_dvar

template<bool is_ad>

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBaseTempl< is_ad >::_dporepressure_dvar

protectedinherited

d(porepressure)/d(PorousFlow variable)

Definition at line 45 of file PorousFlowVariableBase.h.

◆ _dsaturation_dvar

template<bool is_ad>

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBaseTempl< is_ad >::_dsaturation_dvar

protectedinherited

d(saturation)/d(PorousFlow variable)

Definition at line 60 of file PorousFlowVariableBase.h.

◆ _dtemperature_dvar

template<bool is_ad>

const MaterialProperty<std::vector<Real> >* const PorousFlowFluidStateTempl< is_ad >::_dtemperature_dvar

protected

Derivative of temperature wrt PorousFlow variables.

Definition at line 104 of file PorousFlowFluidState.h.

◆ _fluid_density

template<bool is_ad>

GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowFluidStateBaseMaterialTempl< is_ad >::_fluid_density

protectedinherited

Fluid density of each phase.

Definition at line 68 of file PorousFlowFluidStateBaseMaterial.h.

◆ _fluid_enthalpy

template<bool is_ad>

GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowFluidStateBaseMaterialTempl< is_ad >::_fluid_enthalpy

protectedinherited

Enthalpy of each phase.

Definition at line 76 of file PorousFlowFluidStateBaseMaterial.h.

◆ _fluid_internal_energy

template<bool is_ad>

GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowFluidStateBaseMaterialTempl< is_ad >::_fluid_internal_energy

protectedinherited

Internal energy of each phase.

Definition at line 80 of file PorousFlowFluidStateBaseMaterial.h.

◆ _fluid_viscosity

template<bool is_ad>

GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowFluidStateBaseMaterialTempl< is_ad >::_fluid_viscosity

protectedinherited

Viscosity of each phase.

Definition at line 72 of file PorousFlowFluidStateBaseMaterial.h.

◆ _fs

template<bool is_ad>

const PorousFlowFluidStateMultiComponentBase& PorousFlowFluidStateTempl< is_ad >::_fs

protected

FluidState UserObject.

Definition at line 88 of file PorousFlowFluidState.h.

Referenced by PorousFlowFluidStateTempl< is_ad >::PorousFlowFluidStateTempl().

◆ _fsp

template<bool is_ad>

std::vector<FluidStateProperties> PorousFlowFluidStateBaseMaterialTempl< is_ad >::_fsp

protectedinherited

FluidStateProperties data for each fluid component in each fluid phase.

Definition at line 55 of file PorousFlowFluidStateBaseMaterial.h.

Referenced by PorousFlowFluidStateBaseMaterialTempl< is_ad >::PorousFlowFluidStateBaseMaterialTempl().

◆ _gas_fluid_component

template<bool is_ad>

const unsigned int PorousFlowFluidStateTempl< is_ad >::_gas_fluid_component

protected

Fluid component number of the gas phase.

Definition at line 96 of file PorousFlowFluidState.h.

◆ _gas_gradp_qp

template<bool is_ad>

const GenericVariableGradient<is_ad>& PorousFlowFluidStateTempl< is_ad >::_gas_gradp_qp

protected

Gradient of porepressure (only defined at the qps)

Definition at line 62 of file PorousFlowFluidState.h.

◆ _gas_phase_number

template<bool is_ad>

const unsigned int PorousFlowFluidStateTempl< is_ad >::_gas_phase_number

protected

Phase number of the gas phase.

Definition at line 92 of file PorousFlowFluidState.h.

◆ _gas_porepressure

template<bool is_ad>

const GenericVariableValue<is_ad>& PorousFlowFluidStateTempl< is_ad >::_gas_porepressure

protected

Porepressure.

Definition at line 60 of file PorousFlowFluidState.h.

◆ _gas_porepressure_varnum

template<bool is_ad>

const unsigned int PorousFlowFluidStateTempl< is_ad >::_gas_porepressure_varnum

protected

Moose variable number of the gas porepressure.

Definition at line 64 of file PorousFlowFluidState.h.

◆ _grad_mass_frac_qp

template<bool is_ad>

GenericMaterialProperty<std::vector<std::vector<RealGradient> >, is_ad>* const PorousFlowFluidStateBaseMaterialTempl< is_ad >::_grad_mass_frac_qp

protectedinherited

Gradient of the mass fraction matrix (only defined at the qps)

Definition at line 64 of file PorousFlowFluidStateBaseMaterial.h.

◆ _grad_Xnacl_qp

template<bool is_ad>

const GenericVariableGradient<is_ad>& PorousFlowFluidStateTempl< is_ad >::_grad_Xnacl_qp

protected

Gradient of salt mass fraction (only defined at the qps)

Definition at line 82 of file PorousFlowFluidState.h.

◆ _gradp_qp

template<bool is_ad>

GenericMaterialProperty<std::vector<RealGradient>, is_ad>* const PorousFlowVariableBaseTempl< is_ad >::_gradp_qp

protectedinherited

Grad(p) at the quadpoints.

Definition at line 48 of file PorousFlowVariableBase.h.

◆ _grads_qp

template<bool is_ad>

GenericMaterialProperty<std::vector<RealGradient>, is_ad>* const PorousFlowVariableBaseTempl< is_ad >::_grads_qp

protectedinherited

Grad(s) at the quadpoints.

Definition at line 63 of file PorousFlowVariableBase.h.

◆ _gradT_qp

template<bool is_ad>

const GenericMaterialProperty<RealGradient, is_ad>* const PorousFlowFluidStateTempl< is_ad >::_gradT_qp

protected

Gradient of temperature (only defined at the qps)

Definition at line 102 of file PorousFlowFluidState.h.

◆ _gradZ_qp

template<bool is_ad>

std::vector<const GenericVariableGradient<is_ad> *> PorousFlowFluidStateTempl< is_ad >::_gradZ_qp

protected

Gradient(s) of total mass fraction(s) of the gas component(s) (only defined at the qps)

Definition at line 70 of file PorousFlowFluidState.h.

Referenced by PorousFlowFluidStateTempl< is_ad >::PorousFlowFluidStateTempl().

◆ _is_initqp

template<bool is_ad>

bool PorousFlowFluidStateBaseMaterialTempl< is_ad >::_is_initqp

protectedinherited

Flag to indicate whether stateful properties should be computed.

Definition at line 53 of file PorousFlowFluidStateBaseMaterial.h.

◆ _is_Xnacl_nodal

template<bool is_ad>

const bool PorousFlowFluidStateTempl< is_ad >::_is_Xnacl_nodal

protected

Flag for nodal NaCl mass fraction.

Definition at line 78 of file PorousFlowFluidState.h.

◆ _mass_frac

template<bool is_ad>

GenericMaterialProperty<std::vector<std::vector<Real> >, is_ad>& PorousFlowFluidStateBaseMaterialTempl< is_ad >::_mass_frac

protectedinherited

Mass fraction matrix (indexing is fluid component in fluid phase)

Definition at line 62 of file PorousFlowFluidStateBaseMaterial.h.

◆ _num_components

template<bool is_ad>

const unsigned int PorousFlowVariableBaseTempl< is_ad >::_num_components

protectedinherited

Number of components.

Definition at line 36 of file PorousFlowVariableBase.h.

Referenced by PorousFlowFluidStateBaseMaterialTempl< is_ad >::PorousFlowFluidStateBaseMaterialTempl().

◆ _num_pf_vars

template<bool is_ad>

const unsigned int PorousFlowVariableBaseTempl< is_ad >::_num_pf_vars

protectedinherited

Number of PorousFlow variables.

Definition at line 39 of file PorousFlowVariableBase.h.

◆ _num_phases

template<bool is_ad>

const unsigned int PorousFlowVariableBaseTempl< is_ad >::_num_phases

protectedinherited

Number of phases.

Definition at line 33 of file PorousFlowVariableBase.h.

Referenced by PorousFlow2PhaseHysPS::computeQpProperties(), PorousFlow1PhaseFullySaturatedTempl< is_ad >::PorousFlow1PhaseFullySaturatedTempl(), PorousFlow1PhaseHysP::PorousFlow1PhaseHysP(), PorousFlow1PhaseMD_Gaussian::PorousFlow1PhaseMD_Gaussian(), PorousFlow1PhasePTempl< is_ad >::PorousFlow1PhasePTempl(), PorousFlow2PhaseHysPP::PorousFlow2PhaseHysPP(), PorousFlow2PhaseHysPS::PorousFlow2PhaseHysPS(), PorousFlow2PhasePPTempl< is_ad >::PorousFlow2PhasePPTempl(), PorousFlowFluidStateBaseMaterialTempl< is_ad >::PorousFlowFluidStateBaseMaterialTempl(), PorousFlowFluidStateSingleComponentTempl< is_ad >::PorousFlowFluidStateSingleComponentTempl(), and PorousFlowFluidStateTempl< is_ad >::PorousFlowFluidStateTempl().

◆ _num_Z_vars

template<bool is_ad>

const unsigned int PorousFlowFluidStateTempl< is_ad >::_num_Z_vars

protected

Number of coupled total mass fractions. Should be _num_phases - 1.

Definition at line 76 of file PorousFlowFluidState.h.

Referenced by PorousFlowFluidStateTempl< is_ad >::PorousFlowFluidStateTempl().

◆ _pc

template<bool is_ad>

const PorousFlowCapillaryPressure& PorousFlowFluidStateBaseMaterialTempl< is_ad >::_pc

protectedinherited

Capillary pressure UserObject.

Definition at line 57 of file PorousFlowFluidStateBaseMaterial.h.

◆ _pidx

template<bool is_ad>

const unsigned int PorousFlowFluidStateTempl< is_ad >::_pidx

protected

Index of derivative wrt pressure.

Definition at line 110 of file PorousFlowFluidState.h.

◆ _porepressure

template<bool is_ad>

GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowVariableBaseTempl< is_ad >::_porepressure

protectedinherited

Computed nodal or quadpoint values of porepressure of the phases.

Definition at line 42 of file PorousFlowVariableBase.h.

Referenced by PorousFlow1PhaseMD_Gaussian::buildPS(), PorousFlow1PhaseHysP::buildQpPPSS(), PorousFlow2PhaseHysPP::buildQpPPSS(), PorousFlow2PhaseHysPS::buildQpPPSS(), and PorousFlow1PhaseMD_Gaussian::computeQpProperties().

◆ _pvar

template<bool is_ad>

const unsigned int PorousFlowFluidStateTempl< is_ad >::_pvar

protected

PorousFlow variable number of the gas porepressure.

Definition at line 66 of file PorousFlowFluidState.h.

◆ _salt_component

template<bool is_ad>

const unsigned int PorousFlowFluidStateTempl< is_ad >::_salt_component

protected

Salt component index.

Definition at line 98 of file PorousFlowFluidState.h.

◆ _saturation

template<bool is_ad>

GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowVariableBaseTempl< is_ad >::_saturation

protectedinherited

Computed nodal or qp saturation of the phases.

Definition at line 57 of file PorousFlowVariableBase.h.

Referenced by PorousFlow1PhaseMD_Gaussian::buildPS(), PorousFlow1PhaseHysP::buildQpPPSS(), PorousFlow2PhaseHysPP::buildQpPPSS(), PorousFlow2PhaseHysPS::buildQpPPSS(), PorousFlow1PhaseMD_Gaussian::computeQpProperties(), PorousFlowHystereticInfo::computeQpProperties(), and PorousFlowHystereticInfo::initQpStatefulProperties().

◆ _sfx

template<bool is_ad>

const std::string PorousFlowFluidStateBaseMaterialTempl< is_ad >::_sfx

protectedinherited

Suffix to append to material property names (either qp or nodal as required)

Definition at line 59 of file PorousFlowFluidStateBaseMaterial.h.

◆ _T_c2k

template<bool is_ad>

const Real PorousFlowFluidStateBaseMaterialTempl< is_ad >::_T_c2k

protectedinherited

Conversion from degrees Celsius to degrees Kelvin.

Definition at line 51 of file PorousFlowFluidStateBaseMaterial.h.

◆ _temperature

template<bool is_ad>

const GenericMaterialProperty<Real, is_ad>& PorousFlowFluidStateTempl< is_ad >::_temperature

protected

Temperature.

Definition at line 100 of file PorousFlowFluidState.h.

◆ _temperature_varnum

template<bool is_ad>

const unsigned int PorousFlowFluidStateTempl< is_ad >::_temperature_varnum

protected

Moose variable number of the temperature.

Definition at line 106 of file PorousFlowFluidState.h.

◆ _Tidx

template<bool is_ad>

const unsigned int PorousFlowFluidStateTempl< is_ad >::_Tidx

protected

Index of derivative wrt temperature.

Definition at line 112 of file PorousFlowFluidState.h.

◆ _Tvar

template<bool is_ad>

const unsigned int PorousFlowFluidStateTempl< is_ad >::_Tvar

protected

PorousFlow variable number of the temperature.

Definition at line 108 of file PorousFlowFluidState.h.

◆ _Xidx

template<bool is_ad>

const unsigned int PorousFlowFluidStateTempl< is_ad >::_Xidx

protected

Index of derivative wrt salt mass fraction X.

Definition at line 116 of file PorousFlowFluidState.h.

◆ _Xnacl

template<bool is_ad>

const GenericVariableValue<is_ad>& PorousFlowFluidStateTempl< is_ad >::_Xnacl

protected

Salt mass fraction (kg/kg)

Definition at line 80 of file PorousFlowFluidState.h.

◆ _Xnacl_varnum

template<bool is_ad>

const unsigned int PorousFlowFluidStateTempl< is_ad >::_Xnacl_varnum

protected

Salt mass fraction variable number.

Definition at line 84 of file PorousFlowFluidState.h.

◆ _Xvar

template<bool is_ad>

const unsigned int PorousFlowFluidStateTempl< is_ad >::_Xvar

protected

Salt mass fraction PorousFlow variable number.

Definition at line 86 of file PorousFlowFluidState.h.

◆ _Z

template<bool is_ad>

std::vector<const GenericVariableValue<is_ad> *> PorousFlowFluidStateTempl< is_ad >::_Z

protected

Total mass fraction(s) of the gas component(s) summed over all phases.

Definition at line 68 of file PorousFlowFluidState.h.

Referenced by PorousFlowFluidStateTempl< is_ad >::PorousFlowFluidStateTempl().

◆ _Z_varnum

template<bool is_ad>

std::vector<unsigned int> PorousFlowFluidStateTempl< is_ad >::_Z_varnum

protected

Moose variable number of Z.

Definition at line 72 of file PorousFlowFluidState.h.

Referenced by PorousFlowFluidStateTempl< is_ad >::PorousFlowFluidStateTempl().

◆ _Zidx

template<bool is_ad>

const unsigned int PorousFlowFluidStateTempl< is_ad >::_Zidx

protected

Index of derivative wrt total mass fraction Z.

Definition at line 114 of file PorousFlowFluidState.h.

◆ _Zvar

template<bool is_ad>

std::vector<unsigned int> PorousFlowFluidStateTempl< is_ad >::_Zvar

protected

PorousFlow variable number of Z.

Definition at line 74 of file PorousFlowFluidState.h.

Referenced by PorousFlowFluidStateTempl< is_ad >::PorousFlowFluidStateTempl().

◆ usingPorousFlowFluidStateBaseMaterialDerivativeMembers

template<bool is_ad>

PorousFlowFluidStateTempl< is_ad >::usingPorousFlowFluidStateBaseMaterialDerivativeMembers

protected

Definition at line 121 of file PorousFlowFluidState.h.

◆ usingPorousFlowFluidStateBaseMaterialMembers

template<bool is_ad>

PorousFlowFluidStateTempl< is_ad >::usingPorousFlowFluidStateBaseMaterialMembers

protected

Definition at line 119 of file PorousFlowFluidState.h.

◆ usingPorousFlowVariableBaseMembers

template<bool is_ad>

PorousFlowFluidStateBaseMaterialTempl< is_ad >::usingPorousFlowVariableBaseMembers

protectedinherited

Definition at line 84 of file PorousFlowFluidStateBaseMaterial.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PorousFlowFluidStateTempl()

Member Function Documentation

◆ computeQpProperties()

◆ genericValue() [1/3]

◆ genericValue() [2/3]

◆ genericValue() [3/3]

◆ initQpStatefulProperties()

◆ setMaterialVectorSize()

◆ thermophysicalProperties()

◆ validParams()

Member Data Documentation

◆ _aqueous_fluid_component

◆ _aqueous_phase_number

◆ _dfluid_density_dvar

◆ _dfluid_enthalpy_dvar

◆ _dfluid_internal_energy_dvar

◆ _dfluid_viscosity_dvar

◆ _dgradp_qp_dgradv

◆ _dgradp_qp_dv

◆ _dgrads_qp_dgradv

◆ _dgrads_qp_dv

◆ _dmass_frac_dvar

◆ _dporepressure_dvar

◆ _dsaturation_dvar

◆ _dtemperature_dvar

◆ _fluid_density

◆ _fluid_enthalpy

◆ _fluid_internal_energy

◆ _fluid_viscosity

◆ _fs

◆ _fsp

◆ _gas_fluid_component

◆ _gas_gradp_qp

◆ _gas_phase_number

◆ _gas_porepressure

◆ _gas_porepressure_varnum

◆ _grad_mass_frac_qp

◆ _grad_Xnacl_qp

◆ _gradp_qp

◆ _grads_qp

◆ _gradT_qp

◆ _gradZ_qp

◆ _is_initqp

◆ _is_Xnacl_nodal

◆ _mass_frac

◆ _num_components

◆ _num_pf_vars

◆ _num_phases

◆ _num_Z_vars

◆ _pc

◆ _pidx

◆ _porepressure

◆ _pvar

◆ _salt_component

◆ _saturation

◆ _sfx

◆ _T_c2k

◆ _temperature

◆ _temperature_varnum

◆ _Tidx

◆ _Tvar

◆ _Xidx

◆ _Xnacl

◆ _Xnacl_varnum

◆ _Xvar

◆ _Z

◆ _Z_varnum

◆ _Zidx

◆ _Zvar

◆ usingPorousFlowFluidStateBaseMaterialDerivativeMembers

◆ usingPorousFlowFluidStateBaseMaterialMembers