PorousFlowPropertyAux !syntax description /AuxKernels/PorousFlowPropertyAux

This AuxKernel provides simplified access to fluid and material properties. The following properties are available using the property input parameter:

  • pressure

  • saturation

  • temperature

  • density

  • viscosity

  • mass_fraction

  • relperm

  • enthalpy

  • internal_energy

  • secondary_concentration (m(secondary species)/m(fluid))

  • mineral_concentration (m(secondary species)/m(porous material))

  • mineral_reaction_rate (m(secondary species).m(porous material).s))

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.

!!! note: As this AuxKernel uses material properties, only elemental (Monomial) AuxVariables can be used.

Input Parameters

  • variableThe name of the variable that this object applies to

    C++ Type:AuxVariableName

    Options:

    Description:The name of the variable that this object applies to

  • propertyThe fluid property that this auxillary kernel is to calculate

    C++ Type:MooseEnum

    Options:pressure saturation temperature density viscosity mass_fraction relperm enthalpy internal_energy secondary_concentration mineral_concentration mineral_reaction_rate

    Description:The fluid property that this auxillary kernel is to calculate

  • PorousFlowDictatorThe UserObject that holds the list of PorousFlow variable names

    C++ Type:UserObjectName

    Options:

    Description:The UserObject that holds the list of PorousFlow variable names

Required Parameters

  • mineral_species0The mineral chemical species number

    Default:0

    C++ Type:unsigned int

    Options:

    Description:The mineral chemical species number

  • secondary_species0The secondary chemical species number

    Default:0

    C++ Type:unsigned int

    Options:

    Description:The secondary chemical species number

  • fluid_component0The index of the fluid component this auxillary kernel acts on

    Default:0

    C++ Type:unsigned int

    Options:

    Description:The index of the fluid component this auxillary kernel acts on

  • phase0The index of the phase this auxillary kernel acts on

    Default:0

    C++ Type:unsigned int

    Options:

    Description:The index of the phase this auxillary kernel acts on

  • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

    Default:LINEAR TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE

    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies

    C++ Type:std::vector

    Options:

    Description:The list of boundary IDs from the mesh where this boundary condition applies

  • blockThe list of block ids (SubdomainID) that this object will be applied

    C++ Type:std::vector

    Options:

    Description:The list of block ids (SubdomainID) that this object will be applied

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Options:

    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

    Options:

    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

Input Files