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
PorousFlowVariableBaseTempl< is_ad > Class Template Reference

Base class for thermophysical variable materials, which assemble materials for primary variables such as porepressure and saturation at the nodes and quadpoints for all phases as required. More...

#include <PorousFlowVariableBase.h>

Inheritance diagram for PorousFlowVariableBaseTempl< is_ad >:
[legend]

Public Types

typedef DerivativeMaterialPropertyNameInterface::SymbolName SymbolName
 

Public Member Functions

 PorousFlowVariableBaseTempl (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 unsigned int _num_phases
 Number of phases.
 
const unsigned int _num_components
 Number of components.
 
const unsigned int _num_pf_vars
 Number of PorousFlow variables.
 
GenericMaterialProperty< std::vector< Real >, is_ad > & _porepressure
 Computed nodal or quadpoint values of porepressure of the phases.
 
MaterialProperty< std::vector< std::vector< Real > > > *const _dporepressure_dvar
 d(porepressure)/d(PorousFlow variable)
 
GenericMaterialProperty< std::vector< RealGradient >, is_ad > *const _gradp_qp
 Grad(p) at the quadpoints.
 
MaterialProperty< std::vector< std::vector< Real > > > *const _dgradp_qp_dgradv
 d(grad porepressure)/d(grad PorousFlow variable) at the quadpoints
 
MaterialProperty< std::vector< std::vector< RealGradient > > > *const _dgradp_qp_dv
 d(grad porepressure)/d(PorousFlow variable) at the quadpoints
 
GenericMaterialProperty< std::vector< Real >, is_ad > & _saturation
 Computed nodal or qp saturation of the phases.
 
MaterialProperty< std::vector< std::vector< Real > > > *const _dsaturation_dvar
 d(saturation)/d(PorousFlow variable)
 
GenericMaterialProperty< std::vector< RealGradient >, is_ad > *const _grads_qp
 Grad(s) at the quadpoints.
 
MaterialProperty< std::vector< std::vector< Real > > > *const _dgrads_qp_dgradv
 d(grad saturation)/d(grad PorousFlow variable) at the quadpoints
 
MaterialProperty< std::vector< std::vector< RealGradient > > > *const _dgrads_qp_dv
 d(grad saturation)/d(PorousFlow variable) at the quadpoints
 

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

Base class for thermophysical variable materials, which assemble materials for primary variables such as porepressure and saturation at the nodes and quadpoints for all phases as required.

Definition at line 21 of file PorousFlowVariableBase.h.

Constructor & Destructor Documentation

◆ PorousFlowVariableBaseTempl()

template<bool is_ad>
PorousFlowVariableBaseTempl< is_ad >::PorousFlowVariableBaseTempl ( const InputParameters parameters)

Definition at line 24 of file PorousFlowVariableBase.C.

26
27 _num_phases(_dictator.numPhases()),
28 _num_components(_dictator.numComponents()),
29 _num_pf_vars(_dictator.numVariables()),
30
32 _nodal_material
33 ? declareGenericProperty<std::vector<Real>, is_ad>("PorousFlow_porepressure_nodal")
34 : declareGenericProperty<std::vector<Real>, is_ad>("PorousFlow_porepressure_qp")),
35 _dporepressure_dvar(is_ad ? nullptr
36 : _nodal_material ? &declareProperty<std::vector<std::vector<Real>>>(
37 "dPorousFlow_porepressure_nodal_dvar")
38 : &declareProperty<std::vector<std::vector<Real>>>(
39 "dPorousFlow_porepressure_qp_dvar")),
40 _gradp_qp(_nodal_material ? nullptr
41 : &declareGenericProperty<std::vector<RealGradient>, is_ad>(
42 "PorousFlow_grad_porepressure_qp")),
43 _dgradp_qp_dgradv((_nodal_material || is_ad)
44 ? nullptr
45 : &declareProperty<std::vector<std::vector<Real>>>(
46 "dPorousFlow_grad_porepressure_qp_dgradvar")),
47 _dgradp_qp_dv((_nodal_material || is_ad)
48 ? nullptr
49 : &declareProperty<std::vector<std::vector<RealGradient>>>(
50 "dPorousFlow_grad_porepressure_qp_dvar")),
51
53 _nodal_material
54 ? declareGenericProperty<std::vector<Real>, is_ad>("PorousFlow_saturation_nodal")
55 : declareGenericProperty<std::vector<Real>, is_ad>("PorousFlow_saturation_qp")),
57 is_ad ? nullptr
58 : _nodal_material
59 ? &declareProperty<std::vector<std::vector<Real>>>("dPorousFlow_saturation_nodal_dvar")
60 : &declareProperty<std::vector<std::vector<Real>>>("dPorousFlow_saturation_qp_dvar")),
61 _grads_qp(_nodal_material ? nullptr
62 : &declareGenericProperty<std::vector<RealGradient>, is_ad>(
63 "PorousFlow_grad_saturation_qp")),
64 _dgrads_qp_dgradv((_nodal_material || is_ad) ? nullptr
65 : &declareProperty<std::vector<std::vector<Real>>>(
66 "dPorousFlow_grad_saturation_qp_dgradvar")),
67 _dgrads_qp_dv((_nodal_material || is_ad)
68 ? nullptr
69 : &declareProperty<std::vector<std::vector<RealGradient>>>(
70 "dPorousFlow_grad_saturation_qp_dvar"))
71{
72}
MaterialProperty< std::vector< std::vector< RealGradient > > > *const _dgradp_qp_dv
d(grad porepressure)/d(PorousFlow variable) at the quadpoints
GenericMaterialProperty< std::vector< RealGradient >, is_ad > *const _grads_qp
Grad(s) at the quadpoints.
MaterialProperty< std::vector< std::vector< Real > > > *const _dgrads_qp_dgradv
d(grad saturation)/d(grad PorousFlow variable) at the quadpoints
MaterialProperty< std::vector< std::vector< RealGradient > > > *const _dgrads_qp_dv
d(grad saturation)/d(PorousFlow variable) at the quadpoints
const unsigned int _num_phases
Number of phases.
GenericMaterialProperty< std::vector< RealGradient >, is_ad > *const _gradp_qp
Grad(p) at the quadpoints.
const unsigned int _num_pf_vars
Number of PorousFlow variables.
GenericMaterialProperty< std::vector< Real >, is_ad > & _porepressure
Computed nodal or quadpoint values of porepressure of the phases.
MaterialProperty< std::vector< std::vector< Real > > > *const _dsaturation_dvar
d(saturation)/d(PorousFlow variable)
GenericMaterialProperty< std::vector< Real >, is_ad > & _saturation
Computed nodal or qp saturation of the phases.
MaterialProperty< std::vector< std::vector< Real > > > *const _dgradp_qp_dgradv
d(grad porepressure)/d(grad PorousFlow variable) at the quadpoints
const unsigned int _num_components
Number of components.
MaterialProperty< std::vector< std::vector< Real > > > *const _dporepressure_dvar
d(porepressure)/d(PorousFlow variable)
RealVectorValue RealGradient
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

Member Function Documentation

◆ computeQpProperties()

template<bool is_ad>
void PorousFlowVariableBaseTempl< is_ad >::computeQpProperties ( )
overrideprotectedvirtual

Reimplemented in PorousFlow1PhaseFullySaturatedTempl< is_ad >, PorousFlow1PhaseHysP, PorousFlow1PhaseMD_Gaussian, PorousFlow1PhasePTempl< is_ad >, PorousFlow2PhaseHysPP, PorousFlow2PhaseHysPS, PorousFlow2PhasePPTempl< is_ad >, PorousFlow2PhasePSTempl< is_ad >, PorousFlowFluidStateTempl< is_ad >, PorousFlowFluidStateBaseMaterialTempl< is_ad >, PorousFlowFluidStateSingleComponentTempl< is_ad >, PorousFlowHystereticCapillaryPressure, and PorousFlowHystereticInfo.

Definition at line 85 of file PorousFlowVariableBase.C.

86{
87 // do we really need this stuff here? it seems very inefficient to keep resizing everything!
88 _porepressure[_qp].resize(_num_phases);
89 _saturation[_qp].resize(_num_phases);
90
91 if (!is_ad)
92 {
93 (*_dporepressure_dvar)[_qp].resize(_num_phases);
94 (*_dsaturation_dvar)[_qp].resize(_num_phases);
95 }
96
97 if (!_nodal_material)
98 {
99 (*_gradp_qp)[_qp].resize(_num_phases);
100 (*_grads_qp)[_qp].resize(_num_phases);
101
102 if (!is_ad)
103 {
104 (*_dgradp_qp_dgradv)[_qp].resize(_num_phases);
105 (*_dgradp_qp_dv)[_qp].resize(_num_phases);
106
107 (*_dgrads_qp_dgradv)[_qp].resize(_num_phases);
108 (*_dgrads_qp_dv)[_qp].resize(_num_phases);
109 }
110 }
111
112 // Prepare the derivative matrices with zeroes
113 if (!is_ad)
114 for (unsigned phase = 0; phase < _num_phases; ++phase)
115 {
116
117 (*_dporepressure_dvar)[_qp][phase].assign(_num_pf_vars, 0.0);
118 (*_dsaturation_dvar)[_qp][phase].assign(_num_pf_vars, 0.0);
119 if (!_nodal_material)
120 {
121 (*_dgradp_qp_dgradv)[_qp][phase].assign(_num_pf_vars, 0.0);
122 (*_dgradp_qp_dv)[_qp][phase].assign(_num_pf_vars, RealGradient());
123 (*_dgrads_qp_dgradv)[_qp][phase].assign(_num_pf_vars, 0.0);
124 (*_dgrads_qp_dv)[_qp][phase].assign(_num_pf_vars, RealGradient());
125 }
126 }
127}

Referenced by PorousFlow1PhaseFullySaturatedTempl< is_ad >::computeQpProperties(), PorousFlow1PhaseMD_Gaussian::computeQpProperties(), PorousFlow1PhasePTempl< is_ad >::computeQpProperties(), PorousFlow2PhasePPTempl< is_ad >::computeQpProperties(), PorousFlow2PhasePSTempl< is_ad >::computeQpProperties(), PorousFlowFluidStateBaseMaterialTempl< is_ad >::computeQpProperties(), and PorousFlowHystereticCapillaryPressure::computeQpProperties().

◆ initQpStatefulProperties()

template<bool is_ad>
void PorousFlowVariableBaseTempl< is_ad >::initQpStatefulProperties ( )
overrideprotectedvirtual

◆ validParams()

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

Definition at line 14 of file PorousFlowVariableBase.C.

15{
17 params.addPrivateParam<std::string>("pf_material_type", "pressure_saturation");
18 params.addClassDescription("Base class for thermophysical variable materials. Provides pressure "
19 "and saturation material properties for all phases as required");
20 return params;
21}
void addPrivateParam(const std::string &name, const T &value)
void addClassDescription(const std::string &doc_string)
static InputParameters validParams()

Referenced by PorousFlow1PhaseFullySaturatedTempl< is_ad >::validParams(), PorousFlow1PhaseMD_Gaussian::validParams(), PorousFlow1PhasePTempl< is_ad >::validParams(), PorousFlow2PhasePPTempl< is_ad >::validParams(), PorousFlow2PhasePSTempl< is_ad >::validParams(), PorousFlowFluidStateBaseMaterialTempl< is_ad >::validParams(), and PorousFlowHystereticCapillaryPressure::validParams().

Member Data Documentation

◆ _dgradp_qp_dgradv

template<bool is_ad>
MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBaseTempl< is_ad >::_dgradp_qp_dgradv
protected

d(grad porepressure)/d(grad PorousFlow variable) at the quadpoints

Definition at line 51 of file PorousFlowVariableBase.h.

◆ _dgradp_qp_dv

template<bool is_ad>
MaterialProperty<std::vector<std::vector<RealGradient> > >* const PorousFlowVariableBaseTempl< is_ad >::_dgradp_qp_dv
protected

d(grad porepressure)/d(PorousFlow variable) at the quadpoints

Definition at line 54 of file PorousFlowVariableBase.h.

◆ _dgrads_qp_dgradv

template<bool is_ad>
MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBaseTempl< is_ad >::_dgrads_qp_dgradv
protected

d(grad saturation)/d(grad PorousFlow variable) at the quadpoints

Definition at line 66 of file PorousFlowVariableBase.h.

◆ _dgrads_qp_dv

template<bool is_ad>
MaterialProperty<std::vector<std::vector<RealGradient> > >* const PorousFlowVariableBaseTempl< is_ad >::_dgrads_qp_dv
protected

d(grad saturation)/d(PorousFlow variable) at the quadpoints

Definition at line 69 of file PorousFlowVariableBase.h.

◆ _dporepressure_dvar

template<bool is_ad>
MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBaseTempl< is_ad >::_dporepressure_dvar
protected

d(porepressure)/d(PorousFlow variable)

Definition at line 45 of file PorousFlowVariableBase.h.

◆ _dsaturation_dvar

template<bool is_ad>
MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBaseTempl< is_ad >::_dsaturation_dvar
protected

d(saturation)/d(PorousFlow variable)

Definition at line 60 of file PorousFlowVariableBase.h.

◆ _gradp_qp

template<bool is_ad>
GenericMaterialProperty<std::vector<RealGradient>, is_ad>* const PorousFlowVariableBaseTempl< is_ad >::_gradp_qp
protected

Grad(p) at the quadpoints.

Definition at line 48 of file PorousFlowVariableBase.h.

◆ _grads_qp

template<bool is_ad>
GenericMaterialProperty<std::vector<RealGradient>, is_ad>* const PorousFlowVariableBaseTempl< is_ad >::_grads_qp
protected

Grad(s) at the quadpoints.

Definition at line 63 of file PorousFlowVariableBase.h.

◆ _num_components

template<bool is_ad>
const unsigned int PorousFlowVariableBaseTempl< is_ad >::_num_components
protected

◆ _num_pf_vars

template<bool is_ad>
const unsigned int PorousFlowVariableBaseTempl< is_ad >::_num_pf_vars
protected

Number of PorousFlow variables.

Definition at line 39 of file PorousFlowVariableBase.h.

◆ _num_phases

template<bool is_ad>
const unsigned int PorousFlowVariableBaseTempl< is_ad >::_num_phases
protected

◆ _porepressure

template<bool is_ad>
GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowVariableBaseTempl< is_ad >::_porepressure
protected

◆ _saturation

template<bool is_ad>
GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowVariableBaseTempl< is_ad >::_saturation
protected

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