PorousFlowEffectiveFluidPressureTempl< is_ad > Class Template Reference

Material designed to calculate the effective fluid pressure that can be used in the mechanical effective-stress calculations and other similar places. More...

#include <PorousFlowEffectiveFluidPressure.h>

Inheritance diagram for PorousFlowEffectiveFluidPressureTempl< is_ad >:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

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

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual void	initQpStatefulProperties () override
virtual void	computeQpProperties () override

Protected Attributes
const GenericMaterialProperty< std::vector< Real >, is_ad > &	_porepressure
	Quadpoint or nodal porepressure of each phase.
const MaterialProperty< std::vector< std::vector< Real > > > *const	_dporepressure_dvar
	d(porepressure)/d(PorousFlow variable)
const GenericMaterialProperty< std::vector< Real >, is_ad > &	_saturation
	Quadpoint or nodal saturation of each phase.
const MaterialProperty< std::vector< std::vector< Real > > > *const	_dsaturation_dvar
	d(saturation)/d(PorousFlow variable)
GenericMaterialProperty< Real, is_ad > &	_pf
	Computed effective fluid pressure (at quadpoints or nodes)
MaterialProperty< std::vector< Real > > *const	_dpf_dvar
	d(_pf)/d(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

template<bool is_ad>
class PorousFlowEffectiveFluidPressureTempl< is_ad >

Material designed to calculate the effective fluid pressure that can be used in the mechanical effective-stress calculations and other similar places.

This class computes effective fluid pressure = sum_{phases}Saturation_{phase}*Porepressure_{phase}

Definition at line 21 of file PorousFlowEffectiveFluidPressure.h.

Constructor & Destructor Documentation

PorousFlowEffectiveFluidPressureTempl()

template<bool is_ad>

PorousFlowEffectiveFluidPressureTempl< is_ad >::PorousFlowEffectiveFluidPressureTempl

(

const InputParameters &

parameters

)

Definition at line 29 of file PorousFlowEffectiveFluidPressure.C.

  : PorousFlowMaterialVectorBase(parameters),
    _porepressure(
        _nodal_material
            ? getGenericMaterialProperty<std::vector<Real>, is_ad>("PorousFlow_porepressure_nodal")
            : getGenericMaterialProperty<std::vector<Real>, is_ad>("PorousFlow_porepressure_qp")),
    _dporepressure_dvar(is_ad             ? nullptr
                        : _nodal_material ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                                "dPorousFlow_porepressure_nodal_dvar")
                                          : &getMaterialProperty<std::vector<std::vector<Real>>>(
                                                "dPorousFlow_porepressure_qp_dvar")),
    _saturation(
        _nodal_material
            ? getGenericMaterialProperty<std::vector<Real>, is_ad>("PorousFlow_saturation_nodal")
            : getGenericMaterialProperty<std::vector<Real>, is_ad>("PorousFlow_saturation_qp")),
    _dsaturation_dvar(is_ad             ? nullptr
                      : _nodal_material ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                              "dPorousFlow_saturation_nodal_dvar")
                                        : &getMaterialProperty<std::vector<std::vector<Real>>>(
                                              "dPorousFlow_saturation_qp_dvar")),
    _pf(_nodal_material
            ? declareGenericProperty<Real, is_ad>("PorousFlow_effective_fluid_pressure_nodal")
            : declareGenericProperty<Real, is_ad>("PorousFlow_effective_fluid_pressure_qp")),
    _dpf_dvar(
        is_ad ? nullptr
        : _nodal_material
            ? &declareProperty<std::vector<Real>>("dPorousFlow_effective_fluid_pressure_nodal_dvar")
            : &declareProperty<std::vector<Real>>("dPorousFlow_effective_fluid_pressure_qp_dvar"))
{
}

Member Function Documentation

computeQpProperties()

template<bool is_ad>

void PorousFlowEffectiveFluidPressureTempl< is_ad >::computeQpProperties ( )

overrideprotectedvirtual

Definition at line 72 of file PorousFlowEffectiveFluidPressure.C.

{
  _pf[_qp] = 0.0;
 
  if (!is_ad)
    (*_dpf_dvar)[_qp].assign(_num_var, 0.0);
 
  for (unsigned int ph = 0; ph < _num_phases; ++ph)
  {
    _pf[_qp] += _saturation[_qp][ph] * _porepressure[_qp][ph];
 
    if constexpr (!is_ad)
      for (unsigned int v = 0; v < _num_var; ++v)
        (*_dpf_dvar)[_qp][v] += (*_dsaturation_dvar)[_qp][ph][v] * _porepressure[_qp][ph] +
                                _saturation[_qp][ph] * (*_dporepressure_dvar)[_qp][ph][v];
  }
}

initQpStatefulProperties()

template<bool is_ad>

void PorousFlowEffectiveFluidPressureTempl< is_ad >::initQpStatefulProperties ( )

overrideprotectedvirtual

Definition at line 63 of file PorousFlowEffectiveFluidPressure.C.

{
  _pf[_qp] = 0.0;
  for (unsigned int ph = 0; ph < _num_phases; ++ph)
    _pf[_qp] += _saturation[_qp][ph] * _porepressure[_qp][ph];
}

validParams()

template<bool is_ad>

InputParameters PorousFlowEffectiveFluidPressureTempl< is_ad >::validParams ( )

static

Definition at line 17 of file PorousFlowEffectiveFluidPressure.C.

{
  InputParameters params = PorousFlowMaterialVectorBase::validParams();
  params.set<std::string>("pf_material_type") = "effective_pressure";
  params.addClassDescription("This Material calculates an effective fluid pressure: "
                             "effective_stress = total_stress + "
                             "biot_coeff*effective_fluid_pressure.  The effective_fluid_pressure = "
                             "sum_{phases}(S_phase * P_phase)");
  return params;
}

Member Data Documentation

_dpf_dvar

template<bool is_ad>

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

protected

d(_pf)/d(PorousFlow variable)

Definition at line 48 of file PorousFlowEffectiveFluidPressure.h.

_dporepressure_dvar

template<bool is_ad>

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

protected

d(porepressure)/d(PorousFlow variable)

Definition at line 36 of file PorousFlowEffectiveFluidPressure.h.

_dsaturation_dvar

template<bool is_ad>

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

protected

d(saturation)/d(PorousFlow variable)

Definition at line 42 of file PorousFlowEffectiveFluidPressure.h.

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

_pf

template<bool is_ad>

GenericMaterialProperty<Real, is_ad>& PorousFlowEffectiveFluidPressureTempl< is_ad >::_pf

protected

Computed effective fluid pressure (at quadpoints or nodes)

Definition at line 45 of file PorousFlowEffectiveFluidPressure.h.

_porepressure

template<bool is_ad>

const GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowEffectiveFluidPressureTempl< is_ad >::_porepressure

protected

Quadpoint or nodal porepressure of each phase.

Definition at line 33 of file PorousFlowEffectiveFluidPressure.h.

_saturation

template<bool is_ad>

const GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowEffectiveFluidPressureTempl< is_ad >::_saturation

protected

Quadpoint or nodal saturation of each phase.

Definition at line 39 of file PorousFlowEffectiveFluidPressure.h.

---

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

• porous_flow/include/materials/PorousFlowEffectiveFluidPressure.h
• porous_flow/src/materials/PorousFlowEffectiveFluidPressure.C