PorousFlowHystereticRelativePermeabilityGas

This Material computes the gas relative permeability using the van Genuchten formulation. The relative permeability is assumed to be hysteretic. This Material may be used in two-phase situations only.

Along the drying curve, the relative permeability is where In these formulae:

  • is the liquid saturation

  • is the liquid residual saturation

  • is the value of the gas relative permeability for

  • is the van Genuchten exponent

  • is another exponent

See the hysteresis page for more details concerning extending the formulation in the low-saturation region () and for a definition of the wetting relative permeability.

To use this Material, it is necessary to include a PorousFlowHysteresisOrder Material, which computes and records information regarding the hysteresis order and the saturation turning points.

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

  • S_gr_maxResidual gas saturation. For liquid saturation = 1 - S_gr_max, the gas wetting relative-permeability is zero, if the turning point was <= S_lr. 1 - S_gr_max is the maximum liquid saturation for which the van Genuchten expression is valid for the liquid relative-permeability wetting curve. You must ensure S_gr_max < 1 - S_lr. Often S_gr_max = -0.3136 * ln(porosity) - 0.1334 is used

    C++ Type:double

    Controllable:No

    Description:Residual gas saturation. For liquid saturation = 1 - S_gr_max, the gas wetting relative-permeability is zero, if the turning point was <= S_lr. 1 - S_gr_max is the maximum liquid saturation for which the van Genuchten expression is valid for the liquid relative-permeability wetting curve. You must ensure S_gr_max < 1 - S_lr. Often S_gr_max = -0.3136 * ln(porosity) - 0.1334 is used

  • mvan Genuchten m parameter. Suggested value is around 0.9

    C++ Type:double

    Controllable:No

    Description:van Genuchten m parameter. Suggested value is around 0.9

  • phaseThe phase number

    C++ Type:unsigned int

    Controllable:No

    Description:The phase number

Required Parameters

  • S_lr0Liquid residual saturation. At liquid saturation = S_lr, the liquid relative permeability is zero and the gas relative permeability is k_rg_max. Almost definitely you need to set S_lr equal to the quantity used for your hysteretic capillary-pressure curve, if you are using one.

    Default:0

    C++ Type:double

    Controllable:No

    Description:Liquid residual saturation. At liquid saturation = S_lr, the liquid relative permeability is zero and the gas relative permeability is k_rg_max. Almost definitely you need to set S_lr equal to the quantity used for your hysteretic capillary-pressure curve, if you are using one.

  • 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

  • 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 boundary condition applies

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

    Controllable:No

    Description:The list of boundaries (ids or names) from the mesh where this boundary condition 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

    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.

  • gamma0.33Gamma parameter that is used for the gas relative permeability

    Default:0.33

    C++ Type:double

    Controllable:No

    Description:Gamma parameter that is used for the gas relative permeability

  • gas_low_extension_typelinear_likeType of extension to use for liquid saturation < S_lr for the gas relative permeability. All extensions employ a cubic whose value is 1.0 at liquid saturation = 0, and whose derivative is zero at liquid saturation = 0, and whose value is k_rg_max at liquid saturation = S_lr. linear_like: the derivative at liquid_saturation = S_lr is equal to (k_rg_max - 1) / S_lr. cubic: the derivative at liquid_saturation = S_lr equals the derivative of the unextended drying curve at that point

    Default:linear_like

    C++ Type:MooseEnum

    Options:linear_like, cubic

    Controllable:No

    Description:Type of extension to use for liquid saturation < S_lr for the gas relative permeability. All extensions employ a cubic whose value is 1.0 at liquid saturation = 0, and whose derivative is zero at liquid saturation = 0, and whose value is k_rg_max at liquid saturation = S_lr. linear_like: the derivative at liquid_saturation = S_lr is equal to (k_rg_max - 1) / S_lr. cubic: the derivative at liquid_saturation = S_lr equals the derivative of the unextended drying curve at that point

  • k_rg_max1Value of the gas relative permeability at liquid saturation = S_lr

    Default:1

    C++ Type:double

    Controllable:No

    Description:Value of the gas relative permeability at liquid saturation = S_lr

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

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 were 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 were you would like to restrict the output of variables(s) associated with this object

Outputs Parameters

Input Files