PorousFlowHystereticCapillaryPressure

This is a base class that enables computation of capillary pressure, saturations and porepressures in models with hysteresis. It should not usually appear in MOOSE input files. Its derived classes, which should be employed in MOOSE input files, are:

PorousFlow1PhaseHysP which computes the saturation given the porepressure in partially-saturated 1-phase systems
PorousFlowHystereticInfo which computes the capillary pressure, and other quantities, given the saturation.

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. 1 - S_gr_max is the maximum saturation for which the van Genuchten expression is valid for the wetting curve. You must ensure S_gr_max < 1 - S_l_min. Often S_gr_max = -0.3136 * ln(porosity) - 0.1334 is used
C++ Type:double
Controllable:No
Description:Residual gas saturation. 1 - S_gr_max is the maximum saturation for which the van Genuchten expression is valid for the wetting curve. You must ensure S_gr_max < 1 - S_l_min. Often S_gr_max = -0.3136 * ln(porosity) - 0.1334 is used
S_l_minMinimum liquid saturation for which the van Genuchten expression is valid. If no lower extension is used then Pc = Pc_max for liquid saturation <= S_l_min
C++ Type:double
Controllable:No
Description:Minimum liquid saturation for which the van Genuchten expression is valid. If no lower extension is used then Pc = Pc_max for liquid saturation <= S_l_min
alpha_dvan Genuchten alpha parameter for the primary drying curve. If using standard units, this is measured in Pa^-1. Suggested value is around 1E-5
C++ Type:double
Controllable:No
Description:van Genuchten alpha parameter for the primary drying curve. If using standard units, this is measured in Pa^-1. Suggested value is around 1E-5
alpha_wvan Genuchten alpha parameter for the primary wetting curve. If using standard units, this is measured in Pa^-1. Suggested value is around 1E-5
C++ Type:double
Controllable:No
Description:van Genuchten alpha parameter for the primary wetting curve. If using standard units, this is measured in Pa^-1. Suggested value is around 1E-5
n_dvan Genuchten n parameter for the primary drying curve. Dimensionless. Suggested value is around 2
C++ Type:double
Controllable:No
Description:van Genuchten n parameter for the primary drying curve. Dimensionless. Suggested value is around 2
n_wvan Genuchten n parameter for the primary wetting curve. Dimensionless. Suggested value is around 2
C++ Type:double
Controllable:No
Description:van Genuchten n parameter for the primary wetting curve. Dimensionless. Suggested value is around 2

Required Parameters

Pc_max1.79769e+308Value of capillary pressure at which the lower extension commences. The default value means capillary pressure uses the van Genuchten expression for S > S_l_min and is 'infinity' for S <= S_l_min. This will result in poor convergence around S = S_l_min
Default:1.79769e+308
C++ Type:double
Controllable:No
Description:Value of capillary pressure at which the lower extension commences. The default value means capillary pressure uses the van Genuchten expression for S > S_l_min and is 'infinity' for S <= S_l_min. This will result in poor convergence around S = S_l_min
S_lr0Liquid residual saturation where the liquid relative permeability is zero. This is used in the Land expression to find S_gr_del. Almost definitely you need to set S_lr equal to the quantity used for your relative-permeability curves. Almost definitely you should set S_lr > S_l_min
Default:0
C++ Type:double
Controllable:No
Description:Liquid residual saturation where the liquid relative permeability is zero. This is used in the Land expression to find S_gr_del. Almost definitely you need to set S_lr equal to the quantity used for your relative-permeability curves. Almost definitely you should set S_lr > S_l_min
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.
high_extension_typepowerType of extension to use for the wetting curves when the liquid saturation is around 1. The extensions modify the wetting capillary pressure for all saturation values greater than high_ratio * (1 - S_gr_del), where 1 - S_gr_del is the value of liquid saturation when the van Genuchten expression gives Pc = 0. NONE: use the van Genuchten expression and when S > 1 - S_gr_del, set Pc = 0. POWER: Pc is proportional to (1 - S)^power, where the coefficient of proportionality and the power are chosen so the resulting curve is continuous and differentiable
Default:power
C++ Type:MooseEnum
Options:none, power
Controllable:No
Description:Type of extension to use for the wetting curves when the liquid saturation is around 1. The extensions modify the wetting capillary pressure for all saturation values greater than high_ratio * (1 - S_gr_del), where 1 - S_gr_del is the value of liquid saturation when the van Genuchten expression gives Pc = 0. NONE: use the van Genuchten expression and when S > 1 - S_gr_del, set Pc = 0. POWER: Pc is proportional to (1 - S)^power, where the coefficient of proportionality and the power are chosen so the resulting curve is continuous and differentiable
high_ratio0.9The extension to the wetting curves commences at high_ratio * (1 - S_gr_del), where 1 - S_gr_del is the value of the liquid saturation when Pc = 0 (on the wetting curve)
Default:0.9
C++ Type:double
Controllable:No
Description:The extension to the wetting curves commences at high_ratio * (1 - S_gr_del), where 1 - S_gr_del is the value of the liquid saturation when Pc = 0 (on the wetting curve)
low_extension_typeexponentialType of extension to use for small liquid saturation values. The extensions modify the capillary pressure for all saturation values less than S(Pc_max). That is, if the van Genuchten expression would produce Pc > Pc_max, then the extension is used instead. NONE: Simply cut-off the capillary-pressure at Pc_max, so that Pc <= Pc_max for all S. QUADRATIC: Pc is a quadratic in S that is continuous and differentiable at S(Pc_max) and has zero derivative at S = 0 (hence, its value at S = 0 will be greater than Pc_max). EXPONENTIAL: Pc is an exponential in S that is continuous and differentiable at S(Pc_max) (hence, its value at S = 0 will be much greater than Pc_max
Default:exponential
C++ Type:MooseEnum
Options:none, quadratic, exponential
Controllable:No
Description:Type of extension to use for small liquid saturation values. The extensions modify the capillary pressure for all saturation values less than S(Pc_max). That is, if the van Genuchten expression would produce Pc > Pc_max, then the extension is used instead. NONE: Simply cut-off the capillary-pressure at Pc_max, so that Pc <= Pc_max for all S. QUADRATIC: Pc is a quadratic in S that is continuous and differentiable at S(Pc_max) and has zero derivative at S = 0 (hence, its value at S = 0 will be greater than Pc_max). EXPONENTIAL: Pc is an exponential in S that is continuous and differentiable at S(Pc_max) (hence, its value at S = 0 will be much greater than Pc_max
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

Child Objects

(modules/porous_flow/include/materials/PorousFlow2PhaseHysPS.h)
(modules/porous_flow/include/materials/PorousFlow2PhaseHysPP.h)
(modules/porous_flow/include/materials/PorousFlow1PhaseHysP.h)
(modules/porous_flow/include/materials/PorousFlowHystereticInfo.h)

(modules/porous_flow/include/materials/PorousFlow2PhaseHysPS.h)

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// All rights reserved, see COPYRIGHT for full restrictions
// https://github.com/idaholab/moose/blob/master/COPYRIGHT
//
// Licensed under LGPL 2.1, please see LICENSE for details
// https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "PorousFlowHystereticCapillaryPressure.h"

/**
 * Material designed to calculate the 2 porepressures and 2 saturations, as well as derivatives of
 * them, as well as capillary pressure, in two-phase situations with hysteretic capillary pressure,
 * assuming the liquid porepressure and gas saturation are the nonlinear variables.
 */
class PorousFlow2PhaseHysPS : public PorousFlowHystereticCapillaryPressure
{
public:
  static InputParameters validParams();

  PorousFlow2PhaseHysPS(const InputParameters & parameters);

protected:
  virtual void initQpStatefulProperties() override;
  virtual void computeQpProperties() override;

  /// Computed nodal or quadpoint values of capillary pressure
  MaterialProperty<Real> & _pc;

  /**
   * Assemble std::vectors of porepressure and saturation at the nodes
   * and quadpoints
   */
  void buildQpPPSS();

  /// Nodal or quadpoint value of porepressure of phase zero (the liquid phase)
  const VariableValue & _phase0_porepressure;
  /// Gradient(phase0_porepressure) at the qps
  const VariableGradient & _phase0_gradp_qp;
  /// Moose variable number of the phase0 porepressure
  const unsigned int _phase0_porepressure_varnum;
  /// PorousFlow variable number of the phase0 porepressure
  const unsigned int _pvar;
  /// Nodal or quadpoint value of saturation of phase one (the gas phase)
  const VariableValue & _phase1_saturation;
  /// Gradient(phase1_saturation) at the qps
  const VariableGradient & _phase1_grads_qp;
  /// Moose variable number of the phase1 saturation
  const unsigned int _phase1_saturation_varnum;
  /// PorousFlow variable number of the phase1 saturation
  const unsigned int _svar;
};

(modules/porous_flow/include/materials/PorousFlow2PhaseHysPP.h)

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// All rights reserved, see COPYRIGHT for full restrictions
// https://github.com/idaholab/moose/blob/master/COPYRIGHT
//
// Licensed under LGPL 2.1, please see LICENSE for details
// https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "PorousFlowHystereticCapillaryPressure.h"

/**
 * Material designed to calculate the 2 porepressures and 2 saturations, as well as derivatives of
 * them, as well as capillary pressure, in two-phase situations with hysteretic capillary pressure,
 * assuming the phase porepressures as the nonlinear variables.
 */
class PorousFlow2PhaseHysPP : public PorousFlowHystereticCapillaryPressure
{
public:
  static InputParameters validParams();

  PorousFlow2PhaseHysPP(const InputParameters & parameters);

protected:
  virtual void initQpStatefulProperties() override;
  virtual void computeQpProperties() override;

  /// Computed nodal or quadpoint values of capillary pressure
  MaterialProperty<Real> & _pc;

  /**
   * Assemble std::vectors of porepressure and saturation at the nodes
   * and quadpoints
   */
  void buildQpPPSS();

  /// Nodal or quadpoint value of porepressure of the zero phase (eg, the water phase)
  const VariableValue & _phase0_porepressure;
  /// Gradient(phase0_porepressure) at the qps
  const VariableGradient & _phase0_gradp_qp;
  /// Moose variable number of the phase0 porepressure
  const unsigned int _phase0_porepressure_varnum;
  /// PorousFlow variable number of the phase0 porepressure
  const unsigned int _p0var;
  /// Nodal or quadpoint value of porepressure of the one phase (eg, the gas phase)
  const VariableValue & _phase1_porepressure;
  /// Gradient(phase1_porepressure) at the qps
  const VariableGradient & _phase1_gradp_qp;
  /// Moose variable number of the phase1 porepressure
  const unsigned int _phase1_porepressure_varnum;
  /// PorousFlow variable number of the phase1 porepressure
  const unsigned int _p1var;
};

(modules/porous_flow/include/materials/PorousFlow1PhaseHysP.h)

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// All rights reserved, see COPYRIGHT for full restrictions
// https://github.com/idaholab/moose/blob/master/COPYRIGHT
//
// Licensed under LGPL 2.1, please see LICENSE for details
// https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "PorousFlowHystereticCapillaryPressure.h"

/**
 * Material designed to calculate fluid phase porepressure and saturation
 * for the single-phase partially-saturation situation with hysteretic capillary pressure and
 * assuming porepressure is a nonlinear variable
 */
class PorousFlow1PhaseHysP : public PorousFlowHystereticCapillaryPressure
{
public:
  static InputParameters validParams();

  PorousFlow1PhaseHysP(const InputParameters & parameters);

protected:
  virtual void initQpStatefulProperties() override;
  virtual void computeQpProperties() override;

  /// Computed nodal or quadpoint values of capillary pressure
  MaterialProperty<Real> & _pc;

  /**
   * Assemble std::vectors of porepressure and saturation
   */
  void buildQpPPSS();

  /// Nodal or quadpoint value of porepressure of the fluid phase
  const VariableValue & _porepressure_var;
  /// Gradient(_porepressure at quadpoints)
  const VariableGradient & _gradp_qp_var;
  /// Moose variable number of the porepressure
  const unsigned int _porepressure_varnum;
  /// The PorousFlow variable number of the porepressure
  const unsigned int _p_var_num;
};

(modules/porous_flow/include/materials/PorousFlowHystereticInfo.h)

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// All rights reserved, see COPYRIGHT for full restrictions
// https://github.com/idaholab/moose/blob/master/COPYRIGHT
//
// Licensed under LGPL 2.1, please see LICENSE for details
// https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "PorousFlowHystereticCapillaryPressure.h"

/**
 * Material designed to calculate the capillary pressure as a function of saturation, or the
 * saturation as a function of capillary pressure, or derivative information, etc
 */
class PorousFlowHystereticInfo : public PorousFlowHystereticCapillaryPressure
{
public:
  static InputParameters validParams();

  PorousFlowHystereticInfo(const InputParameters & parameters);

protected:
  virtual void initQpStatefulProperties() override;
  virtual void computeQpProperties() override;

  /// Fill _info with the required information
  void computeQpInfo();

  /// Computed nodal or quadpoint value of capillary pressure (needed for hysteretic order computation)
  MaterialProperty<Real> & _pc;

  /// Computed nodal or quadpoint value: the meaning of this depends on info_enum
  MaterialProperty<Real> & _info;

  /// Nodal or quadpoint value of capillary pressure
  const VariableValue & _pc_val;

  /// Nodal or quadpoint value of liquid saturation
  const VariableValue & _sat_val;

  /// small parameter to use in the finite-difference approximations to the derivative
  const Real _fd_eps;

  /// Type of info required
  const enum class InfoTypeEnum {
    PC,
    SAT,
    SAT_GIVEN_PC,
    DS_DPC_ERR,
    DPC_DS_ERR,
    D2S_DPC2_ERR,
    D2PC_DS2_ERR
  } _info_enum;

private:
  /**
   * Computes the relative error between a finite-difference approximation to the derivative and a
   * hand-coded version
   * @return finite_difference / hand_coded - 1, with appropriate guards against division by zero
   * @param finite_difference the finite-difference approximation to the derivative
   * @param hand_coded the hand-coded derivative
   */
  Real relativeError(Real finite_difference, Real hand_coded);
};

Input Parameters
Child Objects

Install MOOSE

New Users

Examples and Tutorials

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools

INL Applications and Remote Access