PorousFlowPorosityLinear

This Material computes porosity (at the nodes or quadpoints, depending on the at_nodes flag) according to

(1)

Here:

  • is the reference porosity, which is a constant-monomial variable or a real number

  • , and are real-valued coefficients

  • is the effective fluid pressure

  • is the reference effective fluid pressure, which is a coupled variable (usually linear-Lagrange) or a real number

  • is the temperature

  • is the reference temperature, which is a coupled variable (usually linear-Lagrange) or a real number

  • is the total volumetric strain

  • is the reference total volumetric strain, which is a constant monomial coupled variable or a real number.

In addition, it is possible to place a lower bound on porosity: . This can be physically useful, but can also be numerically important because during Newton-Raphson iterations, the linear relationship can sometimes yield small, or even negative, values of .

Descriptions of other porosity classes can be found in the porosity documentation

Input Parameters

  • PorousFlowDictatorThe UserObject that holds the list of PorousFlow variable names

    C++ Type:UserObjectName

    Unit:(no unit assumed)

    Controllable:No

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

  • porosity_refThe porosity at reference effective porepressure, temperature and volumetric strain. This must be a real number or a constant monomial variable (not a linear lagrange or other type of variable)

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:The porosity at reference effective porepressure, temperature and volumetric strain. This must be a real number or a constant monomial variable (not a linear lagrange or other type of variable)

Required Parameters

  • P_coeff0Effective porepressure coefficient

    Default:0

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Effective porepressure coefficient

  • P_refThe reference effective porepressure. This should usually be a linear-lagrange variable

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:The reference effective porepressure. This should usually be a linear-lagrange variable

  • T_coeff0Temperature coefficient

    Default:0

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Temperature coefficient

  • T_refThe reference temperature. This should usually be a linear-lagrange variable

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:The reference temperature. This should usually be a linear-lagrange variable

  • at_nodesFalseEvaluate Material properties at nodes instead of quadpoints

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Evaluate Material properties at nodes instead of quadpoints

  • blockThe list of blocks (ids or names) that this object will be applied

    C++ Type:std::vector<SubdomainName>

    Unit:(no unit assumed)

    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>

    Unit:(no unit assumed)

    Controllable:No

    Description:The list of boundaries (ids or names) from the mesh where this object applies

  • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

  • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

    Default:NONE

    C++ Type:MooseEnum

    Unit:(no unit assumed)

    Options:NONE, ELEMENT, SUBDOMAIN

    Controllable:No

    Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

  • declare_suffixAn optional suffix parameter that can be appended to any declared 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 declared properties. The suffix will be prepended with a '_' character.

  • epv_coeff0Volumetric-strain coefficient

    Default:0

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Volumetric-strain coefficient

  • epv_refThe reference volumetric strain. This must be a real number or a constant monomial variable (not a linear lagrange or other type of variable)

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:The reference volumetric strain. This must be a real number or a constant monomial variable (not a linear lagrange or other type of variable)

  • porosity_min0Minimum allowed value of the porosity: if the linear relationship gives values less than this value, then porosity is set to this value instead

    Default:0

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Minimum allowed value of the porosity: if the linear relationship gives values less than this value, then porosity is set to this value instead

  • 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.

  • strain_at_nearest_qpFalseWhen calculating nodal porosity that depends on strain, use the strain at the nearest quadpoint. This adds a small extra computational burden, and is not necessary for simulations involving only linear lagrange elements. If you set this to true, you will also want to set the same parameter to true for related Kernels and Materials

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:When calculating nodal porosity that depends on strain, use the strain at the nearest quadpoint. This adds a small extra computational burden, and is not necessary for simulations involving only linear lagrange elements. If you set this to true, you will also want to set the same parameter to true for related Kernels and Materials

  • 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

    Unit:(no unit assumed)

    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.

Optional Parameters

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

    C++ Type:std::vector<std::string>

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Determines whether this object is calculated using an implicit or explicit form

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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.

  • zero_modifier0.001If the linear relationship produces porosity < porosity_min, then porosity is set porosity_min. This means the derivatives of it will be zero. However, these zero derivatives often result in poor NR convergence, so the derivatives are set to _zero_modifier * (values that are relevant for min porosity) to hint to the NR that porosity is not always constant

    Default:0.001

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:If the linear relationship produces porosity < porosity_min, then porosity is set porosity_min. This means the derivatives of it will be zero. However, these zero derivatives often result in poor NR convergence, so the derivatives are set to _zero_modifier * (values that are relevant for min porosity) to hint to the NR that porosity is not always constant

Advanced Parameters

  • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

    C++ Type:std::vector<std::string>

    Unit:(no unit assumed)

    Controllable:No

    Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

  • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

    Default:none

    C++ Type:std::vector<OutputName>

    Unit:(no unit assumed)

    Controllable:No

    Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

Outputs Parameters

Input Files