Material designed to provide the porosity in PorousFlow simulations porosity_ref + P_coeff * (P - P_ref) + T_coeff * (T - T_ref) + epv_coeff * (epv - epv_ref), where P is the effective porepressure, T is the temperature and epv is the volumetric strain. More...

#include <PorousFlowPorosityLinear.h>

Inheritance diagram for PorousFlowPorosityLinear:

[legend]

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	PorousFlowPorosityLinear (const InputParameters &parameters)

virtual void	initialSetup () override

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

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

const Real	_porosity_min
	If the linear relationship produces porosity < _porosity_min, then porosity is set to _porosity_min.

const VariableValue &	_phi_ref
	Porosity at reference porepressure, temperature and volumetric strain.

const VariableValue &	_P_ref
	Reference effective porepressure.

const VariableValue &	_T_ref
	Reference temperature.

const VariableValue &	_epv_ref
	Reference volumetric strain.

const Real	_P_coeff
	coefficient of effective porepressure

const Real	_T_coeff
	coefficient of temperature

const Real	_epv_coeff
	coefficient of volumetric strain

const bool	_uses_volstrain
	whether epv_coeff has been set

const OptionalMaterialProperty< Real > &	_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))

const OptionalMaterialProperty< std::vector< RealGradient > > &	_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))

const bool	_uses_pf
	whether P_coeff has been set

const OptionalMaterialProperty< Real > &	_pf_nodal
	Effective porepressure at the quadpoints or nodes.

const OptionalMaterialProperty< Real > &	_pf_qp

const MaterialProperty< Real > *	_pf

const OptionalMaterialProperty< std::vector< Real > > &	_dpf_dvar_nodal
	d(effective porepressure)/(d porflow variable)

const OptionalMaterialProperty< std::vector< Real > > &	_dpf_dvar_qp

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

const bool	_uses_T
	whether T_coeff has been set

const OptionalMaterialProperty< Real > &	_temperature_nodal
	Temperature at the quadpoints or nodes.

const OptionalMaterialProperty< Real > &	_temperature_qp

const MaterialProperty< Real > *	_temperature

const OptionalMaterialProperty< std::vector< Real > > &	_dtemperature_dvar_nodal
	d(temperature)/(d porflow variable)

const OptionalMaterialProperty< std::vector< Real > > &	_dtemperature_dvar_qp

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

const Real	_zero_modifier
	If the linear relationship produces porosity < _porosity_min, then porosity is set to _porosity_min. This means the derivatives of it will be zero. However, this gives poor NR convergence, so the derivatives are set to _zero_modifier * (values that are relevant for porosity_min) to hint to the NR that porosity is not always constant.

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

Material designed to provide the porosity in PorousFlow simulations porosity_ref + P_coeff * (P - P_ref) + T_coeff * (T - T_ref) + epv_coeff * (epv - epv_ref), where P is the effective porepressure, T is the temperature and epv is the volumetric strain.

Definition at line 19 of file PorousFlowPorosityLinear.h.

Constructor & Destructor Documentation

◆ PorousFlowPorosityLinear()

PorousFlowPorosityLinear::PorousFlowPorosityLinear ( const InputParameters & parameters )

Definition at line 68 of file PorousFlowPorosityLinear.C.

  : PorousFlowPorosityBase(parameters),
    _strain_at_nearest_qp(getParam<bool>("strain_at_nearest_qp")),
    _porosity_min(getParam<Real>("porosity_min")),
    _phi_ref(coupledValue("porosity_ref")),
    _P_ref(_nodal_material ? coupledDofValues("P_ref") : coupledValue("P_ref")),
    _T_ref(_nodal_material ? coupledDofValues("T_ref") : coupledValue("T_ref")),
    _epv_ref(coupledValue("epv_ref")),
    _P_coeff(getParam<Real>("P_coeff")),
    _T_coeff(getParam<Real>("T_coeff")),
    _epv_coeff(getParam<Real>("epv_coeff")),
 
    _uses_volstrain(parameters.isParamSetByUser("epv_coeff") && _epv_coeff != 0.0),
    _vol_strain_qp(getOptionalMaterialProperty<Real>("PorousFlow_total_volumetric_strain_qp")),
    _dvol_strain_qp_dvar(getOptionalMaterialProperty<std::vector<RealGradient>>(
        "dPorousFlow_total_volumetric_strain_qp_dvar")),
 
    _uses_pf(parameters.isParamSetByUser("P_coeff") && _P_coeff != 0.0),
    _pf_nodal(getOptionalMaterialProperty<Real>("PorousFlow_effective_fluid_pressure_nodal")),
    _pf_qp(getOptionalMaterialProperty<Real>("PorousFlow_effective_fluid_pressure_qp")),
    _dpf_dvar_nodal(getOptionalMaterialProperty<std::vector<Real>>(
        "dPorousFlow_effective_fluid_pressure_nodal_dvar")),
    _dpf_dvar_qp(getOptionalMaterialProperty<std::vector<Real>>(
        "dPorousFlow_effective_fluid_pressure_qp_dvar")),
 
    _uses_T(parameters.isParamSetByUser("T_coeff") && _T_coeff != 0.0),
    _temperature_nodal(getOptionalMaterialProperty<Real>("PorousFlow_temperature_nodal")),
    _temperature_qp(getOptionalMaterialProperty<Real>("PorousFlow_temperature_qp")),
    _dtemperature_dvar_nodal(
        getOptionalMaterialProperty<std::vector<Real>>("dPorousFlow_temperature_nodal_dvar")),
    _dtemperature_dvar_qp(
        getOptionalMaterialProperty<std::vector<Real>>("dPorousFlow_temperature_qp_dvar")),
    _zero_modifier(getParam<Real>("zero_modifier"))
{
}

Member Function Documentation

◆ computeQpProperties()

void PorousFlowPorosityLinear::computeQpProperties ( )

overrideprotectedvirtual

Definition at line 138 of file PorousFlowPorosityLinear.C.

{
  // note the [0] below: _phi_ref is a constant monomial and we use [0] regardless of
  // _nodal_material
  Real porosity = _phi_ref[0];
  if (_uses_pf)
    porosity += _P_coeff * ((*_pf)[_qp] - _P_ref[_qp]);
  if (_uses_T)
    porosity += _T_coeff * ((*_temperature)[_qp] - _T_ref[_qp]);
  if (_uses_volstrain)
  {
    // 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);
    porosity += _epv_coeff * (_vol_strain_qp[qp_to_use] - _epv_ref[0]);
  }
 
  if (porosity < _porosity_min)
    _porosity[_qp] = _porosity_min;
  else
    _porosity[_qp] = porosity;
 
  (*_dporosity_dvar)[_qp].resize(_num_var);
  (*_dporosity_dgradvar)[_qp].resize(_num_var);
  for (unsigned int pvar = 0; pvar < _num_var; ++pvar)
  {
    Real deriv = 0.0;
    if (_uses_pf)
      deriv += _P_coeff * (*_dpf_dvar)[_qp][pvar];
    if (_uses_T)
      deriv += _T_coeff * (*_dtemperature_dvar)[_qp][pvar];
    if (porosity < _porosity_min)
      (*_dporosity_dvar)[_qp][pvar] = _zero_modifier * deriv;
    else
      (*_dporosity_dvar)[_qp][pvar] = deriv;
 
    RealGradient deriv_grad(0.0, 0.0, 0.0);
    if (_uses_volstrain)
    {
      const unsigned qp_to_use =
          (_nodal_material && (_bnd || _strain_at_nearest_qp) ? nearestQP(_qp) : _qp);
      deriv_grad += _epv_coeff * _dvol_strain_qp_dvar[qp_to_use][pvar];
    }
    if (porosity < _porosity_min)
      (*_dporosity_dgradvar)[_qp][pvar] = _zero_modifier * deriv_grad;
    else
      (*_dporosity_dgradvar)[_qp][pvar] = deriv_grad;
  }
}

◆ initialSetup()

void PorousFlowPorosityLinear::initialSetup ( )

overridevirtual

Definition at line 105 of file PorousFlowPorosityLinear.C.

{
  _pf = _nodal_material ? _pf_nodal.get() : _pf_qp.get();
  _dpf_dvar = _nodal_material ? _dpf_dvar_nodal.get() : _dpf_dvar_qp.get();
  if (!(_pf && _dpf_dvar) && _uses_pf)
  {
    mooseError("PorousFlowPorosityLinear: When P_coeff is given you must have an effective fluid "
               "pressure Material");
  }
 
  _temperature = _nodal_material ? _temperature_nodal.get() : _temperature_qp.get();
  _dtemperature_dvar =
      _nodal_material ? _dtemperature_dvar_nodal.get() : _dtemperature_dvar_qp.get();
  if (!_temperature && _uses_T)
    mooseError(
        "PorousFlowPorosityLinear: When T_coeff is given you must have a temperature Material");
 
  if (!(_vol_strain_qp && _dvol_strain_qp_dvar) && _uses_volstrain)
    mooseError("PorousFlowPorosityLinear: When epv_coeff is given you must have a "
               "volumetric-strain Material");
 
  PorousFlowPorosityBase::initialSetup();
}

◆ initQpStatefulProperties()

void PorousFlowPorosityLinear::initQpStatefulProperties ( )

overrideprotectedvirtual

Definition at line 130 of file PorousFlowPorosityLinear.C.

{
  _porosity[_qp] = _phi_ref[0];
  (*_dporosity_dvar)[_qp].assign(_num_var, 0.0);
  (*_dporosity_dgradvar)[_qp].assign(_num_var, 0.0);
}

◆ validParams()

InputParameters PorousFlowPorosityLinear::validParams ( )

static

Definition at line 15 of file PorousFlowPorosityLinear.C.

{
  InputParameters params = PorousFlowPorosityBase::validParams();
  params.addParam<bool>("strain_at_nearest_qp",
                        false,
                        "When calculating nodal porosity that depends on strain, use the strain at "
                        "the nearest quadpoint.  This adds a small extra computational burden, and "
                        "is not necessary for simulations involving only linear lagrange elements. "
                        " If you set this to true, you will also want to set the same parameter to "
                        "true for related Kernels and Materials");
  params.addRequiredCoupledVar(
      "porosity_ref",
      "The porosity at reference effective porepressure, temperature and volumetric strain.  This "
      "must be a real number or a constant monomial variable (not a linear lagrange or other type "
      "of variable)");
  params.addCoupledVar(
      "P_ref",
      0.0,
      "The reference effective porepressure.  This should usually be a linear-lagrange variable");
  params.addCoupledVar(
      "T_ref",
      0.0,
      "The reference temperature.  This should usually be a linear-lagrange variable");
  params.addCoupledVar("epv_ref",
                       0.0,
                       "The reference volumetric strain.  This must be a real number or a constant "
                       "monomial variable (not a linear lagrange or other type of variable)");
  params.addParam<Real>("P_coeff", 0.0, "Effective porepressure coefficient");
  params.addParam<Real>("T_coeff", 0.0, "Temperature coefficient");
  params.addParam<Real>("epv_coeff", 0.0, "Volumetric-strain coefficient");
  params.addRangeCheckedParam<Real>(
      "porosity_min",
      0.0,
      "porosity_min >= 0",
      "Minimum allowed value of the porosity: if the linear relationship gives "
      "values less than this value, then porosity is set to this value instead");
  params.addParam<Real>(
      "zero_modifier",
      1E-3,
      "If the linear relationship produces porosity < porosity_min, then porosity is set "
      "porosity_min.  This means the derivatives of it will be zero.  However, these zero "
      "derivatives often result in poor NR convergence, so the derivatives are set to "
      "_zero_modifier * (values that are relevant for min porosity) to hint to the NR that "
      "porosity is not always constant");
  params.addParamNamesToGroup("zero_modifier", "Advanced");
  params.addClassDescription(
      "This Material calculates the porosity in PorousFlow simulations using the relationship "
      "porosity_ref + P_coeff * (P - P_ref) + T_coeff * (T - T_ref) + epv_coeff * (epv - epv_ref), "
      "where P is the effective porepressure, T is the temperature and epv is the volumetric "
      "strain");
  return params;
}

Member Data Documentation

◆ _dpf_dvar

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

protected

Definition at line 79 of file PorousFlowPorosityLinear.h.

Referenced by initialSetup().

◆ _dpf_dvar_nodal

const OptionalMaterialProperty<std::vector<Real> >& PorousFlowPorosityLinear::_dpf_dvar_nodal

protected

d(effective porepressure)/(d porflow variable)

Definition at line 77 of file PorousFlowPorosityLinear.h.

Referenced by initialSetup().

◆ _dpf_dvar_qp

const OptionalMaterialProperty<std::vector<Real> >& PorousFlowPorosityLinear::_dpf_dvar_qp

protected

Definition at line 78 of file PorousFlowPorosityLinear.h.

Referenced by initialSetup().

◆ _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 PorousFlowPorosityHMBiotModulus::computeQpProperties(), and 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 PorousFlowPorosityHMBiotModulus::computeQpProperties(), and computeQpProperties().

◆ _dtemperature_dvar

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

protected

Definition at line 92 of file PorousFlowPorosityLinear.h.

Referenced by initialSetup().

◆ _dtemperature_dvar_nodal

const OptionalMaterialProperty<std::vector<Real> >& PorousFlowPorosityLinear::_dtemperature_dvar_nodal

protected

d(temperature)/(d porflow variable)

Definition at line 90 of file PorousFlowPorosityLinear.h.

Referenced by initialSetup().

◆ _dtemperature_dvar_qp

const OptionalMaterialProperty<std::vector<Real> >& PorousFlowPorosityLinear::_dtemperature_dvar_qp

protected

Definition at line 91 of file PorousFlowPorosityLinear.h.

Referenced by initialSetup().

◆ _dvol_strain_qp_dvar

const OptionalMaterialProperty<std::vector<RealGradient> >& PorousFlowPorosityLinear::_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 66 of file PorousFlowPorosityLinear.h.

Referenced by computeQpProperties(), and initialSetup().

◆ _epv_coeff

const Real PorousFlowPorosityLinear::_epv_coeff

protected

coefficient of volumetric strain

Definition at line 57 of file PorousFlowPorosityLinear.h.

Referenced by computeQpProperties().

◆ _epv_ref

const VariableValue& PorousFlowPorosityLinear::_epv_ref

protected

Reference volumetric strain.

Definition at line 48 of file PorousFlowPorosityLinear.h.

Referenced by computeQpProperties().

◆ _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_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(), PorousFlowPorosityExponentialBase::computeQpProperties(), PorousFlowPorosityHMBiotModulus::computeQpProperties(), computeQpProperties(), PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity::computeQpProperties(), PorousFlowVolumetricStrain::computeQpProperties(), PorousFlowAqueousPreDisChemistry::initQpStatefulProperties(), and initQpStatefulProperties().

◆ _P_coeff

const Real PorousFlowPorosityLinear::_P_coeff

protected

coefficient of effective porepressure

Definition at line 51 of file PorousFlowPorosityLinear.h.

Referenced by computeQpProperties().

◆ _P_ref

const VariableValue& PorousFlowPorosityLinear::_P_ref

protected

Reference effective porepressure.

Definition at line 42 of file PorousFlowPorosityLinear.h.

Referenced by computeQpProperties().

◆ _pf

const MaterialProperty<Real>* PorousFlowPorosityLinear::_pf

protected

Definition at line 74 of file PorousFlowPorosityLinear.h.

Referenced by initialSetup().

◆ _pf_nodal

const OptionalMaterialProperty<Real>& PorousFlowPorosityLinear::_pf_nodal

protected

Effective porepressure at the quadpoints or nodes.

Definition at line 72 of file PorousFlowPorosityLinear.h.

Referenced by initialSetup().

◆ _pf_qp

const OptionalMaterialProperty<Real>& PorousFlowPorosityLinear::_pf_qp

protected

Definition at line 73 of file PorousFlowPorosityLinear.h.

Referenced by initialSetup().

◆ _phi_ref

const VariableValue& PorousFlowPorosityLinear::_phi_ref

protected

Porosity at reference porepressure, temperature and volumetric strain.

Definition at line 39 of file PorousFlowPorosityLinear.h.

Referenced by computeQpProperties(), and initQpStatefulProperties().

◆ _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 PorousFlowPorosityExponentialBase::computeQpProperties(), PorousFlowPorosityHMBiotModulus::computeQpProperties(), computeQpProperties(), PorousFlowPorosityExponentialBase::initQpStatefulProperties(), and initQpStatefulProperties().

◆ _porosity_min

const Real PorousFlowPorosityLinear::_porosity_min

protected

If the linear relationship produces porosity < _porosity_min, then porosity is set to _porosity_min.

Definition at line 36 of file PorousFlowPorosityLinear.h.

Referenced by computeQpProperties().

◆ _strain_at_nearest_qp

const bool PorousFlowPorosityLinear::_strain_at_nearest_qp

protected

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

Definition at line 33 of file PorousFlowPorosityLinear.h.

Referenced by computeQpProperties().

◆ _T_coeff

const Real PorousFlowPorosityLinear::_T_coeff

protected

coefficient of temperature

Definition at line 54 of file PorousFlowPorosityLinear.h.

Referenced by computeQpProperties().

◆ _T_ref

const VariableValue& PorousFlowPorosityLinear::_T_ref

protected

Reference temperature.

Definition at line 45 of file PorousFlowPorosityLinear.h.

Referenced by computeQpProperties().

◆ _temperature

const MaterialProperty<Real>* PorousFlowPorosityLinear::_temperature

protected

Definition at line 87 of file PorousFlowPorosityLinear.h.

Referenced by initialSetup().

◆ _temperature_nodal

const OptionalMaterialProperty<Real>& PorousFlowPorosityLinear::_temperature_nodal

protected

Temperature at the quadpoints or nodes.

Definition at line 85 of file PorousFlowPorosityLinear.h.

Referenced by initialSetup().

◆ _temperature_qp

const OptionalMaterialProperty<Real>& PorousFlowPorosityLinear::_temperature_qp

protected

Definition at line 86 of file PorousFlowPorosityLinear.h.

Referenced by initialSetup().

◆ _uses_pf

const bool PorousFlowPorosityLinear::_uses_pf

protected

whether P_coeff has been set

Definition at line 69 of file PorousFlowPorosityLinear.h.

Referenced by computeQpProperties(), and initialSetup().

◆ _uses_T

const bool PorousFlowPorosityLinear::_uses_T

protected

whether T_coeff has been set

Definition at line 82 of file PorousFlowPorosityLinear.h.

Referenced by computeQpProperties(), and initialSetup().

◆ _uses_volstrain

const bool PorousFlowPorosityLinear::_uses_volstrain

protected

whether epv_coeff has been set

Definition at line 60 of file PorousFlowPorosityLinear.h.

Referenced by computeQpProperties(), and initialSetup().

◆ _vol_strain_qp

const OptionalMaterialProperty<Real>& PorousFlowPorosityLinear::_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 63 of file PorousFlowPorosityLinear.h.

Referenced by computeQpProperties(), and initialSetup().

◆ _zero_modifier

const Real PorousFlowPorosityLinear::_zero_modifier

protected

If the linear relationship produces porosity < _porosity_min, then porosity is set to _porosity_min. This means the derivatives of it will be zero. However, this gives poor NR convergence, so the derivatives are set to _zero_modifier * (values that are relevant for porosity_min) to hint to the NR that porosity is not always constant.

Definition at line 95 of file PorousFlowPorosityLinear.h.

Referenced by computeQpProperties().

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

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

◆ PorousFlowPorosityLinear()

Member Function Documentation

◆ computeQpProperties()

◆ initialSetup()

◆ initQpStatefulProperties()

◆ validParams()

Member Data Documentation

◆ _dpf_dvar

◆ _dpf_dvar_nodal

◆ _dpf_dvar_qp

◆ _dporosity_dgradvar

◆ _dporosity_dvar

◆ _dtemperature_dvar

◆ _dtemperature_dvar_nodal

◆ _dtemperature_dvar_qp

◆ _dvol_strain_qp_dvar

◆ _epv_coeff

◆ _epv_ref

◆ _num_components

◆ _num_phases

◆ _num_var

◆ _P_coeff

◆ _P_ref

◆ _pf

◆ _pf_nodal

◆ _pf_qp

◆ _phi_ref

◆ _porosity

◆ _porosity_min

◆ _strain_at_nearest_qp

◆ _T_coeff

◆ _T_ref

◆ _temperature

◆ _temperature_nodal

◆ _temperature_qp

◆ _uses_pf

◆ _uses_T

◆ _uses_volstrain

◆ _vol_strain_qp

◆ _zero_modifier