- PorousFlowDictatorThe UserObject that holds the list of PorousFlow variable names
C++ Type:UserObjectName
Controllable:No
Description:The UserObject that holds the list of PorousFlow variable names
- propertyThe fluid property that this auxillary kernel is to calculate
C++ Type:MooseEnum
Controllable:No
Description:The fluid property that this auxillary kernel is to calculate
- variableThe name of the variable that this object applies to
C++ Type:AuxVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this object applies to
PorousFlowPropertyAux
AuxKernel to provide access to properties evaluated at quadpoints. Note that elemental AuxVariables must be used, so that these properties are integrated over each element.
This AuxKernel provides simplified access to fluid and material properties. The following properties are available using the property input parameter:
pressuresaturationtemperaturedensityviscositymass_fractionrelpermcapillary_pressureenthalpyinternal_energysecondary_concentration(m(secondary species)/m(fluid))mineral_concentration(m(secondary species)/m(porous material))mineral_reaction_rate(m(secondary species).m(porous material).s))porositypermeabilityhystersis_orderhysteresis_saturation_turning_pointhysteretic_info— see PorousFlowHystereticInfo
The fluid phase and fluid component are specified in the phase and fluid_component input parameters, respectively. For properties related to chemical reactions, the secondary_species and mineral_species parameters are relevant. For hysteresis_saturation_turning_point the hysteresis_turning_point number is relevant.
commentnote
As this AuxKernel uses material properties, only elemental (Monomial) AuxVariables can be used.
Input Parameters
- blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
- boundaryThe list of boundaries (ids or names) from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
- check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
Default:True
C++ Type:bool
Controllable:No
Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
- column0Column of permeability tensor to output
Default:0
C++ Type:unsigned int
Controllable:No
Description:Column of permeability tensor to output
- execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:LINEAR TIMESTEP_END
C++ Type:ExecFlagEnum
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
- fluid_component0The index of the fluid component this auxillary kernel acts on
Default:0
C++ Type:unsigned int
Controllable:No
Description:The index of the fluid component this auxillary kernel acts on
- gas_phase1The index of the gas phase (used for capillary pressure)
Default:1
C++ Type:unsigned int
Controllable:No
Description:The index of the gas phase (used for capillary pressure)
- hysteresis_turning_point0The hysteresis turning point number
Default:0
C++ Type:unsigned int
Controllable:No
Description:The hysteresis turning point number
- liquid_phase0The index of the liquid phase (used for capillary pressure)
Default:0
C++ Type:unsigned int
Controllable:No
Description:The index of the liquid phase (used for capillary pressure)
- mineral_species0The mineral chemical species number
Default:0
C++ Type:unsigned int
Controllable:No
Description:The mineral chemical species number
- phase0The index of the phase this auxillary kernel acts on
Default:0
C++ Type:unsigned int
Controllable:No
Description:The index of the phase this auxillary kernel acts on
- row0Row of permeability tensor to output
Default:0
C++ Type:unsigned int
Controllable:No
Description:Row of permeability tensor to output
- secondary_species0The secondary chemical species number
Default:0
C++ Type:unsigned int
Controllable:No
Description:The secondary chemical species number
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:Yes
Description:Set the enabled status of the MooseObject.
- seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Controllable:No
Description:The seed for the master random number generator
- use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Advanced Parameters
- prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
- use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.