www.mooseframework.org
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
PorousFlowCapillaryPressureVG Class Reference

van Genuchten form of capillary pressure. More...

#include <PorousFlowCapillaryPressureVG.h>

Inheritance diagram for PorousFlowCapillaryPressureVG:
[legend]

Public Member Functions

 PorousFlowCapillaryPressureVG (const InputParameters &parameters)
 
virtual Real capillaryPressureCurve (Real saturation, unsigned qp=0) const override
 Raw capillary pressure curve (does not include logarithmic extension) More...
 
virtual Real dCapillaryPressureCurve (Real saturation, unsigned qp=0) const override
 Derivative of raw capillary pressure wrt true saturation. More...
 
virtual Real d2CapillaryPressureCurve (Real saturation, unsigned qp=0) const override
 Second derivative of raw capillary pressure wrt true saturation. More...
 
virtual Real effectiveSaturation (Real pc, unsigned qp=0) const override
 Effective saturation as a function of capillary pressure. More...
 
virtual Real dEffectiveSaturation (Real pc, unsigned qp=0) const override
 Derivative of effective saturation wrt capillary pressure. More...
 
virtual Real d2EffectiveSaturation (Real pc, unsigned qp=0) const override
 Second derivative of effective saturation wrt capillary pressure. More...
 
virtual void initialize () final
 
virtual void initialSetup () override
 
virtual Real capillaryPressure (Real saturation, unsigned qp=0) const
 Capillary pressure is calculated as a function of true saturation. More...
 
virtual Real dCapillaryPressure (Real saturation, unsigned qp=0) const
 Derivative of capillary pressure wrt true saturation. More...
 
virtual Real d2CapillaryPressure (Real saturation, unsigned qp=0) const
 Second derivative of capillary pressure wrt true saturation. More...
 
Real saturation (Real pc, unsigned qp=0) const
 Saturation as a function of capillary pressure. More...
 
Real dSaturation (Real pc, unsigned qp=0) const
 Derivative of saturation wrt capillary pressure. More...
 
Real d2Saturation (Real pc, unsigned qp=0) const
 Second derivative of saturation wrt capillary pressure. More...
 

Protected Member Functions

Real effectiveSaturationFromSaturation (Real saturation) const
 Effective saturation of liquid phase given liquid saturation and residual liquid saturation. More...
 
Real extensionSaturation () const
 Calculates the saturation where the logarithmic extension to capillary pressure meets the raw curve using Newton's method. More...
 
Real interceptFunction (Real s) const
 Calculates the saturation where the logarithmic extension to capillary pressure at low saturation. More...
 
Real interceptFunctionDeriv (Real s) const
 Calculates the saturation where the logarithmic extension to capillary pressure at low saturation. More...
 
Real capillaryPressureLogExt (Real s) const
 The capillary pressure in the logarithmic extension This implementation assumes capillary-pressure is a function of saturation only, and not any other quad-point dependent quantities. More...
 
Real dCapillaryPressureLogExt (Real s) const
 The derivative of capillary pressure in the logarithmic extension This implementation assumes capillary-pressure is a function of saturation only, and not any other quad-point dependent quantities. More...
 
Real d2CapillaryPressureLogExt (Real s) const
 The second derivative of capillary pressure in the logarithmic extension This implementation assumes capillary-pressure is a function of saturation only, and not any other quad-point dependent quantities. More...
 

Protected Attributes

const Real _m
 van Genuchten exponent m More...
 
const Real _alpha
 van Genuchten capillary coefficient alpha More...
 
const Real _s_scale
 Capillary pressure = f(Seff * s_scale) - pc_sscale, where f is the van Genuchten function. For almost all simulations s_scale=1 will be appropriate. More...
 
const Real _pc_sscale
 pc_sscale = f(s_scale), where f is the van Genuchten function More...
 
const Real _sat_lr
 Liquid residual saturation. More...
 
const Real _dseff_ds
 Derivative of effective saturation with respect to saturation. More...
 
bool _log_ext
 Flag to use a logarithmic extension for low saturation. More...
 
const Real _pc_max
 Maximum capillary pressure (Pa). Note: must be <= 0. More...
 
Real _sat_ext
 Saturation where the logarithmic extension meets the raw curve This is computed only for qp=0. More...
 
Real _pc_ext
 Capillary pressure where the extension meets the raw curve. More...
 
Real _slope_ext
 Gradient of the logarithmic extension This is computed only for qp=0. More...
 
const Real _log10
 log(10) More...
 

Detailed Description

van Genuchten form of capillary pressure.

From van Genuchten, M. Th., A closed for equation for predicting the hydraulic conductivity of unsaturated soils, Soil Sci. Soc., 44, 892-898 (1980)

Definition at line 26 of file PorousFlowCapillaryPressureVG.h.

Constructor & Destructor Documentation

◆ PorousFlowCapillaryPressureVG()

PorousFlowCapillaryPressureVG::PorousFlowCapillaryPressureVG ( const InputParameters &  parameters)

Definition at line 39 of file PorousFlowCapillaryPressureVG.C.

40  : PorousFlowCapillaryPressure(parameters),
41  _m(getParam<Real>("m")),
42  _alpha(getParam<Real>("alpha")),
43  _s_scale(getParam<Real>("s_scale")),
44  _pc_sscale(PorousFlowVanGenuchten::capillaryPressure(_s_scale, _alpha, _m, _pc_max))
45 {
46 }
PorousFlowCapillaryPressureVG::_m
const Real _m
van Genuchten exponent m
Definition: PorousFlowCapillaryPressureVG.h:41
PorousFlowCapillaryPressure::_pc_max
const Real _pc_max
Maximum capillary pressure (Pa). Note: must be <= 0.
Definition: PorousFlowCapillaryPressure.h:231
PorousFlowCapillaryPressureVG::_alpha
const Real _alpha
van Genuchten capillary coefficient alpha
Definition: PorousFlowCapillaryPressureVG.h:43
PorousFlowCapillaryPressure::PorousFlowCapillaryPressure
PorousFlowCapillaryPressure(const InputParameters &parameters)
Definition: PorousFlowCapillaryPressure.C:37
PorousFlowCapillaryPressureVG::_s_scale
const Real _s_scale
Capillary pressure = f(Seff * s_scale) - pc_sscale, where f is the van Genuchten function. For almost all simulations s_scale=1 will be appropriate.
Definition: PorousFlowCapillaryPressureVG.h:45
PorousFlowCapillaryPressureVG::_pc_sscale
const Real _pc_sscale
pc_sscale = f(s_scale), where f is the van Genuchten function
Definition: PorousFlowCapillaryPressureVG.h:47
PorousFlowVanGenuchten::capillaryPressure
Real capillaryPressure(Real seff, Real alpha, Real m, Real pc_max)
Capillary pressure as a function of effective saturation.
Definition: PorousFlowVanGenuchten.C:63

Member Function Documentation

◆ capillaryPressure()

Real PorousFlowCapillaryPressure::capillaryPressure ( Real  saturation,
unsigned  qp = 0 
) const
virtualinherited

Capillary pressure is calculated as a function of true saturation.

Note that this method includes the ability to use a logarithmic extension at low saturation.

Parameters
saturationtrue saturation
qpquadpoint to use (when capillary-pressure depends on coupled variables, not just saturation)
Returns
capillary pressure (Pa)

Definition at line 64 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlow2PhasePS::buildQpPPSS(), PorousFlowCapillaryPressure::initialSetup(), PorousFlowWaterNCG::thermophysicalProperties(), PorousFlowBrineCO2::thermophysicalProperties(), PorousFlowWaterNCG::totalMassFraction(), and PorousFlowBrineCO2::totalMassFraction().

65 {
66  if (_log_ext && saturation < _sat_ext)
67  return capillaryPressureLogExt(saturation);
68  else
69  return capillaryPressureCurve(saturation, qp);
70 }
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:97
PorousFlowCapillaryPressure::capillaryPressureCurve
virtual Real capillaryPressureCurve(Real saturation, unsigned qp=0) const =0
Raw capillary pressure curve (does not include logarithmic extension)
PorousFlowCapillaryPressure::capillaryPressureLogExt
Real capillaryPressureLogExt(Real s) const
The capillary pressure in the logarithmic extension This implementation assumes capillary-pressure is...
Definition: PorousFlowCapillaryPressure.C:115
PorousFlowCapillaryPressure::_sat_ext
Real _sat_ext
Saturation where the logarithmic extension meets the raw curve This is computed only for qp=0...
Definition: PorousFlowCapillaryPressure.h:237
PorousFlowCapillaryPressure::_log_ext
bool _log_ext
Flag to use a logarithmic extension for low saturation.
Definition: PorousFlowCapillaryPressure.h:229

◆ capillaryPressureCurve()

Real PorousFlowCapillaryPressureVG::capillaryPressureCurve ( Real  saturation,
unsigned  qp = 0 
) const
overridevirtual

Raw capillary pressure curve (does not include logarithmic extension)

Parameters
saturationtrue saturation
Returns
capillary pressure (Pa)

Implements PorousFlowCapillaryPressure.

Definition at line 49 of file PorousFlowCapillaryPressureVG.C.

50 {
51  const Real seff = effectiveSaturationFromSaturation(saturation) * _s_scale;
52  return PorousFlowVanGenuchten::capillaryPressure(seff, _alpha, _m, _pc_max) - _pc_sscale;
53 }
PorousFlowCapillaryPressureVG::_m
const Real _m
van Genuchten exponent m
Definition: PorousFlowCapillaryPressureVG.h:41
PorousFlowCapillaryPressure::effectiveSaturationFromSaturation
Real effectiveSaturationFromSaturation(Real saturation) const
Effective saturation of liquid phase given liquid saturation and residual liquid saturation.
Definition: PorousFlowCapillaryPressure.C:91
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:97
PorousFlowCapillaryPressure::_pc_max
const Real _pc_max
Maximum capillary pressure (Pa). Note: must be <= 0.
Definition: PorousFlowCapillaryPressure.h:231
PorousFlowCapillaryPressureVG::_alpha
const Real _alpha
van Genuchten capillary coefficient alpha
Definition: PorousFlowCapillaryPressureVG.h:43
PorousFlowCapillaryPressureVG::_s_scale
const Real _s_scale
Capillary pressure = f(Seff * s_scale) - pc_sscale, where f is the van Genuchten function. For almost all simulations s_scale=1 will be appropriate.
Definition: PorousFlowCapillaryPressureVG.h:45
PorousFlowCapillaryPressureVG::_pc_sscale
const Real _pc_sscale
pc_sscale = f(s_scale), where f is the van Genuchten function
Definition: PorousFlowCapillaryPressureVG.h:47
PorousFlowVanGenuchten::capillaryPressure
Real capillaryPressure(Real seff, Real alpha, Real m, Real pc_max)
Capillary pressure as a function of effective saturation.
Definition: PorousFlowVanGenuchten.C:63

◆ capillaryPressureLogExt()

Real PorousFlowCapillaryPressure::capillaryPressureLogExt ( Real  s) const
protectedinherited

The capillary pressure in the logarithmic extension This implementation assumes capillary-pressure is a function of saturation only, and not any other quad-point dependent quantities.

Parameters
sliquid saturation
Returns
capillary pressure in logarithmic extension

Definition at line 115 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlowCapillaryPressure::capillaryPressure().

116 {
117  return _pc_ext * std::pow(10.0, _slope_ext * (saturation - _sat_ext));
118 }
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:97
PorousFlowCapillaryPressure::_slope_ext
Real _slope_ext
Gradient of the logarithmic extension This is computed only for qp=0.
Definition: PorousFlowCapillaryPressure.h:247
pow
ExpressionBuilder::EBTerm pow(const ExpressionBuilder::EBTerm &left, T exponent)
Definition: ExpressionBuilder.h:674
PorousFlowCapillaryPressure::_pc_ext
Real _pc_ext
Capillary pressure where the extension meets the raw curve.
Definition: PorousFlowCapillaryPressure.h:242
PorousFlowCapillaryPressure::_sat_ext
Real _sat_ext
Saturation where the logarithmic extension meets the raw curve This is computed only for qp=0...
Definition: PorousFlowCapillaryPressure.h:237

◆ d2CapillaryPressure()

Real PorousFlowCapillaryPressure::d2CapillaryPressure ( Real  saturation,
unsigned  qp = 0 
) const
virtualinherited

Second derivative of capillary pressure wrt true saturation.

Parameters
saturationtrue saturation
qpquadpoint to use (when capillary-pressure depends on coupled variables, not just saturation)
Returns
second derivative of capillary pressure with respect to true saturation

Definition at line 82 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlow2PhasePS::computeQpProperties(), and PorousFlowFluidState::computeQpProperties().

83 {
84  if (_log_ext && saturation < _sat_ext)
85  return d2CapillaryPressureLogExt(saturation);
86  else
87  return d2CapillaryPressureCurve(saturation, qp);
88 }
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:97
PorousFlowCapillaryPressure::d2CapillaryPressureLogExt
Real d2CapillaryPressureLogExt(Real s) const
The second derivative of capillary pressure in the logarithmic extension This implementation assumes ...
Definition: PorousFlowCapillaryPressure.C:127
PorousFlowCapillaryPressure::d2CapillaryPressureCurve
virtual Real d2CapillaryPressureCurve(Real saturation, unsigned qp=0) const =0
Second derivative of raw capillary pressure wrt true saturation.
PorousFlowCapillaryPressure::_sat_ext
Real _sat_ext
Saturation where the logarithmic extension meets the raw curve This is computed only for qp=0...
Definition: PorousFlowCapillaryPressure.h:237
PorousFlowCapillaryPressure::_log_ext
bool _log_ext
Flag to use a logarithmic extension for low saturation.
Definition: PorousFlowCapillaryPressure.h:229

◆ d2CapillaryPressureCurve()

Real PorousFlowCapillaryPressureVG::d2CapillaryPressureCurve ( Real  saturation,
unsigned  qp = 0 
) const
overridevirtual

Second derivative of raw capillary pressure wrt true saturation.

Parameters
saturationtrue saturation
Returns
second derivative of capillary pressure with respect to true saturation

Implements PorousFlowCapillaryPressure.

Definition at line 64 of file PorousFlowCapillaryPressureVG.C.

65 {
66  const Real seff = effectiveSaturationFromSaturation(saturation) * _s_scale;
67  return PorousFlowVanGenuchten::d2CapillaryPressure(seff, _alpha, _m, _pc_max) * _dseff_ds *
68  _dseff_ds * _s_scale * _s_scale;
69 }
PorousFlowCapillaryPressureVG::_m
const Real _m
van Genuchten exponent m
Definition: PorousFlowCapillaryPressureVG.h:41
PorousFlowCapillaryPressure::effectiveSaturationFromSaturation
Real effectiveSaturationFromSaturation(Real saturation) const
Effective saturation of liquid phase given liquid saturation and residual liquid saturation.
Definition: PorousFlowCapillaryPressure.C:91
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:97
PorousFlowCapillaryPressure::_pc_max
const Real _pc_max
Maximum capillary pressure (Pa). Note: must be <= 0.
Definition: PorousFlowCapillaryPressure.h:231
PorousFlowVanGenuchten::d2CapillaryPressure
Real d2CapillaryPressure(Real seff, Real alpha, Real m, Real pc_max)
Second derivative of capillary pressure wrt effective saturation.
Definition: PorousFlowVanGenuchten.C:93
PorousFlowCapillaryPressureVG::_alpha
const Real _alpha
van Genuchten capillary coefficient alpha
Definition: PorousFlowCapillaryPressureVG.h:43
PorousFlowCapillaryPressureVG::_s_scale
const Real _s_scale
Capillary pressure = f(Seff * s_scale) - pc_sscale, where f is the van Genuchten function. For almost all simulations s_scale=1 will be appropriate.
Definition: PorousFlowCapillaryPressureVG.h:45
PorousFlowCapillaryPressure::_dseff_ds
const Real _dseff_ds
Derivative of effective saturation with respect to saturation.
Definition: PorousFlowCapillaryPressure.h:227

◆ d2CapillaryPressureLogExt()

Real PorousFlowCapillaryPressure::d2CapillaryPressureLogExt ( Real  s) const
protectedinherited

The second derivative of capillary pressure in the logarithmic extension This implementation assumes capillary-pressure is a function of saturation only, and not any other quad-point dependent quantities.

Parameters
sliquid saturation
Returns
second derivative of capillary pressure in logarithmic extension

Definition at line 127 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlowCapillaryPressure::d2CapillaryPressure().

128 {
129  return _pc_ext * _slope_ext * _slope_ext * _log10 * _log10 *
130  std::pow(10.0, _slope_ext * (saturation - _sat_ext));
131 }
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:97
PorousFlowCapillaryPressure::_slope_ext
Real _slope_ext
Gradient of the logarithmic extension This is computed only for qp=0.
Definition: PorousFlowCapillaryPressure.h:247
pow
ExpressionBuilder::EBTerm pow(const ExpressionBuilder::EBTerm &left, T exponent)
Definition: ExpressionBuilder.h:674
PorousFlowCapillaryPressure::_pc_ext
Real _pc_ext
Capillary pressure where the extension meets the raw curve.
Definition: PorousFlowCapillaryPressure.h:242
PorousFlowCapillaryPressure::_sat_ext
Real _sat_ext
Saturation where the logarithmic extension meets the raw curve This is computed only for qp=0...
Definition: PorousFlowCapillaryPressure.h:237

◆ d2EffectiveSaturation()

Real PorousFlowCapillaryPressureVG::d2EffectiveSaturation ( Real  pc,
unsigned  qp = 0 
) const
overridevirtual

Second derivative of effective saturation wrt capillary pressure.

Parameters
pccapillary pressure
qpquadpoint to use (when effective saturation depends on coupled variables, not just pc)
Returns
second derivative of effective saturation wrt capillary pressure

Implements PorousFlowCapillaryPressure.

Definition at line 86 of file PorousFlowCapillaryPressureVG.C.

87 {
88  return (1.0 / _s_scale) *
89  PorousFlowVanGenuchten::d2EffectiveSaturation(pc - _pc_sscale, _alpha, _m);
90 }
PorousFlowCapillaryPressureVG::_m
const Real _m
van Genuchten exponent m
Definition: PorousFlowCapillaryPressureVG.h:41
PorousFlowCapillaryPressureVG::_alpha
const Real _alpha
van Genuchten capillary coefficient alpha
Definition: PorousFlowCapillaryPressureVG.h:43
PorousFlowCapillaryPressureVG::_s_scale
const Real _s_scale
Capillary pressure = f(Seff * s_scale) - pc_sscale, where f is the van Genuchten function. For almost all simulations s_scale=1 will be appropriate.
Definition: PorousFlowCapillaryPressureVG.h:45
PorousFlowVanGenuchten::d2EffectiveSaturation
Real d2EffectiveSaturation(Real p, Real alpha, Real m)
Second derivative of effective saturation wrt porepressure.
Definition: PorousFlowVanGenuchten.C:46
PorousFlowCapillaryPressureVG::_pc_sscale
const Real _pc_sscale
pc_sscale = f(s_scale), where f is the van Genuchten function
Definition: PorousFlowCapillaryPressureVG.h:47

◆ d2Saturation()

Real PorousFlowCapillaryPressure::d2Saturation ( Real  pc,
unsigned  qp = 0 
) const
inherited

Second derivative of saturation wrt capillary pressure.

Parameters
pccapillary pressure
qpquadpoint to use (when saturation depends on coupled variables, not just pc)
Returns
second derivative of saturation wrt capillary pressure

Definition at line 109 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlow2PhasePP::computeQpProperties(), and PorousFlow1PhaseP::computeQpProperties().

110 {
111  return d2EffectiveSaturation(pc, qp) * (1.0 - _sat_lr);
112 }
PorousFlowCapillaryPressure::d2EffectiveSaturation
virtual Real d2EffectiveSaturation(Real pc, unsigned qp=0) const =0
Second derivative of effective saturation wrt capillary pressure.
PorousFlowCapillaryPressure::_sat_lr
const Real _sat_lr
Liquid residual saturation.
Definition: PorousFlowCapillaryPressure.h:225

◆ dCapillaryPressure()

Real PorousFlowCapillaryPressure::dCapillaryPressure ( Real  saturation,
unsigned  qp = 0 
) const
virtualinherited

Derivative of capillary pressure wrt true saturation.

Parameters
saturationtrue saturation
qpquadpoint to use (when capillary-pressure depends on coupled variables, not just saturation)
Returns
derivative of capillary pressure with respect to true saturation

Definition at line 73 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlow2PhasePS::computeQpProperties(), and PorousFlowFluidState::computeQpProperties().

74 {
75  if (_log_ext && saturation < _sat_ext)
76  return dCapillaryPressureLogExt(saturation);
77  else
78  return dCapillaryPressureCurve(saturation, qp);
79 }
PorousFlowCapillaryPressure::dCapillaryPressureCurve
virtual Real dCapillaryPressureCurve(Real saturation, unsigned qp=0) const =0
Derivative of raw capillary pressure wrt true saturation.
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:97
PorousFlowCapillaryPressure::_sat_ext
Real _sat_ext
Saturation where the logarithmic extension meets the raw curve This is computed only for qp=0...
Definition: PorousFlowCapillaryPressure.h:237
PorousFlowCapillaryPressure::_log_ext
bool _log_ext
Flag to use a logarithmic extension for low saturation.
Definition: PorousFlowCapillaryPressure.h:229
PorousFlowCapillaryPressure::dCapillaryPressureLogExt
Real dCapillaryPressureLogExt(Real s) const
The derivative of capillary pressure in the logarithmic extension This implementation assumes capilla...
Definition: PorousFlowCapillaryPressure.C:121

◆ dCapillaryPressureCurve()

Real PorousFlowCapillaryPressureVG::dCapillaryPressureCurve ( Real  saturation,
unsigned  qp = 0 
) const
overridevirtual

Derivative of raw capillary pressure wrt true saturation.

Parameters
saturationtrue saturation
Returns
derivative of capillary pressure with respect to true saturation

Implements PorousFlowCapillaryPressure.

Definition at line 56 of file PorousFlowCapillaryPressureVG.C.

57 {
58  const Real seff = effectiveSaturationFromSaturation(saturation) * _s_scale;
59  return PorousFlowVanGenuchten::dCapillaryPressure(seff, _alpha, _m, _pc_max) * _dseff_ds *
60  _s_scale;
61 }
PorousFlowCapillaryPressureVG::_m
const Real _m
van Genuchten exponent m
Definition: PorousFlowCapillaryPressureVG.h:41
PorousFlowCapillaryPressure::effectiveSaturationFromSaturation
Real effectiveSaturationFromSaturation(Real saturation) const
Effective saturation of liquid phase given liquid saturation and residual liquid saturation.
Definition: PorousFlowCapillaryPressure.C:91
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:97
PorousFlowCapillaryPressure::_pc_max
const Real _pc_max
Maximum capillary pressure (Pa). Note: must be <= 0.
Definition: PorousFlowCapillaryPressure.h:231
PorousFlowCapillaryPressureVG::_alpha
const Real _alpha
van Genuchten capillary coefficient alpha
Definition: PorousFlowCapillaryPressureVG.h:43
PorousFlowCapillaryPressureVG::_s_scale
const Real _s_scale
Capillary pressure = f(Seff * s_scale) - pc_sscale, where f is the van Genuchten function. For almost all simulations s_scale=1 will be appropriate.
Definition: PorousFlowCapillaryPressureVG.h:45
PorousFlowVanGenuchten::dCapillaryPressure
Real dCapillaryPressure(Real seff, Real alpha, Real m, Real pc_max)
Derivative of capillary pressure wrt effective saturation.
Definition: PorousFlowVanGenuchten.C:77
PorousFlowCapillaryPressure::_dseff_ds
const Real _dseff_ds
Derivative of effective saturation with respect to saturation.
Definition: PorousFlowCapillaryPressure.h:227

◆ dCapillaryPressureLogExt()

Real PorousFlowCapillaryPressure::dCapillaryPressureLogExt ( Real  s) const
protectedinherited

The derivative of capillary pressure in the logarithmic extension This implementation assumes capillary-pressure is a function of saturation only, and not any other quad-point dependent quantities.

Parameters
sliquid saturation
Returns
derivative of capillary pressure in logarithmic extension

Definition at line 121 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlowCapillaryPressure::dCapillaryPressure().

122 {
123  return _pc_ext * _slope_ext * _log10 * std::pow(10.0, _slope_ext * (saturation - _sat_ext));
124 }
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:97
PorousFlowCapillaryPressure::_slope_ext
Real _slope_ext
Gradient of the logarithmic extension This is computed only for qp=0.
Definition: PorousFlowCapillaryPressure.h:247
pow
ExpressionBuilder::EBTerm pow(const ExpressionBuilder::EBTerm &left, T exponent)
Definition: ExpressionBuilder.h:674
PorousFlowCapillaryPressure::_pc_ext
Real _pc_ext
Capillary pressure where the extension meets the raw curve.
Definition: PorousFlowCapillaryPressure.h:242
PorousFlowCapillaryPressure::_sat_ext
Real _sat_ext
Saturation where the logarithmic extension meets the raw curve This is computed only for qp=0...
Definition: PorousFlowCapillaryPressure.h:237

◆ dEffectiveSaturation()

Real PorousFlowCapillaryPressureVG::dEffectiveSaturation ( Real  pc,
unsigned  qp = 0 
) const
overridevirtual

Derivative of effective saturation wrt capillary pressure.

Parameters
pccapillary pressure (Pa)
qpquadpoint to use (when effective saturation depends on coupled variables, not just pc)
Returns
derivative of effective saturation wrt capillary pressure

Implements PorousFlowCapillaryPressure.

Definition at line 79 of file PorousFlowCapillaryPressureVG.C.

80 {
81  return (1.0 / _s_scale) *
82  PorousFlowVanGenuchten::dEffectiveSaturation(pc - _pc_sscale, _alpha, _m);
83 }
PorousFlowCapillaryPressureVG::_m
const Real _m
van Genuchten exponent m
Definition: PorousFlowCapillaryPressureVG.h:41
PorousFlowCapillaryPressureVG::_alpha
const Real _alpha
van Genuchten capillary coefficient alpha
Definition: PorousFlowCapillaryPressureVG.h:43
PorousFlowCapillaryPressureVG::_s_scale
const Real _s_scale
Capillary pressure = f(Seff * s_scale) - pc_sscale, where f is the van Genuchten function. For almost all simulations s_scale=1 will be appropriate.
Definition: PorousFlowCapillaryPressureVG.h:45
PorousFlowCapillaryPressureVG::_pc_sscale
const Real _pc_sscale
pc_sscale = f(s_scale), where f is the van Genuchten function
Definition: PorousFlowCapillaryPressureVG.h:47
PorousFlowVanGenuchten::dEffectiveSaturation
Real dEffectiveSaturation(Real p, Real alpha, Real m)
Derivative of effective saturation wrt porepressure.
Definition: PorousFlowVanGenuchten.C:31

◆ dSaturation()

Real PorousFlowCapillaryPressure::dSaturation ( Real  pc,
unsigned  qp = 0 
) const
inherited

Derivative of saturation wrt capillary pressure.

Parameters
pccapillary pressure (Pa)
qpquadpoint to use (when saturation depends on coupled variables, not just pc)
Returns
derivative of saturation wrt capillary pressure

Definition at line 103 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlow2PhasePP::computeQpProperties(), and PorousFlow1PhaseP::computeQpProperties().

104 {
105  return dEffectiveSaturation(pc, qp) * (1.0 - _sat_lr);
106 }
PorousFlowCapillaryPressure::_sat_lr
const Real _sat_lr
Liquid residual saturation.
Definition: PorousFlowCapillaryPressure.h:225
PorousFlowCapillaryPressure::dEffectiveSaturation
virtual Real dEffectiveSaturation(Real pc, unsigned qp=0) const =0
Derivative of effective saturation wrt capillary pressure.

◆ effectiveSaturation()

Real PorousFlowCapillaryPressureVG::effectiveSaturation ( Real  pc,
unsigned  qp = 0 
) const
overridevirtual

Effective saturation as a function of capillary pressure.

Parameters
pccapillary pressure (Pa)
qpquadpoint to use (when effective saturation depends on coupled variables, not just pc)
Returns
effective saturation

Implements PorousFlowCapillaryPressure.

Definition at line 72 of file PorousFlowCapillaryPressureVG.C.

73 {
74  return (1.0 / _s_scale) *
75  PorousFlowVanGenuchten::effectiveSaturation(pc - _pc_sscale, _alpha, _m);
76 }
PorousFlowCapillaryPressureVG::_m
const Real _m
van Genuchten exponent m
Definition: PorousFlowCapillaryPressureVG.h:41
PorousFlowCapillaryPressureVG::_alpha
const Real _alpha
van Genuchten capillary coefficient alpha
Definition: PorousFlowCapillaryPressureVG.h:43
PorousFlowVanGenuchten::effectiveSaturation
Real effectiveSaturation(Real p, Real alpha, Real m)
Effective saturation as a function of porepressure.
Definition: PorousFlowVanGenuchten.C:16
PorousFlowCapillaryPressureVG::_s_scale
const Real _s_scale
Capillary pressure = f(Seff * s_scale) - pc_sscale, where f is the van Genuchten function. For almost all simulations s_scale=1 will be appropriate.
Definition: PorousFlowCapillaryPressureVG.h:45
PorousFlowCapillaryPressureVG::_pc_sscale
const Real _pc_sscale
pc_sscale = f(s_scale), where f is the van Genuchten function
Definition: PorousFlowCapillaryPressureVG.h:47

◆ effectiveSaturationFromSaturation()

Real PorousFlowCapillaryPressure::effectiveSaturationFromSaturation ( Real  saturation) const
protectedinherited

Effective saturation of liquid phase given liquid saturation and residual liquid saturation.

Note: not to be mistaken with effectiveSaturation(pc) which is a function of capillary pressure.

Parameters
saturationtrue saturation
Returns
effective saturation

Definition at line 91 of file PorousFlowCapillaryPressure.C.

Referenced by capillaryPressureCurve(), PorousFlowCapillaryPressureBC::capillaryPressureCurve(), d2CapillaryPressureCurve(), PorousFlowCapillaryPressureBC::d2CapillaryPressureCurve(), dCapillaryPressureCurve(), and PorousFlowCapillaryPressureBC::dCapillaryPressureCurve().

92 {
93  return (saturation - _sat_lr) / (1.0 - _sat_lr);
94 }
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:97
PorousFlowCapillaryPressure::_sat_lr
const Real _sat_lr
Liquid residual saturation.
Definition: PorousFlowCapillaryPressure.h:225

◆ extensionSaturation()

Real PorousFlowCapillaryPressure::extensionSaturation ( ) const
protectedinherited

Calculates the saturation where the logarithmic extension to capillary pressure meets the raw curve using Newton's method.

This implementation assumes capillary-pressure is a function of saturation only, and not any other quad-point dependent quantities

Returns
saturation where logarithmic extension begins

Definition at line 134 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlowCapillaryPressure::initialSetup().

135 {
136  // Initial guess for saturation where extension matches curve
137  Real sat = _sat_lr + 0.01;
138 
139  // Calculate the saturation where the extension matches the derivative of the
140  // raw capillary pressure curve
141  const unsigned int max_its = 20;
142  const Real nr_tol = 1.0e-8;
143  unsigned int iter = 0;
144 
145  while (std::abs(interceptFunction(sat)) > nr_tol)
146  {
147  sat = sat - interceptFunction(sat) / interceptFunctionDeriv(sat);
148 
149  iter++;
150  if (iter > max_its)
151  break;
152  }
153 
154  return sat;
155 }
PorousFlowCapillaryPressure::interceptFunctionDeriv
Real interceptFunctionDeriv(Real s) const
Calculates the saturation where the logarithmic extension to capillary pressure at low saturation...
Definition: PorousFlowCapillaryPressure.C:167
PorousFlowCapillaryPressure::interceptFunction
Real interceptFunction(Real s) const
Calculates the saturation where the logarithmic extension to capillary pressure at low saturation...
Definition: PorousFlowCapillaryPressure.C:158
PorousFlowCapillaryPressure::_sat_lr
const Real _sat_lr
Liquid residual saturation.
Definition: PorousFlowCapillaryPressure.h:225

◆ initialize()

virtual void PorousFlowCapillaryPressure::initialize ( )
inlinefinalvirtualinherited

Definition at line 45 of file PorousFlowCapillaryPressure.h.

45 {};

◆ initialSetup()

void PorousFlowCapillaryPressure::initialSetup ( )
overridevirtualinherited

Definition at line 51 of file PorousFlowCapillaryPressure.C.

52 {
53  // If _log_ext = true, calculate the saturation where the the logarithmic
54  // extension meets the raw capillary pressure curve.
55  if (_log_ext)
56  {
57  _sat_ext = extensionSaturation();
58  _pc_ext = capillaryPressure(_sat_ext);
59  _slope_ext = (std::log10(_pc_ext) - std::log10(_pc_max)) / _sat_ext;
60  }
61 }
PorousFlowCapillaryPressure::_slope_ext
Real _slope_ext
Gradient of the logarithmic extension This is computed only for qp=0.
Definition: PorousFlowCapillaryPressure.h:247
PorousFlowCapillaryPressure::_pc_max
const Real _pc_max
Maximum capillary pressure (Pa). Note: must be <= 0.
Definition: PorousFlowCapillaryPressure.h:231
PorousFlowCapillaryPressure::extensionSaturation
Real extensionSaturation() const
Calculates the saturation where the logarithmic extension to capillary pressure meets the raw curve u...
Definition: PorousFlowCapillaryPressure.C:134
PorousFlowCapillaryPressure::capillaryPressure
virtual Real capillaryPressure(Real saturation, unsigned qp=0) const
Capillary pressure is calculated as a function of true saturation.
Definition: PorousFlowCapillaryPressure.C:64
PorousFlowCapillaryPressure::_pc_ext
Real _pc_ext
Capillary pressure where the extension meets the raw curve.
Definition: PorousFlowCapillaryPressure.h:242
PorousFlowCapillaryPressure::_sat_ext
Real _sat_ext
Saturation where the logarithmic extension meets the raw curve This is computed only for qp=0...
Definition: PorousFlowCapillaryPressure.h:237
PorousFlowCapillaryPressure::_log_ext
bool _log_ext
Flag to use a logarithmic extension for low saturation.
Definition: PorousFlowCapillaryPressure.h:229

◆ interceptFunction()

Real PorousFlowCapillaryPressure::interceptFunction ( Real  s) const
protectedinherited

Calculates the saturation where the logarithmic extension to capillary pressure at low saturation.

This is computed for qp=0 only. This implementation assumes capillary-pressure is a function of saturation only, and not any other quad-point dependent quantities

Parameters
seffective saturation
Returns
capillary pressure function in the logarithmic extension

Definition at line 158 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlowCapillaryPressure::extensionSaturation().

159 {
160  Real pc = capillaryPressureCurve(saturation);
161  Real dpc = dCapillaryPressureCurve(saturation);
162 
163  return std::log10(pc) - saturation * dpc / (_log10 * pc) - std::log10(_pc_max);
164 }
PorousFlowCapillaryPressure::dCapillaryPressureCurve
virtual Real dCapillaryPressureCurve(Real saturation, unsigned qp=0) const =0
Derivative of raw capillary pressure wrt true saturation.
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:97
PorousFlowCapillaryPressure::capillaryPressureCurve
virtual Real capillaryPressureCurve(Real saturation, unsigned qp=0) const =0
Raw capillary pressure curve (does not include logarithmic extension)
PorousFlowCapillaryPressure::_pc_max
const Real _pc_max
Maximum capillary pressure (Pa). Note: must be <= 0.
Definition: PorousFlowCapillaryPressure.h:231

◆ interceptFunctionDeriv()

Real PorousFlowCapillaryPressure::interceptFunctionDeriv ( Real  s) const
protectedinherited

Calculates the saturation where the logarithmic extension to capillary pressure at low saturation.

This implementation assumes capillary-pressure is a function of saturation only, and not any other quad-point dependent quantities

Parameters
seffective saturation
Returns
derivative of logarithmic extension function

Definition at line 167 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlowCapillaryPressure::extensionSaturation().

168 {
169  Real pc = capillaryPressureCurve(saturation);
170  Real dpc = dCapillaryPressureCurve(saturation);
171  Real d2pc = d2CapillaryPressureCurve(saturation);
172 
173  return saturation * (dpc * dpc / pc - d2pc) / (_log10 * pc);
174 }
PorousFlowCapillaryPressure::dCapillaryPressureCurve
virtual Real dCapillaryPressureCurve(Real saturation, unsigned qp=0) const =0
Derivative of raw capillary pressure wrt true saturation.
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:97
PorousFlowCapillaryPressure::capillaryPressureCurve
virtual Real capillaryPressureCurve(Real saturation, unsigned qp=0) const =0
Raw capillary pressure curve (does not include logarithmic extension)
PorousFlowCapillaryPressure::d2CapillaryPressureCurve
virtual Real d2CapillaryPressureCurve(Real saturation, unsigned qp=0) const =0
Second derivative of raw capillary pressure wrt true saturation.

◆ saturation()

Real PorousFlowCapillaryPressure::saturation ( Real  pc,
unsigned  qp = 0 
) const
inherited

Saturation as a function of capillary pressure.

Parameters
pccapillary pressure (Pa)
qpquadpoint to use (when saturation depends on coupled variables, not just pc)
Returns
saturation

Definition at line 97 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlow1PhaseP::buildQpPPSS(), PorousFlow2PhasePP::buildQpPPSS(), PorousFlowCapillaryPressure::capillaryPressure(), capillaryPressureCurve(), PorousFlowCapillaryPressureBC::capillaryPressureCurve(), PorousFlowCapillaryPressure::capillaryPressureLogExt(), PorousFlowCapillaryPressure::d2CapillaryPressure(), d2CapillaryPressureCurve(), PorousFlowCapillaryPressureBC::d2CapillaryPressureCurve(), PorousFlowCapillaryPressure::d2CapillaryPressureLogExt(), PorousFlowCapillaryPressure::dCapillaryPressure(), dCapillaryPressureCurve(), PorousFlowCapillaryPressureBC::dCapillaryPressureCurve(), PorousFlowCapillaryPressure::dCapillaryPressureLogExt(), PorousFlowCapillaryPressure::effectiveSaturationFromSaturation(), PorousFlowCapillaryPressure::interceptFunction(), and PorousFlowCapillaryPressure::interceptFunctionDeriv().

98 {
99  return effectiveSaturation(pc, qp) * (1.0 - _sat_lr) + _sat_lr;
100 }
PorousFlowCapillaryPressure::effectiveSaturation
virtual Real effectiveSaturation(Real pc, unsigned qp=0) const =0
Effective saturation as a function of capillary pressure.
PorousFlowCapillaryPressure::_sat_lr
const Real _sat_lr
Liquid residual saturation.
Definition: PorousFlowCapillaryPressure.h:225

Member Data Documentation

◆ _alpha

const Real PorousFlowCapillaryPressureVG::_alpha
protected

van Genuchten capillary coefficient alpha

Definition at line 43 of file PorousFlowCapillaryPressureVG.h.

Referenced by capillaryPressureCurve(), d2CapillaryPressureCurve(), d2EffectiveSaturation(), dCapillaryPressureCurve(), dEffectiveSaturation(), and effectiveSaturation().

◆ _dseff_ds

const Real PorousFlowCapillaryPressure::_dseff_ds
protectedinherited

Derivative of effective saturation with respect to saturation.

Definition at line 227 of file PorousFlowCapillaryPressure.h.

Referenced by d2CapillaryPressureCurve(), PorousFlowCapillaryPressureBC::d2CapillaryPressureCurve(), dCapillaryPressureCurve(), and PorousFlowCapillaryPressureBC::dCapillaryPressureCurve().

◆ _log10

const Real PorousFlowCapillaryPressure::_log10
protectedinherited

log(10)

Definition at line 249 of file PorousFlowCapillaryPressure.h.

Referenced by PorousFlowCapillaryPressure::d2CapillaryPressureLogExt(), PorousFlowCapillaryPressure::dCapillaryPressureLogExt(), PorousFlowCapillaryPressure::interceptFunction(), and PorousFlowCapillaryPressure::interceptFunctionDeriv().

◆ _log_ext

bool PorousFlowCapillaryPressure::_log_ext
protectedinherited

Flag to use a logarithmic extension for low saturation.

Definition at line 229 of file PorousFlowCapillaryPressure.h.

Referenced by PorousFlowCapillaryPressure::capillaryPressure(), PorousFlowCapillaryPressure::d2CapillaryPressure(), PorousFlowCapillaryPressure::dCapillaryPressure(), PorousFlowCapillaryPressure::initialSetup(), PorousFlowCapillaryPressureBW::PorousFlowCapillaryPressureBW(), PorousFlowCapillaryPressureConst::PorousFlowCapillaryPressureConst(), and PorousFlowCapillaryPressureRSC::PorousFlowCapillaryPressureRSC().

◆ _m

const Real PorousFlowCapillaryPressureVG::_m
protected

van Genuchten exponent m

Definition at line 41 of file PorousFlowCapillaryPressureVG.h.

Referenced by capillaryPressureCurve(), d2CapillaryPressureCurve(), d2EffectiveSaturation(), dCapillaryPressureCurve(), dEffectiveSaturation(), and effectiveSaturation().

◆ _pc_ext

Real PorousFlowCapillaryPressure::_pc_ext
protectedinherited

Capillary pressure where the extension meets the raw curve.

This is computed only for qp=0.

Definition at line 242 of file PorousFlowCapillaryPressure.h.

Referenced by PorousFlowCapillaryPressure::capillaryPressureLogExt(), PorousFlowCapillaryPressure::d2CapillaryPressureLogExt(), PorousFlowCapillaryPressure::dCapillaryPressureLogExt(), and PorousFlowCapillaryPressure::initialSetup().

◆ _pc_max

const Real PorousFlowCapillaryPressure::_pc_max
protectedinherited

Maximum capillary pressure (Pa). Note: must be <= 0.

Definition at line 231 of file PorousFlowCapillaryPressure.h.

Referenced by capillaryPressureCurve(), PorousFlowCapillaryPressureBC::capillaryPressureCurve(), d2CapillaryPressureCurve(), PorousFlowCapillaryPressureBC::d2CapillaryPressureCurve(), dCapillaryPressureCurve(), PorousFlowCapillaryPressureBC::dCapillaryPressureCurve(), PorousFlowCapillaryPressure::initialSetup(), and PorousFlowCapillaryPressure::interceptFunction().

◆ _pc_sscale

const Real PorousFlowCapillaryPressureVG::_pc_sscale
protected

pc_sscale = f(s_scale), where f is the van Genuchten function

Definition at line 47 of file PorousFlowCapillaryPressureVG.h.

Referenced by capillaryPressureCurve(), d2EffectiveSaturation(), dEffectiveSaturation(), and effectiveSaturation().

◆ _s_scale

const Real PorousFlowCapillaryPressureVG::_s_scale
protected

Capillary pressure = f(Seff * s_scale) - pc_sscale, where f is the van Genuchten function. For almost all simulations s_scale=1 will be appropriate.

Definition at line 45 of file PorousFlowCapillaryPressureVG.h.

Referenced by capillaryPressureCurve(), d2CapillaryPressureCurve(), d2EffectiveSaturation(), dCapillaryPressureCurve(), dEffectiveSaturation(), and effectiveSaturation().

◆ _sat_ext

Real PorousFlowCapillaryPressure::_sat_ext
protectedinherited

Saturation where the logarithmic extension meets the raw curve This is computed only for qp=0.

Definition at line 237 of file PorousFlowCapillaryPressure.h.

Referenced by PorousFlowCapillaryPressure::capillaryPressure(), PorousFlowCapillaryPressure::capillaryPressureLogExt(), PorousFlowCapillaryPressure::d2CapillaryPressure(), PorousFlowCapillaryPressure::d2CapillaryPressureLogExt(), PorousFlowCapillaryPressure::dCapillaryPressure(), PorousFlowCapillaryPressure::dCapillaryPressureLogExt(), and PorousFlowCapillaryPressure::initialSetup().

◆ _sat_lr

const Real PorousFlowCapillaryPressure::_sat_lr
protectedinherited

Liquid residual saturation.

Definition at line 225 of file PorousFlowCapillaryPressure.h.

Referenced by PorousFlowCapillaryPressure::d2Saturation(), PorousFlowCapillaryPressure::dSaturation(), PorousFlowCapillaryPressure::effectiveSaturationFromSaturation(), PorousFlowCapillaryPressure::extensionSaturation(), and PorousFlowCapillaryPressure::saturation().

◆ _slope_ext

Real PorousFlowCapillaryPressure::_slope_ext
protectedinherited

Gradient of the logarithmic extension This is computed only for qp=0.

Definition at line 247 of file PorousFlowCapillaryPressure.h.

Referenced by PorousFlowCapillaryPressure::capillaryPressureLogExt(), PorousFlowCapillaryPressure::d2CapillaryPressureLogExt(), PorousFlowCapillaryPressure::dCapillaryPressureLogExt(), and PorousFlowCapillaryPressure::initialSetup().

The documentation for this class was generated from the following files:
Generated on Thu Apr 25 2019 13:32:31 for www.mooseframework.org by   doxygen 1.8.14