https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static 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 Types

typedef DataFileName DataFileParameterType
 

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 ADReal capillaryPressure (const ADReal &saturation, unsigned qp=0) const
 
virtual Real dCapillaryPressure (Real saturation, unsigned qp=0) const
 Derivative of capillary pressure wrt true saturation. More...
 
virtual ADReal dCapillaryPressure (const ADReal &saturation, unsigned qp=0) const
 
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...
 
ADReal saturation (const ADReal &pc, unsigned qp=0) const
 
Real dSaturation (Real pc, unsigned qp=0) const
 Derivative of saturation wrt capillary pressure. More...
 
ADReal dSaturation (const ADReal &pc, unsigned int qp=0) const
 
Real d2Saturation (Real pc, unsigned qp=0) const
 Second derivative of saturation wrt capillary pressure. More...
 
bool needThreadedCopy () const override final
 
SubProblem & getSubProblem () const
 
bool shouldDuplicateInitialExecution () const
 
virtual Real spatialValue (const Point &) const
 
virtual const std::vector< Point > spatialPoints () const
 
void gatherSum (T &value)
 
void gatherMax (T &value)
 
void gatherMin (T &value)
 
void gatherProxyValueMax (T1 &proxy, T2 &value)
 
void gatherProxyValueMin (T1 &proxy, T2 &value)
 
void setPrimaryThreadCopy (UserObject *primary)
 
UserObject * primaryThreadCopy ()
 
std::set< UserObjectName > getDependObjects () const
 
const std::set< std::string > & getRequestedItems () override
 
const std::set< std::string > & getSuppliedItems () override
 
unsigned int systemNumber () const
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParameters & parameters () const
 
MooseObjectName uniqueName () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
T getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &nm) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
virtual void timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void subdomainSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnum & getExecuteOnEnum () const
 
UserObjectName getUserObjectName (const std::string &param_name) const
 
const T & getUserObject (const std::string &param_name, bool is_dependency=true) const
 
const T & getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const
 
const UserObject & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObject & getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
 
const std::vector< SubdomainName > & blocks () const
 
unsigned int numBlocks () const
 
virtual const std::set< SubdomainID > & blockIDs () const
 
unsigned int blocksMaxDimension () const
 
bool hasBlocks (const SubdomainName &name) const
 
bool hasBlocks (const std::vector< SubdomainName > &names) const
 
bool hasBlocks (const std::set< SubdomainName > &names) const
 
bool hasBlocks (SubdomainID id) const
 
bool hasBlocks (const std::vector< SubdomainID > &ids) const
 
bool hasBlocks (const std::set< SubdomainID > &ids) const
 
bool isBlockSubset (const std::set< SubdomainID > &ids) const
 
bool isBlockSubset (const std::vector< SubdomainID > &ids) const
 
bool hasBlockMaterialProperty (const std::string &prop_name)
 
const std::set< SubdomainID > & meshBlockIDs () const
 
virtual bool blockRestricted () const
 
virtual void checkVariable (const MooseVariableFieldBase &variable) const
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty (const MaterialPropertyName &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty ()
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialPropertyByName (const std::string &prop_name)
 
const MaterialProperty< T > & getZeroMaterialProperty (Ts... args)
 
std::set< SubdomainID > getMaterialPropertyBlocks (const std::string &name)
 
std::vector< SubdomainName > getMaterialPropertyBlockNames (const std::string &name)
 
std::set< BoundaryID > getMaterialPropertyBoundaryIDs (const std::string &name)
 
std::vector< BoundaryName > getMaterialPropertyBoundaryNames (const std::string &name)
 
void checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)
 
std::unordered_map< SubdomainID, std::vector< MaterialBase *> > buildRequiredMaterials (bool allow_stateful=true)
 
void statefulPropertiesAllowed (bool)
 
bool getMaterialPropertyCalled () const
 
virtual const std::unordered_set< unsigned int > & getMatPropDependencies () const
 
virtual void resolveOptionalProperties ()
 
const GenericMaterialProperty< T, is_ad > & getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)
 
virtual const VariableValue & coupledValueByName (const std::string &var_name)
 
virtual const ArrayVariableValue & coupledArrayValueByName (const std::string &var_name)
 
const std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> > & getCoupledVars () const
 
const std::vector< MooseVariableFieldBase *> & getCoupledMooseVars () const
 
const std::vector< MooseVariable *> & getCoupledStandardMooseVars () const
 
const std::vector< VectorMooseVariable *> & getCoupledVectorMooseVars () const
 
const std::vector< ArrayMooseVariable *> & getCoupledArrayMooseVars () const
 
void addFEVariableCoupleableVectorTag (TagID tag)
 
void addFEVariableCoupleableMatrixTag (TagID tag)
 
std::set< TagID > & getFEVariableCoupleableVectorTags ()
 
const std::set< TagID > & getFEVariableCoupleableVectorTags () const
 
std::set< TagID > & getFEVariableCoupleableMatrixTags ()
 
const std::set< TagID > & getFEVariableCoupleableMatrixTags () const
 
auto & getWritableCoupledVariables () const
 
bool hasWritableCoupledVariables () const
 
const ADVariableValue * getADDefaultValue (const std::string &var_name) const
 
const ADVectorVariableValue * getADDefaultVectorValue (const std::string &var_name) const
 
const ADVariableGradient & getADDefaultGradient () const
 
const ADVectorVariableGradient & getADDefaultVectorGradient () const
 
const ADVariableSecond & getADDefaultSecond () const
 
const ADVectorVariableCurl & getADDefaultCurl () const
 
const std::vector< MooseVariableScalar *> & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
const std::set< MooseVariableFieldBase *> & getMooseVariableDependencies () const
 
std::set< MooseVariableFieldBase *> checkAllVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_omit={})
 
std::set< MooseVariableFieldBase *> checkVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
void addMooseVariableDependency (MooseVariableFieldBase *var)
 
void addMooseVariableDependency (const std::vector< MooseVariableFieldBase * > &vars)
 
bool isImplicit ()
 
Moose::StateArg determineState () const
 
void setRandomResetFrequency (ExecFlagType exec_flag)
 
unsigned long getRandomLong () const
 
Real getRandomReal () const
 
unsigned int getSeed (std::size_t id)
 
unsigned int getMasterSeed () const
 
bool isNodal () const
 
ExecFlagType getResetOnTime () const
 
void setRandomDataPointer (RandomData *random_data)
 
virtual unsigned int getElementIDIndex (const std::string &id_parameter_name, unsigned int comp=0) const
 
virtual unsigned int getElementIDIndexByName (const std::string &id_name) const
 
virtual const dof_id_type & getElementID (const std::string &id_parameter_name, unsigned int comp=0) const
 
dof_id_type getElementID (const Elem *elem, unsigned int elem_id_index) const
 
virtual const dof_id_type & getElementIDNeighbor (const std::string &id_parameter_name, unsigned int comp=0) const
 
virtual const dof_id_type & getElementIDByName (const std::string &id_name) const
 
virtual const dof_id_type & getElementIDNeighborByName (const std::string &id_name) const
 
bool hasElementID (const std::string &id_name) const
 
dof_id_type maxElementID (unsigned int elem_id_index) const
 
dof_id_type minElementID (unsigned int elem_id_index) const
 
bool areElemIDsIdentical (const std::string &id_name1, const std::string &id_name2) const
 
std::unordered_map< dof_id_type, std::set< dof_id_type > > getElemIDMapping (const std::string &id_name1, const std::string &id_name2) const
 
std::set< dof_id_type > getAllElemIDs (unsigned int elem_id_index) const
 
std::set< dof_id_type > getElemIDsOnBlocks (unsigned int elem_id_index, const std::set< SubdomainID > &blks) const
 
virtual void execute () override final
 
virtual void execute () override final
 
virtual void finalize () override final
 
virtual void finalize () override final
 
virtual void threadJoin (const UserObject &) override final
 
virtual void threadJoin (const UserObject &) override final
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
const Function & getFunction (const std::string &name) const
 
const Function & getFunctionByName (const FunctionName &name) const
 
bool hasFunction (const std::string &param_name) const
 
bool hasFunctionByName (const FunctionName &name) const
 
bool isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessor (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessorByName (const PostprocessorName &name) const
 
std::size_t coupledPostprocessors (const std::string &param_name) const
 
const PostprocessorName & getPostprocessorName (const std::string &param_name, const unsigned int index=0) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name) const
 
const VectorPostprocessorName & getVectorPostprocessorName (const std::string &param_name) const
 
T & getSampler (const std::string &name)
 
Sampler & getSampler (const std::string &name)
 
T & getSamplerByName (const SamplerName &name)
 
Sampler & getSamplerByName (const SamplerName &name)
 
virtual void meshChanged ()
 
virtual void meshDisplaced ()
 
PerfGraph & perfGraph ()
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
const Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 

Static Public Member Functions

static InputParameters validParams ()
 
static void sort (typename std::vector< T > &vector)
 
static void sortDFS (typename std::vector< T > &vector)
 
static void cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)
 

Public Attributes

const ConsoleStream _console
 

Static Public Attributes

static constexpr PropertyValue::id_type default_property_id
 
static constexpr PropertyValue::id_type zero_property_id
 
static constexpr auto SYSTEM
 
static constexpr auto NAME
 

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...
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &name) const override
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override
 
virtual void addUserObjectDependencyHelper (const UserObject &uo) const override
 
void addReporterDependencyHelper (const ReporterName &reporter_name) override
 
const ReporterName & getReporterName (const std::string &param_name) const
 
T & declareRestartableData (const std::string &data_name, Args &&... args)
 
ManagedValue< T > declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
const T & getRestartableData (const std::string &data_name) const
 
T & declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
T & declareRecoverableData (const std::string &data_name, Args &&... args)
 
T & declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
 
T & declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
 
std::string restartableName (const std::string &data_name) const
 
const T & getMeshProperty (const std::string &data_name, const std::string &prefix)
 
const T & getMeshProperty (const std::string &data_name)
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name) const
 
bool hasMeshProperty (const std::string &data_name) const
 
std::string meshPropertyName (const std::string &data_name) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_name) const
 
virtual bool hasBlockMaterialPropertyHelper (const std::string &prop_name)
 
void initializeBlockRestrictable (const MooseObject *moose_object)
 
Moose::CoordinateSystemType getBlockCoordSystem ()
 
virtual void checkMaterialProperty (const std::string &name, const unsigned int state)
 
void markMatPropRequested (const std::string &)
 
MaterialPropertyName getMaterialPropertyName (const std::string &name) const
 
void checkExecutionStage ()
 
virtual void coupledCallback (const std::string &, bool) const
 
virtual bool isCoupled (const std::string &var_name, unsigned int i=0) const
 
virtual bool isCoupledConstant (const std::string &var_name) const
 
unsigned int coupledComponents (const std::string &var_name) const
 
VariableName coupledName (const std::string &var_name, unsigned int comp=0) const
 
std::vector< VariableName > coupledNames (const std::string &var_name) const
 
virtual unsigned int coupled (const std::string &var_name, unsigned int comp=0) const
 
std::vector< unsigned int > coupledIndices (const std::string &var_name) const
 
virtual const VariableValue & coupledValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValues (const std::string &var_name) const
 
std::vector< const VectorVariableValue *> coupledVectorValues (const std::string &var_name) const
 
const GenericVariableValue< is_ad > & coupledGenericValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericValue (const std::string &var_name, unsigned int comp) const
 
const GenericVectorVariableValue< is_ad > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVectorVariableValue< false > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp) const
 
const GenericVectorVariableValue< true > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp) const
 
std::vector< const GenericVariableValue< is_ad > *> coupledGenericValues (const std::string &var_name) const
 
std::vector< const GenericVariableValue< false > *> coupledGenericValues (const std::string &var_name) const
 
std::vector< const GenericVariableValue< true > *> coupledGenericValues (const std::string &var_name) const
 
const GenericVariableValue< is_ad > & coupledGenericDofValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDofValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDofValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< is_ad > & coupledGenericDot (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< is_ad > & coupledGenericDotDot (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDotDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDotDot (const std::string &var_name, unsigned int comp) const
 
virtual const VariableValue & coupledValueLower (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableValue *> adCoupledValues (const std::string &var_name) const
 
const ADVariableValue & adCoupledLowerValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableValue & adCoupledVectorValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVectorVariableValue *> adCoupledVectorValues (const std::string &var_name) const
 
virtual const VariableValue & coupledVectorTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableValue & coupledVectorTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const VariableValue *> coupledVectorTagValues (const std::string &var_names, TagID tag) const
 
std::vector< const VariableValue *> coupledVectorTagValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const ArrayVariableValue & coupledVectorTagArrayValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const ArrayVariableValue & coupledVectorTagArrayValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const ArrayVariableValue *> coupledVectorTagArrayValues (const std::string &var_names, TagID tag) const
 
std::vector< const ArrayVariableValue *> coupledVectorTagArrayValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const VariableGradient & coupledVectorTagGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableGradient & coupledVectorTagGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const VariableGradient *> coupledVectorTagGradients (const std::string &var_names, TagID tag) const
 
std::vector< const VariableGradient *> coupledVectorTagGradients (const std::string &var_names, const std::string &tag_name) const
 
virtual const ArrayVariableGradient & coupledVectorTagArrayGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const ArrayVariableGradient & coupledVectorTagArrayGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const ArrayVariableGradient *> coupledVectorTagArrayGradients (const std::string &var_names, TagID tag) const
 
std::vector< const ArrayVariableGradient *> coupledVectorTagArrayGradients (const std::string &var_names, const std::string &tag_name) const
 
virtual const VariableValue & coupledVectorTagDofValue (const std::string &var_name, TagID tag, unsigned int index=0) const
 
virtual const VariableValue & coupledVectorTagDofValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
const ArrayVariableValue & coupledVectorTagArrayDofValue (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledVectorTagDofValues (const std::string &var_names, TagID tag) const
 
std::vector< const VariableValue *> coupledVectorTagDofValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const VariableValue & coupledMatrixTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableValue & coupledMatrixTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const VariableValue *> coupledMatrixTagValues (const std::string &var_names, TagID tag) const
 
std::vector< const VariableValue *> coupledMatrixTagValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const VectorVariableValue & coupledVectorValue (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ArrayVariableValue *> coupledArrayValues (const std::string &var_name) const
 
MooseWritableVariable & writableVariable (const std::string &var_name, unsigned int comp=0)
 
virtual VariableValue & writableCoupledValue (const std::string &var_name, unsigned int comp=0)
 
void checkWritableVar (MooseWritableVariable *var)
 
virtual const VariableValue & coupledValueOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValuesOld (const std::string &var_name) const
 
std::vector< const VectorVariableValue *> coupledVectorValuesOld (const std::string &var_name) const
 
virtual const VariableValue & coupledValueOlder (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValuesOlder (const std::string &var_name) const
 
virtual const VariableValue & coupledValuePreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorValueOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorValueOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayValueOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayValueOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradient (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableGradient *> coupledGradients (const std::string &var_name) const
 
const ADVariableGradient & adCoupledGradient (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableGradient & adCoupledGradientDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableGradient *> adCoupledGradients (const std::string &var_name) const
 
const GenericVariableGradient< is_ad > & coupledGenericGradient (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableGradient< false > & coupledGenericGradient (const std::string &var_name, unsigned int comp) const
 
const GenericVariableGradient< true > & coupledGenericGradient (const std::string &var_name, unsigned int comp) const
 
std::vector< const GenericVariableGradient< is_ad > *> coupledGenericGradients (const std::string &var_name) const
 
std::vector< const GenericVariableGradient< false > *> coupledGenericGradients (const std::string &var_name) const
 
std::vector< const GenericVariableGradient< true > *> coupledGenericGradients (const std::string &var_name) const
 
const ADVectorVariableGradient & adCoupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableSecond & adCoupledSecond (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableSecond & adCoupledVectorSecond (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradientOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableGradient *> coupledGradientsOld (const std::string &var_name) const
 
virtual const VariableGradient & coupledGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradientPreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradientDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradientDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradient & coupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradient & coupledVectorGradientOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradient & coupledVectorGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradient & coupledArrayGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradient & coupledArrayGradientOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradient & coupledArrayGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradient & coupledArrayGradientDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurl & coupledCurl (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurl & coupledCurlOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurl & coupledCurlOlder (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableCurl & adCoupledCurl (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergence & coupledDiv (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergence & coupledDivOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergence & coupledDivOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecond & coupledSecond (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecond & coupledSecondOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecond & coupledSecondOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecond & coupledSecondPreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledDots (const std::string &var_name) const
 
virtual const VariableValue & coupledDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableValue *> adCoupledDots (const std::string &var_name) const
 
const ADVariableValue & adCoupledDotDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableValue & adCoupledVectorDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledVectorDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledVectorDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledArrayDotDu (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValue (const std::string &var_name, unsigned int comp=0) const
 
const Moose::ADType< T >::type & adCoupledNodalValue (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValueOld (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValuePreviousNL (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledNodalDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledNodalDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledNodalDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDofValues (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValues (const std::string &var_name) const
 
virtual const VariableValue & coupledDofValuesOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValuesOld (const std::string &var_name) const
 
virtual const VariableValue & coupledDofValuesOlder (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValuesOlder (const std::string &var_name) const
 
virtual const ArrayVariableValue & coupledArrayDofValues (const std::string &var_name, unsigned int comp=0) const
 
virtual const ADVariableValue & adCoupledDofValues (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adZeroValue () const
 
const ADVariableGradient & adZeroGradient () const
 
const ADVariableSecond & adZeroSecond () const
 
const GenericVariableValue< is_ad > & genericZeroValue ()
 
const GenericVariableValue< false > & genericZeroValue ()
 
const GenericVariableValue< true > & genericZeroValue ()
 
const GenericVariableGradient< is_ad > & genericZeroGradient ()
 
const GenericVariableGradient< false > & genericZeroGradient ()
 
const GenericVariableGradient< true > & genericZeroGradient ()
 
const GenericVariableSecond< is_ad > & genericZeroSecond ()
 
const GenericVariableSecond< false > & genericZeroSecond ()
 
const GenericVariableSecond< true > & genericZeroSecond ()
 
bool checkVar (const std::string &var_name, unsigned int comp=0, unsigned int comp_bound=0) const
 
const MooseVariableFieldBase * getFEVar (const std::string &var_name, unsigned int comp) const
 
const MooseVariableFieldBase * getFieldVar (const std::string &var_name, unsigned int comp) const
 
MooseVariableFieldBase * getFieldVar (const std::string &var_name, unsigned int comp)
 
const T * getVarHelper (const std::string &var_name, unsigned int comp) const
 
T * getVarHelper (const std::string &var_name, unsigned int comp)
 
MooseVariable * getVar (const std::string &var_name, unsigned int comp)
 
const MooseVariable * getVar (const std::string &var_name, unsigned int comp) const
 
VectorMooseVariable * getVectorVar (const std::string &var_name, unsigned int comp)
 
const VectorMooseVariable * getVectorVar (const std::string &var_name, unsigned int comp) const
 
ArrayMooseVariable * getArrayVar (const std::string &var_name, unsigned int comp)
 
const ArrayMooseVariable * getArrayVar (const std::string &var_name, unsigned int comp) const
 
void validateExecutionerType (const std::string &name, const std::string &fn_name) const
 
std::vector< T > coupledVectorHelper (const std::string &var_name, const Func &func) const
 
bool isCoupledScalar (const std::string &var_name, unsigned int i=0) const
 
unsigned int coupledScalarComponents (const std::string &var_name) const
 
unsigned int coupledScalar (const std::string &var_name, unsigned int comp=0) const
 
libMesh::Order coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< is_ad > & coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const VariableValue & coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const MooseVariableScalar * getScalarVar (const std::string &var_name, unsigned int comp) const
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 

Static Protected Member Functions

static std::string meshPropertyName (const std::string &data_name, const std::string &prefix)
 

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...
 
MooseMesh & _mesh
 
const Elem *const & _current_elem
 
const Real & _current_elem_volume
 
const MooseArray< Point > & _q_point
 
const QBase *const & _qrule
 
const MooseArray< Real > & _JxW
 
const MooseArray< Real > & _coord
 
SubProblem & _subproblem
 
FEProblemBase & _fe_problem
 
SystemBase & _sys
 
const THREAD_ID _tid
 
Assembly & _assembly
 
const Moose::CoordinateSystemType & _coord_sys
 
const bool _duplicate_initial_execution
 
std::set< std::string > _depend_uo
 
const bool & _enabled
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
const ExecFlagEnum & _execute_enum
 
const ExecFlagType & _current_execute_flag
 
MooseApp & _restartable_app
 
const std::string _restartable_system_name
 
const THREAD_ID _restartable_tid
 
const bool _restartable_read_only
 
FEProblemBase & _mci_feproblem
 
FEProblemBase & _mdi_feproblem
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
const MaterialData * _blk_material_data
 
const InputParameters & _mi_params
 
const std::string _mi_name
 
const MooseObjectName _mi_moose_object_name
 
FEProblemBase & _mi_feproblem
 
SubProblem & _mi_subproblem
 
const THREAD_ID _mi_tid
 
const Moose::MaterialDataType _material_data_type
 
MaterialData & _material_data
 
bool _stateful_allowed
 
bool _get_material_property_called
 
std::vector< std::unique_ptr< PropertyValue > > _default_properties
 
std::unordered_set< unsigned int > _material_property_dependencies
 
const MaterialPropertyName _get_suffix
 
const bool _use_interpolated_state
 
const InputParameters & _c_parameters
 
const std::string & _c_name
 
const std::string & _c_type
 
FEProblemBase & _c_fe_problem
 
const SystemBase *const _c_sys
 
std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> > _coupled_vars
 
std::vector< MooseVariableFieldBase *> _coupled_moose_vars
 
std::vector< MooseVariable *> _coupled_standard_moose_vars
 
std::vector< VectorMooseVariable *> _coupled_vector_moose_vars
 
std::vector< ArrayMooseVariable *> _coupled_array_moose_vars
 
std::vector< MooseVariableFV< Real > *> _coupled_standard_fv_moose_vars
 
std::vector< MooseLinearVariableFV< Real > *> _coupled_standard_linear_fv_moose_vars
 
const std::unordered_map< std::string, std::string > & _new_to_deprecated_coupled_vars
 
bool _c_nodal
 
bool _c_is_implicit
 
const bool _c_allow_element_to_nodal_coupling
 
THREAD_ID _c_tid
 
std::unordered_map< std::string, std::vector< std::unique_ptr< VariableValue > > > _default_value
 
std::unordered_map< std::string, std::unique_ptr< MooseArray< ADReal > > > _ad_default_value
 
std::unordered_map< std::string, std::unique_ptr< VectorVariableValue > > _default_vector_value
 
std::unordered_map< std::string, std::unique_ptr< ArrayVariableValue > > _default_array_value
 
std::unordered_map< std::string, std::unique_ptr< MooseArray< ADRealVectorValue > > > _ad_default_vector_value
 
VariableValue _default_value_zero
 
VariableGradient _default_gradient
 
MooseArray< ADRealVectorValue > _ad_default_gradient
 
MooseArray< ADRealTensorValue > _ad_default_vector_gradient
 
VariableSecond _default_second
 
MooseArray< ADRealTensorValue > _ad_default_second
 
MooseArray< ADRealVectorValue > _ad_default_curl
 
const VariableValue & _zero
 
const VariablePhiValue & _phi_zero
 
const MooseArray< ADReal > & _ad_zero
 
const VariableGradient & _grad_zero
 
const MooseArray< ADRealVectorValue > & _ad_grad_zero
 
const VariablePhiGradient & _grad_phi_zero
 
const VariableSecond & _second_zero
 
const MooseArray< ADRealTensorValue > & _ad_second_zero
 
const VariablePhiSecond & _second_phi_zero
 
const VectorVariableValue & _vector_zero
 
const VectorVariableCurl & _vector_curl_zero
 
VectorVariableValue _default_vector_value_zero
 
VectorVariableGradient _default_vector_gradient
 
VectorVariableCurl _default_vector_curl
 
VectorVariableDivergence _default_div
 
ArrayVariableValue _default_array_value_zero
 
ArrayVariableGradient _default_array_gradient
 
bool _coupleable_neighbor
 
FEProblemBase & _sc_fe_problem
 
const THREAD_ID _sc_tid
 
const Real & _real_zero
 
const VariableValue & _scalar_zero
 
const Point & _point_zero
 
const InputParameters & _ti_params
 
FEProblemBase & _ti_feproblem
 
bool _is_implicit
 
Real & _t
 
const Real & _t_old
 
int & _t_step
 
Real & _dt
 
Real & _dt_old
 
bool _is_transient
 
const Parallel::Communicator & _communicator
 

Static Protected Attributes

static const std::string _interpolated_old
 
static const std::string _interpolated_older
 

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 20 of file PorousFlowCapillaryPressureVG.h.

Constructor & Destructor Documentation

◆ PorousFlowCapillaryPressureVG()

PorousFlowCapillaryPressureVG::PorousFlowCapillaryPressureVG ( const InputParameters &  parameters)

Definition at line 38 of file PorousFlowCapillaryPressureVG.C.

39  : PorousFlowCapillaryPressure(parameters),
40  _m(getParam<Real>("m")),
41  _alpha(getParam<Real>("alpha")),
42  _s_scale(getParam<Real>("s_scale")),
43  _pc_sscale(PorousFlowVanGenuchten::capillaryPressure(_s_scale, _alpha, _m, _pc_max))
44 {
45 }
PorousFlowCapillaryPressureVG::_m
const Real _m
van Genuchten exponent m
Definition: PorousFlowCapillaryPressureVG.h:37
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:39
PorousFlowCapillaryPressure::PorousFlowCapillaryPressure
PorousFlowCapillaryPressure(const InputParameters &parameters)
Definition: PorousFlowCapillaryPressure.C:36
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:41
DiscreteElementUserObject::parameters
const InputParameters & parameters() const
PorousFlowCapillaryPressureVG::_pc_sscale
const Real _pc_sscale
pc_sscale = f(s_scale), where f is the van Genuchten function
Definition: PorousFlowCapillaryPressureVG.h:43
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() [1/2]

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 63 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlowCapillaryPressure::capillaryPressure(), PorousFlowCapillaryPressure::initialSetup(), PorousFlowWaterVapor::thermophysicalProperties(), PorousFlowWaterNCG::thermophysicalProperties(), PorousFlowBrineCO2::thermophysicalProperties(), PorousFlowWaterNCG::totalMassFraction(), PorousFlowBrineCO2::totalMassFraction(), PorousFlowWaterNCG::twoPhaseProperties(), and PorousFlowBrineCO2::twoPhaseProperties().

64 {
65  if (_log_ext && saturation < _sat_ext)
66  return capillaryPressureLogExt(saturation);
67  else
68  return capillaryPressureCurve(saturation, qp);
69 }
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:120
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:162
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

◆ capillaryPressure() [2/2]

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

Definition at line 72 of file PorousFlowCapillaryPressure.C.

73 {
74  const Real Pc = capillaryPressure(saturation.value(), qp);
75  const Real dPc_ds = dCapillaryPressure(saturation.value(), qp);
76 
77  ADReal result = Pc;
78  result.derivatives() = saturation.derivatives() * dPc_ds;
79 
80  return result;
81 }
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:120
ADReal
DualNumber< Real, DNDerivativeType, true > ADReal
PorousFlowCapillaryPressure::capillaryPressure
virtual Real capillaryPressure(Real saturation, unsigned qp=0) const
Capillary pressure is calculated as a function of true saturation.
Definition: PorousFlowCapillaryPressure.C:63
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
PorousFlowCapillaryPressure::dCapillaryPressure
virtual Real dCapillaryPressure(Real saturation, unsigned qp=0) const
Derivative of capillary pressure wrt true saturation.
Definition: PorousFlowCapillaryPressure.C:84

◆ 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 48 of file PorousFlowCapillaryPressureVG.C.

49 {
50  const Real seff = effectiveSaturationFromSaturation(saturation) * _s_scale;
51  return PorousFlowVanGenuchten::capillaryPressure(seff, _alpha, _m, _pc_max) - _pc_sscale;
52 }
PorousFlowCapillaryPressureVG::_m
const Real _m
van Genuchten exponent m
Definition: PorousFlowCapillaryPressureVG.h:37
PorousFlowCapillaryPressure::effectiveSaturationFromSaturation
Real effectiveSaturationFromSaturation(Real saturation) const
Effective saturation of liquid phase given liquid saturation and residual liquid saturation.
Definition: PorousFlowCapillaryPressure.C:114
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:120
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:39
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
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:41
PorousFlowCapillaryPressureVG::_pc_sscale
const Real _pc_sscale
pc_sscale = f(s_scale), where f is the van Genuchten function
Definition: PorousFlowCapillaryPressureVG.h:43
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 162 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlowCapillaryPressure::capillaryPressure().

163 {
164  return _pc_ext * std::pow(10.0, _slope_ext * (saturation - _sat_ext));
165 }
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:120
PorousFlowCapillaryPressure::_slope_ext
Real _slope_ext
Gradient of the logarithmic extension This is computed only for qp=0.
Definition: PorousFlowCapillaryPressure.h:247
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
std::pow
MooseUnits pow(const MooseUnits &, int)

◆ 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 105 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlowCapillaryPressure::dCapillaryPressure().

106 {
107  if (_log_ext && saturation < _sat_ext)
108  return d2CapillaryPressureLogExt(saturation);
109  else
110  return d2CapillaryPressureCurve(saturation, qp);
111 }
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:120
PorousFlowCapillaryPressure::d2CapillaryPressureLogExt
Real d2CapillaryPressureLogExt(Real s) const
The second derivative of capillary pressure in the logarithmic extension This implementation assumes ...
Definition: PorousFlowCapillaryPressure.C:174
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 63 of file PorousFlowCapillaryPressureVG.C.

64 {
65  const Real seff = effectiveSaturationFromSaturation(saturation) * _s_scale;
66  return PorousFlowVanGenuchten::d2CapillaryPressure(seff, _alpha, _m, _pc_max) * _dseff_ds *
67  _dseff_ds * _s_scale * _s_scale;
68 }
PorousFlowCapillaryPressureVG::_m
const Real _m
van Genuchten exponent m
Definition: PorousFlowCapillaryPressureVG.h:37
PorousFlowCapillaryPressure::effectiveSaturationFromSaturation
Real effectiveSaturationFromSaturation(Real saturation) const
Effective saturation of liquid phase given liquid saturation and residual liquid saturation.
Definition: PorousFlowCapillaryPressure.C:114
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:120
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:39
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
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:41
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 174 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlowCapillaryPressure::d2CapillaryPressure().

175 {
176  return _pc_ext * _slope_ext * _slope_ext * _log10 * _log10 *
177  std::pow(10.0, _slope_ext * (saturation - _sat_ext));
178 }
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:120
PorousFlowCapillaryPressure::_slope_ext
Real _slope_ext
Gradient of the logarithmic extension This is computed only for qp=0.
Definition: PorousFlowCapillaryPressure.h:247
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
std::pow
MooseUnits pow(const MooseUnits &, int)

◆ 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 85 of file PorousFlowCapillaryPressureVG.C.

86 {
87  return (1.0 / _s_scale) *
88  PorousFlowVanGenuchten::d2EffectiveSaturation(pc - _pc_sscale, _alpha, _m);
89 }
PorousFlowCapillaryPressureVG::_m
const Real _m
van Genuchten exponent m
Definition: PorousFlowCapillaryPressureVG.h:37
PorousFlowCapillaryPressureVG::_alpha
const Real _alpha
van Genuchten capillary coefficient alpha
Definition: PorousFlowCapillaryPressureVG.h:39
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:41
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:43

◆ 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 156 of file PorousFlowCapillaryPressure.C.

157 {
158  return d2EffectiveSaturation(pc, qp) * (1.0 - _sat_lr);
159 }
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() [1/2]

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 84 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlowCapillaryPressure::capillaryPressure(), and PorousFlowCapillaryPressure::dCapillaryPressure().

85 {
86  if (_log_ext && saturation < _sat_ext)
87  return dCapillaryPressureLogExt(saturation);
88  else
89  return dCapillaryPressureCurve(saturation, qp);
90 }
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:120
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:168

◆ dCapillaryPressure() [2/2]

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

Definition at line 93 of file PorousFlowCapillaryPressure.C.

94 {
95  const Real dPc = dCapillaryPressure(saturation.value(), qp);
96  const Real d2Pc_ds2 = d2CapillaryPressure(saturation.value(), qp);
97 
98  ADReal result = dPc;
99  result.derivatives() = saturation.derivatives() * d2Pc_ds2;
100 
101  return result;
102 }
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:120
ADReal
DualNumber< Real, DNDerivativeType, true > ADReal
PorousFlowCapillaryPressure::d2CapillaryPressure
virtual Real d2CapillaryPressure(Real saturation, unsigned qp=0) const
Second derivative of capillary pressure wrt true saturation.
Definition: PorousFlowCapillaryPressure.C:105
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
PorousFlowCapillaryPressure::dCapillaryPressure
virtual Real dCapillaryPressure(Real saturation, unsigned qp=0) const
Derivative of capillary pressure wrt true saturation.
Definition: PorousFlowCapillaryPressure.C:84

◆ 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 55 of file PorousFlowCapillaryPressureVG.C.

56 {
57  const Real seff = effectiveSaturationFromSaturation(saturation) * _s_scale;
58  return PorousFlowVanGenuchten::dCapillaryPressure(seff, _alpha, _m, _pc_max) * _dseff_ds *
59  _s_scale;
60 }
PorousFlowCapillaryPressureVG::_m
const Real _m
van Genuchten exponent m
Definition: PorousFlowCapillaryPressureVG.h:37
PorousFlowCapillaryPressure::effectiveSaturationFromSaturation
Real effectiveSaturationFromSaturation(Real saturation) const
Effective saturation of liquid phase given liquid saturation and residual liquid saturation.
Definition: PorousFlowCapillaryPressure.C:114
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:120
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:39
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
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:41
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 168 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlowCapillaryPressure::dCapillaryPressure().

169 {
170  return _pc_ext * _slope_ext * _log10 * std::pow(10.0, _slope_ext * (saturation - _sat_ext));
171 }
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:120
PorousFlowCapillaryPressure::_slope_ext
Real _slope_ext
Gradient of the logarithmic extension This is computed only for qp=0.
Definition: PorousFlowCapillaryPressure.h:247
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
std::pow
MooseUnits pow(const MooseUnits &, int)

◆ 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 78 of file PorousFlowCapillaryPressureVG.C.

79 {
80  return (1.0 / _s_scale) *
81  PorousFlowVanGenuchten::dEffectiveSaturation(pc - _pc_sscale, _alpha, _m);
82 }
PorousFlowCapillaryPressureVG::_m
const Real _m
van Genuchten exponent m
Definition: PorousFlowCapillaryPressureVG.h:37
PorousFlowCapillaryPressureVG::_alpha
const Real _alpha
van Genuchten capillary coefficient alpha
Definition: PorousFlowCapillaryPressureVG.h:39
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:41
PorousFlowCapillaryPressureVG::_pc_sscale
const Real _pc_sscale
pc_sscale = f(s_scale), where f is the van Genuchten function
Definition: PorousFlowCapillaryPressureVG.h:43
PorousFlowVanGenuchten::dEffectiveSaturation
Real dEffectiveSaturation(Real p, Real alpha, Real m)
Derivative of effective saturation wrt porepressure.
Definition: PorousFlowVanGenuchten.C:31

◆ dSaturation() [1/2]

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 138 of file PorousFlowCapillaryPressure.C.

139 {
140  return dEffectiveSaturation(pc, qp) * (1.0 - _sat_lr);
141 }
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.

◆ dSaturation() [2/2]

ADReal PorousFlowCapillaryPressure::dSaturation ( const ADReal &  pc,
unsigned int  qp = 0 
) const
inherited

◆ 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 71 of file PorousFlowCapillaryPressureVG.C.

72 {
73  return (1.0 / _s_scale) *
74  PorousFlowVanGenuchten::effectiveSaturation(pc - _pc_sscale, _alpha, _m);
75 }
PorousFlowCapillaryPressureVG::_m
const Real _m
van Genuchten exponent m
Definition: PorousFlowCapillaryPressureVG.h:37
PorousFlowCapillaryPressureVG::_alpha
const Real _alpha
van Genuchten capillary coefficient alpha
Definition: PorousFlowCapillaryPressureVG.h:39
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:41
PorousFlowCapillaryPressureVG::_pc_sscale
const Real _pc_sscale
pc_sscale = f(s_scale), where f is the van Genuchten function
Definition: PorousFlowCapillaryPressureVG.h:43

◆ 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 114 of file PorousFlowCapillaryPressure.C.

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

115 {
116  return (saturation - _sat_lr) / (1.0 - _sat_lr);
117 }
PorousFlowCapillaryPressure::saturation
Real saturation(Real pc, unsigned qp=0) const
Saturation as a function of capillary pressure.
Definition: PorousFlowCapillaryPressure.C:120
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 181 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlowCapillaryPressure::initialSetup().

182 {
183  // Initial guess for saturation where extension matches curve
184  Real sat = _sat_lr + 0.01;
185 
186  // Calculate the saturation where the extension matches the derivative of the
187  // raw capillary pressure curve
188  const unsigned int max_its = 20;
189  const Real nr_tol = 1.0e-8;
190  unsigned int iter = 0;
191 
192  while (std::abs(interceptFunction(sat)) > nr_tol)
193  {
194  sat = sat - interceptFunction(sat) / interceptFunctionDeriv(sat);
195 
196  iter++;
197  if (iter > max_its)
198  break;
199  }
200 
201  return sat;
202 }
PorousFlowCapillaryPressure::interceptFunctionDeriv
Real interceptFunctionDeriv(Real s) const
Calculates the saturation where the logarithmic extension to capillary pressure at low saturation...
Definition: PorousFlowCapillaryPressure.C:214
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
PorousFlowCapillaryPressure::interceptFunction
Real interceptFunction(Real s) const
Calculates the saturation where the logarithmic extension to capillary pressure at low saturation...
Definition: PorousFlowCapillaryPressure.C:205
PorousFlowCapillaryPressure::_sat_lr
const Real _sat_lr
Liquid residual saturation.
Definition: PorousFlowCapillaryPressure.h:225

◆ initialize()

virtual void PorousFlowCapillaryPressure::initialize ( )
inlinefinalvirtualinherited

Reimplemented from DiscreteElementUserObject.

Definition at line 41 of file PorousFlowCapillaryPressure.h.

41 {};

◆ initialSetup()

void PorousFlowCapillaryPressure::initialSetup ( )
overridevirtualinherited

Reimplemented from DiscreteElementUserObject.

Definition at line 50 of file PorousFlowCapillaryPressure.C.

51 {
52  // If _log_ext = true, calculate the saturation where the the logarithmic
53  // extension meets the raw capillary pressure curve.
54  if (_log_ext)
55  {
56  _sat_ext = extensionSaturation();
57  _pc_ext = capillaryPressure(_sat_ext);
58  _slope_ext = (std::log10(_pc_ext) - std::log10(_pc_max)) / _sat_ext;
59  }
60 }
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:181
PorousFlowCapillaryPressure::capillaryPressure
virtual Real capillaryPressure(Real saturation, unsigned qp=0) const
Capillary pressure is calculated as a function of true saturation.
Definition: PorousFlowCapillaryPressure.C:63
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 205 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlowCapillaryPressure::extensionSaturation().

206 {
207  Real pc = capillaryPressureCurve(saturation);
208  Real dpc = dCapillaryPressureCurve(saturation);
209 
210  return std::log10(pc) - saturation * dpc / (_log10 * pc) - std::log10(_pc_max);
211 }
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:120
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
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

◆ 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 214 of file PorousFlowCapillaryPressure.C.

Referenced by PorousFlowCapillaryPressure::extensionSaturation().

215 {
216  Real pc = capillaryPressureCurve(saturation);
217  Real dpc = dCapillaryPressureCurve(saturation);
218  Real d2pc = d2CapillaryPressureCurve(saturation);
219 
220  return saturation * (dpc * dpc / pc - d2pc) / (_log10 * pc);
221 }
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:120
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.
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

◆ saturation() [1/2]

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 120 of file PorousFlowCapillaryPressure.C.

Referenced by 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().

121 {
122  return effectiveSaturation(pc, qp) * (1.0 - _sat_lr) + _sat_lr;
123 }
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

◆ saturation() [2/2]

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

Definition at line 126 of file PorousFlowCapillaryPressure.C.

127 {
128  const Real s = effectiveSaturation(pc.value(), qp) * (1.0 - _sat_lr) + _sat_lr;
129  const Real ds_dpc = dEffectiveSaturation(pc.value(), qp) * (1.0 - _sat_lr);
130 
131  ADReal result = s;
132  result.derivatives() = pc.derivatives() * ds_dpc;
133 
134  return result;
135 }
PorousFlowCapillaryPressure::effectiveSaturation
virtual Real effectiveSaturation(Real pc, unsigned qp=0) const =0
Effective saturation as a function of capillary pressure.
ADReal
DualNumber< Real, DNDerivativeType, true > ADReal
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
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.

◆ validParams()

InputParameters PorousFlowCapillaryPressureVG::validParams ( )
static

Definition at line 16 of file PorousFlowCapillaryPressureVG.C.

17 {
18  InputParameters params = PorousFlowCapillaryPressure::validParams();
19  params.addRequiredRangeCheckedParam<Real>(
20  "m",
21  "m >= 0 & m <= 1",
22  "van Genuchten exponent m. Must be between 0 and 1, and optimally should be set to >0.5");
23  params.addRequiredRangeCheckedParam<Real>(
24  "alpha", "alpha > 0", "van Genuchten parameter alpha. Must be positive");
25  params.addRangeCheckedParam<Real>("s_scale",
26  1.0,
27  "s_scale > 0.0 & s_scale <= 1.0",
28  "CapillaryPressure = f(Seff * s_scale) - "
29  "f(s_scale), where f is the van Genuchten "
30  "expression. Setting s_scale<1 is unusual "
31  "but sometimes helps fully saturated, "
32  "2-phase PP simulations converge as the "
33  "zero derivative (1/f'(S=1)=0) is removed");
34  params.addClassDescription("van Genuchten capillary pressure");
35  return params;
36 }
InputParameters::addRequiredRangeCheckedParam
void addRequiredRangeCheckedParam(const std::string &name, const std::string &parsed_function, const std::string &doc_string)
PorousFlowCapillaryPressure::validParams
static InputParameters validParams()
Definition: PorousFlowCapillaryPressure.C:13
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
InputParameters::addRangeCheckedParam
void addRangeCheckedParam(const std::string &name, const T &value, const std::string &parsed_function, const std::string &doc_string)

Member Data Documentation

◆ _alpha

const Real PorousFlowCapillaryPressureVG::_alpha
protected

van Genuchten capillary coefficient alpha

Definition at line 39 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 37 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 43 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 41 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 Fri Jul 18 2025 13:50:03 for https://mooseframework.inl.gov by   doxygen 1.8.14