PorousFlowPorosity

This Material calculates the porosity PorousFlow simulations

This Material computes porosity (at the nodes or quadpoints, depending on the at_nodes flag): (1) A full description is provided in the porosity documentation

Flags provided to PorousFlowPorosity control its evolution.

  • If mechanical = true then the porosity will depend on . Otherwise that term in Eq. (1) is ignored.

  • If fluid = true then the porosity will depend on . Otherwise that term in Eq. (1) is ignored.

  • If thermal = true then the porosity will depend on . Otherwise that term in Eq. (1) is ignored.

  • If chemical = true then porosity will depend on . Otherwise that term in Eq. (1) is ignored.

Input Parameters

  • 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

  • porosity_zeroThe porosity at zero volumetric strain and reference temperature and reference effective porepressure and reference chemistry. 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>

    Controllable:No

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

Required Parameters

  • at_nodesFalseEvaluate Material properties at nodes instead of quadpoints

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Evaluate Material properties at nodes instead of quadpoints

  • biot_coefficient1Biot coefficient

    Default:1

    C++ Type:double

    Controllable:No

    Description:Biot coefficient

  • biot_coefficient_primeBiot coefficient that appears in the term (biot_coefficient_prime - 1) * (P - reference_porepressure) / solid_bulk. If not provided, this defaults to the standard biot_coefficient

    C++ Type:double

    Controllable:No

    Description:Biot coefficient that appears in the term (biot_coefficient_prime - 1) * (P - reference_porepressure) / solid_bulk. If not provided, this defaults to the standard biot_coefficient

  • 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

  • chemicalFalseIf true, porosity will be a function of precipitate

    Default:False

    C++ Type:bool

    Controllable:No

    Description:If true, porosity will be a function of precipitate

  • chemical_weightsWhen chemical=true, porosity is a linear combination of the solid mineral concentrations multiplied by these weights. Default=1 for all minerals.

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

    Controllable:No

    Description:When chemical=true, porosity is a linear combination of the solid mineral concentrations multiplied by these weights. Default=1 for all minerals.

  • 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

    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

    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

    Controllable:No

    Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

  • ensure_positiveTrueModify the usual exponential relationships that governs porosity so that porosity is always positive

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Modify the usual exponential relationships that governs porosity so that porosity is always positive

  • fluidFalseIf true, porosity will be a function of effective porepressure

    Default:False

    C++ Type:bool

    Controllable:No

    Description:If true, porosity will be a function of effective porepressure

  • initial_mineral_concentrationsInitial mineral concentrations (m^3(precipitate)/m^3(porous material)), entered as a vector (one value per mineral). (Only used if chemical=true)

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

    Controllable:No

    Description:Initial mineral concentrations (m^3(precipitate)/m^3(porous material)), entered as a vector (one value per mineral). (Only used if chemical=true)

  • mechanicalFalseIf true, porosity will be a function of total volumetric strain

    Default:False

    C++ Type:bool

    Controllable:No

    Description:If true, porosity will be a function of total volumetric strain

  • 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

    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.

  • reference_chemistryReference values of the solid mineral concentrations (m^3(precipitate)/m^3(porous material)), entered as a vector (one value per mineral). (Only used if chemical=true)

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

    Controllable:No

    Description:Reference values of the solid mineral concentrations (m^3(precipitate)/m^3(porous material)), entered as a vector (one value per mineral). (Only used if chemical=true)

  • reference_porepressureReference porepressure (only used if fluid=true)

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

    Controllable:No

    Description:Reference porepressure (only used if fluid=true)

  • reference_temperatureReference temperature (only used if thermal=true)

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

    Controllable:No

    Description:Reference temperature (only used if thermal=true)

  • solid_bulkBulk modulus of the drained porous solid skeleton (only used if fluid=true)

    C++ Type:double

    Controllable:No

    Description:Bulk modulus of the drained porous solid skeleton (only used if fluid=true)

  • 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

    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

  • thermalFalseIf true, porosity will be a function of temperature

    Default:False

    C++ Type:bool

    Controllable:No

    Description:If true, porosity will be a function of temperature

  • thermal_expansion_coeffVolumetric thermal expansion coefficient of the drained porous solid skeleton (only used if thermal=true)

    C++ Type:double

    Controllable:No

    Description:Volumetric thermal expansion coefficient of the drained porous solid skeleton (only used if thermal=true)

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

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.

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

    Default:True

    C++ Type:bool

    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

    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

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

    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>

    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

Child Objects