PorousFlowVolumetricStrainTempl< is_ad > Class Template Reference

PorousFlowVolumetricStrain computes volumetric strains, and derivatives thereof. More...

#include <PorousFlowVolumetricStrain.h>

Inheritance diagram for PorousFlowVolumetricStrainTempl< is_ad >:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

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

Protected Attributes
const std::string	_base_name
	base name used in the Tensor Mechanics strain calculator
const GenericMaterialProperty< RankTwoTensor, is_ad > &	_total_strain
	total strain calculated by a Tensor Mechanics strain calculator
const MaterialProperty< RankTwoTensor > &	_total_strain_old
	Old value of total strain calculated by a Tensor Mechanics strain calculator.
const unsigned int	_ndisp
	Number of displacements supplied (1 in 1D, 2 in 2D, 3 in 3D)
std::vector< unsigned int >	_disp_var_num
	MOOSE variable number of the displacements variables provided.
GenericMaterialProperty< Real, is_ad > &	_vol_strain_rate_qp
	The volumetric strain rate at the quadpoints.
MaterialProperty< std::vector< RealGradient > > *const	_dvol_strain_rate_qp_dvar
	The derivative of the volumetric strain rate with respect to the porous flow variables.
GenericMaterialProperty< Real, is_ad > &	_vol_total_strain_qp
	The total volumetric strain at the quadpoints.
MaterialProperty< std::vector< RealGradient > > *const	_dvol_total_strain_qp_dvar
	The derivative of the total volumetric strain with respect to the porous flow variables.
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 PorousFlowVolumetricStrainTempl< is_ad >

PorousFlowVolumetricStrain computes volumetric strains, and derivatives thereof.

Definition at line 19 of file PorousFlowVolumetricStrain.h.

Constructor & Destructor Documentation

PorousFlowVolumetricStrainTempl()

template<bool is_ad>

PorousFlowVolumetricStrainTempl< is_ad >::PorousFlowVolumetricStrainTempl

(

const InputParameters &

parameters

)

Definition at line 38 of file PorousFlowVolumetricStrain.C.

  : PorousFlowMaterialVectorBase(parameters),
    _base_name(isParamValid("base_name") ? getParam<std::string>("base_name") + "_" : ""),
    _total_strain(getGenericMaterialProperty<RankTwoTensor, is_ad>(_base_name + "total_strain")),
    _total_strain_old(getMaterialPropertyOld<RankTwoTensor>(_base_name + "total_strain")),
    _ndisp(coupledComponents("displacements")),
    _disp_var_num(coupledIndices("displacements")),
 
    _vol_strain_rate_qp(
        declareGenericProperty<Real, is_ad>("PorousFlow_volumetric_strain_rate_qp")),
    _dvol_strain_rate_qp_dvar(is_ad ? nullptr
                                    : &declareProperty<std::vector<RealGradient>>(
                                          "dPorousFlow_volumetric_strain_rate_qp_dvar")),
    _vol_total_strain_qp(
        declareGenericProperty<Real, is_ad>("PorousFlow_total_volumetric_strain_qp")),
    _dvol_total_strain_qp_dvar(is_ad ? nullptr
                                     : &declareProperty<std::vector<RealGradient>>(
                                           "dPorousFlow_total_volumetric_strain_qp_dvar"))
{
  if (_ndisp != _mesh.dimension())
    paramError("displacements", "The number of variables supplied must match the mesh dimension.");
 
  if (_nodal_material)
    mooseError("PorousFlowVolumetricStrain classes are only defined for at_nodes = false");
}

Member Function Documentation

computeQpProperties()

template<bool is_ad>

void PorousFlowVolumetricStrainTempl< is_ad >::computeQpProperties ( )

overrideprotectedvirtual

Definition at line 74 of file PorousFlowVolumetricStrain.C.

{
  _vol_total_strain_qp[_qp] = _total_strain[_qp].trace();
  _vol_strain_rate_qp[_qp] = (_vol_total_strain_qp[_qp] - _total_strain_old[_qp].trace()) / _dt;
 
  if constexpr (!is_ad)
  {
    // The AD path carries the derivatives with respect to the displacement variables inside the
    // AD strain, so only the non-AD path needs to fill in these derivative material properties.
    (*_dvol_strain_rate_qp_dvar)[_qp].resize(_num_var, RealGradient());
    (*_dvol_total_strain_qp_dvar)[_qp].resize(_num_var, RealGradient());
    for (unsigned i = 0; i < _ndisp; ++i)
      if (_dictator.isPorousFlowVariable(_disp_var_num[i]))
      {
        // the i_th displacement is a PorousFlow variable
        const unsigned int pvar = _dictator.porousFlowVariableNum(_disp_var_num[i]);
        (*_dvol_strain_rate_qp_dvar)[_qp][pvar](i) = 1.0 / _dt;
        (*_dvol_total_strain_qp_dvar)[_qp][pvar](i) = 1.0;
      }
  }
}

initQpStatefulProperties()

template<bool is_ad>

void PorousFlowVolumetricStrainTempl< is_ad >::initQpStatefulProperties ( )

overrideprotectedvirtual

Definition at line 67 of file PorousFlowVolumetricStrain.C.

{
  _vol_total_strain_qp[_qp] = 0.0;
}

validParams()

template<bool is_ad>

InputParameters PorousFlowVolumetricStrainTempl< is_ad >::validParams ( )

static

Definition at line 20 of file PorousFlowVolumetricStrain.C.

{
  InputParameters params = PorousFlowMaterialVectorBase::validParams();
  params.addParam<std::string>("base_name",
                               "This should be the same base_name as given to the TensorMechanics "
                               "object that computes strain");
  params.addRequiredCoupledVar(
      "displacements",
      "The displacements appropriate for the simulation geometry and coordinate system");
  params.addClassDescription(
      "Compute volumetric strain and the volumetric_strain rate, for use in PorousFlow.");
  params.set<std::string>("pf_material_type") = "volumetric_strain";
  params.set<bool>("stateful_displacements") = true;
  params.set<bool>("at_nodes") = false;
  return params;
}

Member Data Documentation

_base_name

template<bool is_ad>

const std::string PorousFlowVolumetricStrainTempl< is_ad >::_base_name

protected

base name used in the Tensor Mechanics strain calculator

Definition at line 31 of file PorousFlowVolumetricStrain.h.

_disp_var_num

template<bool is_ad>

std::vector<unsigned int> PorousFlowVolumetricStrainTempl< is_ad >::_disp_var_num

protected

MOOSE variable number of the displacements variables provided.

Definition at line 43 of file PorousFlowVolumetricStrain.h.

_dvol_strain_rate_qp_dvar

template<bool is_ad>

MaterialProperty<std::vector<RealGradient> >* const PorousFlowVolumetricStrainTempl< is_ad >::_dvol_strain_rate_qp_dvar

protected

The derivative of the volumetric strain rate with respect to the porous flow variables.

Since the volumetric strain rate depends on derivatives of the displacement variables, this should be multiplied by _grad_phi in kernels

Definition at line 53 of file PorousFlowVolumetricStrain.h.

_dvol_total_strain_qp_dvar

template<bool is_ad>

MaterialProperty<std::vector<RealGradient> >* const PorousFlowVolumetricStrainTempl< is_ad >::_dvol_total_strain_qp_dvar

protected

The derivative of the total volumetric strain with respect to the porous flow variables.

Since the total volumetric strain depends on derivatives of the displacement variables, this should be multiplied by _grad_phi in kernels

Definition at line 63 of file PorousFlowVolumetricStrain.h.

_ndisp

template<bool is_ad>

const unsigned int PorousFlowVolumetricStrainTempl< is_ad >::_ndisp

protected

Number of displacements supplied (1 in 1D, 2 in 2D, 3 in 3D)

Definition at line 40 of file PorousFlowVolumetricStrain.h.

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

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

_total_strain

template<bool is_ad>

const GenericMaterialProperty<RankTwoTensor, is_ad>& PorousFlowVolumetricStrainTempl< is_ad >::_total_strain

protected

total strain calculated by a Tensor Mechanics strain calculator

Definition at line 34 of file PorousFlowVolumetricStrain.h.

_total_strain_old

template<bool is_ad>

const MaterialProperty<RankTwoTensor>& PorousFlowVolumetricStrainTempl< is_ad >::_total_strain_old

protected

Old value of total strain calculated by a Tensor Mechanics strain calculator.

Definition at line 37 of file PorousFlowVolumetricStrain.h.

_vol_strain_rate_qp

template<bool is_ad>

GenericMaterialProperty<Real, is_ad>& PorousFlowVolumetricStrainTempl< is_ad >::_vol_strain_rate_qp

protected

The volumetric strain rate at the quadpoints.

Definition at line 46 of file PorousFlowVolumetricStrain.h.

_vol_total_strain_qp

template<bool is_ad>

GenericMaterialProperty<Real, is_ad>& PorousFlowVolumetricStrainTempl< is_ad >::_vol_total_strain_qp

protected

The total volumetric strain at the quadpoints.

Definition at line 56 of file PorousFlowVolumetricStrain.h.

---

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

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