PorousFlowDarcyBaseTempl< is_ad > Class Template Reference

Darcy advective flux. More...

#include <PorousFlowDarcyBase.h>

Inheritance diagram for PorousFlowDarcyBaseTempl< is_ad >:

Public Types
enum	ResidualTagType
typedef DataFileName	DataFileParameterType

Public Member Functions
	PorousFlowDarcyBaseTempl (const InputParameters &parameters)
virtual void	computeOffDiagJacobianScalar (unsigned int jvar) override
virtual const MooseVariable &	variable () const override
virtual void	computeNonlocalJacobian ()
virtual void	computeNonlocalOffDiagJacobian (unsigned int)
const SubProblem &	subProblem () const
virtual void	prepareShapes (unsigned int var_num)
virtual std::set< std::string >	additionalROVariables ()
virtual bool	enabled () const
std::shared_ptr< MooseObject >	getSharedPtr ()
std::shared_ptr< const MooseObject >	getSharedPtr () const
bool	isKokkosObject () const
MooseApp &	getMooseApp () const
const std::string &	type () const
const std::string &	name () const
std::string	typeAndName () const
MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const
MooseObjectName	uniqueName () const
const InputParameters &	parameters () const
const hit::Node *	getHitNode () const
bool	hasBase () const
const std::string &	getBase () 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 &name) const
void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
void	paramError (const std::string &param, Args... args) const
void	paramWarning (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
std::string	messagePrefix (const bool hit_prefix=true) const
std::string	errorPrefix (const std::string &) const
void	mooseError (Args &&... args) const
void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
void	mooseErrorNonPrefixed (Args &&... args) const
void	mooseWarning (Args &&... args) const
void	mooseWarning (Args &&... args) const
void	mooseWarningNonPrefixed (Args &&... args) const
void	mooseWarningNonPrefixed (Args &&... args) const
void	mooseDeprecated (Args &&... args) const
void	mooseDeprecated (Args &&... args) const
void	mooseDeprecatedNoTrace (Args &&... args) const
void	mooseInfo (Args &&... args) const
void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) 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	initialSetup ()
virtual void	residualSetup ()
virtual void	subdomainSetup ()
virtual void	customSetup (const ExecFlagType &)
const ExecFlagEnum &	getExecuteOnEnum () const
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
Moose::Kokkos::Function	getKokkosFunction (const std::string &name) const
const T &	getKokkosFunction (const std::string &name) const
Moose::Kokkos::Function	getKokkosFunctionByName (const FunctionName &name) const
const T &	getKokkosFunctionByName (const FunctionName &name) const
bool	hasKokkosFunction (const std::string &param_name) const
bool	hasKokkosFunctionByName (const FunctionName &name) 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 UserObjectBase &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
const UserObjectBase &	getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
bool	isImplicit ()
Moose::StateArg	determineState () 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
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 void	meshChanged ()
void	useVectorTag (const TagName &tag_name, VectorTagsKey)
void	useVectorTag (TagID tag_id, VectorTagsKey)
void	useMatrixTag (const TagName &tag_name, MatrixTagsKey)
void	useMatrixTag (TagID tag_id, MatrixTagsKey)
bool	isVectorTagged ()
bool	isMatrixTagged ()
bool	hasVectorTags () const
const std::set< TagID > &	getVectorTags (VectorTagsKey) const
const std::set< TagID > &	getMatrixTags (MatrixTagsKey) 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 MooseVariableBase &variable) const
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
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagValuesByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::VariableGradient	kokkosCoupledVectorTagGradientByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::VariableGradient	kokkosCoupledVectorTagGradientsByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagNodalValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagNodalValuesByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagDofValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagDofValuesByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagValues (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::VariableGradient	kokkosCoupledVectorTagGradient (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::VariableGradient	kokkosCoupledVectorTagGradients (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagNodalValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagNodalValues (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagDofValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagDofValues (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorValuesByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorTagVectorGradientByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorTagVectorGradientsByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorNodalValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorNodalValuesByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorDofValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorDofValuesByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorValues (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorTagVectorGradient (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorTagVectorGradients (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorNodalValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorNodalValues (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorDofValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorTagVectorDofValues (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::VariableValue	kokkosCoupledValue (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledValues (const std::string &var_name) const
Moose::Kokkos::VariableGradient	kokkosCoupledGradient (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableGradient	kokkosCoupledGradients (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledNodalValue (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledNodalValues (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledDofValue (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledDofValues (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledValueOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledValuesOld (const std::string &var_name) const
Moose::Kokkos::VariableGradient	kokkosCoupledGradientOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableGradient	kokkosCoupledGradientsOld (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledNodalValueOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledNodalValuesOld (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledDofValueOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledDofValuesOld (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledValueOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledValuesOlder (const std::string &var_name) const
Moose::Kokkos::VariableGradient	kokkosCoupledGradientOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableGradient	kokkosCoupledGradientsOlder (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledNodalValueOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledNodalValuesOlder (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledDofValueOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledDofValuesOlder (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledDot (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledDots (const std::string &var_name) const
Moose::Kokkos::VariableValue	kokkosCoupledNodalDot (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledNodalDots (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorValue (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorNodalValue (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorDofValue (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorValues (const std::string &var_name) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorGradients (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorNodalValues (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorDofValues (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorValueOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorGradientOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorNodalValueOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorDofValueOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorValuesOld (const std::string &var_name) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorGradientsOld (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorNodalValuesOld (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorDofValuesOld (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorValueOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorGradientOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorNodalValueOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorDofValueOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorValuesOlder (const std::string &var_name) const
Moose::Kokkos::VectorVariableGradient	kokkosCoupledVectorGradientsOlder (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorNodalValuesOlder (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorDofValuesOlder (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorDot (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorNodalDot (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorDots (const std::string &var_name) const
Moose::Kokkos::VectorVariableValue	kokkosCoupledVectorNodalDots (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagValuesByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledVectorTagGradientByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledVectorTagGradientsByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagNodalValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagNodalValuesByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagDofValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagDofValuesByName (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagValues (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledVectorTagGradient (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledVectorTagGradients (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagNodalValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagNodalValues (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagDofValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledVectorTagDofValues (const std::string &var_name, const std::string &tag_param_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledValue (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledValues (const std::string &var_name) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledGradient (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledGradients (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledNodalValue (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledNodalValues (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledDofValue (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledDofValues (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledValueOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledValuesOld (const std::string &var_name) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledGradientOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledGradientsOld (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledNodalValueOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledNodalValuesOld (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledDofValueOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledDofValuesOld (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledValueOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledValuesOlder (const std::string &var_name) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledGradientOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableGradient	kokkosADCoupledGradientsOlder (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledNodalValueOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledNodalValuesOlder (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledDofValueOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledDofValuesOlder (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledDot (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledDots (const std::string &var_name) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledNodalDot (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::ADVariableValue	kokkosADCoupledNodalDots (const std::string &var_name) const
Moose::Kokkos::Scalar< const Real >	kokkosCoupledDotDu (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosZeroValue () const
Moose::Kokkos::VariableGradient	kokkosZeroGradient () const
Moose::Kokkos::VariableValue	kokkosZeroNodalValue () 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={})
virtual std::set< MooseVariableFieldBase * >	checkVariables (const libMesh::Node &node, const std::set< MooseVariableFieldBase * > &vars_to_check)
std::set< MooseVariableFieldBase * >	checkVariables (const libMesh::Elem &element, const std::set< MooseVariableFieldBase * > &vars_to_check)
void	addMooseVariableDependency (MooseVariableFieldBase *var)
void	addMooseVariableDependency (const std::vector< MooseVariableFieldBase * > &vars)
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)
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyByName (const std::string &prop_name_in)
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOldByName (const std::string &prop_name)
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOlderByName (const std::string &prop_name)
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialProperty (const std::string &name)
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOld (const std::string &name)
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOlder (const std::string &name)
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > >	getBlockMaterialProperty (const MaterialPropertyName &name)
std::pair< Moose::Kokkos::MaterialProperty< T, dimension >, std::set< SubdomainID > >	getKokkosBlockMaterialProperty (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)
virtual 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 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
MooseVariableBase *	mooseVariableBase () const
MooseVariableField< Real > &	mooseVariableField ()
MooseVariableFE< Real > *	mooseVariable () const
MooseVariableFV< Real > *	mooseVariableFV () const
MooseLinearVariableFV< Real > *	mooseLinearVariableFV () 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	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 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 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	hasKokkosMaterialProperty (const std::string &name)
bool	hasKokkosMaterialProperty (const std::string &name)
bool	hasKokkosMaterialPropertyByName (const std::string &name)
bool	hasKokkosMaterialPropertyByName (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)
PenetrationLocator &	getPenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
PenetrationLocator &	getQuadraturePenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
NearestNodeLocator &	getNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
NearestNodeLocator &	getQuadratureNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
bool	requiresGeometricSearch () 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	callMooseError (MooseApp *const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node *node, const bool show_trace=true)

Public Attributes
	usingCombinedWarningSolutionWarnings
const ConsoleStream	_console

Static Public Attributes
static const std::string	type_param
static const std::string	name_param
static const std::string	unique_name_param
static const std::string	app_param
static const std::string	moose_base_param
static const std::string	kokkos_object_param
static constexpr PropertyValue::id_type	default_property_id
static constexpr PropertyValue::id_type	zero_property_id

Protected Types
enum class	JacRes { CALCULATE_RESIDUAL = 0 , CALCULATE_JACOBIAN = 1 }
enum class	FallbackEnum { QUICK , HARMONIC }
	If full upwinding is failing due to nodes swapping between upwind and downwind in successive nonlinear iterations (within one timestep and element) a fallback scheme is used instead. More...

Protected Member Functions
virtual void	timestepSetup () override
virtual void	jacobianSetup () override
virtual GenericReal< is_ad >	computeQpResidual () override
virtual void	computeResidual () override
virtual void	computeJacobian () override
virtual void	computeOffDiagJacobian (unsigned int jvar) override
virtual GenericReal< is_ad >	darcyQp (unsigned int ph) const
	The Darcy part of the flux (this is the non-upwinded part)
virtual Real	darcyQpJacobian (unsigned int jvar, unsigned int ph) const
	Jacobian of the Darcy part of the flux – non-AD path only.
virtual GenericReal< is_ad >	mobility (unsigned nodenum, unsigned phase) const
	The mobility of the fluid.
virtual Real	dmobility (unsigned nodenum, unsigned phase, unsigned pvar) const
	The derivative of mobility with respect to PorousFlow variable pvar – non-AD path only.
void	computeResidualAndJacobian (JacRes res_or_jac, unsigned int jvar)
	Computation of the residual and Jacobian (non-AD path only).
void	fullyUpwind (JacRes res_or_jac, unsigned int ph, unsigned int pvar)
	Calculate the residual or Jacobian using full upwinding.
void	quickUpwind (JacRes res_or_jac, unsigned int ph, unsigned int pvar)
	Calculate the residual or Jacobian using the nodal mobilities, but without conserving fluid mass.
void	harmonicMean (JacRes res_or_jac, unsigned int ph, unsigned int pvar)
	Calculate the residual or Jacobian by using the harmonic mean of the nodal mobilities for the entire element.
virtual void	computeResidualAndJacobian ()
virtual Real	computeQpJacobian ()
virtual Real	computeQpOffDiagJacobian (unsigned int)
virtual Real	computeQpOffDiagJacobianScalar (unsigned int)
virtual RealEigenVector	computeQpOffDiagJacobianArray (const ArrayMooseVariable &jvar)
virtual void	precalculateResidual ()
virtual void	precalculateJacobian ()
virtual void	precalculateOffDiagJacobian (unsigned int)
const MooseVariableFieldBase &	getVariable (unsigned int jvar_num) const
void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const
virtual void	addUserObjectDependencyHelper (const UserObjectBase &) const
virtual void	addPostprocessorDependencyHelper (const PostprocessorName &) const
virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) 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
void	prepareVectorTag (Assembly &assembly, unsigned int ivar)
void	prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
void	prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
void	prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
void	prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
void	prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
void	prepareVectorTagNeighbor (Assembly &assembly, unsigned int ivar)
void	prepareVectorTagLower (Assembly &assembly, unsigned int ivar)
void	prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar)
void	prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar, DenseMatrix< Number > &k) const
void	prepareMatrixTagNonlocal (Assembly &assembly, unsigned int ivar, unsigned int jvar)
void	prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type)
void	prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, DenseMatrix< Number > &k) const
void	prepareMatrixTagLower (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::ConstraintJacobianType type)
void	accumulateTaggedLocalResidual ()
void	assignTaggedLocalResidual ()
void	accumulateTaggedLocalMatrix ()
void	accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, const DenseMatrix< Number > &k)
void	accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, const DenseMatrix< Number > &k)
void	accumulateTaggedNonlocalMatrix ()
void	assignTaggedLocalMatrix ()
void	addResiduals (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
void	addResiduals (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, const std::vector< Real > &scaling_factors)
void	addResiduals (Assembly &assembly, const DenseVector< T > &residuals, const Indices &dof_indices, Real scaling_factor)
void	addResiduals (Assembly &assembly, const ADResidualsPacket &packet)
void	addResidualsAndJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
void	addResidualsAndJacobian (Assembly &assembly, const ADResidualsPacket &packet)
void	addJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
void	addJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, const std::vector< Real > &scaling_factors)
void	addJacobian (Assembly &assembly, const ADResidualsPacket &packet)
void	addJacobian (Assembly &assembly, const DenseMatrix< Real > &local_k, const std::vector< dof_id_type > &row_indices, const std::vector< dof_id_type > &column_indices, Real scaling_factor)
void	addResidualsWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
void	addResidualsAndJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
void	addJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
void	addJacobianElement (Assembly &assembly, Real value, dof_id_type row_index, dof_id_type column_index, Real scaling_factor)
void	setResidual (SystemBase &sys, const T &residual, MooseVariableFE< T > &var)
void	setResidual (SystemBase &sys, Real residual, dof_id_type dof_index)
void	setResidual (SystemBase &sys, SetResidualFunctor set_residual_functor)
virtual bool	hasBlockMaterialPropertyHelper (const std::string &prop_name)
void	initializeBlockRestrictable (const MooseObject *moose_object)
void	initializeKokkosBlockRestrictable ()
Moose::CoordinateSystemType	getBlockCoordSystem ()
KOKKOS_FUNCTION dof_id_type	numKokkosBlockElements () const
KOKKOS_FUNCTION dof_id_type	numKokkosBlockNodes () const
KOKKOS_FUNCTION dof_id_type	numKokkosBlockSides () const
KOKKOS_FUNCTION ContiguousElementID	kokkosBlockElementID (Moose::Kokkos::ThreadID tid) const
KOKKOS_FUNCTION ContiguousElementID	kokkosBlockNodeID (Moose::Kokkos::ThreadID tid) const
KOKKOS_FUNCTION auto	kokkosBlockElementSideID (Moose::Kokkos::ThreadID tid) const
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)
std::vector< const MooseVariableFieldBase * >	getFieldVars (const std::string &var_name) const
const T *	getVarHelper (const std::string &var_name, unsigned int comp) const
T *	getVarHelper (const std::string &var_name, unsigned int comp)
std::vector< const T * >	getVarsHelper (const std::string &var_name) const
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, const std::string &tag_param_name, unsigned int comp=0) const
const VariableValue &	coupledMatrixTagScalarValue (const std::string &var_name, const std::string &tag_param_name, 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
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagScalarValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledVectorTagScalarValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::VariableValue	kokkosCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
Moose::Kokkos::Scalar< const Real >	kokkosCoupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const
const MooseVariableScalar *	getScalarVar (const std::string &var_name, unsigned int comp) const
virtual void	checkMaterialProperty (const std::string &name, const unsigned int state)
virtual void	getKokkosMaterialPropertyHook (const std::string &, const unsigned int)
void	markMatPropRequested (const std::string &)
MaterialPropertyName	getMaterialPropertyName (const std::string &name) const
void	checkExecutionStage ()
virtual const OutputTools< Real >::VariableValue &	value ()
virtual const OutputTools< Real >::VariableValue &	valueOld ()
virtual const OutputTools< Real >::VariableValue &	valueOlder ()
virtual const OutputTools< Real >::VariableValue &	dot ()
virtual const OutputTools< Real >::VariableValue &	dotDot ()
virtual const OutputTools< Real >::VariableValue &	dotOld ()
virtual const OutputTools< Real >::VariableValue &	dotDotOld ()
virtual const VariableValue &	dotDu ()
virtual const VariableValue &	dotDotDu ()
virtual const OutputTools< Real >::VariableGradient &	gradient ()
virtual const OutputTools< Real >::VariableGradient &	gradientOld ()
virtual const OutputTools< Real >::VariableGradient &	gradientOlder ()
virtual const OutputTools< Real >::VariableSecond &	second ()
virtual const OutputTools< Real >::VariableSecond &	secondOld ()
virtual const OutputTools< Real >::VariableSecond &	secondOlder ()
virtual const OutputTools< Real >::VariableTestSecond &	secondTest ()
virtual const OutputTools< Real >::VariableTestSecond &	secondTestFace ()
virtual const OutputTools< Real >::VariablePhiSecond &	secondPhi ()
virtual const OutputTools< Real >::VariablePhiSecond &	secondPhiFace ()
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)

Protected Attributes
const GenericMaterialProperty< RealTensorValue, is_ad > &	_permeability
	Permeability of porous material.
const MaterialProperty< std::vector< RealTensorValue > > *const	_dpermeability_dvar
	d(permeabiity)/d(PorousFlow variable) – null for AD path
const MaterialProperty< std::vector< std::vector< RealTensorValue > > > *const	_dpermeability_dgradvar
	d(permeabiity)/d(grad(PorousFlow variable)) – null for AD path
const GenericMaterialProperty< std::vector< Real >, is_ad > &	_fluid_density_node
	Fluid density for each phase (at the node)
const MaterialProperty< std::vector< std::vector< Real > > > *const	_dfluid_density_node_dvar
	Derivative of the fluid density for each phase wrt PorousFlow variables (at the node) – null for AD path.
const GenericMaterialProperty< std::vector< Real >, is_ad > &	_fluid_density_qp
	Fluid density for each phase (at the qp)
const MaterialProperty< std::vector< std::vector< Real > > > *const	_dfluid_density_qp_dvar
	Derivative of the fluid density for each phase wrt PorousFlow variables (at the qp) – null for AD path.
const GenericMaterialProperty< std::vector< Real >, is_ad > &	_fluid_viscosity
	Viscosity of each component in each phase.
const MaterialProperty< std::vector< std::vector< Real > > > *const	_dfluid_viscosity_dvar
	Derivative of the fluid viscosity for each phase wrt PorousFlow variables – null for AD path.
const GenericMaterialProperty< std::vector< Real >, is_ad > &	_pp
	Nodal pore pressure in each phase.
const GenericMaterialProperty< std::vector< RealGradient >, is_ad > &	_grad_p
	Gradient of the pore pressure in each phase.
const MaterialProperty< std::vector< std::vector< Real > > > *const	_dgrad_p_dgrad_var
	Derivative of Grad porepressure in each phase wrt grad(PorousFlow variables) – null for AD path.
const MaterialProperty< std::vector< std::vector< RealGradient > > > *const	_dgrad_p_dvar
	Derivative of Grad porepressure in each phase wrt PorousFlow variables – null for AD path.
const PorousFlowDictator &	_dictator
	PorousFlowDictator UserObject.
const unsigned int	_num_phases
	The number of fluid phases.
const RealVectorValue	_gravity
	Gravity. Defaults to 9.81 m/s^2.
const bool	_perm_derivs
	Flag to check whether permeabiity derivatives are non-zero.
const unsigned	_full_upwind_threshold
	If the number of upwind-downwind swaps is less than this amount then full upwinding is used.
enum PorousFlowDarcyBaseTempl::FallbackEnum	_fallback_scheme
std::vector< std::vector< GenericReal< is_ad > > >	_proto_flux
	The Darcy flux.
std::vector< std::vector< std::vector< Real > > >	_jacobian
	Derivative of _proto_flux with respect to nodal variables.
std::unordered_map< unsigned, std::vector< std::vector< unsigned > > >	_num_upwinds
	Number of nonlinear iterations (in this timestep and this element) that a node is an upwind node for a given fluid phase.
std::unordered_map< unsigned, std::vector< std::vector< unsigned > > >	_num_downwinds
	Number of nonlinear iterations (in this timestep and this element) that a node is an downwind node for a given fluid phase.
	usingGenericKernelMembers
MooseVariable &	_var
const VariableTestValue &	_test
const VariableTestGradient &	_grad_test
const VariablePhiValue &	_phi
const VariablePhiGradient &	_grad_phi
const VariableValue &	_u
const VariableGradient &	_grad_u
const Elem *const &	_current_elem
const Real &	_current_elem_volume
unsigned int	_qp
const MooseArray< Point > &	_q_point
const QBase *const &	_qrule
const MooseArray< Real > &	_JxW
const MooseArray< Real > &	_coord
unsigned int	_i
unsigned int	_j
bool	_has_save_in
std::vector< MooseVariableFEBase * >	_save_in
std::vector< AuxVariableName >	_save_in_strings
bool	_has_diag_save_in
std::vector< MooseVariableFEBase * >	_diag_save_in
std::vector< AuxVariableName >	_diag_save_in_strings
std::vector< unsigned int >	_displacements
const bool	_use_displaced_mesh
SubProblem &	_subproblem
FEProblemBase &	_fe_problem
SystemBase &	_sys
THREAD_ID	_tid
Assembly &	_assembly
MooseMesh &	_mesh
const bool &	_enabled
MooseApp &	_app
Factory &	_factory
ActionFactory &	_action_factory
const std::string &	_type
const std::string &	_name
const InputParameters &	_pars
const ExecFlagEnum &	_execute_enum
const ExecFlagType &	_current_execute_flag
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
MooseApp &	_restartable_app
const std::string	_restartable_system_name
const THREAD_ID	_restartable_tid
const bool	_restartable_read_only
FEProblemBase &	_mci_feproblem
DenseVector< Number >	_local_re
DenseMatrix< Number >	_local_ke
DenseMatrix< Number >	_nonlocal_ke
const MaterialData *	_blk_material_data
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< MooseVariableField< Real > * >	_coupled_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 &	_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 bool	_is_kokkos_object
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
GeometricSearchData &	_geometric_search_data
bool	_requires_geometric_search
bool	_nodal
MooseVariableFE< Real > *	_variable
MooseVariableFV< Real > *	_fv_variable
MooseLinearVariableFV< Real > *	_linear_fv_variable
MooseVariableField< Real > *	_field_variable
Assembly *	_mvi_assembly
const Parallel::Communicator &	_communicator

Static Protected Attributes
static const std::string	_interpolated_old
static const std::string	_interpolated_older

Private Types
enum	FuncAge
enum	VarType

Private Member Functions
void	computeProtoFluxWithoutMobility ()
	Build proto fluxes (without mobility weighting) for all phases and nodes.
void	initializeUpwindTracking (unsigned elem, unsigned int num_nodes)
	Ensure per-element upwind/downwind counters are allocated for this element.
void	updateUpwindCounts (unsigned elem, unsigned int num_nodes)
	Update upwind/downwind counters from the sign of _proto_flux.
std::vector< unsigned >	computeMaxSwaps (unsigned elem, unsigned int num_nodes) const
	Compute per-phase maximum upwind/downwind swap counts for this element.
void	applyUpwinding (const std::vector< unsigned > &max_swaps, JacRes res_or_jac, unsigned int pvar)
	Apply selected upwinding/fallback scheme for all phases.
void	adComputeProtoFlux (bool do_counting)
	For the AD path: fills _proto_flux (per-phase, per-node ADReal) by integrating darcyQp and applying the upwinding scheme with GenericReal<is_ad> mobility.
void	adComputeJacobian ()
	For the AD path: performs the proto-flux/upwinding pass and hands the per-node ADReal residuals to addJacobianWithoutConstraints, which extracts every Jacobian block (diagonal and off-diagonal) from the ADReal derivatives in a single pass.
void	assembleProtoFluxResidual ()
	Assemble the real-valued residual vector from _proto_flux into the tagged local residual (and apply save_in).
const Moose::FunctionBase *	getKokkosFunctionByNameHelper (const FunctionName &name) const
const UserObjectBase &	getUserObjectFromFEProblem (const UserObjectName &object_name, const THREAD_ID tid=0) const
const T &	castUserObject (const UserObjectBase &uo_base, const std::string &param_name="") const
void	mooseObjectError (const std::string &param_name, std::stringstream &oss) const
const std::string &	userObjectType (const UserObjectBase &uo) const
const std::string &	userObjectName (const UserObjectBase &uo) const
const PostprocessorName &	getPostprocessorNameInternal (const std::string &param_name, const unsigned int index, const bool allow_default_value=true) const
bool	isDefaultPostprocessorValueByName (const PostprocessorName &name) const
PostprocessorValue	getDefaultPostprocessorValueByName (const PostprocessorName &name) const
void	checkParam (const std::string &param_name, const unsigned int index=std::numeric_limits< unsigned int >::max()) const
bool	postprocessorsAdded () const
const VectorPostprocessorValue &	getVectorPostprocessorByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name, bool broadcast, std::size_t t_index) const
const VectorPostprocessorContext< VectorPostprocessorValue > &	getVectorPostprocessorContextByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name) const
bool	vectorPostprocessorsAdded () const
RestartableDataValue &	registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const
void	registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)
RestartableData< T > &	declareRestartableDataHelper (const std::string &data_name, void *context, Args &&... args) const
void	prepareVectorTagInternal (Assembly &assembly, unsigned int ivar, const std::set< TagID > &vector_tags, const std::set< TagID > &absolute_value_vector_tags)
void	checkForNans () const
const OutputTools< T >::VariableValue &	vectorTagValueHelper (const std::string &var_names, TagID tag, unsigned int index=0) const
const OutputTools< T >::VariableValue &	vectorTagValueHelper (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
const OutputTools< T >::VariableValue &	vectorTagDofValueHelper (const std::string &var_name, TagID tag, unsigned int comp=0) const
const OutputTools< T >::VariableValue &	vectorTagDofValueHelper (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
void	requestStates (const std::string &var_name, const TagName &tag_name, const unsigned int comp)
void	checkFuncType (const std::string var_name, VarType t, FuncAge age) const
const VariableValue *	getDefaultValue (const std::string &var_name, unsigned int comp) const
const VectorVariableValue *	getDefaultVectorValue (const std::string &var_name) const
const ArrayVariableValue *	getDefaultArrayValue (const std::string &var_name) const
const T &	getDefaultNodalValue (const std::string &var_name, unsigned int comp=0) const
const RealVectorValue &	getDefaultNodalValue (const std::string &var_name, unsigned int) const
const RealEigenVector &	getDefaultNodalValue (const std::string &var_name, unsigned int) const
const Moose::Functor< T > &	getDefaultFunctor (const std::string &var_name) const
Moose::Kokkos::Variable	kokkosCoupledVectorTagVariable (const std::string &var_name, const std::string &tag_name, unsigned int comp) const
Moose::Kokkos::Variable	kokkosCoupledVectorTagVariables (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::Variable	kokkosCoupledVectorTagVectorVariable (const std::string &var_name, const std::string &tag_name, unsigned int comp) const
Moose::Kokkos::Variable	kokkosCoupledVectorTagVectorVariables (const std::string &var_name, const std::string &tag_name) const
Moose::Kokkos::Variable	kokkosZeroVariable () const
Moose::Kokkos::Variable	kokkosCoupledVectorTagScalarVariable (const std::string &var_name, const std::string &tag_name, unsigned int comp) const
std::set< MooseVariableFieldBase * >	checkVariablesHelper (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_check)
Moose::MaterialDataType	getMaterialDataType (const std::set< BoundaryID > &boundary_ids) const
unsigned int	getMaxQps () const
void	addConsumedPropertyName (const MooseObjectName &obj_name, const std::string &prop_name)
const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const
const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const
void	possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
void	possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
void	possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
void	possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)
static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
const Elem *	_my_elem_darcy = nullptr
	Element pointer cached on the first AD computeOffDiagJacobian() call for an element so that the remaining off-diagonal calls (one per coupled variable) become no-ops; the single AD pass already filled all blocks.
const ParallelParamObject &	_parent
const MooseBase &	_si_moose_base
const FEProblemBase *	_si_problem
ExecFlagEnum	_empty_execute_enum
const MooseObject &	_fni_object
const InputParameters &	_fni_params
FEProblemBase &	_fni_feproblem
const THREAD_ID	_fni_tid
const MooseObject &	_uoi_moose_object
const FEProblemBase &	_uoi_feproblem
const THREAD_ID	_uoi_tid
const std::string	_ti_name
const MooseObject &	_ppi_moose_object
const InputParameters &	_ppi_params
const FEProblemBase &	_ppi_feproblem
std::map< PostprocessorName, std::unique_ptr< PostprocessorValue > >	_default_values
const bool	_broadcast_by_default
const MooseObject &	_vpi_moose_object
const FEProblemBase &	_vpi_feproblem
const THREAD_ID	_vpi_tid
RandomData *	_random_data
MooseRandom *	_generator
FEProblemBase &	_ri_problem
const std::string	_ri_name
unsigned int	_master_seed
bool	_is_nodal
ExecFlagType	_reset_on
const Node *const &	_curr_node
const Elem *const &	_curr_element
const RestartableDataMapName	_metaname
std::string	_restartable_name
std::set< TagID >	_vector_tags
std::set< TagID >	_abs_vector_tags
std::set< TagID >	_matrix_tags
std::set< TagID >	_non_ref_vector_tags
std::set< TagID >	_non_ref_abs_vector_tags
std::set< TagID >	_ref_vector_tags
std::set< TagID >	_ref_abs_vector_tags
const MooseObject &	_moose_object
const InputParameters &	_tag_params
std::vector< DenseVector< Number > * >	_re_blocks
std::vector< DenseVector< Number > * >	_absre_blocks
std::vector< DenseMatrix< Number > * >	_ke_blocks
std::vector< Real >	_absolute_residuals
std::set< SubdomainID >	_blk_ids
std::vector< SubdomainID >	_vec_ids
std::vector< SubdomainName >	_blocks
const bool	_blk_dual_restrictable
FEProblemBase *	_blk_feproblem
const MooseMesh *	_blk_mesh
const std::set< BoundaryID >	_empty_boundary_ids
const std::set< BoundaryID > &	_boundary_ids
THREAD_ID	_blk_tid
const std::string &	_blk_name
unsigned int	_blk_dim
Moose::Kokkos::Array< ContiguousElementID >	_kokkos_element_ids
Moose::Kokkos::Array< ContiguousNodeID >	_kokkos_node_ids
Moose::Kokkos::Array< Moose::Kokkos::Pair< ContiguousElementID, unsigned int > >	_kokkos_element_side_ids
unsigned int	_coupleable_max_qps
std::unordered_map< std::string, std::vector< unsigned int > >	_optional_var_index
std::unordered_map< std::string, std::vector< MooseVariableScalar * > >	_c_coupled_scalar_vars
std::set< TagID >	_fe_coupleable_vector_tags
std::set< TagID >	_fe_coupleable_matrix_tags
const bool	_is_fv
const MooseObject *const	_obj
const std::set< std::string >	_older_state_tags
std::vector< std::set< MooseWritableVariable * > >	_writable_coupled_variables
const Real	_kokkos_default_value_zero
const InputParameters &	_sc_parameters
const std::string &	_sc_name
const bool	_sc_is_implicit
std::unordered_map< std::string, std::vector< MooseVariableScalar * > >	_coupled_scalar_vars
std::unordered_map< std::string, std::unique_ptr< ADVariableValue > >	_dual_default_value
std::vector< MooseVariableScalar * >	_coupled_moose_scalar_vars
std::unordered_map< std::string, std::vector< MooseVariableFieldBase * > >	_sc_coupled_vars
std::set< TagID >	_sc_coupleable_vector_tags
std::set< TagID >	_sc_coupleable_matrix_tags
std::set< MooseVariableFieldBase * >	_moose_variable_dependencies
std::vector< libMesh::dof_id_type >	_dof_indices
const MooseObject &	_mi_moose_object
const bool	_mi_boundary_restricted
const std::set< SubdomainID > &	_mi_block_ids
const std::set< BoundaryID > &	_mi_boundary_ids
std::vector< std::unique_ptr< OptionalMaterialPropertyProxyBase< MaterialPropertyInterface > > >	_optional_property_proxies
const InputParameters &	_obj_parameters
std::shared_ptr< MooseMesh > &	_id_mesh
const std::string &	_ei_name

Detailed Description

template<bool is_ad>
class PorousFlowDarcyBaseTempl< is_ad >

Darcy advective flux.

A fully-updwinded version is implemented, where the mobility of the upstream nodes is used. Alternately, after some number of upwind-downwind swaps, another type of handling of the mobility may be employed (see fallback_scheme, below)

Templated on is_ad: the false instantiation uses hand-coded Jacobians; the true instantiation propagates derivatives through AD material properties.

Definition at line 27 of file PorousFlowDarcyBase.h.

Member Enumeration Documentation

FallbackEnum

template<bool is_ad>

enum class PorousFlowDarcyBaseTempl::FallbackEnum

strongprotected

If full upwinding is failing due to nodes swapping between upwind and downwind in successive nonlinear iterations (within one timestep and element) a fallback scheme is used instead.

QUICK: use the nodal mobilities, as in full upwinding, but do not attempt to conserve fluid mass. HARMONIC: assign the harmonic mean of the mobilities to the entire element.

Enumerator
QUICK
HARMONIC

Definition at line 155 of file PorousFlowDarcyBase.h.

{ QUICK, HARMONIC } _fallback_scheme;

JacRes

template<bool is_ad>

enum class PorousFlowDarcyBaseTempl::JacRes

strongprotected

Enumerator
CALCULATE_RESIDUAL
CALCULATE_JACOBIAN

Definition at line 64 of file PorousFlowDarcyBase.h.

  {
    CALCULATE_RESIDUAL = 0,
    CALCULATE_JACOBIAN = 1
  };

Constructor & Destructor Documentation

PorousFlowDarcyBaseTempl()

template<bool is_ad>

PorousFlowDarcyBaseTempl< is_ad >::PorousFlowDarcyBaseTempl

(

const InputParameters &

parameters

)

Definition at line 46 of file PorousFlowDarcyBase.C.

  : GenericKernel<is_ad>(parameters),
    _permeability(this->template getGenericMaterialProperty<RealTensorValue, is_ad>(
        "PorousFlow_permeability_qp")),
    _dpermeability_dvar(is_ad ? nullptr
                              : &this->template getMaterialProperty<std::vector<RealTensorValue>>(
                                    "dPorousFlow_permeability_qp_dvar")),
    _dpermeability_dgradvar(
        is_ad ? nullptr
              : &this->template getMaterialProperty<std::vector<std::vector<RealTensorValue>>>(
                    "dPorousFlow_permeability_qp_dgradvar")),
    _fluid_density_node(this->template getGenericMaterialProperty<std::vector<Real>, is_ad>(
        "PorousFlow_fluid_phase_density_nodal")),
    _dfluid_density_node_dvar(
        is_ad ? nullptr
              : &this->template getMaterialProperty<std::vector<std::vector<Real>>>(
                    "dPorousFlow_fluid_phase_density_nodal_dvar")),
    _fluid_density_qp(this->template getGenericMaterialProperty<std::vector<Real>, is_ad>(
        "PorousFlow_fluid_phase_density_qp")),
    _dfluid_density_qp_dvar(
        is_ad ? nullptr
              : &this->template getMaterialProperty<std::vector<std::vector<Real>>>(
                    "dPorousFlow_fluid_phase_density_qp_dvar")),
    _fluid_viscosity(this->template getGenericMaterialProperty<std::vector<Real>, is_ad>(
        "PorousFlow_viscosity_nodal")),
    _dfluid_viscosity_dvar(
        is_ad ? nullptr
              : &this->template getMaterialProperty<std::vector<std::vector<Real>>>(
                    "dPorousFlow_viscosity_nodal_dvar")),
    _pp(this->template getGenericMaterialProperty<std::vector<Real>, is_ad>(
        "PorousFlow_porepressure_nodal")),
    _grad_p(this->template getGenericMaterialProperty<std::vector<RealGradient>, is_ad>(
        "PorousFlow_grad_porepressure_qp")),
    _dgrad_p_dgrad_var(is_ad ? nullptr
                             : &this->template getMaterialProperty<std::vector<std::vector<Real>>>(
                                   "dPorousFlow_grad_porepressure_qp_dgradvar")),
    _dgrad_p_dvar(is_ad
                      ? nullptr
                      : &this->template getMaterialProperty<std::vector<std::vector<RealGradient>>>(
                            "dPorousFlow_grad_porepressure_qp_dvar")),
    _dictator(this->template getUserObject<PorousFlowDictator>("PorousFlowDictator")),
    _num_phases(_dictator.numPhases()),
    _gravity(this->template getParam<RealVectorValue>("gravity")),
    _perm_derivs(_dictator.usePermDerivs()),
    _full_upwind_threshold(this->template getParam<unsigned>("full_upwind_threshold")),
    _fallback_scheme(
        this->template getParam<MooseEnum>("fallback_scheme").template getEnum<FallbackEnum>()),
    _proto_flux(_num_phases),
    _jacobian(_num_phases),
    _num_upwinds(),
    _num_downwinds()
{
  // The full-upwinding scheme identifies each element test function with a mesh node, which is
  // only valid for nodal (Lagrange) variables.
  if (!_var.isNodal())
    mooseError("The variable '",
               _var.name(),
               "' is not a nodal (Lagrange) variable.  This kernel uses full upwinding, which "
               "requires a nodal variable.  PorousFlow has no discontinuous-Galerkin "
               "finite-element discretisation, so an element-local variable (eg CONSTANT "
               "MONOMIAL) cannot be used as a PorousFlow variable.");
 
#ifdef LIBMESH_HAVE_TBB_API
  if (libMesh::n_threads() > 1)
    mooseWarning("PorousFlowDarcyBase: num_upwinds and num_downwinds may not be computed "
                 "accurately when using TBB and greater than 1 thread");
#endif
}

Member Function Documentation

adComputeJacobian()

template<bool is_ad>

void PorousFlowDarcyBaseTempl< is_ad >::adComputeJacobian ( )

private

For the AD path: performs the proto-flux/upwinding pass and hands the per-node ADReal residuals to addJacobianWithoutConstraints, which extracts every Jacobian block (diagonal and off-diagonal) from the ADReal derivatives in a single pass.

Definition at line 224 of file PorousFlowDarcyBase.C.

{
  if constexpr (is_ad)
  {
    // Compute ADReal proto fluxes with upwind counting, then extract the Jacobian.
    // Every block (diagonal and off-diagonal) is encoded in the ADReal derivatives, so a
    // single call to addJacobianWithoutConstraints captures all variable sensitivities.
    //
    // See PorousFlowLumpedKernelBase.C::computeJacobian for the detailed rationale of why
    // addJacobianWithoutConstraints (rather than the default ADKernel addJacobian) is required:
    // each residual row's column set must be read from its own derivatives instead of being shared
    // from row 0. There it is forced by mass-lumped nodal materials; here it is forced by the
    // upwinding scheme, which makes each node's proto flux depend on a different set of nodal DOFs.
    adComputeProtoFlux(true);
 
    const unsigned int num_nodes = _test.size();
    std::vector<ADReal> darcy_residuals(num_nodes, 0.0);
    for (const auto n : make_range(num_nodes))
      for (const auto ph : make_range(_num_phases))
        darcy_residuals[n] += _proto_flux[ph][n];
 
    this->addJacobianWithoutConstraints(
        this->_assembly, darcy_residuals, this->dofIndices(), _var.scalingFactor());
  }
}

adComputeProtoFlux()

template<bool is_ad>

void PorousFlowDarcyBaseTempl< is_ad >::adComputeProtoFlux ( bool  do_counting )

private

For the AD path: fills _proto_flux (per-phase, per-node ADReal) by integrating darcyQp and applying the upwinding scheme with GenericReal<is_ad> mobility.

Also optionally records upwind/downwind counts for the fallback-scheme heuristic.

Parameters

do_counting

whether to update _num_upwinds/_num_downwinds

Definition at line 357 of file PorousFlowDarcyBase.C.

{
  const unsigned int num_nodes = _test.size();
  computeProtoFluxWithoutMobility();
 
  // Initialise upwind-tracking maps for this element on first encounter
  const unsigned elem = this->_current_elem->id();
  initializeUpwindTracking(elem, num_nodes);
 
  if (do_counting)
    updateUpwindCounts(elem, num_nodes);
 
  // Determine how many upwind-downwind swaps have occurred this timestep
  const std::vector<unsigned> max_swaps = computeMaxSwaps(elem, num_nodes);
 
  // Apply mobility via the chosen upwinding scheme (always in residual mode for AD)
  applyUpwinding(max_swaps, JacRes::CALCULATE_RESIDUAL, 0);
}

applyUpwinding()

template<bool is_ad>

void PorousFlowDarcyBaseTempl< is_ad >::applyUpwinding ( const std::vector< unsigned > &  max_swaps, JacRes  res_or_jac, unsigned int  pvar  )

private

Apply selected upwinding/fallback scheme for all phases.

Definition at line 332 of file PorousFlowDarcyBase.C.

{
  for (unsigned int ph = 0; ph < _num_phases; ++ph)
  {
    if (max_swaps[ph] < _full_upwind_threshold)
      fullyUpwind(res_or_jac, ph, pvar);
    else
    {
      switch (_fallback_scheme)
      {
        case FallbackEnum::QUICK:
          quickUpwind(res_or_jac, ph, pvar);
          break;
        case FallbackEnum::HARMONIC:
          harmonicMean(res_or_jac, ph, pvar);
          break;
      }
    }
  }
}

assembleProtoFluxResidual()

template<bool is_ad>

void PorousFlowDarcyBaseTempl< is_ad >::assembleProtoFluxResidual ( )

private

Assemble the real-valued residual vector from _proto_flux into the tagged local residual (and apply save_in).

Shared by the AD and non-AD residual paths.

Definition at line 197 of file PorousFlowDarcyBase.C.

{
  this->prepareVectorTag(this->_assembly, _var.number());
  for (_i = 0; _i < _test.size(); _i++)
    for (unsigned int ph = 0; ph < _num_phases; ++ph)
      this->_local_re(_i) += MetaPhysicL::raw_value(_proto_flux[ph][_i]);
  this->accumulateTaggedLocalResidual();
 
  if (this->_has_save_in)
    for (unsigned int i = 0; i < this->_save_in.size(); i++)
      this->_save_in[i]->sys().solution().add_vector(this->_local_re,
                                                     this->_save_in[i]->dofIndices());
}

computeJacobian()

template<bool is_ad>

void PorousFlowDarcyBaseTempl< is_ad >::computeJacobian ( )

overrideprotectedvirtual

Reimplemented from GenericKernel< is_ad >.

Definition at line 213 of file PorousFlowDarcyBase.C.

{
  if constexpr (!is_ad)
    computeResidualAndJacobian(JacRes::CALCULATE_JACOBIAN, _var.number());
  else
    // Block-diagonal (e.g. PJFNK) assembly path: this is the only Jacobian call we get.
    adComputeJacobian();
}

computeMaxSwaps()

template<bool is_ad>

std::vector< unsigned > PorousFlowDarcyBaseTempl< is_ad >::computeMaxSwaps ( unsigned  elem, unsigned int  num_nodes  ) const

private

Compute per-phase maximum upwind/downwind swap counts for this element.

Definition at line 319 of file PorousFlowDarcyBase.C.

{
  std::vector<unsigned> max_swaps(_num_phases, 0);
  for (unsigned ph = 0; ph < _num_phases; ++ph)
    for (unsigned nod = 0; nod < num_nodes; ++nod)
      max_swaps[ph] =
          std::max(max_swaps[ph],
                   std::min(_num_upwinds.at(elem)[ph][nod], _num_downwinds.at(elem)[ph][nod]));
  return max_swaps;
}

computeOffDiagJacobian()

template<bool is_ad>

void PorousFlowDarcyBaseTempl< is_ad >::computeOffDiagJacobian ( unsigned int  jvar )

overrideprotectedvirtual

Reimplemented from GenericKernel< is_ad >.

Definition at line 252 of file PorousFlowDarcyBase.C.

{
  if constexpr (!is_ad)
    computeResidualAndJacobian(JacRes::CALCULATE_JACOBIAN, jvar);
  else
  {
    libmesh_ignore(jvar);
    // Full (SMP) assembly calls this once per coupled variable; the first call performs the
    // single AD pass that fills every block, and the guard makes the rest no-ops. This mirrors
    // ADKernel::computeOffDiagJacobian and avoids the ADD-semantics double-counting.
    if (_my_elem_darcy != this->_current_elem)
    {
      adComputeJacobian();
      _my_elem_darcy = this->_current_elem;
    }
  }
}

computeProtoFluxWithoutMobility()

template<bool is_ad>

void PorousFlowDarcyBaseTempl< is_ad >::computeProtoFluxWithoutMobility ( )

private

Build proto fluxes (without mobility weighting) for all phases and nodes.

Definition at line 272 of file PorousFlowDarcyBase.C.

{
  const unsigned int num_nodes = _test.size();
  for (unsigned ph = 0; ph < _num_phases; ++ph)
  {
    _proto_flux[ph].assign(num_nodes, 0.0);
    for (_qp = 0; _qp < this->_qrule->n_points(); _qp++)
    {
      const Real jxw_coord = this->_JxW[_qp] * this->_coord[_qp];
      for (_i = 0; _i < num_nodes; ++_i)
        _proto_flux[ph][_i] += jxw_coord * darcyQp(ph);
    }
  }
}

computeQpResidual()

template<bool is_ad>

GenericReal< is_ad > PorousFlowDarcyBaseTempl< is_ad >::computeQpResidual ( )

overrideprotectedvirtual

Implements GenericKernel< is_ad >.

Definition at line 175 of file PorousFlowDarcyBase.C.

{
  mooseError("PorousFlowDarcyBase: computeQpResidual called");
  return 0.0;
}

computeResidual()

template<bool is_ad>

void PorousFlowDarcyBaseTempl< is_ad >::computeResidual ( )

overrideprotectedvirtual

Reimplemented from GenericKernel< is_ad >.

Definition at line 183 of file PorousFlowDarcyBase.C.

{
  if constexpr (!is_ad)
    computeResidualAndJacobian(JacRes::CALCULATE_RESIDUAL, 0);
  else
  {
    adComputeProtoFlux(false);
    // Assemble the real-valued residual from the value parts of the ADReal proto fluxes
    assembleProtoFluxResidual();
  }
}

computeResidualAndJacobian() [1/2]

template<bool is_ad>

virtual void ResidualObject::computeResidualAndJacobian ( )

protectedvirtual

Reimplemented from GenericKernel< is_ad >.

computeResidualAndJacobian() [2/2]

template<bool is_ad>

void PorousFlowDarcyBaseTempl< is_ad >::computeResidualAndJacobian ( JacRes  res_or_jac, unsigned int  jvar  )

protected

Computation of the residual and Jacobian (non-AD path only).

If res_or_jac=CALCULATE_JACOBIAN then the residual gets calculated anyway (becuase we have to know which nodes are upwind and which are downwind) except we don't actually need to store the residual in _assembly.residualBlock and we don't need to save in save_in.

If res_or_jac=CALCULATE_RESIDUAL then we don't have to do all the Jacobian calculations.

Parameters

res_or_jac	Whether to calculate the residual or the jacobian.
jvar	PorousFlow variable to take derivatives wrt to

Definition at line 378 of file PorousFlowDarcyBase.C.

{
  if ((res_or_jac == JacRes::CALCULATE_JACOBIAN) && _dictator.notPorousFlowVariable(jvar))
    return;
 
  // The PorousFlow variable index corresponding to the variable number jvar
  const unsigned int pvar =
      ((res_or_jac == JacRes::CALCULATE_JACOBIAN) ? _dictator.porousFlowVariableNum(jvar) : 0);
 
  this->prepareMatrixTag(this->_assembly, _var.number(), jvar);
  if ((this->_local_ke.n() == 0) &&
      (res_or_jac == JacRes::CALCULATE_JACOBIAN)) // this removes a problem
                                                  // encountered in the
                                                  // initial timestep when
                                                  // use_displaced_mesh=true
    return;
 
  // The number of nodes in the element
  const unsigned int num_nodes = _test.size();
 
  // Compute the residual and jacobian without the mobility terms. Even if we are computing the
  // Jacobian we still need this in order to see which nodes are upwind and which are downwind.
  computeProtoFluxWithoutMobility();
 
  // for this element, record whether each node is "upwind" or "downwind" (or neither)
  const unsigned elem = this->_current_elem->id();
  initializeUpwindTracking(elem, num_nodes);
  // record the information once per nonlinear iteration
  if (res_or_jac == JacRes::CALCULATE_JACOBIAN && jvar == _var.number())
    updateUpwindCounts(elem, num_nodes);
 
  // based on _num_upwinds and _num_downwinds, calculate the maximum number
  // of upwind-downwind swaps that have been encountered in this timestep
  // for this element
  const std::vector<unsigned> max_swaps = computeMaxSwaps(elem, num_nodes);
 
  // size the _jacobian correctly and calculate it for the case residual = _proto_flux
  if (res_or_jac == JacRes::CALCULATE_JACOBIAN)
  {
    for (unsigned ph = 0; ph < _num_phases; ++ph)
    {
      _jacobian[ph].resize(this->_local_ke.m());
      for (_i = 0; _i < _test.size(); _i++)
      {
        _jacobian[ph][_i].assign(this->_local_ke.n(), 0.0);
        for (_j = 0; _j < _phi.size(); _j++)
          for (_qp = 0; _qp < this->_qrule->n_points(); _qp++)
            _jacobian[ph][_i][_j] +=
                this->_JxW[_qp] * this->_coord[_qp] * darcyQpJacobian(jvar, ph);
      }
    }
  }
 
  // Loop over all the phases, computing the mass flux, which
  // gets placed into _proto_flux, and the derivative of this
  // which gets placed into _jacobian
  applyUpwinding(max_swaps, res_or_jac, pvar);
 
  // Add results to the Residual or Jacobian
  if (res_or_jac == JacRes::CALCULATE_RESIDUAL)
    assembleProtoFluxResidual();
 
  if (res_or_jac == JacRes::CALCULATE_JACOBIAN)
  {
    for (_i = 0; _i < _test.size(); _i++)
      for (_j = 0; _j < _phi.size(); _j++)
        for (unsigned int ph = 0; ph < _num_phases; ++ph)
          this->_local_ke(_i, _j) += _jacobian[ph][_i][_j];
 
    this->accumulateTaggedLocalMatrix();
 
    if (this->_has_diag_save_in && jvar == _var.number())
    {
      unsigned int rows = this->_local_ke.m();
      DenseVector<Number> diag(rows);
      for (unsigned int i = 0; i < rows; i++)
        diag(i) = this->_local_ke(i, i);
 
      for (unsigned int i = 0; i < this->_diag_save_in.size(); i++)
        this->_diag_save_in[i]->sys().solution().add_vector(diag,
                                                            this->_diag_save_in[i]->dofIndices());
    }
  }
}

darcyQp()

template<bool is_ad>

GenericReal< is_ad > PorousFlowDarcyBaseTempl< is_ad >::darcyQp ( unsigned int  ph ) const

protectedvirtual

The Darcy part of the flux (this is the non-upwinded part)

Definition at line 134 of file PorousFlowDarcyBase.C.

{
  return _grad_test[_i][_qp] *
         (_permeability[_qp] * (_grad_p[_qp][ph] - _fluid_density_qp[_qp][ph] * _gravity));
}

darcyQpJacobian()

template<bool is_ad>

Real PorousFlowDarcyBaseTempl< is_ad >::darcyQpJacobian ( unsigned int  jvar, unsigned int  ph  ) const

protectedvirtual

Jacobian of the Darcy part of the flux – non-AD path only.

Definition at line 142 of file PorousFlowDarcyBase.C.

{
  if constexpr (!is_ad)
  {
    if (_dictator.notPorousFlowVariable(jvar))
      return 0.0;
 
    const unsigned int pvar = _dictator.porousFlowVariableNum(jvar);
 
    RealVectorValue deriv =
        _permeability[_qp] * (_grad_phi[_j][_qp] * (*_dgrad_p_dgrad_var)[_qp][ph][pvar] -
                              _phi[_j][_qp] * (*_dfluid_density_qp_dvar)[_qp][ph][pvar] * _gravity);
 
    deriv += _permeability[_qp] * ((*_dgrad_p_dvar)[_qp][ph][pvar] * _phi[_j][_qp]);
 
    if (_perm_derivs)
    {
      deriv += (*_dpermeability_dvar)[_qp][pvar] * _phi[_j][_qp] *
               (_grad_p[_qp][ph] - _fluid_density_qp[_qp][ph] * _gravity);
      for (const auto i : make_range(Moose::dim))
        deriv += (*_dpermeability_dgradvar)[_qp][i][pvar] * _grad_phi[_j][_qp](i) *
                 (_grad_p[_qp][ph] - _fluid_density_qp[_qp][ph] * _gravity);
    }
 
    return _grad_test[_i][_qp] * deriv;
  }
  else
    libmesh_ignore(jvar, ph);
  return 0.0;
}

dmobility()

template<bool is_ad>

Real PorousFlowDarcyBaseTempl< is_ad >::dmobility ( unsigned  nodenum, unsigned  phase, unsigned  pvar  ) const

protectedvirtual

The derivative of mobility with respect to PorousFlow variable pvar – non-AD path only.

Parameters

nodenum	The node-number to evaluate the mobility for
phase	the fluid phase number
pvar	the PorousFlow variable pvar

Reimplemented in PorousFlowAdvectiveFluxTempl< is_ad >, PorousFlowFullySaturatedAdvectiveFluxTempl< is_ad >, PorousFlowFullySaturatedUpwindHeatAdvectionTempl< is_ad >, and PorousFlowHeatAdvectionTempl< is_ad >.

Definition at line 701 of file PorousFlowDarcyBase.C.

{
  if constexpr (!is_ad)
  {
    Real dm = (*_dfluid_density_node_dvar)[nodenum][phase][pvar] / _fluid_viscosity[nodenum][phase];
    dm -= _fluid_density_node[nodenum][phase] * (*_dfluid_viscosity_dvar)[nodenum][phase][pvar] /
          std::pow(_fluid_viscosity[nodenum][phase], 2);
    return dm;
  }
  else
    libmesh_ignore(nodenum, phase, pvar);
  return 0.0;
}

fullyUpwind()

template<bool is_ad>

void PorousFlowDarcyBaseTempl< is_ad >::fullyUpwind ( JacRes  res_or_jac, unsigned int  ph, unsigned int  pvar  )

protected

Calculate the residual or Jacobian using full upwinding.

Parameters

res_or_jac	whether to compute the residual or jacobian (non-AD: CALCULATE_JACOBIAN fills _jacobian; AD: always pass CALCULATE_RESIDUAL)
ph	fluid phase number
pvar	differentiate wrt to this PorousFlow variable (when computing the jacobian)

Perform the full upwinding by multiplying the residuals at the upstream nodes by their mobilities. Mobility is different for each phase, and in each situation: mobility = density / viscosity for single-component Darcy flow mobility = mass_fraction * density * relative_perm / viscosity for multi-component, multiphase flow mobility = enthalpy * density * relative_perm / viscosity for heat convection

The residual for the kernel is the sum over Darcy fluxes for each phase. The Darcy flux for a particular phase is R_i = int{mobility*flux_no_mob} = int{mobility*grad(pot)*permeability*grad(test_i)} for node i. where int is the integral over the element. However, in fully-upwind, the first step is to take the mobility outside the integral, which was done in the _proto_flux calculation above.

NOTE: Physically _proto_flux[i][ph] is a measure of fluid of phase ph flowing out of node i. If we had left in mobility, it would be exactly the component mass flux flowing out of node i.

This leads to the definition of upwinding:

If _proto_flux(i)[ph] is positive then we use mobility_i. That is we use the upwind value of mobility.

The final subtle thing is we must also conserve fluid mass: the total component mass flowing out of node i must be the sum of the masses flowing into the other nodes.

note the -= means the result is positive

Definition at line 465 of file PorousFlowDarcyBase.C.

{
  // res_or_jac and pvar drive the hand-coded non-AD Jacobian only; the AD path ignores them
  if constexpr (is_ad)
    libmesh_ignore(res_or_jac, pvar);
 
  // The number of nodes in the element
  const unsigned int num_nodes = _test.size();
 
  GenericReal<is_ad> mob;
  // Define variables used to ensure mass conservation
  GenericReal<is_ad> total_mass_out = 0.0;
  GenericReal<is_ad> total_in = 0.0;
 
  // The following holds derivatives of these (non-AD path only)
  std::vector<Real> dtotal_mass_out;
  std::vector<Real> dtotal_in;
 
  // These accumulate Jacobian columns, so they must be sized by the column variable's
  // DOF count (_phi.size(), not by num_nodes = _test.size() (which is the row variable's)
  if constexpr (!is_ad)
    if (res_or_jac == JacRes::CALCULATE_JACOBIAN)
    {
      dtotal_mass_out.assign(_phi.size(), 0.0);
      dtotal_in.assign(_phi.size(), 0.0);
    }
 
  // Perform the upwinding using the mobility
  std::vector<bool> upwind_node(num_nodes);
  for (unsigned int n = 0; n < num_nodes; ++n)
  {
    if (_proto_flux[ph][n] >= 0.0) // upstream node
    {
      upwind_node[n] = true;
      // The mobility at the upstream node
      mob = mobility(n, ph);
      if constexpr (!is_ad)
        if (res_or_jac == JacRes::CALCULATE_JACOBIAN)
        {
          // The derivative of the mobility wrt the PorousFlow variable
          const Real dmob = dmobility(n, ph, pvar);
 
          for (_j = 0; _j < _phi.size(); _j++)
            _jacobian[ph][n][_j] *= mob;
 
          if (_test.size() == _phi.size())
            /* mobility at node=n depends only on the variables at node=n, by construction.  For
             * linear-lagrange variables, this means that Jacobian entries involving the derivative
             * of mobility will only be nonzero for derivatives wrt variables at node=n.  Hence the
             * [n][n] in the line below.  However, for other variable types (eg constant monomials)
             * I cannot tell what variable number contributes to the derivative.  However, in all
             * cases I can possibly imagine, the derivative is zero anyway, since in the full
             * upwinding scheme, mobility shouldn't depend on these other sorts of variables.
             */
            _jacobian[ph][n][n] += dmob * MetaPhysicL::raw_value(_proto_flux[ph][n]);
 
          for (_j = 0; _j < _phi.size(); _j++)
            dtotal_mass_out[_j] += _jacobian[ph][n][_j];
        }
      _proto_flux[ph][n] *= mob;
      total_mass_out += _proto_flux[ph][n];
    }
    else
    {
      upwind_node[n] = false;
      total_in -= _proto_flux[ph][n]; 
      if constexpr (!is_ad)
        if (res_or_jac == JacRes::CALCULATE_JACOBIAN)
          for (_j = 0; _j < _phi.size(); _j++)
            dtotal_in[_j] -= _jacobian[ph][n][_j];
    }
  }
 
  // Conserve mass over all phases by proportioning the total_mass_out mass to the inflow nodes,
  // weighted by their proto_flux values
  for (unsigned int n = 0; n < num_nodes; ++n)
  {
    if (!upwind_node[n]) // downstream node
    {
      if constexpr (!is_ad)
        if (res_or_jac == JacRes::CALCULATE_JACOBIAN)
          for (_j = 0; _j < _phi.size(); _j++)
          {
            _jacobian[ph][n][_j] *= MetaPhysicL::raw_value(total_mass_out / total_in);
            _jacobian[ph][n][_j] +=
                MetaPhysicL::raw_value(_proto_flux[ph][n]) *
                (dtotal_mass_out[_j] / MetaPhysicL::raw_value(total_in) -
                 dtotal_in[_j] * MetaPhysicL::raw_value(total_mass_out) /
                     MetaPhysicL::raw_value(total_in) / MetaPhysicL::raw_value(total_in));
          }
      _proto_flux[ph][n] *= total_mass_out / total_in;
    }
  }
}

harmonicMean()

template<bool is_ad>

void PorousFlowDarcyBaseTempl< is_ad >::harmonicMean ( JacRes  res_or_jac, unsigned int  ph, unsigned int  pvar  )

protected

Calculate the residual or Jacobian by using the harmonic mean of the nodal mobilities for the entire element.

Parameters

res_or_jac	whether to compute the residual or jacobian
ph	fluid phase number
pvar	differentiate wrt to this PorousFlow variable (when computing the jacobian)

Definition at line 631 of file PorousFlowDarcyBase.C.

{
  // res_or_jac and pvar drive the hand-coded non-AD Jacobian only; the AD path ignores them
  if constexpr (is_ad)
    libmesh_ignore(res_or_jac, pvar);
 
  // The number of nodes in the element
  const unsigned int num_nodes = _test.size();
 
  std::vector<GenericReal<is_ad>> mob(num_nodes);
  unsigned num_zero = 0;
  GenericReal<is_ad> harmonic_mob = 0;
  for (unsigned n = 0; n < num_nodes; ++n)
  {
    mob[n] = mobility(n, ph);
    if (MetaPhysicL::raw_value(mob[n]) == 0.0)
    {
      num_zero++;
    }
    else
      harmonic_mob += 1.0 / mob[n];
  }
  if (num_zero > 0)
    harmonic_mob = 0.0;
  else
    harmonic_mob = (1.0 * num_nodes) / harmonic_mob;
 
  // d(harmonic_mob)/d(PorousFlow variable at node n) -- non-AD path only
  std::vector<Real> dharmonic_mob(num_nodes, 0.0);
  if constexpr (!is_ad)
    if (res_or_jac == JacRes::CALCULATE_JACOBIAN)
    {
      const Real harm2 = std::pow(MetaPhysicL::raw_value(harmonic_mob), 2) / (1.0 * num_nodes);
      if (num_zero == 0)
        for (unsigned n = 0; n < num_nodes; ++n)
          dharmonic_mob[n] =
              dmobility(n, ph, pvar) * harm2 / std::pow(MetaPhysicL::raw_value(mob[n]), 2);
      else if (num_zero == 1)
        for (unsigned n = 0; n < num_nodes; ++n)
          if (MetaPhysicL::raw_value(mob[n]) == 0.0)
          {
            dharmonic_mob[n] = num_nodes * dmobility(n, ph, pvar); // other derivs are zero
            break;
          }
      // if num_zero > 1 then all dharmonic_mob = 0.0
    }
 
  if constexpr (!is_ad)
    if (res_or_jac == JacRes::CALCULATE_JACOBIAN)
      for (unsigned n = 0; n < num_nodes; ++n)
        for (_j = 0; _j < _phi.size(); _j++)
        {
          _jacobian[ph][n][_j] *= MetaPhysicL::raw_value(harmonic_mob);
          if (_test.size() == _phi.size())
            _jacobian[ph][n][_j] += dharmonic_mob[_j] * MetaPhysicL::raw_value(_proto_flux[ph][n]);
        }
 
  for (unsigned n = 0; n < num_nodes; ++n)
    _proto_flux[ph][n] *= harmonic_mob;
}

initializeUpwindTracking()

template<bool is_ad>

void PorousFlowDarcyBaseTempl< is_ad >::initializeUpwindTracking ( unsigned  elem, unsigned int  num_nodes  )

private

Ensure per-element upwind/downwind counters are allocated for this element.

Definition at line 289 of file PorousFlowDarcyBase.C.

{
  if (_num_upwinds.find(elem) == _num_upwinds.end())
  {
    _num_upwinds[elem] = std::vector<std::vector<unsigned>>(_num_phases);
    _num_downwinds[elem] = std::vector<std::vector<unsigned>>(_num_phases);
    for (unsigned ph = 0; ph < _num_phases; ++ph)
    {
      _num_upwinds[elem][ph].assign(num_nodes, 0);
      _num_downwinds[elem][ph].assign(num_nodes, 0);
    }
  }
}

jacobianSetup()

template<bool is_ad>

void PorousFlowDarcyBaseTempl< is_ad >::jacobianSetup ( )

overrideprotectedvirtual

Reimplemented from GenericKernel< is_ad >.

Definition at line 126 of file PorousFlowDarcyBase.C.

{
  GenericKernel<is_ad>::jacobianSetup();
  _my_elem_darcy = nullptr;
}

mobility()

template<bool is_ad>

GenericReal< is_ad > PorousFlowDarcyBaseTempl< is_ad >::mobility ( unsigned  nodenum, unsigned  phase  ) const

protectedvirtual

The mobility of the fluid.

For multi-component Darcy flow this is mass_fraction * fluid_density * relative_permeability / fluid_viscosity

Parameters

nodenum	The node-number to evaluate the mobility for
phase	the fluid phase number

Reimplemented in PorousFlowAdvectiveFluxTempl< is_ad >, PorousFlowFullySaturatedAdvectiveFluxTempl< is_ad >, PorousFlowFullySaturatedUpwindHeatAdvectionTempl< is_ad >, and PorousFlowHeatAdvectionTempl< is_ad >.

Definition at line 694 of file PorousFlowDarcyBase.C.

{
  return _fluid_density_node[nodenum][phase] / _fluid_viscosity[nodenum][phase];
}

quickUpwind()

template<bool is_ad>

void PorousFlowDarcyBaseTempl< is_ad >::quickUpwind ( JacRes  res_or_jac, unsigned int  ph, unsigned int  pvar  )

protected

Calculate the residual or Jacobian using the nodal mobilities, but without conserving fluid mass.

Parameters

res_or_jac	whether to compute the residual or jacobian
ph	fluid phase number
pvar	differentiate wrt to this PorousFlow variable (when computing the jacobian)

Definition at line 591 of file PorousFlowDarcyBase.C.

{
  // res_or_jac and pvar drive the hand-coded non-AD Jacobian only; the AD path ignores them
  if constexpr (is_ad)
    libmesh_ignore(res_or_jac, pvar);
 
  // The number of nodes in the element
  const unsigned int num_nodes = _test.size();
 
  // Use the raw nodal mobility
  for (unsigned int n = 0; n < num_nodes; ++n)
  {
    // The mobility at the node
    const GenericReal<is_ad> mob = mobility(n, ph);
    if constexpr (!is_ad)
      if (res_or_jac == JacRes::CALCULATE_JACOBIAN)
      {
        // The derivative of the mobility wrt the PorousFlow variable
        const Real dmob = dmobility(n, ph, pvar);
 
        for (_j = 0; _j < _phi.size(); _j++)
          _jacobian[ph][n][_j] *= mob;
 
        if (_test.size() == _phi.size())
          /* mobility at node=n depends only on the variables at node=n, by construction.  For
           * linear-lagrange variables, this means that Jacobian entries involving the derivative
           * of mobility will only be nonzero for derivatives wrt variables at node=n.  Hence the
           * [n][n] in the line below.  However, for other variable types (eg constant monomials)
           * I cannot tell what variable number contributes to the derivative.  However, in all
           * cases I can possibly imagine, the derivative is zero anyway, since in the full
           * upwinding scheme, mobility shouldn't depend on these other sorts of variables.
           */
          _jacobian[ph][n][n] += dmob * MetaPhysicL::raw_value(_proto_flux[ph][n]);
      }
    _proto_flux[ph][n] *= mob;
  }
}

timestepSetup()

template<bool is_ad>

void PorousFlowDarcyBaseTempl< is_ad >::timestepSetup ( )

overrideprotectedvirtual

Reimplemented from GenericKernel< is_ad >.

Definition at line 117 of file PorousFlowDarcyBase.C.

{
  GenericKernel<is_ad>::timestepSetup();
  _num_upwinds = std::unordered_map<unsigned, std::vector<std::vector<unsigned>>>();
  _num_downwinds = std::unordered_map<unsigned, std::vector<std::vector<unsigned>>>();
}

updateUpwindCounts()

template<bool is_ad>

void PorousFlowDarcyBaseTempl< is_ad >::updateUpwindCounts ( unsigned  elem, unsigned int  num_nodes  )

private

Update upwind/downwind counters from the sign of _proto_flux.

Definition at line 305 of file PorousFlowDarcyBase.C.

{
  for (unsigned ph = 0; ph < _num_phases; ++ph)
    for (unsigned nod = 0; nod < num_nodes; ++nod)
    {
      if (_proto_flux[ph][nod] > 0)
        _num_upwinds[elem][ph][nod]++;
      else if (_proto_flux[ph][nod] < 0)
        _num_downwinds[elem][ph][nod]++;
    }
}

validParams()

template<bool is_ad>

InputParameters PorousFlowDarcyBaseTempl< is_ad >::validParams ( )

static

Definition at line 21 of file PorousFlowDarcyBase.C.

{
  InputParameters params = GenericKernel<is_ad>::validParams();
  params.addRequiredParam<RealVectorValue>("gravity",
                                           "Gravitational acceleration vector downwards (m/s^2)");
  params.addRequiredParam<UserObjectName>(
      "PorousFlowDictator", "The UserObject that holds the list of PorousFlow variable names");
  params.addParam<unsigned>("full_upwind_threshold",
                            5,
                            "If, for each timestep, the number of "
                            "upwind-downwind swaps in an element is less than "
                            "this quantity, then full upwinding is used for that element.  "
                            "Otherwise the fallback scheme is employed.");
  MooseEnum fallback_enum("quick harmonic", "quick");
  params.addParam<MooseEnum>("fallback_scheme",
                             fallback_enum,
                             "quick: use nodal mobility without "
                             "preserving mass.  harmonic: use a "
                             "harmonic mean of nodal mobilities "
                             "and preserve fluid mass");
  params.addClassDescription("Fully-upwinded advective Darcy flux");
  return params;
}

Referenced by PorousFlowAdvectiveFluxTempl< is_ad >::validParams(), PorousFlowFullySaturatedAdvectiveFluxTempl< is_ad >::validParams(), PorousFlowFullySaturatedUpwindHeatAdvectionTempl< is_ad >::validParams(), and PorousFlowHeatAdvectionTempl< is_ad >::validParams().

Member Data Documentation

_dfluid_density_node_dvar

template<bool is_ad>

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowDarcyBaseTempl< is_ad >::_dfluid_density_node_dvar

protected

Derivative of the fluid density for each phase wrt PorousFlow variables (at the node) – null for AD path.

Definition at line 102 of file PorousFlowDarcyBase.h.

_dfluid_density_qp_dvar

template<bool is_ad>

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowDarcyBaseTempl< is_ad >::_dfluid_density_qp_dvar

protected

Derivative of the fluid density for each phase wrt PorousFlow variables (at the qp) – null for AD path.

Definition at line 108 of file PorousFlowDarcyBase.h.

_dfluid_viscosity_dvar

template<bool is_ad>

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowDarcyBaseTempl< is_ad >::_dfluid_viscosity_dvar

protected

Derivative of the fluid viscosity for each phase wrt PorousFlow variables – null for AD path.

Definition at line 114 of file PorousFlowDarcyBase.h.

_dgrad_p_dgrad_var

template<bool is_ad>

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowDarcyBaseTempl< is_ad >::_dgrad_p_dgrad_var

protected

Derivative of Grad porepressure in each phase wrt grad(PorousFlow variables) – null for AD path.

Definition at line 123 of file PorousFlowDarcyBase.h.

_dgrad_p_dvar

template<bool is_ad>

const MaterialProperty<std::vector<std::vector<RealGradient> > >* const PorousFlowDarcyBaseTempl< is_ad >::_dgrad_p_dvar

protected

Derivative of Grad porepressure in each phase wrt PorousFlow variables – null for AD path.

Definition at line 126 of file PorousFlowDarcyBase.h.

_dictator

template<bool is_ad>

const PorousFlowDictator& PorousFlowDarcyBaseTempl< is_ad >::_dictator

protected

PorousFlowDictator UserObject.

Definition at line 129 of file PorousFlowDarcyBase.h.

Referenced by PorousFlowAdvectiveFluxTempl< is_ad >::PorousFlowAdvectiveFluxTempl(), PorousFlowFullySaturatedAdvectiveFluxTempl< is_ad >::PorousFlowFullySaturatedAdvectiveFluxTempl(), and PorousFlowFullySaturatedUpwindHeatAdvectionTempl< is_ad >::PorousFlowFullySaturatedUpwindHeatAdvectionTempl().

_dpermeability_dgradvar

template<bool is_ad>

const MaterialProperty<std::vector<std::vector<RealTensorValue> > >* const PorousFlowDarcyBaseTempl< is_ad >::_dpermeability_dgradvar

protected

d(permeabiity)/d(grad(PorousFlow variable)) – null for AD path

Definition at line 96 of file PorousFlowDarcyBase.h.

_dpermeability_dvar

template<bool is_ad>

const MaterialProperty<std::vector<RealTensorValue> >* const PorousFlowDarcyBaseTempl< is_ad >::_dpermeability_dvar

protected

d(permeabiity)/d(PorousFlow variable) – null for AD path

Definition at line 93 of file PorousFlowDarcyBase.h.

_fallback_scheme

template<bool is_ad>

enum PorousFlowDarcyBaseTempl::FallbackEnum PorousFlowDarcyBaseTempl< is_ad >::_fallback_scheme

protected

_fluid_density_node

template<bool is_ad>

const GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowDarcyBaseTempl< is_ad >::_fluid_density_node

protected

Fluid density for each phase (at the node)

Definition at line 99 of file PorousFlowDarcyBase.h.

_fluid_density_qp

template<bool is_ad>

const GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowDarcyBaseTempl< is_ad >::_fluid_density_qp

protected

Fluid density for each phase (at the qp)

Definition at line 105 of file PorousFlowDarcyBase.h.

_fluid_viscosity

template<bool is_ad>

const GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowDarcyBaseTempl< is_ad >::_fluid_viscosity

protected

Viscosity of each component in each phase.

Definition at line 111 of file PorousFlowDarcyBase.h.

_full_upwind_threshold

template<bool is_ad>

const unsigned PorousFlowDarcyBaseTempl< is_ad >::_full_upwind_threshold

protected

If the number of upwind-downwind swaps is less than this amount then full upwinding is used.

Otherwise the fallback scheme is employed

Definition at line 144 of file PorousFlowDarcyBase.h.

_grad_p

template<bool is_ad>

const GenericMaterialProperty<std::vector<RealGradient>, is_ad>& PorousFlowDarcyBaseTempl< is_ad >::_grad_p

protected

Gradient of the pore pressure in each phase.

Definition at line 120 of file PorousFlowDarcyBase.h.

_gravity

template<bool is_ad>

const RealVectorValue PorousFlowDarcyBaseTempl< is_ad >::_gravity

protected

Gravity. Defaults to 9.81 m/s^2.

Definition at line 135 of file PorousFlowDarcyBase.h.

_jacobian

template<bool is_ad>

std::vector<std::vector<std::vector<Real> > > PorousFlowDarcyBaseTempl< is_ad >::_jacobian

protected

Derivative of _proto_flux with respect to nodal variables.

This gets modified with the mobility and its derivative during computation of MOOSE's Jacobian. Only used on the non-AD path.

Definition at line 170 of file PorousFlowDarcyBase.h.

_my_elem_darcy

template<bool is_ad>

const Elem* PorousFlowDarcyBaseTempl< is_ad >::_my_elem_darcy = nullptr

private

Element pointer cached on the first AD computeOffDiagJacobian() call for an element so that the remaining off-diagonal calls (one per coupled variable) become no-ops; the single AD pass already filled all blocks.

Reset each Jacobian evaluation in jacobianSetup().

Definition at line 255 of file PorousFlowDarcyBase.h.

_num_downwinds

template<bool is_ad>

std::unordered_map<unsigned, std::vector<std::vector<unsigned> > > PorousFlowDarcyBaseTempl< is_ad >::_num_downwinds

protected

Number of nonlinear iterations (in this timestep and this element) that a node is an downwind node for a given fluid phase.

_num_upwinds[element_number][phase][node_number_in_element]

Definition at line 184 of file PorousFlowDarcyBase.h.

_num_phases

template<bool is_ad>

const unsigned int PorousFlowDarcyBaseTempl< is_ad >::_num_phases

protected

The number of fluid phases.

Definition at line 132 of file PorousFlowDarcyBase.h.

_num_upwinds

template<bool is_ad>

std::unordered_map<unsigned, std::vector<std::vector<unsigned> > > PorousFlowDarcyBaseTempl< is_ad >::_num_upwinds

protected

Number of nonlinear iterations (in this timestep and this element) that a node is an upwind node for a given fluid phase.

_num_upwinds[element_number][phase][node_number_in_element]

Definition at line 177 of file PorousFlowDarcyBase.h.

_perm_derivs

template<bool is_ad>

const bool PorousFlowDarcyBaseTempl< is_ad >::_perm_derivs

protected

Flag to check whether permeabiity derivatives are non-zero.

Definition at line 138 of file PorousFlowDarcyBase.h.

_permeability

template<bool is_ad>

const GenericMaterialProperty<RealTensorValue, is_ad>& PorousFlowDarcyBaseTempl< is_ad >::_permeability

protected

Permeability of porous material.

Definition at line 90 of file PorousFlowDarcyBase.h.

_pp

template<bool is_ad>

const GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowDarcyBaseTempl< is_ad >::_pp

protected

Nodal pore pressure in each phase.

Definition at line 117 of file PorousFlowDarcyBase.h.

_proto_flux

template<bool is_ad>

std::vector<std::vector<GenericReal<is_ad> > > PorousFlowDarcyBaseTempl< is_ad >::_proto_flux

protected

The Darcy flux.

When multiplied by the mobility, this is the mass flux of fluid moving out of a node. This multiplication occurs during the formation of the residual and Jacobian. _proto_flux[num_phases][num_nodes]

Definition at line 163 of file PorousFlowDarcyBase.h.

usingGenericKernelMembers

template<bool is_ad>

PorousFlowDarcyBaseTempl< is_ad >::usingGenericKernelMembers

protected

Definition at line 213 of file PorousFlowDarcyBase.h.

---

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

• porous_flow/include/kernels/PorousFlowDarcyBase.h
• porous_flow/src/kernels/PorousFlowDarcyBase.C