This Matrial evolves porosity so that the PorousFlow equations match the standard equations of poroelasticity theory with a constant BiotModulus. More...

#include <PorousFlowPorosityHMBiotModulus.h>

Inheritance diagram for PorousFlowPorosityHMBiotModulus:

[legend]

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	PorousFlowPorosityHMBiotModulus (const InputParameters &parameters)

const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialProperty (const std::string &name)

const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialPropertyByName (const std::string &name)

Moose::Kokkos::MaterialProperty< U, dimension >	declareKokkosPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

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="")

Moose::Kokkos::MaterialProperty< U, dimension >	getKokkosMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

Moose::Kokkos::MaterialProperty< U, dimension >	getKokkosMaterialPropertyDerivative (const std::string &base, const SymbolName &c1)

Moose::Kokkos::MaterialProperty< U, dimension >	getKokkosMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

Moose::Kokkos::MaterialProperty< U, dimension >	getKokkosMaterialPropertyDerivative (const std::string &base, const SymbolName &c1)

Moose::Kokkos::MaterialProperty< U, dimension >	getKokkosMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)

Moose::Kokkos::MaterialProperty< U, dimension >	getKokkosMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)

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	computeQpProperties () override

virtual GenericReal< is_ad >	atNegInfinityQp () const override
	Returns "a" at the quadpoint (porosity = a + (b - a) * exp(decay))

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

virtual GenericReal< is_ad >	atZeroQp () const override
	Returns "b" at the quadpoint (porosity = a + (b - a) * exp(decay))

virtual Real	datZeroQp (unsigned pvar) const override
	d(b)/d(PorousFlow variable pvar)

virtual GenericReal< is_ad >	decayQp () const override
	Returns "decay" at the quadpoint (porosity = a + (b - a) * exp(decay))

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

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

virtual void	initQpStatefulProperties () override

void	applyPorosityMin ()
	If _porosity[_qp] < porosity_min, set _porosity[_qp] = porosity_min and multiply the derivatives of porosity by _zero_modifier (the derivative material properties for non-AD objects, and the AD derivatives for AD objects).

Protected Attributes
const MaterialProperty< Real > &	_porosity_old
	Old value of porosity.

const Real	_biot_modulus
	Constant biot modulus.

const Real	_fluid_bulk_modulus
	Constant fluid bulk modulus.

const MaterialProperty< Real > &	_pf_old
	Old value of effective fluid pressure.

const MaterialProperty< Real > &	_vol_strain_qp_old
	Old value of total volumetric strain.

const MaterialProperty< Real > &	_vol_strain_rate_qp
	Volumetric strain rate.

const MaterialProperty< std::vector< RealGradient > > &	_dvol_strain_rate_qp_dvar
	d(volumetric strain rate)/d(PorousFlow variable)

const bool	_mechanical
	Porosity is a function of volumetric strain.

const bool	_fluid
	Porosity is a function of effective porepressure.

const bool	_thermal
	Porosity is a function of temperature.

const bool	_chemical
	Porosity is a function of chemistry.

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

const Real	_biot
	Biot coefficient.

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

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.

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

const VariableValue &	_t_reference
	Reference temperature.

const VariableValue &	_p_reference
	Reference porepressure.

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

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

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

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

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

const GenericMaterialProperty< Real, is_ad > *const	_vol_strain_qp
	Strain.

const MaterialProperty< std::vector< RealGradient > > *const	_dvol_strain_qp_dvar
	d(strain)/(dvar)

const GenericMaterialProperty< Real, is_ad > *const	_pf
	Effective porepressure at the quadpoints or nodes.

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

const GenericMaterialProperty< Real, is_ad > *const	_temperature
	Temperature at the quadpoints or nodes.

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

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

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

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

const unsigned int	_aq_ph
	Aqueous phase number.

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

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

	usingPorousFlowPorosityExponentialBaseMembers

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

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

	usingPorousFlowPorosityBaseMembers

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

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

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

const Real	_porosity_min
	Minimum allowed porosity (default zero, so porosity is never negative)

const Real	_zero_modifier
	When the porosity_min floor is active, the porosity derivatives are multiplied by this.

const unsigned int	_num_phases
	Number of phases.

const unsigned int	_num_components
	Number of fluid components.

const unsigned int	_num_var
	Number of PorousFlow variables.

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

This Matrial evolves porosity so that the PorousFlow equations match the standard equations of poroelasticity theory with a constant BiotModulus.

Even though a constant BiotModulus is not strictly correct, many analytical solutions of poroelasticity theory assume this, so PorousFlowPorosityHMBiotModulus is useful for comparing with those solutions. Otherwise it shouldn't generally be used because PorousFlowPorosity is physically more correct.

Definition at line 23 of file PorousFlowPorosityHMBiotModulus.h.

Constructor & Destructor Documentation

◆ PorousFlowPorosityHMBiotModulus()

PorousFlowPorosityHMBiotModulus::PorousFlowPorosityHMBiotModulus ( const InputParameters & parameters )

Definition at line 35 of file PorousFlowPorosityHMBiotModulus.C.

  : PorousFlowPorosity(parameters),
    _porosity_old(_nodal_material ? getMaterialPropertyOld<Real>("PorousFlow_porosity_nodal")
                                  : getMaterialPropertyOld<Real>("PorousFlow_porosity_qp")),
    _biot_modulus(getParam<Real>("constant_biot_modulus")),
    _fluid_bulk_modulus(getParam<Real>("constant_fluid_bulk_modulus")),
    _pf_old(_nodal_material
                ? getMaterialPropertyOld<Real>("PorousFlow_effective_fluid_pressure_nodal")
                : getMaterialPropertyOld<Real>("PorousFlow_effective_fluid_pressure_qp")),
    _vol_strain_qp_old(getMaterialPropertyOld<Real>("PorousFlow_total_volumetric_strain_qp")),
    _vol_strain_rate_qp(getMaterialProperty<Real>("PorousFlow_volumetric_strain_rate_qp")),
    _dvol_strain_rate_qp_dvar(getMaterialProperty<std::vector<RealGradient>>(
        "dPorousFlow_volumetric_strain_rate_qp_dvar"))
{
}

Member Function Documentation

◆ applyPorosityMin()

template<bool is_ad>

void PorousFlowPorosityBaseTempl< is_ad >::applyPorosityMin ( )

protectedinherited

If _porosity[_qp] < porosity_min, set _porosity[_qp] = porosity_min and multiply the derivatives of porosity by _zero_modifier (the derivative material properties for non-AD objects, and the AD derivatives for AD objects).

Otherwise do nothing. Derived classes call this at the end of computeQpProperties(), after the unfloored porosity and its derivatives have been computed.

Definition at line 58 of file PorousFlowPorosityBase.C.

{
  if (MetaPhysicL::raw_value(_porosity[_qp]) >= _porosity_min)
    return;
 
  if constexpr (!is_ad)
  {
    _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;
    }
  }
  else
  {
    // The AD path carries its derivatives inside the value and has no derivative material
    // properties, so the value and the derivatives are softened separately.  Assigning
    // _porosity_min to the ADReal would instead discard the derivatives entirely.
    _porosity[_qp].value() = _porosity_min;
    _porosity[_qp].derivatives() *= _zero_modifier;
  }
}

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

◆ atNegInfinityQp()

template<bool is_ad>

GenericReal< is_ad > PorousFlowPorosityTempl< is_ad >::atNegInfinityQp ( ) const

overrideprotectedvirtualinherited

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

Implements PorousFlowPorosityExponentialBaseTempl< is_ad >.

Definition at line 207 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
   *
   */
  GenericReal<is_ad> 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()

template<bool is_ad>

GenericReal< is_ad > PorousFlowPorosityTempl< is_ad >::atZeroQp ( ) const

overrideprotectedvirtualinherited

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

Implements PorousFlowPorosityExponentialBaseTempl< is_ad >.

Definition at line 250 of file PorousFlowPorosity.C.

{
  // note the [0] below: _phi0 is a constant monomial and we use [0] regardless of _nodal_material
  GenericReal<is_ad> 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 PorousFlowPorosityHMBiotModulus::computeQpProperties ( )

overrideprotectedvirtual

Reimplemented from PorousFlowPorosityExponentialBaseTempl< is_ad >.

Definition at line 52 of file PorousFlowPorosityHMBiotModulus.C.

{
  // 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);
 
  const Real denom = (1.0 + _vol_strain_rate_qp[qp_to_use] * _dt + _vol_strain_qp_old[qp_to_use]);
  const Real s_p = _porosity_old[_qp] * (1 + _vol_strain_qp_old[qp_to_use]);
  _porosity[_qp] = (s_p * std::exp(-((*_pf)[_qp] - _pf_old[_qp]) / _fluid_bulk_modulus) +
                    ((*_pf)[_qp] - _pf_old[_qp]) / _biot_modulus +
                    _biot * ((*_vol_strain_qp)[qp_to_use] - _vol_strain_qp_old[qp_to_use])) /
                   denom;
 
  (*_dporosity_dvar)[_qp].resize(_num_var);
  for (unsigned int v = 0; v < _num_var; ++v)
    (*_dporosity_dvar)[_qp][v] =
        (*_dpf_dvar)[_qp][v] *
        (-s_p * std::exp(-((*_pf)[_qp] - _pf_old[_qp]) / _fluid_bulk_modulus) /
             _fluid_bulk_modulus +
         1.0 / _biot_modulus) /
        denom;
 
  (*_dporosity_dgradvar)[_qp].resize(_num_var);
  for (unsigned int v = 0; v < _num_var; ++v)
    (*_dporosity_dgradvar)[_qp][v] =
        _biot * (*_dvol_strain_qp_dvar)[qp_to_use][v] / denom -
        _porosity[_qp] / denom * _dvol_strain_rate_qp_dvar[qp_to_use][v] * _dt;
 
  applyPorosityMin();
}

◆ datNegInfinityQp()

template<bool is_ad>

Real PorousFlowPorosityTempl< is_ad >::datNegInfinityQp ( unsigned pvar ) const

overrideprotectedvirtualinherited

d(a)/d(PorousFlow variable pvar)

Implements PorousFlowPorosityExponentialBaseTempl< is_ad >.

Definition at line 237 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()

template<bool is_ad>

Real PorousFlowPorosityTempl< is_ad >::datZeroQp ( unsigned pvar ) const

overrideprotectedvirtualinherited

d(b)/d(PorousFlow variable pvar)

Implements PorousFlowPorosityExponentialBaseTempl< is_ad >.

Definition at line 271 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()

template<bool is_ad>

RealGradient PorousFlowPorosityTempl< is_ad >::ddecayQp_dgradvar ( unsigned pvar ) const

overrideprotectedvirtualinherited

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

Implements PorousFlowPorosityExponentialBaseTempl< is_ad >.

Definition at line 375 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()

template<bool is_ad>

Real PorousFlowPorosityTempl< is_ad >::ddecayQp_dvar ( unsigned pvar ) const

overrideprotectedvirtualinherited

d(decay)/d(PorousFlow variable pvar)

Implements PorousFlowPorosityExponentialBaseTempl< is_ad >.

Definition at line 335 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 == Material::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)
      this->mooseError("PorousFlowPorosity: solid_bulk must be larger than Zero.");
    result += _coeff / solid_bulk * (*_dpf_dvar)[_qp][pvar];
  }
 
  return result;
}

◆ decayQp()

template<bool is_ad>

GenericReal< is_ad > PorousFlowPorosityTempl< is_ad >::decayQp ( ) const

overrideprotectedvirtualinherited

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

Implements PorousFlowPorosityExponentialBaseTempl< is_ad >.

Definition at line 284 of file PorousFlowPorosity.C.

{
  GenericReal<is_ad> 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 == Material::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)
      this->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()

template<bool is_ad>

void PorousFlowPorosityExponentialBaseTempl< is_ad >::initQpStatefulProperties ( )

overrideprotectedvirtualinherited

Definition at line 55 of file PorousFlowPorosityExponentialBase.C.

{
  // Unqualified calls so ADL finds the MetaPhysicL overloads for the AD (DualNumber) instantiation
  using std::exp;
  using std::log;
 
  const GenericReal<is_ad> a = atNegInfinityQp();
  const GenericReal<is_ad> b = atZeroQp();
  mooseAssert(a > b, "PorousFlowPorosityExponentialBase a must be larger than b");
  const GenericReal<is_ad> decay = decayQp();
 
  if (decay <= 0.0 || !_ensure_positive)
    _porosity[_qp] = a + (b - a) * exp(decay);
  else
  {
    const GenericReal<is_ad> c = log(a / (a - b));
    const GenericReal<is_ad> expx = exp(-decay / c);
    _porosity[_qp] = a + (b - a) * exp(c * (1.0 - expx));
  }
 
  if (_porosity[_qp] < _porosity_min)
    _porosity[_qp] = _porosity_min;
}

◆ validParams()

InputParameters PorousFlowPorosityHMBiotModulus::validParams ( )

static

Definition at line 16 of file PorousFlowPorosityHMBiotModulus.C.

{
  InputParameters params = PorousFlowPorosity::validParams();
  params.set<bool>("mechanical") = true;
  params.set<bool>("fluid") = true;
  params.addRequiredRangeCheckedParam<Real>("constant_biot_modulus",
                                            "constant_biot_modulus>0",
                                            "Biot modulus, which is constant for this Material");
  params.addRequiredRangeCheckedParam<Real>(
      "constant_fluid_bulk_modulus",
      "constant_fluid_bulk_modulus>0",
      "Fluid bulk modulus, which is constant for this Material");
  params.addClassDescription(
      "This Material calculates the porosity for hydro-mechanical simulations, assuming that the "
      "Biot modulus and the fluid bulk modulus are both constant.  This is useful for comparing "
      "with solutions from poroelasticity theory, but is less accurate than PorousFlowPorosity");
  return params;
}

Member Data Documentation

◆ _aq_ph

template<bool is_ad>

const unsigned int PorousFlowPorosityTempl< is_ad >::_aq_ph

protectedinherited

Aqueous phase number.

Definition at line 117 of file PorousFlowPorosity.h.

◆ _biot

template<bool is_ad>

const Real PorousFlowPorosityTempl< is_ad >::_biot

protectedinherited

Biot coefficient.

Definition at line 53 of file PorousFlowPorosity.h.

Referenced by computeQpProperties().

◆ _biot_modulus

const Real PorousFlowPorosityHMBiotModulus::_biot_modulus

protected

Constant biot modulus.

Definition at line 37 of file PorousFlowPorosityHMBiotModulus.h.

Referenced by computeQpProperties().

◆ _c_reference

template<bool is_ad>

std::vector<const VariableValue *> PorousFlowPorosityTempl< is_ad >::_c_reference

protectedinherited

Reference mineral concentrations.

Definition at line 75 of file PorousFlowPorosity.h.

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

◆ _c_weights

template<bool is_ad>

std::vector<Real> PorousFlowPorosityTempl< is_ad >::_c_weights

protectedinherited

Weights for the mineral concentrations.

Definition at line 84 of file PorousFlowPorosity.h.

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

◆ _chemical

template<bool is_ad>

const bool PorousFlowPorosityTempl< is_ad >::_chemical

protectedinherited

Porosity is a function of chemistry.

Definition at line 47 of file PorousFlowPorosity.h.

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

◆ _coeff

template<bool is_ad>

const Real PorousFlowPorosityTempl< is_ad >::_coeff

protectedinherited

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

Definition at line 63 of file PorousFlowPorosity.h.

◆ _dpf_dvar

template<bool is_ad>

const MaterialProperty<std::vector<Real> >* const PorousFlowPorosityTempl< is_ad >::_dpf_dvar

protectedinherited

d(effective porepressure)/(d porflow variable)

Definition at line 99 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 42 of file PorousFlowPorosityBase.h.

Referenced by 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 39 of file PorousFlowPorosityBase.h.

Referenced by computeQpProperties(), and PorousFlowPorosityVinsomeWesterveld::computeUnboundedPorosityQp().

◆ _dreaction_rate_dvar

template<bool is_ad>

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowPorosityTempl< is_ad >::_dreaction_rate_dvar

protectedinherited

d(reaction_rate_conc)/d(porflow variable)

Definition at line 114 of file PorousFlowPorosity.h.

◆ _dsaturation_dvar

template<bool is_ad>

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

protectedinherited

d(saturation)/d(PorousFlow var)

Definition at line 123 of file PorousFlowPorosity.h.

◆ _dtemperature_dvar

template<bool is_ad>

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

protectedinherited

d(temperature)/(d porflow variable)

Definition at line 105 of file PorousFlowPorosity.h.

◆ _dvol_strain_qp_dvar

template<bool is_ad>

const MaterialProperty<std::vector<RealGradient> >* const PorousFlowPorosityTempl< is_ad >::_dvol_strain_qp_dvar

protectedinherited

d(strain)/(dvar)

Definition at line 93 of file PorousFlowPorosity.h.

◆ _dvol_strain_rate_qp_dvar

const MaterialProperty<std::vector<RealGradient> >& PorousFlowPorosityHMBiotModulus::_dvol_strain_rate_qp_dvar

protected

d(volumetric strain rate)/d(PorousFlow variable)

Definition at line 52 of file PorousFlowPorosityHMBiotModulus.h.

Referenced by computeQpProperties().

◆ _ensure_positive

template<bool is_ad>

const bool PorousFlowPorosityExponentialBaseTempl< is_ad >::_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 74 of file PorousFlowPorosityExponentialBase.h.

◆ _exp_coeff

template<bool is_ad>

const Real PorousFlowPorosityTempl< is_ad >::_exp_coeff

protectedinherited

Thermal expansion coefficient of the solid porous skeleton.

Definition at line 56 of file PorousFlowPorosity.h.

◆ _fluid

template<bool is_ad>

const bool PorousFlowPorosityTempl< is_ad >::_fluid

protectedinherited

Porosity is a function of effective porepressure.

Definition at line 41 of file PorousFlowPorosity.h.

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

◆ _fluid_bulk_modulus

const Real PorousFlowPorosityHMBiotModulus::_fluid_bulk_modulus

protected

Constant fluid bulk modulus.

Definition at line 40 of file PorousFlowPorosityHMBiotModulus.h.

Referenced by computeQpProperties().

◆ _initial_c

template<bool is_ad>

std::vector<const VariableValue *> PorousFlowPorosityTempl< is_ad >::_initial_c

protectedinherited

Reference mineral concentrations.

Definition at line 81 of file PorousFlowPorosity.h.

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

◆ _mechanical

template<bool is_ad>

const bool PorousFlowPorosityTempl< is_ad >::_mechanical

protectedinherited

Porosity is a function of volumetric strain.

Definition at line 38 of file PorousFlowPorosity.h.

◆ _mineral_conc_old

template<bool is_ad>

const MaterialProperty<std::vector<Real> >* const PorousFlowPorosityTempl< is_ad >::_mineral_conc_old

protectedinherited

Old value of mineral concentration at the quadpoints or nodes.

Definition at line 108 of file PorousFlowPorosity.h.

◆ _num_c_ref

template<bool is_ad>

const unsigned PorousFlowPorosityTempl< is_ad >::_num_c_ref

protectedinherited

Number of reference mineral concentrations provided by user.

Definition at line 72 of file PorousFlowPorosity.h.

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

◆ _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

template<bool is_ad>

const unsigned PorousFlowPorosityTempl< is_ad >::_num_initial_c

protectedinherited

Number of reference mineral concentrations provided by user.

Definition at line 78 of file PorousFlowPorosity.h.

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

◆ _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 PorousFlowAqueousPreDisChemistry::computeQpProperties(), PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), computeQpProperties(), PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity::computeQpProperties(), PorousFlowPorosityLinear::computeUnboundedPorosityQp(), PorousFlowPorosityVinsomeWesterveld::computeUnboundedPorosityQp(), PorousFlowAqueousPreDisChemistry::initQpStatefulProperties(), and PorousFlowPorosityLinear::initQpStatefulProperties().

◆ _p_reference

template<bool is_ad>

const VariableValue& PorousFlowPorosityTempl< is_ad >::_p_reference

protectedinherited

Reference porepressure.

Definition at line 69 of file PorousFlowPorosity.h.

◆ _pf

template<bool is_ad>

const GenericMaterialProperty<Real, is_ad>* const PorousFlowPorosityTempl< is_ad >::_pf

protectedinherited

Effective porepressure at the quadpoints or nodes.

Definition at line 96 of file PorousFlowPorosity.h.

Referenced by computeQpProperties().

◆ _pf_old

const MaterialProperty<Real>& PorousFlowPorosityHMBiotModulus::_pf_old

protected

Old value of effective fluid pressure.

Definition at line 43 of file PorousFlowPorosityHMBiotModulus.h.

Referenced by computeQpProperties().

◆ _phi0

template<bool is_ad>

const VariableValue& PorousFlowPorosityTempl< is_ad >::_phi0

protectedinherited

Porosity at zero strain and zero porepressure and zero temperature.

Definition at line 50 of file PorousFlowPorosity.h.

◆ _porosity

template<bool is_ad>

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

protectedinherited

Computed porosity at the nodes or quadpoints.

Definition at line 36 of file PorousFlowPorosityBase.h.

Referenced by computeQpProperties(), PorousFlowPorosityLinear::computeUnboundedPorosityQp(), PorousFlowPorosityVinsomeWesterveld::computeUnboundedPorosityQp(), and PorousFlowPorosityLinear::initQpStatefulProperties().

◆ _porosity_min

template<bool is_ad>

const Real PorousFlowPorosityBaseTempl< is_ad >::_porosity_min

protectedinherited

Minimum allowed porosity (default zero, so porosity is never negative)

Definition at line 45 of file PorousFlowPorosityBase.h.

◆ _porosity_old

const MaterialProperty<Real>& PorousFlowPorosityHMBiotModulus::_porosity_old

protected

Old value of porosity.

Definition at line 34 of file PorousFlowPorosityHMBiotModulus.h.

Referenced by computeQpProperties().

◆ _reaction_rate

template<bool is_ad>

const MaterialProperty<std::vector<Real> >* const PorousFlowPorosityTempl< is_ad >::_reaction_rate

protectedinherited

Reaction rate of mineralisation.

Definition at line 111 of file PorousFlowPorosity.h.

◆ _saturation

template<bool is_ad>

const MaterialProperty<std::vector<Real> >* const PorousFlowPorosityTempl< is_ad >::_saturation

protectedinherited

Saturation.

Definition at line 120 of file PorousFlowPorosity.h.

◆ _solid_bulk

template<bool is_ad>

const Moose::Functor<Real>* PorousFlowPorosityTempl< is_ad >::_solid_bulk

protectedinherited

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

Definition at line 60 of file PorousFlowPorosity.h.

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

◆ _strain_at_nearest_qp

template<bool is_ad>

const bool PorousFlowPorosityExponentialBaseTempl< is_ad >::_strain_at_nearest_qp

protectedinherited

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

Definition at line 65 of file PorousFlowPorosityExponentialBase.h.

Referenced by computeQpProperties().

◆ _t_reference

template<bool is_ad>

const VariableValue& PorousFlowPorosityTempl< is_ad >::_t_reference

protectedinherited

Reference temperature.

Definition at line 66 of file PorousFlowPorosity.h.

◆ _temperature

template<bool is_ad>

const GenericMaterialProperty<Real, is_ad>* const PorousFlowPorosityTempl< is_ad >::_temperature

protectedinherited

Temperature at the quadpoints or nodes.

Definition at line 102 of file PorousFlowPorosity.h.

◆ _thermal

template<bool is_ad>

const bool PorousFlowPorosityTempl< is_ad >::_thermal

protectedinherited

Porosity is a function of temperature.

Definition at line 44 of file PorousFlowPorosity.h.

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

◆ _vol_strain_qp

template<bool is_ad>

const GenericMaterialProperty<Real, is_ad>* const PorousFlowPorosityTempl< is_ad >::_vol_strain_qp

protectedinherited

Strain.

Definition at line 90 of file PorousFlowPorosity.h.

Referenced by computeQpProperties().

◆ _vol_strain_qp_old

const MaterialProperty<Real>& PorousFlowPorosityHMBiotModulus::_vol_strain_qp_old

protected

Old value of total volumetric strain.

Definition at line 46 of file PorousFlowPorosityHMBiotModulus.h.

Referenced by computeQpProperties().

◆ _vol_strain_rate_qp

const MaterialProperty<Real>& PorousFlowPorosityHMBiotModulus::_vol_strain_rate_qp

protected

Volumetric strain rate.

Definition at line 49 of file PorousFlowPorosityHMBiotModulus.h.

Referenced by computeQpProperties().

◆ _zero_modifier

template<bool is_ad>

const Real PorousFlowPorosityBaseTempl< is_ad >::_zero_modifier

protectedinherited

When the porosity_min floor is active, the porosity derivatives are multiplied by this.

Definition at line 48 of file PorousFlowPorosityBase.h.

◆ usingPorousFlowPorosityBaseMembers

template<bool is_ad>

PorousFlowPorosityExponentialBaseTempl< is_ad >::usingPorousFlowPorosityBaseMembers

protectedinherited

Definition at line 76 of file PorousFlowPorosityExponentialBase.h.

◆ usingPorousFlowPorosityExponentialBaseMembers

template<bool is_ad>

PorousFlowPorosityTempl< is_ad >::usingPorousFlowPorosityExponentialBaseMembers

protectedinherited

Definition at line 125 of file PorousFlowPorosity.h.

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

porous_flow/include/materials/PorousFlowPorosityHMBiotModulus.h
porous_flow/src/materials/PorousFlowPorosityHMBiotModulus.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

◆ PorousFlowPorosityHMBiotModulus()

Member Function Documentation

◆ applyPorosityMin()

◆ atNegInfinityQp()

◆ atZeroQp()

◆ computeQpProperties()

◆ datNegInfinityQp()

◆ datZeroQp()

◆ ddecayQp_dgradvar()

◆ ddecayQp_dvar()

◆ decayQp()

◆ initQpStatefulProperties()

◆ validParams()

Member Data Documentation

◆ _aq_ph

◆ _biot

◆ _biot_modulus

◆ _c_reference

◆ _c_weights

◆ _chemical

◆ _coeff

◆ _dpf_dvar

◆ _dporosity_dgradvar

◆ _dporosity_dvar

◆ _dreaction_rate_dvar

◆ _dsaturation_dvar

◆ _dtemperature_dvar

◆ _dvol_strain_qp_dvar

◆ _dvol_strain_rate_qp_dvar

◆ _ensure_positive

◆ _exp_coeff

◆ _fluid

◆ _fluid_bulk_modulus

◆ _initial_c

◆ _mechanical

◆ _mineral_conc_old

◆ _num_c_ref

◆ _num_components

◆ _num_initial_c

◆ _num_phases

◆ _num_var

◆ _p_reference

◆ _pf

◆ _pf_old

◆ _phi0

◆ _porosity

◆ _porosity_min

◆ _porosity_old

◆ _reaction_rate

◆ _saturation

◆ _solid_bulk

◆ _strain_at_nearest_qp

◆ _t_reference

◆ _temperature

◆ _thermal

◆ _vol_strain_qp

◆ _vol_strain_qp_old

◆ _vol_strain_rate_qp

◆ _zero_modifier

◆ usingPorousFlowPorosityBaseMembers

◆ usingPorousFlowPorosityExponentialBaseMembers