https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
PorousFlowPermeabilityTensorFromVarTempl< is_ad > Class Template Reference

Material designed to provide the permeability tensor which is calculated from a tensor multiplied by a scalar: k = k_ijk * k0 where k_ijk is a tensor providing the anisotropy, and k0 is a scalar variable. More...

#include <PorousFlowPermeabilityTensorFromVar.h>

Inheritance diagram for PorousFlowPermeabilityTensorFromVarTempl< is_ad >:
[legend]

Public Types

typedef DerivativeMaterialPropertyNameInterface::SymbolName SymbolName
 

Public Member Functions

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

void computeQpProperties () override
 

Protected Attributes

const VariableValue & _perm
 Permeability components Note: these can only be constant (Real constant Monomial auxvariables) so no AD version.
 
const RealTensorValue _k_anisotropy
 Tensor multiplier k_ijk.
 
 usingPorousFlowPermeabilityBaseMembers
 
GenericMaterialProperty< RealTensorValue, is_ad > & _permeability_qp
 Quadpoint permeability.
 
MaterialProperty< std::vector< RealTensorValue > > *const _dpermeability_qp_dvar
 d(quadpoint permeability)/d(PorousFlow variable)
 
MaterialProperty< std::vector< std::vector< RealTensorValue > > > *const _dpermeability_qp_dgradvar
 d(quadpoint permeability)/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

template<bool is_ad>
class PorousFlowPermeabilityTensorFromVarTempl< is_ad >

Material designed to provide the permeability tensor which is calculated from a tensor multiplied by a scalar: k = k_ijk * k0 where k_ijk is a tensor providing the anisotropy, and k0 is a scalar variable.

Definition at line 22 of file PorousFlowPermeabilityTensorFromVar.h.

Constructor & Destructor Documentation

◆ PorousFlowPermeabilityTensorFromVarTempl()

template<bool is_ad>
PorousFlowPermeabilityTensorFromVarTempl< is_ad >::PorousFlowPermeabilityTensorFromVarTempl ( const InputParameters &  parameters)

Definition at line 33 of file PorousFlowPermeabilityTensorFromVar.C.

35 : PorousFlowPermeabilityBaseTempl<is_ad>(parameters),
36 _perm(coupledValue("perm")),
37 _k_anisotropy(parameters.isParamValid("k_anisotropy")
38 ? this->template getParam<RealTensorValue>("k_anisotropy")
39 : RealTensorValue(1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 1.0))
40{
41}
InputParameters::isParamValid
bool isParamValid(const std::string &name) const
PorousFlowPermeabilityBaseTempl
Base class Material designed to provide the permeability tensor.
Definition PorousFlowPermeabilityBase.h:19
PorousFlowPermeabilityTensorFromVarTempl::_k_anisotropy
const RealTensorValue _k_anisotropy
Tensor multiplier k_ijk.
Definition PorousFlowPermeabilityTensorFromVar.h:37
PorousFlowPermeabilityTensorFromVarTempl::_perm
const VariableValue & _perm
Permeability components Note: these can only be constant (Real constant Monomial auxvariables) so no ...
Definition PorousFlowPermeabilityTensorFromVar.h:34
libMesh::RealTensorValue
TensorValue< Real > RealTensorValue

Member Function Documentation

◆ computeQpProperties()

template<bool is_ad>
void PorousFlowPermeabilityTensorFromVarTempl< is_ad >::computeQpProperties ( )
overrideprotected

Definition at line 45 of file PorousFlowPermeabilityTensorFromVar.C.

46{
47 _permeability_qp[_qp] = _k_anisotropy * _perm[_qp];
48
49 if (!is_ad)
50 {
51 (*_dpermeability_qp_dvar)[_qp].resize(_num_var, RealTensorValue());
52 (*_dpermeability_qp_dgradvar)[_qp].resize(LIBMESH_DIM);
53
54 for (const auto i : make_range(Moose::dim))
55 (*_dpermeability_qp_dgradvar)[_qp][i].resize(_num_var, RealTensorValue());
56 }
57}
dim
unsigned int dim
PorousFlowMaterialVectorBase::_num_var
const unsigned int _num_var
Number of PorousFlow variables.
Definition PorousFlowMaterialVectorBase.h:33
PorousFlowPermeabilityBaseTempl::_dpermeability_qp_dgradvar
MaterialProperty< std::vector< std::vector< RealTensorValue > > > *const _dpermeability_qp_dgradvar
d(quadpoint permeability)/d(grad(PorousFlow variable))
Definition PorousFlowPermeabilityBase.h:33
PorousFlowPermeabilityBaseTempl::_permeability_qp
GenericMaterialProperty< RealTensorValue, is_ad > & _permeability_qp
Quadpoint permeability.
Definition PorousFlowPermeabilityBase.h:27
libMesh::make_range
IntRange< T > make_range(T beg, T end)

◆ validParams()

template<bool is_ad>
InputParameters PorousFlowPermeabilityTensorFromVarTempl< is_ad >::validParams ( )
static

Definition at line 17 of file PorousFlowPermeabilityTensorFromVar.C.

18{
19 InputParameters params = PorousFlowPermeabilityBase::validParams();
20 params.addRequiredCoupledVar("perm", "The scalar permeability");
21 params.addParam<RealTensorValue>("k_anisotropy",
22 "A tensor to multiply the scalar "
23 "permeability, in order to obtain anisotropy if "
24 "required. Defaults to isotropic permeability "
25 "if not specified.");
26 params.addClassDescription(
27 "This Material calculates the permeability tensor from a coupled variable "
28 "multiplied by a tensor");
29 return params;
30}
InputParameters::addRequiredCoupledVar
void addRequiredCoupledVar(const std::string &name, const std::string &doc_string)
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _dpermeability_qp_dgradvar

template<bool is_ad>
MaterialProperty<std::vector<std::vector<RealTensorValue> > >* const PorousFlowPermeabilityBaseTempl< is_ad >::_dpermeability_qp_dgradvar
protectedinherited

d(quadpoint permeability)/d(grad(PorousFlow variable))

Definition at line 33 of file PorousFlowPermeabilityBase.h.

◆ _dpermeability_qp_dvar

template<bool is_ad>
MaterialProperty<std::vector<RealTensorValue> >* const PorousFlowPermeabilityBaseTempl< is_ad >::_dpermeability_qp_dvar
protectedinherited

d(quadpoint permeability)/d(PorousFlow variable)

Definition at line 30 of file PorousFlowPermeabilityBase.h.

◆ _k_anisotropy

template<bool is_ad>
const RealTensorValue PorousFlowPermeabilityTensorFromVarTempl< is_ad >::_k_anisotropy
protected

Tensor multiplier k_ijk.

Definition at line 37 of file PorousFlowPermeabilityTensorFromVar.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().

◆ _perm

template<bool is_ad>
const VariableValue& PorousFlowPermeabilityTensorFromVarTempl< is_ad >::_perm
protected

Permeability components Note: these can only be constant (Real constant Monomial auxvariables) so no AD version.

Definition at line 34 of file PorousFlowPermeabilityTensorFromVar.h.

◆ _permeability_qp

template<bool is_ad>
GenericMaterialProperty<RealTensorValue, is_ad>& PorousFlowPermeabilityBaseTempl< is_ad >::_permeability_qp
protectedinherited

Quadpoint permeability.

Definition at line 27 of file PorousFlowPermeabilityBase.h.

◆ usingPorousFlowPermeabilityBaseMembers

template<bool is_ad>
PorousFlowPermeabilityTensorFromVarTempl< is_ad >::usingPorousFlowPermeabilityBaseMembers
protected

Definition at line 39 of file PorousFlowPermeabilityTensorFromVar.h.

The documentation for this class was generated from the following files:
Generated on Fri Aug 21 2026 13:43:39 for https://mooseframework.inl.gov by doxygen 1.9.8