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

#include <PorousFlowHystereticInfo.h>

Inheritance diagram for PorousFlowHystereticInfo:

[legend]

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	PorousFlowHystereticInfo (const InputParameters &parameters)

const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialProperty (const std::string &name)

const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialPropertyByName (const std::string &name)

void	validateDerivativeMaterialPropertyBase (const std::string &base)

const MaterialPropertyName	derivativePropertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	derivativePropertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	derivativePropertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	derivativePropertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)

void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)

void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

Static Public Member Functions
static InputParameters	validParams ()

Protected Types
enum	InfoTypeEnum { InfoTypeEnum::PC, InfoTypeEnum::SAT, InfoTypeEnum::SAT_GIVEN_PC, InfoTypeEnum::DS_DPC_ERR, InfoTypeEnum::DPC_DS_ERR, InfoTypeEnum::D2S_DPC2_ERR, InfoTypeEnum::D2PC_DS2_ERR }
	Type of info required. More...

Protected Member Functions
virtual void	initQpStatefulProperties () override

virtual void	computeQpProperties () override

void	computeQpInfo ()
	Fill _info with the required information. More...

Real	landSat (Real slDel) const

void	computeTurningPointInfo (unsigned tp_num, Real tp_sat, Real tp_pc)
	Compute all relevant quantities at the given turning point. More...

Real	capillaryPressureQp (Real sat) const

Real	dcapillaryPressureQp (Real sat) const

Real	d2capillaryPressureQp (Real sat) const

Real	liquidSaturationQp (Real pc) const

Real	dliquidSaturationQp (Real pc) const

Real	d2liquidSaturationQp (Real pc) const

Protected Attributes
MaterialProperty< Real > &	_pc
	Computed nodal or quadpoint value of capillary pressure (needed for hysteretic order computation) More...

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

const VariableValue &	_pc_val
	Nodal or quadpoint value of capillary pressure. More...

const VariableValue &	_sat_val
	Nodal or quadpoint value of liquid saturation. More...

const Real	_fd_eps
	small parameter to use in the finite-difference approximations to the derivative More...

enum PorousFlowHystereticInfo::InfoTypeEnum	_info_enum

const Real	_alpha_d
	van Genuchten alpha parameter for the primary drying curve More...

const Real	_alpha_w
	van Genuchten alpha parameter for the primary wetting curve More...

const Real	_n_d
	van Genuchten n parameter for the primary drying curve More...

const Real	_n_w
	van Genuchten n parameter for the primary wetting curve More...

const Real	_s_l_min
	Minimum liquid saturation for which the van Genuchten expression is valid (Pc(_s_l_min) = infinity) More...

const Real	_s_lr
	Liquid saturation below which the liquid relative permeability is zero. More...

const Real	_s_gr_max
	Residual gas saturation: 1 - _s_gr_max is the maximum saturation for which the van Genuchten expression is valid for the wetting curve. More...

const Real	_pc_max
	Maximum capillary pressure: for Pc above this value, a "lower" extension will be used. More...

const Real	_high_ratio
	The high-saturation extension to the wetting will commence at _high_ratio * (1 - _s_gr_del) More...

const PorousFlowVanGenuchten::LowCapillaryPressureExtension::ExtensionStrategy	_low_ext_type
	Type of low-saturation extension. More...

const Real	_s_low_d
	Saturation on the primary drying curve where low-saturation extension commences. More...

const Real	_dpc_low_d
	d(Pc)/dS on the primary drying curve at S = _s_low_d More...

const PorousFlowVanGenuchten::LowCapillaryPressureExtension	_low_ext_d
	Parameters involved in the low-saturation extension of the primary drying curve. More...

const Real	_s_low_w
	Saturation on the primary wetting curve where low-saturation extension commences. More...

const Real	_dpc_low_w
	d(Pc)/dS on the primary wetting curve at S = _s_low_w More...

const PorousFlowVanGenuchten::LowCapillaryPressureExtension	_low_ext_w
	Parameters involved in the low-saturation extension of the primary wetting curve. More...

const PorousFlowVanGenuchten::HighCapillaryPressureExtension::ExtensionStrategy	_high_ext_type
	Type of high-saturation extension of the wetting curves. More...

const Real	_s_high
	Saturation at the point of high-saturation extension. More...

const Real	_pc_high
	Pc at the point of high-saturation extension. More...

const Real	_dpc_high
	d(Pc)/d(S) at the point of high-saturation extension More...

const PorousFlowVanGenuchten::HighCapillaryPressureExtension	_high_ext
	Parameters involved in the high-saturation extension of the primary wetting curve. More...

const MaterialProperty< unsigned > &	_hys_order
	Hysteresis order, as computed by PorousFlowHysteresisOrder. More...

const MaterialProperty< unsigned > &	_hys_order_old
	Old value of hysteresis order, as computed by PorousFlowHysteresisOrder. More...

const MaterialProperty< std::array< Real, PorousFlowConstants::MAX_HYSTERESIS_ORDER > > &	_hys_sat_tps
	Saturation values at the turning points, as computed by PorousFlowHysteresisOrder. More...

const MaterialProperty< Real > &	_pc_older
	Older value of capillary pressure. More...

MaterialProperty< std::array< Real, PorousFlowConstants::MAX_HYSTERESIS_ORDER > > &	_pc_tps
	Nodal or quadpoint values of Pc at the turning points. More...

MaterialProperty< std::array< Real, PorousFlowConstants::MAX_HYSTERESIS_ORDER > > &	_s_d_tps
	Computed nodal or quadpoint values of saturation on the drying curve at _pc_tps. More...

MaterialProperty< std::array< Real, PorousFlowConstants::MAX_HYSTERESIS_ORDER > > &	_s_gr_tps
	Computed nodal or quadpoint values of S_gr_Del, ie, the Land expression, at the turning points. More...

MaterialProperty< std::array< PorousFlowVanGenuchten::LowCapillaryPressureExtension, PorousFlowConstants::MAX_HYSTERESIS_ORDER > > &	_w_low_ext_tps
	Nodal or quadpoint values of the low extension of the wetting curve defined by _s_gr_tps. More...

MaterialProperty< std::array< PorousFlowVanGenuchten::HighCapillaryPressureExtension, PorousFlowConstants::MAX_HYSTERESIS_ORDER > > &	_w_high_ext_tps
	Nodal or quadpoint values of the high extension of the wetting curve defined by _s_gr_tps. More...

MaterialProperty< std::array< Real, PorousFlowConstants::MAX_HYSTERESIS_ORDER > > &	_s_w_tps
	Computed nodal or quadpoint values of liquid saturation on the wetting curve defined by _s_gr_del, at pc = _pc_d_tps. More...

const unsigned int	_num_phases
	Number of phases. More...

const unsigned int	_num_components
	Number of components. More...

const unsigned int	_num_pf_vars
	Number of PorousFlow variables. More...

GenericMaterialProperty< std::vector< Real >, is_ad > &	_porepressure
	Computed nodal or quadpoint values of porepressure of the phases. More...

MaterialProperty< std::vector< std::vector< Real > > > *const	_dporepressure_dvar
	d(porepressure)/d(PorousFlow variable) More...

GenericMaterialProperty< std::vector< RealGradient >, is_ad > *const	_gradp_qp
	Grad(p) at the quadpoints. More...

MaterialProperty< std::vector< std::vector< Real > > > *const	_dgradp_qp_dgradv
	d(grad porepressure)/d(grad PorousFlow variable) at the quadpoints More...

MaterialProperty< std::vector< std::vector< RealGradient > > > *const	_dgradp_qp_dv
	d(grad porepressure)/d(PorousFlow variable) at the quadpoints More...

GenericMaterialProperty< std::vector< Real >, is_ad > &	_saturation
	Computed nodal or qp saturation of the phases. More...

MaterialProperty< std::vector< std::vector< Real > > > *const	_dsaturation_dvar
	d(saturation)/d(PorousFlow variable) More...

GenericMaterialProperty< std::vector< RealGradient >, is_ad > *const	_grads_qp
	Grad(s) at the quadpoints. More...

MaterialProperty< std::vector< std::vector< Real > > > *const	_dgrads_qp_dgradv
	d(grad saturation)/d(grad PorousFlow variable) at the quadpoints More...

MaterialProperty< std::vector< std::vector< RealGradient > > > *const	_dgrads_qp_dv
	d(grad saturation)/d(PorousFlow variable) at the quadpoints More...

Private Member Functions
Real	relativeError (Real finite_difference, Real hand_coded)
	Computes the relative error between a finite-difference approximation to the derivative and a hand-coded version. More...

Detailed Description

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.

Definition at line 18 of file PorousFlowHystereticInfo.h.

Member Enumeration Documentation

◆ InfoTypeEnum

enum PorousFlowHystereticInfo::InfoTypeEnum

strongprotected

Type of info required.

Enumerator
PC
SAT
SAT_GIVEN_PC
DS_DPC_ERR
DPC_DS_ERR
D2S_DPC2_ERR
D2PC_DS2_ERR

Definition at line 48 of file PorousFlowHystereticInfo.h.

                                 {
     PC,
     SAT,
     SAT_GIVEN_PC,
     DS_DPC_ERR,
     DPC_DS_ERR,
     D2S_DPC2_ERR,
     D2PC_DS2_ERR
   } _info_enum;

Constructor & Destructor Documentation

◆ PorousFlowHystereticInfo()

PorousFlowHystereticInfo::PorousFlowHystereticInfo ( const InputParameters & parameters )

Definition at line 60 of file PorousFlowHystereticInfo.C.

   : PorousFlowHystereticCapillaryPressure(parameters),
     _pc(_nodal_material ? declareProperty<Real>("PorousFlow_hysteretic_capillary_pressure_nodal")
                         : declareProperty<Real>("PorousFlow_hysteretic_capillary_pressure_qp")),
     _info(_nodal_material ? declareProperty<Real>("PorousFlow_hysteretic_info_nodal")
                           : declareProperty<Real>("PorousFlow_hysteretic_info_qp")),
     _pc_val(_nodal_material ? coupledDofValues("pc_var") : coupledValue("pc_var")),
     _sat_val(_nodal_material ? coupledDofValues("sat_var") : coupledValue("sat_var")),
     _fd_eps(getParam<Real>("fd_eps")),
     _info_enum(getParam<MooseEnum>("info_required").getEnum<InfoTypeEnum>())
 {
   // note that _num_phases must be positive, otherwise get a problem with using
   // PorousFlowHysteresisOrder, so _num_phases > 0 needn't be checked here
 }

Member Function Documentation

◆ capillaryPressureQp()

Real PorousFlowHystereticCapillaryPressure::capillaryPressureQp ( Real sat ) const

protectedinherited

Returns: the value of capillary pressure, given the liquid saturation. This uses _hys_order[_qp]

Parameters

sat	liquid saturation

Definition at line 300 of file PorousFlowHystereticCapillaryPressure.C.

Referenced by PorousFlow2PhaseHysPS::buildQpPPSS(), computeQpInfo(), computeQpProperties(), and initQpStatefulProperties().

 {
   Real pc = 0.0;
   if (_hys_order[_qp] == 0) // on primary drying curve
     pc = PorousFlowVanGenuchten::capillaryPressureHys(
         sat, _s_l_min, 0.0, _alpha_d, _n_d, _low_ext_d);
   else if (_hys_order[_qp] == 1) // first-order wetting
     pc = firstOrderWettingPc(sat);
   else if (_hys_order[_qp] == 2) // second-order drying
     pc = secondOrderDryingPc(sat);
   else // third order drying and wetting
   {
     const Real tp1 = _hys_sat_tps[_qp].at(1);
     const Real tp2 = _hys_sat_tps[_qp].at(2);
     const Real pc1 = firstOrderWettingPc(sat);
     const Real pc2 = secondOrderDryingPc(sat);
     // handle cases that occur just at the transition from 3rd to 2nd order, or 3rd to 1st order
     if (sat < tp2)
       pc = pc2;
     else if (sat > tp1)
       pc = pc1;
     else if (pc1 >= pc2)
       pc = pc1;
     else if (pc1 <= 0.0 || pc2 <= 0.0)
       pc = 0.0;
     else
       pc = std::exp(std::log(pc1) + (sat - tp1) * (std::log(pc2) - std::log(pc1)) / (tp2 - tp1));
   }
   return pc;
 }

◆ computeQpInfo()

void PorousFlowHystereticInfo::computeQpInfo ( )

protected

Fill _info with the required information.

Definition at line 94 of file PorousFlowHystereticInfo.C.

Referenced by computeQpProperties(), and initQpStatefulProperties().

 {
   switch (_info_enum)
   {
     case InfoTypeEnum::PC:
       _info[_qp] = capillaryPressureQp(_sat_val[_qp]);
       break;
     case InfoTypeEnum::SAT:
     {
       const Real pc = capillaryPressureQp(_sat_val[_qp]);
       _info[_qp] = liquidSaturationQp(pc);
       break;
     }
     case InfoTypeEnum::SAT_GIVEN_PC:
       _info[_qp] = liquidSaturationQp(_pc_val[_qp]);
       break;
     case InfoTypeEnum::DS_DPC_ERR:
     {
       const Real pc = capillaryPressureQp(_sat_val[_qp]);
       const Real fd =
           0.5 * (liquidSaturationQp(pc + _fd_eps) - liquidSaturationQp(pc - _fd_eps)) / _fd_eps;
       _info[_qp] = relativeError(fd, dliquidSaturationQp(pc));
       break;
     }
     case InfoTypeEnum::DPC_DS_ERR:
     {
       const Real fd = 0.5 *
                       (capillaryPressureQp(_sat_val[_qp] + _fd_eps) -
                        capillaryPressureQp(_sat_val[_qp] - _fd_eps)) /
                       _fd_eps;
       _info[_qp] = relativeError(fd, dcapillaryPressureQp(_sat_val[_qp]));
       break;
     }
     case InfoTypeEnum::D2S_DPC2_ERR:
     {
       const Real pc = capillaryPressureQp(_sat_val[_qp]);
       const Real fd =
           0.5 * (dliquidSaturationQp(pc + _fd_eps) - dliquidSaturationQp(pc - _fd_eps)) / _fd_eps;
       _info[_qp] = relativeError(fd, d2liquidSaturationQp(pc));
       break;
     }
     case InfoTypeEnum::D2PC_DS2_ERR:
     {
       const Real fd = 0.5 *
                       (dcapillaryPressureQp(_sat_val[_qp] + _fd_eps) -
                        dcapillaryPressureQp(_sat_val[_qp] - _fd_eps)) /
                       _fd_eps;
       _info[_qp] = relativeError(fd, d2capillaryPressureQp(_sat_val[_qp]));
       break;
     }
   }
 }

◆ computeQpProperties()

void PorousFlowHystereticInfo::computeQpProperties ( )

overrideprotectedvirtual

Reimplemented from PorousFlowHystereticCapillaryPressure.

Definition at line 85 of file PorousFlowHystereticInfo.C.

 {
   PorousFlowHystereticCapillaryPressure::computeQpProperties();
   _saturation[_qp][0] = _sat_val[_qp];
   _pc[_qp] = capillaryPressureQp(_sat_val[_qp]);
   computeQpInfo();
 }

◆ computeTurningPointInfo()

void PorousFlowHystereticCapillaryPressure::computeTurningPointInfo	(	unsigned	tp_num,
		Real	tp_sat,
		Real	tp_pc
	)

protectedinherited

Compute all relevant quantities at the given turning point.

Parameters

tp_num	The turning point number. Eg, tp_num=0 upon transition from zeroth-order drying to first-order wetting
tp_sat	Liquid saturation at the turning point
tp_pc	Capillary pressure at the turning point

Definition at line 240 of file PorousFlowHystereticCapillaryPressure.C.

Referenced by PorousFlowHystereticCapillaryPressure::computeQpProperties(), and PorousFlowHystereticCapillaryPressure::initQpStatefulProperties().

 {
   _pc_tps[_qp].at(tp_num) = tp_pc;
 
   // Quantities on the drying curve:
   // pc on the drying curve at the turning point saturation
   const Real pc_d_tps = PorousFlowVanGenuchten::capillaryPressureHys(
       tp_sat, _s_l_min, 0.0, _alpha_d, _n_d, _low_ext_d);
   // saturation on the drying curve, at tp_pc
   _s_d_tps[_qp].at(tp_num) =
       PorousFlowVanGenuchten::saturationHys(tp_pc, _s_l_min, 0.0, _alpha_d, _n_d, _low_ext_d);
 
   // Quantities relevant to the wetting curve defined by the Land expression.
   // s_gr_tps is the Land expression as a function of the turning point saturation
   _s_gr_tps[_qp].at(tp_num) = landSat(tp_sat);
   // the low extension of the wetting curve defined by _s_gr_tps
   const Real s_w_low_ext = PorousFlowVanGenuchten::saturationHys(
       _pc_max, _s_l_min, _s_gr_tps[_qp].at(tp_num), _alpha_w, _n_w);
   const Real dpc_w_low_ext = PorousFlowVanGenuchten::dcapillaryPressureHys(
       s_w_low_ext, _s_l_min, _s_gr_tps[_qp].at(tp_num), _alpha_w, _n_w);
   _w_low_ext_tps[_qp].at(tp_num) = PorousFlowVanGenuchten::LowCapillaryPressureExtension(
       _low_ext_type, s_w_low_ext, _pc_max, dpc_w_low_ext);
   // the high extension of the wetting curve defined by _s_gr_tps
   const Real s_w_high_ext =
       (_high_ext_type == PorousFlowVanGenuchten::HighCapillaryPressureExtension::NONE)
           ? 1.0 - _s_gr_tps[_qp].at(tp_num)
           : _high_ratio *
                 (1.0 -
                  _s_gr_tps[_qp].at(
                      tp_num)); // if NONE then use the vanGenuchten all the way to 1 - _s_gr_tps
   const Real pc_w_high_ext =
       PorousFlowVanGenuchten::capillaryPressureHys(s_w_high_ext,
                                                    _s_l_min,
                                                    _s_gr_tps[_qp].at(tp_num),
                                                    _alpha_w,
                                                    _n_w,
                                                    _w_low_ext_tps[_qp].at(tp_num));
   const Real dpc_w_high_ext =
       PorousFlowVanGenuchten::dcapillaryPressureHys(s_w_high_ext,
                                                     _s_l_min,
                                                     _s_gr_tps[_qp].at(tp_num),
                                                     _alpha_w,
                                                     _n_w,
                                                     _w_low_ext_tps[_qp].at(tp_num));
   _w_high_ext_tps[_qp].at(tp_num) = PorousFlowVanGenuchten::HighCapillaryPressureExtension(
       _high_ext_type, s_w_high_ext, pc_w_high_ext, dpc_w_high_ext);
 
   // saturation on the wetting curve defined by _s_gr_tps, at pc = pc_d_tps
   _s_w_tps[_qp].at(tp_num) = PorousFlowVanGenuchten::saturationHys(pc_d_tps,
                                                                    _s_l_min,
                                                                    _s_gr_tps[_qp].at(tp_num),
                                                                    _alpha_w,
                                                                    _n_w,
                                                                    _w_low_ext_tps[_qp].at(tp_num),
                                                                    _w_high_ext_tps[_qp].at(tp_num));
 }

◆ d2capillaryPressureQp()

Real PorousFlowHystereticCapillaryPressure::d2capillaryPressureQp ( Real sat ) const

protectedinherited

Returns: d^2(capillary pressure)/d(sat)^2. This uses _hys_order[_qp]

Parameters

sat	liquid saturation

Definition at line 371 of file PorousFlowHystereticCapillaryPressure.C.

Referenced by computeQpInfo(), and PorousFlow2PhaseHysPS::computeQpProperties().

 {
   Real d2pc = 0.0;
   if (_hys_order[_qp] == 0) // on primary drying curve
     d2pc = PorousFlowVanGenuchten::d2capillaryPressureHys(
         sat, _s_l_min, 0.0, _alpha_d, _n_d, _low_ext_d);
   else if (_hys_order[_qp] == 1) // first-order wetting
     d2pc = d2firstOrderWettingPc(sat);
   else if (_hys_order[_qp] == 2) // second-order drying
     d2pc = d2secondOrderDryingPc(sat);
   else // third order drying and wetting
   {
     const Real tp1 = _hys_sat_tps[_qp].at(1);
     const Real tp2 = _hys_sat_tps[_qp].at(2);
     const Real pc1 = firstOrderWettingPc(sat);
     const Real pc2 = secondOrderDryingPc(sat);
     // handle cases that occur just at the transition from 3rd to 2nd order, or 3rd to 1st order
     if (sat < tp2)
       d2pc = d2secondOrderDryingPc(sat);
     else if (sat > tp1)
       d2pc = d2firstOrderWettingPc(sat);
     else if (pc1 >= pc2)
       d2pc = d2firstOrderWettingPc(sat);
     else if (pc1 <= 0.0 || pc2 <= 0.0)
       d2pc = 0.0;
     else
     {
       const Real pc =
           std::exp(std::log(pc1) + (sat - tp1) * (std::log(pc2) - std::log(pc1)) / (tp2 - tp1));
       const Real dpc1 = dfirstOrderWettingPc(sat);
       const Real dpc2 = dsecondOrderDryingPc(sat);
       const Real dpc = pc * (dpc1 / pc1 + (std::log(pc2) - std::log(pc1)) / (tp2 - tp1) +
                              (sat - tp1) * (dpc2 / pc2 - dpc1 / pc1) / (tp2 - tp1));
       const Real d2pc1 = d2firstOrderWettingPc(sat);
       const Real d2pc2 = d2secondOrderDryingPc(sat);
       d2pc =
           dpc * (dpc1 / pc1 + (std::log(pc2) - std::log(pc1)) / (tp2 - tp1) +
                  (sat - tp1) * (dpc2 / pc2 - dpc1 / pc1) / (tp2 - tp1)) +
           pc *
               (d2pc1 / pc1 - dpc1 * dpc1 / pc1 / pc1 + (dpc2 / pc2 - dpc1 / pc1) / (tp2 - tp1) +
                (dpc2 / pc2 - dpc1 / pc1) / (tp2 - tp1) +
                (sat - tp1) *
                    (d2pc2 / pc2 - dpc2 * dpc2 / pc2 / pc2 - d2pc1 / pc1 + dpc1 * dpc1 / pc1 / pc1) /
                    (tp2 - tp1));
     }
   }
   return d2pc;
 }

◆ d2liquidSaturationQp()

Real PorousFlowHystereticCapillaryPressure::d2liquidSaturationQp ( Real pc ) const

protectedinherited

Returns: d^2(liquid saturation)/d(pc)^2. This uses _hys_order[_qp]

Parameters

pc	capillary pressure

Definition at line 698 of file PorousFlowHystereticCapillaryPressure.C.

Referenced by computeQpInfo(), PorousFlow1PhaseHysP::computeQpProperties(), and PorousFlow2PhaseHysPP::computeQpProperties().

 {
   Real d2sat = 0.0;
   if (_hys_order[_qp] == 0) // on primary drying curve
     d2sat = PorousFlowVanGenuchten::d2saturationHys(pc, _s_l_min, 0.0, _alpha_d, _n_d, _low_ext_d);
   else if (_hys_order[_qp] == 1) // first-order wetting
     d2sat = d2firstOrderWettingSat(pc);
   else if (_hys_order[_qp] == 2) // second-order drying
     d2sat = d2secondOrderDryingSat(pc);
   else // third order drying and wetting
   {
     const Real pc_tp1 = _pc_tps[_qp].at(1); // pc on first-order wetting at TP_1
     const Real pc_tp2 = _pc_tps[_qp].at(2); // pc on second-order drying at TP_2
     const Real sat1 = firstOrderWettingSat(pc);
     const Real sat2 = secondOrderDryingSat(pc);
     const Real dsat1 = dfirstOrderWettingSat(pc);
     const Real dsat2 = dsecondOrderDryingSat(pc);
     const Real d2sat1 = d2firstOrderWettingSat(pc);
     const Real d2sat2 = d2secondOrderDryingSat(pc);
     if (pc_tp1 <= 0.0 || pc <= 0.0 || pc_tp2 <= 0.0)
       d2sat = d2sat2;
     else if (pc > pc_tp2)
       d2sat = d2sat2;
     else if (pc < pc_tp1)
       d2sat = d2sat1;
     else
       d2sat = d2sat1 - 1.0 / pc / pc * (sat2 - sat1) / std::log(pc_tp2 / pc_tp1) +
               2.0 / pc * (dsat2 - dsat1) / std::log(pc_tp2 / pc_tp1) +
               (std::log(pc) - std::log(pc_tp1)) * (d2sat2 - d2sat1) / std::log(pc_tp2 / pc_tp1);
   }
   return d2sat;
 }

◆ dcapillaryPressureQp()

Real PorousFlowHystereticCapillaryPressure::dcapillaryPressureQp ( Real sat ) const

protectedinherited

Returns: d(capillary pressure)/d(sat). This uses _hys_order[_qp]

Parameters

sat	liquid saturation

Definition at line 332 of file PorousFlowHystereticCapillaryPressure.C.

Referenced by computeQpInfo(), and PorousFlow2PhaseHysPS::computeQpProperties().

 {
   Real dpc = 0.0;
   if (_hys_order[_qp] == 0) // on primary drying curve
     dpc = PorousFlowVanGenuchten::dcapillaryPressureHys(
         sat, _s_l_min, 0.0, _alpha_d, _n_d, _low_ext_d);
   else if (_hys_order[_qp] == 1) // first-order wetting
     dpc = dfirstOrderWettingPc(sat);
   else if (_hys_order[_qp] == 2) // second-order drying
     dpc = dsecondOrderDryingPc(sat);
   else // third order drying and wetting
   {
     const Real tp1 = _hys_sat_tps[_qp].at(1);
     const Real tp2 = _hys_sat_tps[_qp].at(2);
     const Real pc1 = firstOrderWettingPc(sat);
     const Real pc2 = secondOrderDryingPc(sat);
     // handle cases that occur just at the transition from 3rd to 2nd order, or 3rd to 1st order
     if (sat < tp2)
       dpc = dsecondOrderDryingPc(sat);
     else if (sat > tp1)
       dpc = dfirstOrderWettingPc(sat);
     else if (pc1 >= pc2)
       dpc = dfirstOrderWettingPc(sat);
     else if (pc1 <= 0.0 || pc2 <= 0.0)
       dpc = 0.0;
     else
     {
       const Real pc =
           std::exp(std::log(pc1) + (sat - tp1) * (std::log(pc2) - std::log(pc1)) / (tp2 - tp1));
       const Real dpc1 = dfirstOrderWettingPc(sat);
       const Real dpc2 = dsecondOrderDryingPc(sat);
       dpc = pc * (dpc1 / pc1 + (std::log(pc2) - std::log(pc1)) / (tp2 - tp1) +
                   (sat - tp1) * (dpc2 / pc2 - dpc1 / pc1) / (tp2 - tp1));
     }
   }
   return dpc;
 }

◆ dliquidSaturationQp()

Real PorousFlowHystereticCapillaryPressure::dliquidSaturationQp ( Real pc ) const

protectedinherited

Returns: d(liquid saturation)/d(pc). This uses _hys_order[_qp]

Parameters

pc	capillary pressure

Definition at line 667 of file PorousFlowHystereticCapillaryPressure.C.

Referenced by computeQpInfo(), PorousFlow1PhaseHysP::computeQpProperties(), and PorousFlow2PhaseHysPP::computeQpProperties().

 {
   Real dsat = 0.0;
   if (_hys_order[_qp] == 0) // on primary drying curve
     dsat = PorousFlowVanGenuchten::dsaturationHys(pc, _s_l_min, 0.0, _alpha_d, _n_d, _low_ext_d);
   else if (_hys_order[_qp] == 1) // first-order wetting
     dsat = dfirstOrderWettingSat(pc);
   else if (_hys_order[_qp] == 2) // second-order drying
     dsat = dsecondOrderDryingSat(pc);
   else // third order drying and wetting
   {
     const Real pc_tp1 = _pc_tps[_qp].at(1); // pc on first-order wetting at TP_1
     const Real pc_tp2 = _pc_tps[_qp].at(2); // pc on second-order drying at TP_2
     const Real sat1 = firstOrderWettingSat(pc);
     const Real sat2 = secondOrderDryingSat(pc);
     const Real dsat1 = dfirstOrderWettingSat(pc);
     const Real dsat2 = dsecondOrderDryingSat(pc);
     if (pc_tp1 <= 0.0 || pc <= 0.0 || pc_tp2 <= 0.0)
       dsat = dsat2;
     else if (pc > pc_tp2)
       dsat = dsat2;
     else if (pc < pc_tp1)
       dsat = dsat1;
     else
       dsat = dsat1 + 1.0 / pc * (sat2 - sat1) / std::log(pc_tp2 / pc_tp1) +
              (std::log(pc) - std::log(pc_tp1)) * (dsat2 - dsat1) / std::log(pc_tp2 / pc_tp1);
   }
   return dsat;
 }

◆ initQpStatefulProperties()

void PorousFlowHystereticInfo::initQpStatefulProperties ( )

overrideprotectedvirtual

Reimplemented from PorousFlowHystereticCapillaryPressure.

Definition at line 76 of file PorousFlowHystereticInfo.C.

 {
   PorousFlowHystereticCapillaryPressure::initQpStatefulProperties();
   _saturation[_qp][0] = _sat_val[_qp];
   _pc[_qp] = capillaryPressureQp(_sat_val[_qp]);
   computeQpInfo();
 }

◆ landSat()

Real PorousFlowHystereticCapillaryPressure::landSat ( Real slDel ) const

protectedinherited

Returns: the value of gas saturation (called S_gr^Delta in the markdown documentation) using the Land expression. (This is a function of the liquid saturation at the turning point)

Parameters

slDel the value of the liquid saturation at the turning point

Definition at line 233 of file PorousFlowHystereticCapillaryPressure.C.

Referenced by PorousFlowHystereticCapillaryPressure::computeTurningPointInfo().

 {
   const Real a = 1.0 / _s_gr_max - 1.0 / (1.0 - _s_lr);
   return (1.0 - slDel) / (1.0 + a * (1.0 - slDel));
 }

◆ liquidSaturationQp()

Real PorousFlowHystereticCapillaryPressure::liquidSaturationQp ( Real pc ) const

protectedinherited

Returns: the value of liquid saturation, given the capillary pressure. This uses _hys_order[_qp]

Parameters

pc	capillary pressure

Definition at line 630 of file PorousFlowHystereticCapillaryPressure.C.

Referenced by PorousFlow1PhaseHysP::buildQpPPSS(), PorousFlow2PhaseHysPP::buildQpPPSS(), and computeQpInfo().

 {
   Real sat = 0.0;
   if (_hys_order[_qp] == 0) // on primary drying curve
     sat = PorousFlowVanGenuchten::saturationHys(pc, _s_l_min, 0.0, _alpha_d, _n_d, _low_ext_d);
   else if (_hys_order[_qp] == 1) // first-order wetting
     sat = firstOrderWettingSat(pc);
   else if (_hys_order[_qp] == 2) // second-order drying
     sat = secondOrderDryingSat(pc);
   else // third order drying and wetting
   {
     // NOTE: this is not the exact inverse of the third-order capillary-pressure formula, but only
     // the approximate inverse.  In any simulation, only liquidSaturationQp or capillaryPressureQp
     // are used (not both) so having a slightly different formulation for these two functions is OK
     // Rationale: when pc is close to pc_tp1 then use the first-order wetting curve; when pc is
     // close to pc_tp2 then use the second-order drying curve
     const Real pc_tp1 = _pc_tps[_qp].at(1); // pc on first-order wetting at TP_1
     const Real pc_tp2 = _pc_tps[_qp].at(2); // pc on second-order drying at TP_2
     const Real sat1 = firstOrderWettingSat(pc);
     const Real sat2 = secondOrderDryingSat(pc);
     // handle cases that occur just at the transition from 3rd to 2nd order, or 3rd to 1st order
     if (pc_tp1 <= 0.0 || pc <= 0.0 ||
         pc_tp2 <= 0.0) // only the first condition is strictly necessary as cannot get pc==0 or
                        // pc_tp2=0 without pc_tp1=0 in reality.  The other conditions are added in
                        // case of numerical strangenesses
       sat = sat2;
     else if (pc > pc_tp2)
       sat = sat2;
     else if (pc < pc_tp1)
       sat = sat1;
     else
       sat = sat1 + (std::log(pc) - std::log(pc_tp1)) * (sat2 - sat1) / std::log(pc_tp2 / pc_tp1);
   }
   return sat;
 }

◆ relativeError()

Real PorousFlowHystereticInfo::relativeError	(	Real	finite_difference,
		Real	hand_coded
	)

private

Computes the relative error between a finite-difference approximation to the derivative and a hand-coded version.

Returns: finite_difference / hand_coded - 1, with appropriate guards against division by zero

Parameters

finite_difference	the finite-difference approximation to the derivative
hand_coded	the hand-coded derivative

Definition at line 148 of file PorousFlowHystereticInfo.C.

Referenced by computeQpInfo().

 {
   if (finite_difference == 0.0 && hand_coded == 0.0)
     return 0.0;
   else if (finite_difference > 0.0 && hand_coded == 0.0)
     return std::numeric_limits<Real>::max();
   else if (finite_difference < 0.0 && hand_coded == 0.0)
     return std::numeric_limits<Real>::min();
   return finite_difference / hand_coded - 1.0;
 }

◆ validParams()

InputParameters PorousFlowHystereticInfo::validParams ( )

static

Definition at line 15 of file PorousFlowHystereticInfo.C.

 {
   InputParameters params = PorousFlowHystereticCapillaryPressure::validParams();
   params.addCoupledVar("pc_var",
                        0,
                        "Variable that represents capillary pressure.  Depending on info_required, "
                        "this may not be used to compute the info");
   params.addRequiredCoupledVar(
       "sat_var",
       "Variable that represent liquid saturation.  This is always needed to "
       "ensure the hysteretic order is computed correctly");
   MooseEnum property_enum("pc sat sat_given_pc dS_dPc_err dPc_dS_err d2S_dPc2_err d2Pc_dS2_err",
                           "pc");
   params.addParam<MooseEnum>(
       "info_required",
       property_enum,
       "The type of information required.  pc: capillary pressure given the saturation (pc_var is "
       "not used in this case).  sat: given the liquid saturation, compute the capillary pressure, "
       "then invert the relationship to yield liquid saturation again (pc_var is not used in this "
       "case).  This is useful to understand the non-invertibility of the hysteretic relationships. "
       " sat_given_pc: given the capillary pressure, compute the saturation.  dS_dPc_err: relative "
       "error in d(sat)/d(pc) calculation, ie (S(Pc + fd_eps) - S(Pc - fd_eps))/(2 * eps * S'(Pc)) "
       "- 1, where S' is the coded derivative (Pc is computed from sat in this case: pc_var is not "
       "used).  This is useful for checking derivatives.  dPc_dS_err: relative error in "
       "d(pc)/d(sat) calculation, ie (Pc(S + fd_eps) - Pc(S - fd_eps)) / (2 * eps * Pc'(S)) - 1, "
       "where Pc' is the coded derative (pc_var is not used in this case).  d2S_dPc2_err: relative "
       "error in d^2(sat)/d(pc)^2 (Pc is computed from sat in this case: pc_var is not used).  "
       "d2Pc_dS2_err: relative error in d^2(pc)/d(sat)^2.");
   params.addParam<Real>(
       "fd_eps",
       1E-8,
       "Small quantity used in computing the finite-difference approximations to derivatives");
   params.addClassDescription(
       "This Material computes capillary pressure or saturation, etc.  It is primarily "
       "of use when users desire to compute hysteretic quantities such as capillary pressure for "
       "visualisation purposes.  The "
       "result is written into PorousFlow_hysteretic_info_nodal or "
       "PorousFlow_hysteretic_info_qp (depending on the at_nodes flag).  It "
       "does not "
       "compute porepressure and should not be used in simulations that employ "
       "PorousFlow*PhaseHys* "
       "Materials.");
   return params;
 }

Member Data Documentation

◆ _alpha_d

const Real PorousFlowHystereticCapillaryPressure::_alpha_d

protectedinherited

van Genuchten alpha parameter for the primary drying curve

Definition at line 86 of file PorousFlowHystereticCapillaryPressure.h.

◆ _alpha_w

const Real PorousFlowHystereticCapillaryPressure::_alpha_w

protectedinherited

van Genuchten alpha parameter for the primary wetting curve

Definition at line 88 of file PorousFlowHystereticCapillaryPressure.h.

Referenced by PorousFlowHystereticCapillaryPressure::computeTurningPointInfo(), PorousFlowHystereticCapillaryPressure::d2firstOrderWettingPc(), PorousFlowHystereticCapillaryPressure::d2firstOrderWettingSat(), PorousFlowHystereticCapillaryPressure::dfirstOrderWettingPc(), PorousFlowHystereticCapillaryPressure::dfirstOrderWettingSat(), PorousFlowHystereticCapillaryPressure::firstOrderWettingPc(), and PorousFlowHystereticCapillaryPressure::firstOrderWettingSat().

◆ _dgradp_qp_dgradv

template<bool is_ad>

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBaseTempl< is_ad >::_dgradp_qp_dgradv

protectedinherited

d(grad porepressure)/d(grad PorousFlow variable) at the quadpoints

Definition at line 51 of file PorousFlowVariableBase.h.

◆ _dgradp_qp_dv

template<bool is_ad>

MaterialProperty<std::vector<std::vector<RealGradient> > >* const PorousFlowVariableBaseTempl< is_ad >::_dgradp_qp_dv

protectedinherited

d(grad porepressure)/d(PorousFlow variable) at the quadpoints

Definition at line 54 of file PorousFlowVariableBase.h.

◆ _dgrads_qp_dgradv

template<bool is_ad>

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBaseTempl< is_ad >::_dgrads_qp_dgradv

protectedinherited

d(grad saturation)/d(grad PorousFlow variable) at the quadpoints

Definition at line 66 of file PorousFlowVariableBase.h.

◆ _dgrads_qp_dv

template<bool is_ad>

MaterialProperty<std::vector<std::vector<RealGradient> > >* const PorousFlowVariableBaseTempl< is_ad >::_dgrads_qp_dv

protectedinherited

d(grad saturation)/d(PorousFlow variable) at the quadpoints

Definition at line 69 of file PorousFlowVariableBase.h.

◆ _dpc_high

const Real PorousFlowHystereticCapillaryPressure::_dpc_high

protectedinherited

d(Pc)/d(S) at the point of high-saturation extension

Definition at line 124 of file PorousFlowHystereticCapillaryPressure.h.

◆ _dpc_low_d

const Real PorousFlowHystereticCapillaryPressure::_dpc_low_d

protectedinherited

d(Pc)/dS on the primary drying curve at S = _s_low_d

Definition at line 108 of file PorousFlowHystereticCapillaryPressure.h.

◆ _dpc_low_w

const Real PorousFlowHystereticCapillaryPressure::_dpc_low_w

protectedinherited

d(Pc)/dS on the primary wetting curve at S = _s_low_w

Definition at line 114 of file PorousFlowHystereticCapillaryPressure.h.

◆ _dporepressure_dvar

template<bool is_ad>

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBaseTempl< is_ad >::_dporepressure_dvar

protectedinherited

d(porepressure)/d(PorousFlow variable)

Definition at line 45 of file PorousFlowVariableBase.h.

◆ _dsaturation_dvar

template<bool is_ad>

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBaseTempl< is_ad >::_dsaturation_dvar

protectedinherited

d(saturation)/d(PorousFlow variable)

Definition at line 60 of file PorousFlowVariableBase.h.

◆ _fd_eps

const Real PorousFlowHystereticInfo::_fd_eps

protected

small parameter to use in the finite-difference approximations to the derivative

Definition at line 45 of file PorousFlowHystereticInfo.h.

Referenced by computeQpInfo().

◆ _gradp_qp

template<bool is_ad>

GenericMaterialProperty<std::vector<RealGradient>, is_ad>* const PorousFlowVariableBaseTempl< is_ad >::_gradp_qp

protectedinherited

Grad(p) at the quadpoints.

Definition at line 48 of file PorousFlowVariableBase.h.

◆ _grads_qp

template<bool is_ad>

GenericMaterialProperty<std::vector<RealGradient>, is_ad>* const PorousFlowVariableBaseTempl< is_ad >::_grads_qp

protectedinherited

Grad(s) at the quadpoints.

Definition at line 63 of file PorousFlowVariableBase.h.

◆ _high_ext

const PorousFlowVanGenuchten::HighCapillaryPressureExtension PorousFlowHystereticCapillaryPressure::_high_ext

protectedinherited

Parameters involved in the high-saturation extension of the primary wetting curve.

Definition at line 126 of file PorousFlowHystereticCapillaryPressure.h.

◆ _high_ext_type

const PorousFlowVanGenuchten::HighCapillaryPressureExtension::ExtensionStrategy PorousFlowHystereticCapillaryPressure::_high_ext_type

protectedinherited

Type of high-saturation extension of the wetting curves.

Definition at line 118 of file PorousFlowHystereticCapillaryPressure.h.

Referenced by PorousFlowHystereticCapillaryPressure::computeTurningPointInfo().

◆ _high_ratio

const Real PorousFlowHystereticCapillaryPressure::_high_ratio

protectedinherited

The high-saturation extension to the wetting will commence at _high_ratio * (1 - _s_gr_del)

Definition at line 102 of file PorousFlowHystereticCapillaryPressure.h.

Referenced by PorousFlowHystereticCapillaryPressure::computeTurningPointInfo().

◆ _hys_order

const MaterialProperty<unsigned>& PorousFlowHystereticCapillaryPressure::_hys_order

protectedinherited

Hysteresis order, as computed by PorousFlowHysteresisOrder.

Definition at line 129 of file PorousFlowHystereticCapillaryPressure.h.

◆ _hys_order_old

const MaterialProperty<unsigned>& PorousFlowHystereticCapillaryPressure::_hys_order_old

protectedinherited

Old value of hysteresis order, as computed by PorousFlowHysteresisOrder.

Definition at line 132 of file PorousFlowHystereticCapillaryPressure.h.

Referenced by PorousFlowHystereticCapillaryPressure::computeQpProperties().

◆ _hys_sat_tps

const MaterialProperty<std::array<Real, PorousFlowConstants::MAX_HYSTERESIS_ORDER> >& PorousFlowHystereticCapillaryPressure::_hys_sat_tps

protectedinherited

Saturation values at the turning points, as computed by PorousFlowHysteresisOrder.

Definition at line 136 of file PorousFlowHystereticCapillaryPressure.h.

◆ _info

MaterialProperty<Real>& PorousFlowHystereticInfo::_info

protected

Computed nodal or quadpoint value: the meaning of this depends on info_enum.

Definition at line 36 of file PorousFlowHystereticInfo.h.

Referenced by computeQpInfo().

◆ _info_enum

enum PorousFlowHystereticInfo::InfoTypeEnum PorousFlowHystereticInfo::_info_enum

protected

Referenced by computeQpInfo().

◆ _low_ext_d

const PorousFlowVanGenuchten::LowCapillaryPressureExtension PorousFlowHystereticCapillaryPressure::_low_ext_d

protectedinherited

Parameters involved in the low-saturation extension of the primary drying curve.

Definition at line 110 of file PorousFlowHystereticCapillaryPressure.h.

◆ _low_ext_type

const PorousFlowVanGenuchten::LowCapillaryPressureExtension::ExtensionStrategy PorousFlowHystereticCapillaryPressure::_low_ext_type

protectedinherited

Type of low-saturation extension.

Definition at line 104 of file PorousFlowHystereticCapillaryPressure.h.

Referenced by PorousFlowHystereticCapillaryPressure::computeTurningPointInfo().

◆ _low_ext_w

const PorousFlowVanGenuchten::LowCapillaryPressureExtension PorousFlowHystereticCapillaryPressure::_low_ext_w

protectedinherited

Parameters involved in the low-saturation extension of the primary wetting curve.

Definition at line 116 of file PorousFlowHystereticCapillaryPressure.h.

◆ _n_d

const Real PorousFlowHystereticCapillaryPressure::_n_d

protectedinherited

van Genuchten n parameter for the primary drying curve

Definition at line 90 of file PorousFlowHystereticCapillaryPressure.h.

◆ _n_w

const Real PorousFlowHystereticCapillaryPressure::_n_w

protectedinherited

van Genuchten n parameter for the primary wetting curve

Definition at line 92 of file PorousFlowHystereticCapillaryPressure.h.

Referenced by PorousFlowHystereticCapillaryPressure::computeTurningPointInfo(), PorousFlowHystereticCapillaryPressure::d2firstOrderWettingPc(), PorousFlowHystereticCapillaryPressure::d2firstOrderWettingSat(), PorousFlowHystereticCapillaryPressure::dfirstOrderWettingPc(), PorousFlowHystereticCapillaryPressure::dfirstOrderWettingSat(), PorousFlowHystereticCapillaryPressure::firstOrderWettingPc(), and PorousFlowHystereticCapillaryPressure::firstOrderWettingSat().

◆ _num_components

template<bool is_ad>

const unsigned int PorousFlowVariableBaseTempl< is_ad >::_num_components

protectedinherited

Number of components.

Definition at line 36 of file PorousFlowVariableBase.h.

Referenced by PorousFlowFluidStateBaseMaterialTempl< is_ad >::PorousFlowFluidStateBaseMaterialTempl().

◆ _num_pf_vars

template<bool is_ad>

const unsigned int PorousFlowVariableBaseTempl< is_ad >::_num_pf_vars

protectedinherited

Number of PorousFlow variables.

Definition at line 39 of file PorousFlowVariableBase.h.

◆ _num_phases

template<bool is_ad>

const unsigned int PorousFlowVariableBaseTempl< is_ad >::_num_phases

protectedinherited

Number of phases.

Definition at line 33 of file PorousFlowVariableBase.h.

Referenced by PorousFlow2PhaseHysPS::computeQpProperties(), PorousFlow1PhaseFullySaturatedTempl< is_ad >::PorousFlow1PhaseFullySaturatedTempl(), PorousFlow1PhaseHysP::PorousFlow1PhaseHysP(), PorousFlow1PhaseMD_Gaussian::PorousFlow1PhaseMD_Gaussian(), PorousFlow1PhasePTempl< is_ad >::PorousFlow1PhasePTempl(), PorousFlow2PhaseHysPP::PorousFlow2PhaseHysPP(), PorousFlow2PhaseHysPS::PorousFlow2PhaseHysPS(), PorousFlow2PhasePPTempl< is_ad >::PorousFlow2PhasePPTempl(), PorousFlowFluidStateBaseMaterialTempl< is_ad >::PorousFlowFluidStateBaseMaterialTempl(), PorousFlowFluidStateSingleComponentTempl< is_ad >::PorousFlowFluidStateSingleComponentTempl(), and PorousFlowFluidStateTempl< is_ad >::PorousFlowFluidStateTempl().

◆ _pc

MaterialProperty<Real>& PorousFlowHystereticInfo::_pc

protected

Computed nodal or quadpoint value of capillary pressure (needed for hysteretic order computation)

Definition at line 33 of file PorousFlowHystereticInfo.h.

Referenced by computeQpProperties(), and initQpStatefulProperties().

◆ _pc_high

const Real PorousFlowHystereticCapillaryPressure::_pc_high

protectedinherited

Pc at the point of high-saturation extension.

Definition at line 122 of file PorousFlowHystereticCapillaryPressure.h.

◆ _pc_max

const Real PorousFlowHystereticCapillaryPressure::_pc_max

protectedinherited

Maximum capillary pressure: for Pc above this value, a "lower" extension will be used.

Definition at line 100 of file PorousFlowHystereticCapillaryPressure.h.

Referenced by PorousFlowHystereticCapillaryPressure::computeTurningPointInfo().

◆ _pc_older

const MaterialProperty<Real>& PorousFlowHystereticCapillaryPressure::_pc_older

protectedinherited

Older value of capillary pressure.

Definition at line 139 of file PorousFlowHystereticCapillaryPressure.h.

Referenced by PorousFlowHystereticCapillaryPressure::computeQpProperties().

◆ _pc_tps

MaterialProperty<std::array<Real, PorousFlowConstants::MAX_HYSTERESIS_ORDER> >& PorousFlowHystereticCapillaryPressure::_pc_tps

protectedinherited

Nodal or quadpoint values of Pc at the turning points.

Definition at line 142 of file PorousFlowHystereticCapillaryPressure.h.

Referenced by PorousFlowHystereticCapillaryPressure::computeTurningPointInfo(), PorousFlowHystereticCapillaryPressure::d2liquidSaturationQp(), PorousFlowHystereticCapillaryPressure::dliquidSaturationQp(), and PorousFlowHystereticCapillaryPressure::liquidSaturationQp().

◆ _pc_val

const VariableValue& PorousFlowHystereticInfo::_pc_val

protected

Nodal or quadpoint value of capillary pressure.

Definition at line 39 of file PorousFlowHystereticInfo.h.

Referenced by computeQpInfo().

◆ _porepressure

template<bool is_ad>

GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowVariableBaseTempl< is_ad >::_porepressure

protectedinherited

Computed nodal or quadpoint values of porepressure of the phases.

Definition at line 42 of file PorousFlowVariableBase.h.

Referenced by PorousFlow1PhaseMD_Gaussian::buildPS(), PorousFlow1PhaseHysP::buildQpPPSS(), PorousFlow2PhaseHysPP::buildQpPPSS(), PorousFlow2PhaseHysPS::buildQpPPSS(), and PorousFlow1PhaseMD_Gaussian::computeQpProperties().

◆ _s_d_tps

MaterialProperty<std::array<Real, PorousFlowConstants::MAX_HYSTERESIS_ORDER> >& PorousFlowHystereticCapillaryPressure::_s_d_tps

protectedinherited

Computed nodal or quadpoint values of saturation on the drying curve at _pc_tps.

Definition at line 145 of file PorousFlowHystereticCapillaryPressure.h.

Referenced by PorousFlowHystereticCapillaryPressure::computeTurningPointInfo(), PorousFlowHystereticCapillaryPressure::d2secondOrderDryingPc(), PorousFlowHystereticCapillaryPressure::d2secondOrderDryingSat(), PorousFlowHystereticCapillaryPressure::dsecondOrderDryingPc(), PorousFlowHystereticCapillaryPressure::dsecondOrderDryingSat(), PorousFlowHystereticCapillaryPressure::secondOrderDryingPc(), and PorousFlowHystereticCapillaryPressure::secondOrderDryingSat().

◆ _s_gr_max

const Real PorousFlowHystereticCapillaryPressure::_s_gr_max

protectedinherited

Residual gas saturation: 1 - _s_gr_max is the maximum saturation for which the van Genuchten expression is valid for the wetting curve.

Definition at line 98 of file PorousFlowHystereticCapillaryPressure.h.

Referenced by PorousFlowHystereticCapillaryPressure::landSat(), and PorousFlowHystereticCapillaryPressure::PorousFlowHystereticCapillaryPressure().

◆ _s_gr_tps

MaterialProperty<std::array<Real, PorousFlowConstants::MAX_HYSTERESIS_ORDER> >& PorousFlowHystereticCapillaryPressure::_s_gr_tps

protectedinherited

Computed nodal or quadpoint values of S_gr_Del, ie, the Land expression, at the turning points.

Definition at line 148 of file PorousFlowHystereticCapillaryPressure.h.

Referenced by PorousFlowHystereticCapillaryPressure::computeTurningPointInfo(), PorousFlowHystereticCapillaryPressure::d2firstOrderWettingPc(), PorousFlowHystereticCapillaryPressure::d2firstOrderWettingSat(), PorousFlowHystereticCapillaryPressure::dfirstOrderWettingPc(), PorousFlowHystereticCapillaryPressure::dfirstOrderWettingSat(), PorousFlowHystereticCapillaryPressure::firstOrderWettingPc(), and PorousFlowHystereticCapillaryPressure::firstOrderWettingSat().

◆ _s_high

const Real PorousFlowHystereticCapillaryPressure::_s_high

protectedinherited

Saturation at the point of high-saturation extension.

Definition at line 120 of file PorousFlowHystereticCapillaryPressure.h.

Referenced by PorousFlowHystereticCapillaryPressure::PorousFlowHystereticCapillaryPressure().

◆ _s_l_min

const Real PorousFlowHystereticCapillaryPressure::_s_l_min

protectedinherited

Minimum liquid saturation for which the van Genuchten expression is valid (Pc(_s_l_min) = infinity)

Definition at line 94 of file PorousFlowHystereticCapillaryPressure.h.

◆ _s_low_d

const Real PorousFlowHystereticCapillaryPressure::_s_low_d

protectedinherited

Saturation on the primary drying curve where low-saturation extension commences.

Definition at line 106 of file PorousFlowHystereticCapillaryPressure.h.

◆ _s_low_w

const Real PorousFlowHystereticCapillaryPressure::_s_low_w

protectedinherited

Saturation on the primary wetting curve where low-saturation extension commences.

Definition at line 112 of file PorousFlowHystereticCapillaryPressure.h.

Referenced by PorousFlowHystereticCapillaryPressure::PorousFlowHystereticCapillaryPressure().

◆ _s_lr

const Real PorousFlowHystereticCapillaryPressure::_s_lr

protectedinherited

Liquid saturation below which the liquid relative permeability is zero.

Definition at line 96 of file PorousFlowHystereticCapillaryPressure.h.

Referenced by PorousFlowHystereticCapillaryPressure::landSat(), and PorousFlowHystereticCapillaryPressure::PorousFlowHystereticCapillaryPressure().

◆ _s_w_tps

MaterialProperty<std::array<Real, PorousFlowConstants::MAX_HYSTERESIS_ORDER> >& PorousFlowHystereticCapillaryPressure::_s_w_tps

protectedinherited

Computed nodal or quadpoint values of liquid saturation on the wetting curve defined by _s_gr_del, at pc = _pc_d_tps.

Definition at line 159 of file PorousFlowHystereticCapillaryPressure.h.

Referenced by PorousFlowHystereticCapillaryPressure::computeTurningPointInfo(), PorousFlowHystereticCapillaryPressure::d2firstOrderWettingPc(), PorousFlowHystereticCapillaryPressure::d2firstOrderWettingSat(), PorousFlowHystereticCapillaryPressure::dfirstOrderWettingPc(), PorousFlowHystereticCapillaryPressure::dfirstOrderWettingSat(), PorousFlowHystereticCapillaryPressure::firstOrderWettingPc(), and PorousFlowHystereticCapillaryPressure::firstOrderWettingSat().

◆ _sat_val

const VariableValue& PorousFlowHystereticInfo::_sat_val

protected

Nodal or quadpoint value of liquid saturation.

Definition at line 42 of file PorousFlowHystereticInfo.h.

Referenced by computeQpInfo(), computeQpProperties(), and initQpStatefulProperties().

◆ _saturation

template<bool is_ad>

GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowVariableBaseTempl< is_ad >::_saturation

protectedinherited

Computed nodal or qp saturation of the phases.

Definition at line 57 of file PorousFlowVariableBase.h.

Referenced by PorousFlow1PhaseMD_Gaussian::buildPS(), PorousFlow1PhaseHysP::buildQpPPSS(), PorousFlow2PhaseHysPP::buildQpPPSS(), PorousFlow2PhaseHysPS::buildQpPPSS(), computeQpProperties(), PorousFlow1PhaseMD_Gaussian::computeQpProperties(), and initQpStatefulProperties().

◆ _w_high_ext_tps

MaterialProperty<std::array<PorousFlowVanGenuchten::HighCapillaryPressureExtension, PorousFlowConstants::MAX_HYSTERESIS_ORDER> >& PorousFlowHystereticCapillaryPressure::_w_high_ext_tps

protectedinherited

Nodal or quadpoint values of the high extension of the wetting curve defined by _s_gr_tps.

Definition at line 156 of file PorousFlowHystereticCapillaryPressure.h.

Referenced by PorousFlowHystereticCapillaryPressure::computeTurningPointInfo(), PorousFlowHystereticCapillaryPressure::d2firstOrderWettingPc(), PorousFlowHystereticCapillaryPressure::d2firstOrderWettingSat(), PorousFlowHystereticCapillaryPressure::dfirstOrderWettingPc(), PorousFlowHystereticCapillaryPressure::dfirstOrderWettingSat(), PorousFlowHystereticCapillaryPressure::firstOrderWettingPc(), and PorousFlowHystereticCapillaryPressure::firstOrderWettingSat().

◆ _w_low_ext_tps

MaterialProperty<std::array<PorousFlowVanGenuchten::LowCapillaryPressureExtension, PorousFlowConstants::MAX_HYSTERESIS_ORDER> >& PorousFlowHystereticCapillaryPressure::_w_low_ext_tps

protectedinherited

Nodal or quadpoint values of the low extension of the wetting curve defined by _s_gr_tps.

Definition at line 152 of file PorousFlowHystereticCapillaryPressure.h.

Referenced by PorousFlowHystereticCapillaryPressure::computeTurningPointInfo(), PorousFlowHystereticCapillaryPressure::d2firstOrderWettingPc(), PorousFlowHystereticCapillaryPressure::d2firstOrderWettingSat(), PorousFlowHystereticCapillaryPressure::dfirstOrderWettingPc(), PorousFlowHystereticCapillaryPressure::dfirstOrderWettingSat(), PorousFlowHystereticCapillaryPressure::firstOrderWettingPc(), and PorousFlowHystereticCapillaryPressure::firstOrderWettingSat().

The documentation for this class was generated from the following files:

porous_flow/include/materials/PorousFlowHystereticInfo.h
porous_flow/src/materials/PorousFlowHystereticInfo.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ InfoTypeEnum

Constructor & Destructor Documentation

◆ PorousFlowHystereticInfo()

Member Function Documentation

◆ capillaryPressureQp()

◆ computeQpInfo()

◆ computeQpProperties()

◆ computeTurningPointInfo()

◆ d2capillaryPressureQp()

◆ d2liquidSaturationQp()

◆ dcapillaryPressureQp()

◆ dliquidSaturationQp()

◆ initQpStatefulProperties()

◆ landSat()

◆ liquidSaturationQp()

◆ relativeError()

◆ validParams()

Member Data Documentation

◆ _alpha_d

◆ _alpha_w

◆ _dgradp_qp_dgradv

◆ _dgradp_qp_dv

◆ _dgrads_qp_dgradv

◆ _dgrads_qp_dv

◆ _dpc_high

◆ _dpc_low_d

◆ _dpc_low_w

◆ _dporepressure_dvar

◆ _dsaturation_dvar

◆ _fd_eps

◆ _gradp_qp

◆ _grads_qp

◆ _high_ext

◆ _high_ext_type

◆ _high_ratio

◆ _hys_order

◆ _hys_order_old

◆ _hys_sat_tps

◆ _info

◆ _info_enum

◆ _low_ext_d

◆ _low_ext_type

◆ _low_ext_w

◆ _n_d

◆ _n_w

◆ _num_components

◆ _num_pf_vars

◆ _num_phases

◆ _pc

◆ _pc_high

◆ _pc_max

◆ _pc_older

◆ _pc_tps

◆ _pc_val

◆ _porepressure

◆ _s_d_tps

◆ _s_gr_max

◆ _s_gr_tps

◆ _s_high

◆ _s_l_min

◆ _s_low_d

◆ _s_low_w

◆ _s_lr

◆ _s_w_tps

◆ _sat_val

◆ _saturation

◆ _w_high_ext_tps

◆ _w_low_ext_tps