Material designed to provide the porosity in PorousFlow simulations chemistry + biot + (phi0 - reference_chemistry - biot) * exp(-vol_strain. More...

#include <PorousFlowPorosity.h>

Inheritance diagram for PorousFlowPorosity:

[legend]

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	PorousFlowPorosity (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 Real	atNegInfinityQp () const override
	Returns "a" at the quadpoint (porosity = a + (b - a) * exp(decay)) More...

virtual Real	datNegInfinityQp (unsigned pvar) const override
	d(a)/d(PorousFlow variable pvar) More...

virtual Real	atZeroQp () const override
	Returns "b" at the quadpoint (porosity = a + (b - a) * exp(decay)) More...

virtual Real	datZeroQp (unsigned pvar) const override
	d(a)/d(PorousFlow variable pvar) More...

virtual Real	decayQp () const override
	Returns "decay" at the quadpoint (porosity = a + (b - a) * exp(decay)) More...

virtual Real	ddecayQp_dvar (unsigned pvar) const override
	d(decay)/d(PorousFlow variable pvar) More...

virtual RealGradient	ddecayQp_dgradvar (unsigned pvar) const override
	d(decay)/d(grad(PorousFlow variable pvar)) More...

virtual void	initQpStatefulProperties () override

virtual void	computeQpProperties () override

Protected Attributes
const bool	_mechanical
	Porosity is a function of volumetric strain. More...

const bool	_fluid
	Porosity is a function of effective porepressure. More...

const bool	_thermal
	Porosity is a function of temperature. More...

const bool	_chemical
	Porosity is a function of chemistry. More...

const VariableValue &	_phi0
	Porosity at zero strain and zero porepressure and zero temperature. More...

const Real	_biot
	Biot coefficient. More...

const Real	_exp_coeff
	Thermal expansion coefficient of the solid porous skeleton. More...

const Moose::Functor< Real > *	_solid_bulk
	Drained bulk modulus of the porous skeleton (as a functor; can be variable, function, etc.) Only used if _fluid is True. More...

const Real	_coeff
	Short-hand number (biot-1). Please note: this variable is not yet divided by solid_bulk. More...

const VariableValue &	_t_reference
	Reference temperature. More...

const VariableValue &	_p_reference
	Reference porepressure. More...

const unsigned	_num_c_ref
	Number of reference mineral concentrations provided by user. More...

std::vector< const VariableValue * >	_c_reference
	Reference mineral concentrations. More...

const unsigned	_num_initial_c
	Number of reference mineral concentrations provided by user. More...

std::vector< const VariableValue * >	_initial_c
	Reference mineral concentrations. More...

std::vector< Real >	_c_weights
	Weights for the mineral concentrations. More...

const MaterialProperty< Real > *const	_porosity_old
	Old value of porosity. More...

const MaterialProperty< Real > *const	_vol_strain_qp
	Strain (first const means we never want to dereference and change the value, second means we'll always be pointing to the same address after initialization (like a reference)) More...

const MaterialProperty< std::vector< RealGradient > > *const	_dvol_strain_qp_dvar
	d(strain)/(dvar) (first const means we never want to dereference and change the value, second means we'll always be pointing to the same address after initialization (like a reference)) More...

const MaterialProperty< Real > *const	_pf
	Effective porepressure at the quadpoints or nodes. More...

const MaterialProperty< std::vector< Real > > *const	_dpf_dvar
	d(effective porepressure)/(d porflow variable) More...

const MaterialProperty< Real > *const	_temperature
	Temperature at the quadpoints or nodes. More...

const MaterialProperty< std::vector< Real > > *const	_dtemperature_dvar
	d(temperature)/(d porflow variable) More...

const MaterialProperty< std::vector< Real > > *const	_mineral_conc_old
	Old value of mineral concentration at the quadpoints or nodes. More...

const MaterialProperty< std::vector< Real > > *const	_reaction_rate
	Reaction rate of mineralisation. More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_dreaction_rate_dvar
	d(reaction_rate_conc)/d(porflow variable) More...

const unsigned int	_aq_ph
	Aqueous phase number. More...

const MaterialProperty< std::vector< Real > > *const	_saturation
	Saturation. More...

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

const bool	_strain_at_nearest_qp
	When calculating nodal porosity, use the strain at the nearest quadpoint to the node. More...

const bool	_ensure_positive
	for decayQp() > 0, porosity can be negative when using porosity = a + (b - a) * exp(decay). More...

const Real	_porosity_min
	Minimum allowed porosity. More...

const Real	_zero_modifier
	If the porosity_min floor is active the porosity derivatives are set to _zero_modifier times their unfloored values (rather than exactly zero) to hint to the Newton process that porosity is not strictly constant, which aids convergence. More...

GenericMaterialProperty< Real, is_ad > &	_porosity
	Computed porosity at the nodes or quadpoints. More...

MaterialProperty< std::vector< Real > > *const	_dporosity_dvar
	d(porosity)/d(PorousFlow variable) More...

MaterialProperty< std::vector< RealGradient > > *const	_dporosity_dgradvar
	d(porosity)/d(grad PorousFlow variable) More...

const unsigned int	_num_phases
	Number of phases. More...

const unsigned int	_num_components
	Number of fluid components. More...

const unsigned int	_num_var
	Number of PorousFlow variables. More...

Detailed Description

Material designed to provide the porosity in PorousFlow simulations chemistry + biot + (phi0 - reference_chemistry - biot) * exp(-vol_strain.

coeff * (effective_pressure - reference_pressure)
thermal_exp_coeff * (temperature - reference_temperature))

Definition at line 20 of file PorousFlowPorosity.h.

Constructor & Destructor Documentation

◆ PorousFlowPorosity()

PorousFlowPorosity::PorousFlowPorosity ( const InputParameters & parameters )

Definition at line 61 of file PorousFlowPorosity.C.

   : PorousFlowPorosityExponentialBase(parameters),
 
     _mechanical(getParam<bool>("mechanical")),
     _fluid(getParam<bool>("fluid")),
     _thermal(getParam<bool>("thermal")),
     _chemical(getParam<bool>("chemical")),
     _phi0(coupledValue("porosity_zero")),
     _biot(getParam<Real>("biot_coefficient")),
     _exp_coeff(isParamValid("thermal_expansion_coeff") ? getParam<Real>("thermal_expansion_coeff")
                                                        : 0.0),
     _solid_bulk(isParamValid("solid_bulk") ? &(getFunctor<Real>("solid_bulk")) : nullptr),
     _coeff(isParamValid("biot_coefficient_prime") ? (getParam<Real>("biot_coefficient_prime") - 1.0)
                                                   : (_biot - 1.0)),
 
     _t_reference(_nodal_material ? coupledDofValues("reference_temperature")
                                  : coupledValue("reference_temperature")),
     _p_reference(_nodal_material ? coupledDofValues("reference_porepressure")
                                  : coupledValue("reference_porepressure")),
     _num_c_ref(coupledComponents("reference_chemistry")),
     _c_reference(_num_c_ref),
     _num_initial_c(coupledComponents("initial_mineral_concentrations")),
     _initial_c(_num_initial_c),
     _c_weights(isParamValid("chemical_weights") ? getParam<std::vector<Real>>("chemical_weights")
                                                 : std::vector<Real>(_num_c_ref, 1.0)),
 
     _porosity_old(_chemical ? (_nodal_material
                                    ? &getMaterialPropertyOld<Real>("PorousFlow_porosity_nodal")
                                    : &getMaterialPropertyOld<Real>("PorousFlow_porosity_qp"))
                             : nullptr),
     _vol_strain_qp(_mechanical ? &getMaterialProperty<Real>("PorousFlow_total_volumetric_strain_qp")
                                : nullptr),
     _dvol_strain_qp_dvar(_mechanical ? &getMaterialProperty<std::vector<RealGradient>>(
                                            "dPorousFlow_total_volumetric_strain_qp_dvar")
                                      : nullptr),
 
     _pf(_fluid ? (_nodal_material
                       ? &getMaterialProperty<Real>("PorousFlow_effective_fluid_pressure_nodal")
                       : &getMaterialProperty<Real>("PorousFlow_effective_fluid_pressure_qp"))
                : nullptr),
     _dpf_dvar(_fluid ? (_nodal_material ? &getMaterialProperty<std::vector<Real>>(
                                               "dPorousFlow_effective_fluid_pressure_nodal_dvar")
                                         : &getMaterialProperty<std::vector<Real>>(
                                               "dPorousFlow_effective_fluid_pressure_qp_dvar"))
                      : nullptr),
 
     _temperature(_thermal
                      ? (_nodal_material ? &getMaterialProperty<Real>("PorousFlow_temperature_nodal")
                                         : &getMaterialProperty<Real>("PorousFlow_temperature_qp"))
                      : nullptr),
     _dtemperature_dvar(
         _thermal
             ? (_nodal_material
                    ? &getMaterialProperty<std::vector<Real>>("dPorousFlow_temperature_nodal_dvar")
                    : &getMaterialProperty<std::vector<Real>>("dPorousFlow_temperature_qp_dvar"))
             : nullptr),
 
     _mineral_conc_old(_chemical ? (_nodal_material ? &getMaterialPropertyOld<std::vector<Real>>(
                                                          "PorousFlow_mineral_concentration_nodal")
                                                    : &getMaterialPropertyOld<std::vector<Real>>(
                                                          "PorousFlow_mineral_concentration_qp"))
                                 : nullptr),
     _reaction_rate(_chemical ? (_nodal_material ? &getMaterialProperty<std::vector<Real>>(
                                                       "PorousFlow_mineral_reaction_rate_nodal")
                                                 : &getMaterialProperty<std::vector<Real>>(
                                                       "PorousFlow_mineral_reaction_rate_qp"))
                              : nullptr),
     _dreaction_rate_dvar(_chemical ? (_nodal_material
                                           ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                                 "dPorousFlow_mineral_reaction_rate_nodal_dvar")
                                           : &getMaterialProperty<std::vector<std::vector<Real>>>(
                                                 "dPorousFlow_mineral_reaction_rate_qp_dvar"))
                                    : nullptr),
     _aq_ph(_dictator.aqueousPhaseNumber()),
     _saturation(_chemical
                     ? (_nodal_material
                            ? &getMaterialProperty<std::vector<Real>>("PorousFlow_saturation_nodal")
                            : &getMaterialProperty<std::vector<Real>>("PorousFlow_saturation_qp"))
                     : nullptr),
     _dsaturation_dvar(_chemical
                           ? (_nodal_material ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                                    "dPorousFlow_saturation_nodal_dvar")
                                              : &getMaterialProperty<std::vector<std::vector<Real>>>(
                                                    "dPorousFlow_saturation_qp_dvar"))
                           : nullptr)
 {
   if (_thermal && !isParamValid("thermal_expansion_coeff"))
     mooseError("PorousFlowPorosity: When thermal=true you must provide a thermal_expansion_coeff");
   if (_fluid && !_solid_bulk)
     mooseError("PorousFlowPorosity: When fluid=true you must provide a solid_bulk");
   if (_chemical && _num_c_ref != _dictator.numAqueousKinetic())
     mooseError("PorousFlowPorosity: When chemical=true you must provide the reference_chemistry "
                "values.  The Dictator proclaims there should be ",
                _dictator.numAqueousKinetic(),
                " of these");
   if (_chemical && _num_initial_c != _dictator.numAqueousKinetic())
     mooseError("PorousFlowPorosity: When chemical=true you must provide the "
                "initial_mineral_concentrations.  "
                "The Dictator proclaims there should be ",
                _dictator.numAqueousKinetic(),
                " of these");
   if (_chemical && _c_weights.size() != _dictator.numAqueousKinetic())
     mooseError(
         "PorousFlowPorosity: When chemical=true you must provde the correct number of "
         "chemical_weights (which the Dictator knows is ",
         _dictator.numAqueousKinetic(),
         ") or do not provide any chemical_weights and use the default value of 1 for each mineral");
 
   for (unsigned i = 0; i < _num_c_ref; ++i)
   {
     _c_reference[i] = (_nodal_material ? &coupledDofValues("reference_chemistry", i)
                                        : &coupledValue("reference_chemistry", i));
     _initial_c[i] = (_nodal_material ? &coupledDofValues("initial_mineral_concentrations", i)
                                      : &coupledValue("initial_mineral_concentrations", i));
   }
 }

Member Function Documentation

◆ atNegInfinityQp()

Real PorousFlowPorosity::atNegInfinityQp ( ) const

overrideprotectedvirtual

Returns "a" at the quadpoint (porosity = a + (b - a) * exp(decay))

Implements PorousFlowPorosityExponentialBase.

Definition at line 179 of file PorousFlowPorosity.C.

 {
   /*
    *
    * Note the use of the OLD value of porosity here.
    * This strategy, which breaks the cyclic dependency between porosity
    * and mineral concentration, is used in
    * Kernel: PorousFlowPreDis
    * Material: PorousFlowPorosity
    * Material: PorousFlowAqueousPreDisChemistry
    * Material: PorousFlowAqueousPreDisMineral
    *
    */
   Real result = _biot;
   if (_chemical)
   {
     if (_t_step == 0 && !_app.isRestarting())
       for (unsigned i = 0; i < _num_c_ref; ++i)
         result -= _c_weights[i] * (*_initial_c[i])[_qp];
     else
       for (unsigned i = 0; i < _num_c_ref; ++i)
         result -= _c_weights[i] * ((*_mineral_conc_old)[_qp][i] + _dt * (*_porosity_old)[_qp] *
                                                                       (*_saturation)[_qp][_aq_ph] *
                                                                       (*_reaction_rate)[_qp][i]);
   }
   return result;
 }

◆ atZeroQp()

Real PorousFlowPorosity::atZeroQp ( ) const

overrideprotectedvirtual

Returns "b" at the quadpoint (porosity = a + (b - a) * exp(decay))

Implements PorousFlowPorosityExponentialBase.

Definition at line 220 of file PorousFlowPorosity.C.

 {
   // note the [0] below: _phi0 is a constant monomial and we use [0] regardless of _nodal_material
   Real result = _phi0[0];
   if (_chemical)
   {
     if (_t_step == 0 && !_app.isRestarting())
       for (unsigned i = 0; i < _num_c_ref; ++i)
         result -= _c_weights[i] * ((*_initial_c[i])[_qp] - (*_c_reference[i])[_qp]);
     else
       for (unsigned i = 0; i < _num_c_ref; ++i)
         result -= _c_weights[i] * ((*_mineral_conc_old)[_qp][i] +
                                    _dt * (*_porosity_old)[_qp] * (*_saturation)[_qp][_aq_ph] *
                                        (*_reaction_rate)[_qp][i] -
                                    (*_c_reference[i])[_qp]);
   }
   return result;
 }

◆ computeQpProperties()

void PorousFlowPorosityExponentialBase::computeQpProperties ( )

overrideprotectedvirtualinherited

Reimplemented in PorousFlowPorosityHMBiotModulus.

Definition at line 85 of file PorousFlowPorosityExponentialBase.C.

 {
   const Real a = atNegInfinityQp();
   const Real b = atZeroQp();
   const Real decay = decayQp();
   Real exp_term = 1.0; // set appropriately below
 
   Real deriv = 0.0; // = d(porosity)/d(decay)
   if (decay <= 0.0 || !_ensure_positive)
   {
     exp_term = std::exp(decay);
     _porosity[_qp] = a + (b - a) * exp_term;
     deriv = _porosity[_qp] - a;
   }
   else
   {
     const Real c = std::log(a / (a - b));
     const Real expx = std::exp(-decay / c);
     // note that at decay = 0, we have expx = 1, so porosity = a + b - a = b
     // and at decay = infinity, expx = 0, so porosity = a + (b - a) * a / (a - b) = 0
     exp_term = std::exp(c * (1.0 - expx));
     _porosity[_qp] = a + (b - a) * exp_term;
     deriv = (_porosity[_qp] - a) * expx;
   }
 
   (*_dporosity_dvar)[_qp].resize(_num_var);
   (*_dporosity_dgradvar)[_qp].resize(_num_var);
   for (unsigned int v = 0; v < _num_var; ++v)
   {
     (*_dporosity_dvar)[_qp][v] = ddecayQp_dvar(v) * deriv;
     (*_dporosity_dgradvar)[_qp][v] = ddecayQp_dgradvar(v) * deriv;
 
     const Real da = datNegInfinityQp(v);
     const Real db = datZeroQp(v);
     (*_dporosity_dvar)[_qp][v] += da * (1 - exp_term) + db * exp_term;
 
     if (!(decay <= 0.0 || !_ensure_positive))
     {
       const Real c = std::log(a / (a - b));
       const Real expx = std::exp(-decay / c);
       const Real dc = (a - b) * (da * b / a - db) / std::pow(a, 2);
       (*_dporosity_dvar)[_qp][v] += (b - a) * exp_term * dc * (1 - expx - expx / c);
     }
   }
 
   // Apply the porosity floor last, after the unfloored derivatives above have been
   // formed.  When floored, soften the derivatives with _zero_modifier so the Newton
   // process still sees porosity as weakly varying (cf. PorousFlowPorosityLinear).
   if (_porosity[_qp] < _porosity_min)
   {
     _porosity[_qp] = _porosity_min;
     for (unsigned int v = 0; v < _num_var; ++v)
     {
       (*_dporosity_dvar)[_qp][v] *= _zero_modifier;
       (*_dporosity_dgradvar)[_qp][v] *= _zero_modifier;
     }
   }
 }

◆ datNegInfinityQp()

Real PorousFlowPorosity::datNegInfinityQp ( unsigned pvar ) const

overrideprotectedvirtual

d(a)/d(PorousFlow variable pvar)

Implements PorousFlowPorosityExponentialBase.

Definition at line 208 of file PorousFlowPorosity.C.

 {
   Real result = 0.0;
   if (_chemical && (_t_step >= 1 || _app.isRestarting()))
     for (unsigned i = 0; i < _num_c_ref; ++i)
       result -= _c_weights[i] * _dt * (*_porosity_old)[_qp] *
                 ((*_saturation)[_qp][_aq_ph] * (*_dreaction_rate_dvar)[_qp][i][pvar] +
                  (*_dsaturation_dvar)[_qp][_aq_ph][pvar] * (*_reaction_rate)[_qp][i]);
   return result;
 }

◆ datZeroQp()

Real PorousFlowPorosity::datZeroQp ( unsigned pvar ) const

overrideprotectedvirtual

d(a)/d(PorousFlow variable pvar)

Implements PorousFlowPorosityExponentialBase.

Definition at line 240 of file PorousFlowPorosity.C.

 {
   Real result = 0.0;
   if (_chemical && (_t_step >= 1 || _app.isRestarting()))
     for (unsigned i = 0; i < _num_c_ref; ++i)
       result -= _c_weights[i] * _dt * (*_porosity_old)[_qp] *
                 ((*_saturation)[_qp][_aq_ph] * (*_dreaction_rate_dvar)[_qp][i][pvar] +
                  (*_dsaturation_dvar)[_qp][_aq_ph][pvar] * (*_reaction_rate)[_qp][i]);
   return result;
 }

◆ ddecayQp_dgradvar()

RealGradient PorousFlowPorosity::ddecayQp_dgradvar ( unsigned pvar ) const

overrideprotectedvirtual

d(decay)/d(grad(PorousFlow variable pvar))

Implements PorousFlowPorosityExponentialBase.

Definition at line 341 of file PorousFlowPorosity.C.

 {
   RealGradient result(0.0, 0.0, 0.0);
   if (_mechanical)
   {
     const unsigned qp_to_use =
         (_nodal_material && (_bnd || _strain_at_nearest_qp) ? nearestQP(_qp) : _qp);
     result += -(*_dvol_strain_qp_dvar)[qp_to_use][pvar];
   }
   return result;
 }

◆ ddecayQp_dvar()

Real PorousFlowPorosity::ddecayQp_dvar ( unsigned pvar ) const

overrideprotectedvirtual

d(decay)/d(PorousFlow variable pvar)

Implements PorousFlowPorosityExponentialBase.

Definition at line 302 of file PorousFlowPorosity.C.

 {
   Real result = 0.0;
 
   if (_thermal)
     result += _exp_coeff * (*_dtemperature_dvar)[_qp][pvar];
 
   if (_fluid)
   {
     Real solid_bulk;
     // Using Qp 0 can leverage the functor caching
     // TODO: Find a way to effectively use subdomain-constant-ness
     unsigned int qp_used = (_constant_option == ConstantTypeEnum::NONE) ? _qp : 0;
     if (_nodal_material)
     {
       const std::set<SubdomainID> subdomain_set = {_current_elem->subdomain_id()};
       const Moose::NodeArg space_arg = {_current_elem->node_ptr(qp_used), &subdomain_set};
       solid_bulk = (*_solid_bulk)(space_arg, Moose::currentState());
     }
     else if (_bnd)
     {
       const Moose::ElemSideQpArg space_arg = {
           _current_elem, _current_side, qp_used, _qrule, _q_point[qp_used]};
       solid_bulk = (*_solid_bulk)(space_arg, Moose::currentState());
     }
     else
     {
       const Moose::ElemQpArg space_arg = {_current_elem, qp_used, _qrule, _q_point[qp_used]};
       solid_bulk = (*_solid_bulk)(space_arg, Moose::currentState());
     }
     if (solid_bulk <= 0)
       mooseError("PorousFlowPorosity: solid_bulk must be larger than Zero.");
     result += _coeff / solid_bulk * (*_dpf_dvar)[_qp][pvar];
   }
 
   return result;
 }

◆ decayQp()

Real PorousFlowPorosity::decayQp ( ) const

overrideprotectedvirtual

Returns "decay" at the quadpoint (porosity = a + (b - a) * exp(decay))

Implements PorousFlowPorosityExponentialBase.

Definition at line 252 of file PorousFlowPorosity.C.

 {
   Real result = 0.0;
 
   if (_thermal)
     result += _exp_coeff * ((*_temperature)[_qp] - _t_reference[_qp]);
 
   if (_fluid)
   {
     Real solid_bulk;
     // Using Qp 0 can leverage the functor caching
     // TODO: Find a way to effectively use subdomain-constant-ness
     unsigned int qp_used = (_constant_option == ConstantTypeEnum::NONE) ? _qp : 0;
     if (_nodal_material)
     {
       const std::set<SubdomainID> subdomain_set = {_current_elem->subdomain_id()};
       const Moose::NodeArg space_arg = {_current_elem->node_ptr(qp_used), &subdomain_set};
       solid_bulk = (*_solid_bulk)(space_arg, Moose::currentState());
     }
     else if (_bnd)
     {
       const Moose::ElemSideQpArg space_arg = {
           _current_elem, _current_side, qp_used, _qrule, _q_point[qp_used]};
       solid_bulk = (*_solid_bulk)(space_arg, Moose::currentState());
     }
     else
     {
       const Moose::ElemQpArg space_arg = {_current_elem, qp_used, _qrule, _q_point[qp_used]};
       solid_bulk = (*_solid_bulk)(space_arg, Moose::currentState());
     }
     if (solid_bulk <= 0)
       mooseError("PorousFlowPorosity: solid_bulk must be larger than Zero");
     result += _coeff / solid_bulk * ((*_pf)[_qp] - _p_reference[_qp]);
   }
 
   if (_mechanical)
   {
     // Note that in the following _strain[_qp] is evaluated at q quadpoint
     // So _porosity_nodal[_qp], which should be the nodal value of porosity
     // actually uses the strain at a quadpoint.  This
     // is OK for LINEAR elements, as strain is constant over the element anyway.
     const unsigned qp_to_use =
         (_nodal_material && (_bnd || _strain_at_nearest_qp) ? nearestQP(_qp) : _qp);
     result += -(*_vol_strain_qp)[qp_to_use];
   }
 
   return result;
 }

◆ initQpStatefulProperties()

void PorousFlowPorosityExponentialBase::initQpStatefulProperties ( )

overrideprotectedvirtualinherited

Definition at line 64 of file PorousFlowPorosityExponentialBase.C.

 {
   const Real a = atNegInfinityQp();
   const Real b = atZeroQp();
   mooseAssert(a > b, "PorousFlowPorosityExponentialBase a must be larger than b");
   const Real decay = decayQp();
 
   if (decay <= 0.0 || !_ensure_positive)
     _porosity[_qp] = a + (b - a) * std::exp(decay);
   else
   {
     const Real c = std::log(a / (a - b));
     const Real expx = std::exp(-decay / c);
     _porosity[_qp] = a + (b - a) * std::exp(c * (1.0 - expx));
   }
 
   if (_porosity[_qp] < _porosity_min)
     _porosity[_qp] = _porosity_min;
 }

◆ validParams()

InputParameters PorousFlowPorosity::validParams ( )

static

Definition at line 15 of file PorousFlowPorosity.C.

Referenced by PorousFlowPorosityHMBiotModulus::validParams().

 {
   InputParameters params = PorousFlowPorosityExponentialBase::validParams();
   params.addParam<bool>(
       "mechanical", false, "If true, porosity will be a function of total volumetric strain");
   params.addParam<bool>(
       "fluid", false, "If true, porosity will be a function of effective porepressure");
   params.addParam<bool>("thermal", false, "If true, porosity will be a function of temperature");
   params.addParam<bool>("chemical", false, "If true, porosity will be a function of precipitate");
   params.addRequiredCoupledVar("porosity_zero",
                                "The porosity at zero volumetric strain and "
                                "reference temperature and reference effective "
                                "porepressure and reference chemistry.  This must be a real number "
                                "or a constant monomial variable (not a linear lagrange or other "
                                "type of variable)");
   params.addParam<Real>("thermal_expansion_coeff",
                         "Volumetric thermal expansion coefficient of the drained porous solid "
                         "skeleton (only used if thermal=true)");
   params.addRangeCheckedParam<Real>(
       "biot_coefficient", 1, "biot_coefficient>=0 & biot_coefficient<=1", "Biot coefficient");
   params.addParam<Real>("biot_coefficient_prime",
                         "Biot coefficient that appears in the term (biot_coefficient_prime - 1) * "
                         "(P - reference_porepressure) / solid_bulk.  If not provided, this "
                         "defaults to the standard biot_coefficient");
   params.addParam<MooseFunctorName>(
       "solid_bulk", "Bulk modulus of the drained porous solid skeleton (only used if fluid=true)");
   params.addCoupledVar(
       "reference_temperature", 0.0, "Reference temperature (only used if thermal=true)");
   params.addCoupledVar(
       "reference_porepressure", 0.0, "Reference porepressure (only used if fluid=true)");
   params.addCoupledVar("reference_chemistry",
                        "Reference values of the solid mineral concentrations "
                        "(m^3(precipitate)/m^3(porous material)), entered as "
                        "a vector (one value per mineral).  (Only used if chemical=true)");
   params.addCoupledVar(
       "initial_mineral_concentrations",
       "Initial mineral concentrations (m^3(precipitate)/m^3(porous material)), entered as "
       "a vector (one value per mineral).  (Only used if chemical=true)");
   params.addParam<std::vector<Real>>("chemical_weights",
                                      "When chemical=true, porosity is a linear combination of the "
                                      "solid mineral concentrations multiplied by these weights.  "
                                      "Default=1 for all minerals.");
   params.addClassDescription("This Material calculates the porosity PorousFlow simulations");
   return params;
 }

Member Data Documentation

◆ _aq_ph

const unsigned int PorousFlowPorosity::_aq_ph

protected

Aqueous phase number.

Definition at line 116 of file PorousFlowPorosity.h.

Referenced by atNegInfinityQp(), atZeroQp(), datNegInfinityQp(), and datZeroQp().

◆ _biot

const Real PorousFlowPorosity::_biot

protected

Biot coefficient.

Definition at line 52 of file PorousFlowPorosity.h.

Referenced by atNegInfinityQp(), and PorousFlowPorosityHMBiotModulus::computeQpProperties().

◆ _c_reference

std::vector<const VariableValue *> PorousFlowPorosity::_c_reference

protected

Reference mineral concentrations.

Definition at line 74 of file PorousFlowPorosity.h.

Referenced by atZeroQp(), and PorousFlowPorosity().

◆ _c_weights

std::vector<Real> PorousFlowPorosity::_c_weights

protected

Weights for the mineral concentrations.

Definition at line 83 of file PorousFlowPorosity.h.

Referenced by atNegInfinityQp(), atZeroQp(), datNegInfinityQp(), datZeroQp(), and PorousFlowPorosity().

◆ _chemical

const bool PorousFlowPorosity::_chemical

protected

Porosity is a function of chemistry.

Definition at line 46 of file PorousFlowPorosity.h.

Referenced by atNegInfinityQp(), atZeroQp(), datNegInfinityQp(), datZeroQp(), and PorousFlowPorosity().

◆ _coeff

const Real PorousFlowPorosity::_coeff

protected

Short-hand number (biot-1). Please note: this variable is not yet divided by solid_bulk.

Definition at line 62 of file PorousFlowPorosity.h.

Referenced by ddecayQp_dvar(), and decayQp().

◆ _dpf_dvar

const MaterialProperty<std::vector<Real> >* const PorousFlowPorosity::_dpf_dvar

protected

d(effective porepressure)/(d porflow variable)

Definition at line 98 of file PorousFlowPorosity.h.

◆ _dporosity_dgradvar

template<bool is_ad>

MaterialProperty<std::vector<RealGradient> >* const PorousFlowPorosityBaseTempl< is_ad >::_dporosity_dgradvar

protectedinherited

d(porosity)/d(grad PorousFlow variable)

Definition at line 33 of file PorousFlowPorosityBase.h.

Referenced by PorousFlowPorosityLinear::computeQpProperties(), and PorousFlowPorosityHMBiotModulus::computeQpProperties().

◆ _dporosity_dvar

template<bool is_ad>

MaterialProperty<std::vector<Real> >* const PorousFlowPorosityBaseTempl< is_ad >::_dporosity_dvar

protectedinherited

d(porosity)/d(PorousFlow variable)

Definition at line 30 of file PorousFlowPorosityBase.h.

Referenced by PorousFlowPorosityLinear::computeQpProperties(), and PorousFlowPorosityHMBiotModulus::computeQpProperties().

◆ _dreaction_rate_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowPorosity::_dreaction_rate_dvar

protected

d(reaction_rate_conc)/d(porflow variable)

Definition at line 113 of file PorousFlowPorosity.h.

◆ _dsaturation_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowPorosity::_dsaturation_dvar

protected

d(saturation)/d(PorousFlow var)

Definition at line 122 of file PorousFlowPorosity.h.

◆ _dtemperature_dvar

const MaterialProperty<std::vector<Real> >* const PorousFlowPorosity::_dtemperature_dvar

protected

d(temperature)/(d porflow variable)

Definition at line 104 of file PorousFlowPorosity.h.

◆ _dvol_strain_qp_dvar

const MaterialProperty<std::vector<RealGradient> >* const PorousFlowPorosity::_dvol_strain_qp_dvar

protected

d(strain)/(dvar) (first const means we never want to dereference and change the value, second means we'll always be pointing to the same address after initialization (like a reference))

Definition at line 92 of file PorousFlowPorosity.h.

◆ _ensure_positive

const bool PorousFlowPorosityExponentialBase::_ensure_positive

protectedinherited

for decayQp() > 0, porosity can be negative when using porosity = a + (b - a) * exp(decay).

This expression is modified if ensure_positive = true to read porosity = a + (b - a) * exp(c * (1 - Exp(- decay / c))) where c = log(a/(b-a))

Definition at line 73 of file PorousFlowPorosityExponentialBase.h.

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

◆ _exp_coeff

const Real PorousFlowPorosity::_exp_coeff

protected

Thermal expansion coefficient of the solid porous skeleton.

Definition at line 55 of file PorousFlowPorosity.h.

Referenced by ddecayQp_dvar(), and decayQp().

◆ _fluid

const bool PorousFlowPorosity::_fluid

protected

Porosity is a function of effective porepressure.

Definition at line 40 of file PorousFlowPorosity.h.

Referenced by ddecayQp_dvar(), decayQp(), and PorousFlowPorosity().

◆ _initial_c

std::vector<const VariableValue *> PorousFlowPorosity::_initial_c

protected

Reference mineral concentrations.

Definition at line 80 of file PorousFlowPorosity.h.

Referenced by atNegInfinityQp(), atZeroQp(), and PorousFlowPorosity().

◆ _mechanical

const bool PorousFlowPorosity::_mechanical

protected

Porosity is a function of volumetric strain.

Definition at line 37 of file PorousFlowPorosity.h.

Referenced by ddecayQp_dgradvar(), and decayQp().

◆ _mineral_conc_old

const MaterialProperty<std::vector<Real> >* const PorousFlowPorosity::_mineral_conc_old

protected

Old value of mineral concentration at the quadpoints or nodes.

Definition at line 107 of file PorousFlowPorosity.h.

Referenced by atNegInfinityQp(), and atZeroQp().

◆ _num_c_ref

const unsigned PorousFlowPorosity::_num_c_ref

protected

Number of reference mineral concentrations provided by user.

Definition at line 71 of file PorousFlowPorosity.h.

Referenced by atNegInfinityQp(), atZeroQp(), datNegInfinityQp(), datZeroQp(), and PorousFlowPorosity().

◆ _num_components

const unsigned int PorousFlowMaterialVectorBase::_num_components

protectedinherited

Number of fluid components.

Definition at line 30 of file PorousFlowMaterialVectorBase.h.

Referenced by PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), PorousFlowAqueousPreDisChemistry::PorousFlowAqueousPreDisChemistry(), PorousFlowDiffusivityBaseTempl< is_ad >::PorousFlowDiffusivityBaseTempl(), and PorousFlowMassFractionTempl< is_ad >::PorousFlowMassFractionTempl().

◆ _num_initial_c

const unsigned PorousFlowPorosity::_num_initial_c

protected

Number of reference mineral concentrations provided by user.

Definition at line 77 of file PorousFlowPorosity.h.

Referenced by PorousFlowPorosity().

◆ _num_phases

const unsigned int PorousFlowMaterialVectorBase::_num_phases

protectedinherited

Number of phases.

Definition at line 27 of file PorousFlowMaterialVectorBase.h.

Referenced by PorousFlowDiffusivityBaseTempl< is_ad >::PorousFlowDiffusivityBaseTempl(), PorousFlowDiffusivityConstTempl< is_ad >::PorousFlowDiffusivityConstTempl(), PorousFlowJoinerTempl< is_ad >::PorousFlowJoinerTempl(), PorousFlowMassFractionTempl< is_ad >::PorousFlowMassFractionTempl(), PorousFlowThermalConductivityFromPorosityTempl< is_ad >::PorousFlowThermalConductivityFromPorosityTempl(), PorousFlowThermalConductivityIdealTempl< is_ad >::PorousFlowThermalConductivityIdealTempl(), and PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity::PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity().

◆ _num_var

const unsigned int PorousFlowMaterialVectorBase::_num_var

protectedinherited

Number of PorousFlow variables.

Definition at line 33 of file PorousFlowMaterialVectorBase.h.

Referenced by PorousFlowVolumetricStrain::computeQpProperties(), PorousFlowAqueousPreDisChemistry::computeQpProperties(), PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), PorousFlowPorosityLinear::computeQpProperties(), PorousFlowPorosityHMBiotModulus::computeQpProperties(), PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity::computeQpProperties(), PorousFlowPorosityExponentialBase::computeQpProperties(), PorousFlowAqueousPreDisChemistry::initQpStatefulProperties(), and PorousFlowPorosityLinear::initQpStatefulProperties().

◆ _p_reference

const VariableValue& PorousFlowPorosity::_p_reference

protected

Reference porepressure.

Definition at line 68 of file PorousFlowPorosity.h.

Referenced by decayQp().

◆ _pf

const MaterialProperty<Real>* const PorousFlowPorosity::_pf

protected

Effective porepressure at the quadpoints or nodes.

Definition at line 95 of file PorousFlowPorosity.h.

Referenced by PorousFlowPorosityHMBiotModulus::computeQpProperties().

◆ _phi0

const VariableValue& PorousFlowPorosity::_phi0

protected

Porosity at zero strain and zero porepressure and zero temperature.

Definition at line 49 of file PorousFlowPorosity.h.

Referenced by atZeroQp().

◆ _porosity

template<bool is_ad>

GenericMaterialProperty<Real, is_ad>& PorousFlowPorosityBaseTempl< is_ad >::_porosity

protectedinherited

Computed porosity at the nodes or quadpoints.

Definition at line 27 of file PorousFlowPorosityBase.h.

Referenced by PorousFlowPorosityLinear::computeQpProperties(), PorousFlowPorosityHMBiotModulus::computeQpProperties(), PorousFlowPorosityExponentialBase::computeQpProperties(), PorousFlowPorosityLinear::initQpStatefulProperties(), and PorousFlowPorosityExponentialBase::initQpStatefulProperties().

◆ _porosity_min

const Real PorousFlowPorosityExponentialBase::_porosity_min

protectedinherited

Minimum allowed porosity.

The ensure_positive transform above only acts for decay > 0, so chemistry-driven porosity (which enters through "a" and "b", not "decay") is otherwise unbounded below and can go negative once pore space is filled by precipitated mineral. If the computed porosity is less than this value it is set to this value instead. Defaults to no floor.

Definition at line 82 of file PorousFlowPorosityExponentialBase.h.

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

◆ _porosity_old

const MaterialProperty<Real>* const PorousFlowPorosity::_porosity_old

protected

Old value of porosity.

Definition at line 86 of file PorousFlowPorosity.h.

Referenced by datNegInfinityQp(), and datZeroQp().

◆ _reaction_rate

const MaterialProperty<std::vector<Real> >* const PorousFlowPorosity::_reaction_rate

protected

Reaction rate of mineralisation.

Definition at line 110 of file PorousFlowPorosity.h.

◆ _saturation

const MaterialProperty<std::vector<Real> >* const PorousFlowPorosity::_saturation

protected

Saturation.

Definition at line 119 of file PorousFlowPorosity.h.

◆ _solid_bulk

const Moose::Functor<Real>* PorousFlowPorosity::_solid_bulk

protected

Drained bulk modulus of the porous skeleton (as a functor; can be variable, function, etc.) Only used if _fluid is True.

Definition at line 59 of file PorousFlowPorosity.h.

Referenced by PorousFlowPorosity().

◆ _strain_at_nearest_qp

const bool PorousFlowPorosityExponentialBase::_strain_at_nearest_qp

protectedinherited

When calculating nodal porosity, use the strain at the nearest quadpoint to the node.

Definition at line 64 of file PorousFlowPorosityExponentialBase.h.

Referenced by PorousFlowPorosityHMBiotModulus::computeQpProperties(), ddecayQp_dgradvar(), and decayQp().

◆ _t_reference

const VariableValue& PorousFlowPorosity::_t_reference

protected

Reference temperature.

Definition at line 65 of file PorousFlowPorosity.h.

Referenced by decayQp().

◆ _temperature

const MaterialProperty<Real>* const PorousFlowPorosity::_temperature

protected

Temperature at the quadpoints or nodes.

Definition at line 101 of file PorousFlowPorosity.h.

◆ _thermal

const bool PorousFlowPorosity::_thermal

protected

Porosity is a function of temperature.

Definition at line 43 of file PorousFlowPorosity.h.

Referenced by ddecayQp_dvar(), decayQp(), and PorousFlowPorosity().

◆ _vol_strain_qp

const MaterialProperty<Real>* const PorousFlowPorosity::_vol_strain_qp

protected

Strain (first const means we never want to dereference and change the value, second means we'll always be pointing to the same address after initialization (like a reference))

Definition at line 89 of file PorousFlowPorosity.h.

Referenced by PorousFlowPorosityHMBiotModulus::computeQpProperties().

◆ _zero_modifier

const Real PorousFlowPorosityExponentialBase::_zero_modifier

protectedinherited

If the porosity_min floor is active the porosity derivatives are set to _zero_modifier times their unfloored values (rather than exactly zero) to hint to the Newton process that porosity is not strictly constant, which aids convergence.

Definition at line 90 of file PorousFlowPorosityExponentialBase.h.

Referenced by PorousFlowPorosityExponentialBase::computeQpProperties().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PorousFlowPorosity()

Member Function Documentation

◆ atNegInfinityQp()

◆ atZeroQp()

◆ computeQpProperties()

◆ datNegInfinityQp()

◆ datZeroQp()

◆ ddecayQp_dgradvar()

◆ ddecayQp_dvar()

◆ decayQp()

◆ initQpStatefulProperties()

◆ validParams()

Member Data Documentation

◆ _aq_ph

◆ _biot

◆ _c_reference

◆ _c_weights

◆ _chemical

◆ _coeff

◆ _dpf_dvar

◆ _dporosity_dgradvar

◆ _dporosity_dvar

◆ _dreaction_rate_dvar

◆ _dsaturation_dvar

◆ _dtemperature_dvar

◆ _dvol_strain_qp_dvar

◆ _ensure_positive

◆ _exp_coeff

◆ _fluid

◆ _initial_c

◆ _mechanical

◆ _mineral_conc_old

◆ _num_c_ref

◆ _num_components

◆ _num_initial_c

◆ _num_phases

◆ _num_var

◆ _p_reference

◆ _pf

◆ _phi0

◆ _porosity

◆ _porosity_min

◆ _porosity_old

◆ _reaction_rate

◆ _saturation

◆ _solid_bulk

◆ _strain_at_nearest_qp

◆ _t_reference

◆ _temperature

◆ _thermal

◆ _vol_strain_qp

◆ _zero_modifier