Applies a flux sink to a boundary. More...

#include <PorousFlowSink.h>

Inheritance diagram for PorousFlowSink:

Public Types
enum	ResidualTagType { ResidualTagType::NonReference, ResidualTagType::Reference }

enum	TEST_TYPE

typedef DataFileName	DataFileParameterType

Public Member Functions
	PorousFlowSink (const InputParameters &parameters)

virtual const MooseVariable &	variable () const override

virtual void	computeResidual () override

virtual void	computeJacobian () override

virtual void	computeOffDiagJacobian (unsigned int jvar) override

void	computeOffDiagJacobianScalar (unsigned int jvar) override

virtual void	computeResidualAndJacobian () override

void	prepareShapes (unsigned int var_num) override final

virtual bool	shouldApply () const override

virtual void	computeNonlocalJacobian ()

virtual void	computeNonlocalOffDiagJacobian (unsigned int)

const SubProblem &	subProblem () const

virtual std::set< std::string >	additionalROVariables ()

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

MooseApp &	getMooseApp () const

const std::string &	type () const

virtual const std::string &	name () const

std::string	typeAndName () const

std::string	errorPrefix (const std::string &error_type) const

void	callMooseError (std::string msg, const bool with_prefix) const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

const InputParameters &	parameters () const

MooseObjectName	uniqueName () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &nm) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	mooseError (Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseInfo (Args &&... args) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

virtual void	initialSetup ()

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

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

UserObjectName	getUserObjectName (const std::string &param_name) const

const T &	getUserObject (const std::string &param_name, bool is_dependency=true) const

const T &	getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const

const UserObject &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const

const UserObject &	getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const

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

virtual const std::set< BoundaryID > &	boundaryIDs () const

const std::vector< BoundaryName > &	boundaryNames () const

unsigned int	numBoundaryIDs () const

bool	hasBoundary (const BoundaryName &name) const

bool	hasBoundary (const std::vector< BoundaryName > &names) const

bool	hasBoundary (const BoundaryID &id) const

bool	hasBoundary (const std::vector< BoundaryID > &ids, TEST_TYPE type=ALL) const

bool	hasBoundary (const std::set< BoundaryID > &ids, TEST_TYPE type=ALL) const

bool	hasBoundary (const std::vector< BoundaryID > &ids, TEST_TYPE type=ALL) const

bool	hasBoundary (const std::set< BoundaryID > &ids, TEST_TYPE type=ALL) const

bool	isBoundarySubset (const std::set< BoundaryID > &ids) const

bool	isBoundarySubset (const std::vector< BoundaryID > &ids) const

bool	hasBoundaryMaterialProperty (const std::string &prop_name) const

virtual bool	boundaryRestricted () const

const std::set< BoundaryID > &	meshBoundaryIDs () const

virtual bool	checkVariableBoundaryIntegrity () const

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

virtual const VariableValue &	coupledValueByName (const std::string &var_name)

virtual const ArrayVariableValue &	coupledArrayValueByName (const std::string &var_name)

const std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> > &	getCoupledVars () const

const std::vector< MooseVariableFieldBase *> &	getCoupledMooseVars () const

const std::vector< MooseVariable *> &	getCoupledStandardMooseVars () const

const std::vector< VectorMooseVariable *> &	getCoupledVectorMooseVars () const

const std::vector< ArrayMooseVariable *> &	getCoupledArrayMooseVars () const

void	addFEVariableCoupleableVectorTag (TagID tag)

void	addFEVariableCoupleableMatrixTag (TagID tag)

std::set< TagID > &	getFEVariableCoupleableVectorTags ()

const std::set< TagID > &	getFEVariableCoupleableVectorTags () const

std::set< TagID > &	getFEVariableCoupleableMatrixTags ()

const std::set< TagID > &	getFEVariableCoupleableMatrixTags () const

auto &	getWritableCoupledVariables () const

bool	hasWritableCoupledVariables () const

const ADVariableValue *	getADDefaultValue (const std::string &var_name) const

const ADVectorVariableValue *	getADDefaultVectorValue (const std::string &var_name) const

const ADVariableGradient &	getADDefaultGradient () const

const ADVectorVariableGradient &	getADDefaultVectorGradient () const

const ADVariableSecond &	getADDefaultSecond () const

const ADVectorVariableCurl &	getADDefaultCurl () const

const std::vector< MooseVariableScalar *> &	getCoupledMooseScalarVars ()

const std::set< TagID > &	getScalarVariableCoupleableVectorTags () const

const std::set< TagID > &	getScalarVariableCoupleableMatrixTags () const

const std::set< MooseVariableFieldBase *> &	getMooseVariableDependencies () const

std::set< MooseVariableFieldBase *>	checkAllVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_omit={})

std::set< MooseVariableFieldBase *>	checkVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_check)

void	addMooseVariableDependency (MooseVariableFieldBase *var)

void	addMooseVariableDependency (const std::vector< MooseVariableFieldBase * > &vars)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, const unsigned int state=0)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name, MaterialData &material_data)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)

std::pair< const MaterialProperty< T > *, std::set< SubdomainID > >	getBlockMaterialProperty (const MaterialPropertyName &name)

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty (const std::string &name)

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty ()

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialPropertyByName (const std::string &prop_name)

const MaterialProperty< T > &	getZeroMaterialProperty (Ts... args)

std::set< SubdomainID >	getMaterialPropertyBlocks (const std::string &name)

std::vector< SubdomainName >	getMaterialPropertyBlockNames (const std::string &name)

std::set< BoundaryID >	getMaterialPropertyBoundaryIDs (const std::string &name)

std::vector< BoundaryName >	getMaterialPropertyBoundaryNames (const std::string &name)

void	checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)

std::unordered_map< SubdomainID, std::vector< MaterialBase *> >	buildRequiredMaterials (bool allow_stateful=true)

void	statefulPropertiesAllowed (bool)

bool	getMaterialPropertyCalled () const

virtual const std::unordered_set< unsigned int > &	getMatPropDependencies () const

virtual void	resolveOptionalProperties ()

const GenericMaterialProperty< T, is_ad > &	getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)

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 Distribution &	getDistribution (const std::string &name) const

const T &	getDistribution (const std::string &name) const

const Distribution &	getDistribution (const std::string &name) const

const T &	getDistribution (const std::string &name) const

const Distribution &	getDistributionByName (const DistributionName &name) const

const T &	getDistributionByName (const std::string &name) const

const Distribution &	getDistributionByName (const DistributionName &name) const

const T &	getDistributionByName (const std::string &name) const

const GenericOptionalMaterialProperty< T, is_ad > &	getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const GenericOptionalMaterialProperty< T, is_ad > &	getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalMaterialProperty< T > &	getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalMaterialProperty< T > &	getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalADMaterialProperty< T > &	getOptionalADMaterialProperty (const std::string &name)

const OptionalADMaterialProperty< T > &	getOptionalADMaterialProperty (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOld (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOld (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOlder (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOlder (const std::string &name)

MaterialBase &	getMaterial (const std::string &name)

MaterialBase &	getMaterial (const std::string &name)

MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)

MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)

bool	hasMaterialProperty (const std::string &name)

bool	hasMaterialProperty (const std::string &name)

bool	hasMaterialPropertyByName (const std::string &name)

bool	hasMaterialPropertyByName (const std::string &name)

bool	hasADMaterialProperty (const std::string &name)

bool	hasADMaterialProperty (const std::string &name)

bool	hasADMaterialPropertyByName (const std::string &name)

bool	hasADMaterialPropertyByName (const std::string &name)

bool	hasGenericMaterialProperty (const std::string &name)

bool	hasGenericMaterialProperty (const std::string &name)

bool	hasGenericMaterialPropertyByName (const std::string &name)

bool	hasGenericMaterialPropertyByName (const std::string &name)

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static bool	restricted (const std::set< BoundaryID > &ids)

Public Attributes
	ALL

	ANY

const ConsoleStream	_console

Static Public Attributes
static constexpr PropertyValue::id_type	default_property_id

static constexpr PropertyValue::id_type	zero_property_id

Protected Member Functions
virtual Real	computeQpResidual () override

virtual Real	computeQpJacobian () override

virtual Real	computeQpOffDiagJacobian (unsigned int jvar) override

Real	jac (unsigned int jvar) const
	Derivative of residual with respect to the jvar variable. More...

virtual Real	multiplier () const
	The flux gets multiplied by this quantity. More...

virtual Real	dmultiplier_dvar (unsigned int pvar) const
	d(multiplier)/d(Porous flow variable pvar) More...

virtual Real	computeQpOffDiagJacobianScalar (unsigned int jvar)

virtual void	precalculateQpResidual ()

virtual void	precalculateQpJacobian ()

virtual void	precalculateQpOffDiagJacobian (const MooseVariableFEBase &)

virtual void	precalculateResidual ()

virtual void	precalculateJacobian ()

virtual void	precalculateOffDiagJacobian (unsigned int)

const MooseVariableFieldBase &	getVariable (unsigned int jvar_num) const

virtual void	addUserObjectDependencyHelper (const UserObject &) 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	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 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 ADResidualsPacket &packet)

void	addJacobian (Assembly &assembly, 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)

bool	hasBoundaryMaterialPropertyHelper (const std::string &prop_name) 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)

const T *	getVarHelper (const std::string &var_name, unsigned int comp) const

T *	getVarHelper (const std::string &var_name, unsigned int comp)

MooseVariable *	getVar (const std::string &var_name, unsigned int comp)

const MooseVariable *	getVar (const std::string &var_name, unsigned int comp) const

VectorMooseVariable *	getVectorVar (const std::string &var_name, unsigned int comp)

const VectorMooseVariable *	getVectorVar (const std::string &var_name, unsigned int comp) const

ArrayMooseVariable *	getArrayVar (const std::string &var_name, unsigned int comp)

const ArrayMooseVariable *	getArrayVar (const std::string &var_name, unsigned int comp) const

void	validateExecutionerType (const std::string &name, const std::string &fn_name) const

std::vector< T >	coupledVectorHelper (const std::string &var_name, const Func &func) const

bool	isCoupledScalar (const std::string &var_name, unsigned int i=0) const

unsigned int	coupledScalarComponents (const std::string &var_name) const

unsigned int	coupledScalar (const std::string &var_name, unsigned int comp=0) const

libMesh::Order	coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarValue (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< is_ad > &	coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< false > &	coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const

const GenericVariableValue< true > &	coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const

const VariableValue &	coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const

const VariableValue &	coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const

const VariableValue &	coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDot (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const

const MooseVariableScalar *	getScalarVar (const std::string &var_name, unsigned int comp) const

virtual void	checkMaterialProperty (const std::string &name, const unsigned int state)

void	markMatPropRequested (const std::string &)

MaterialPropertyName	getMaterialPropertyName (const std::string &name) const

void	checkExecutionStage ()

virtual 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 PorousFlowDictator &	_dictator
	PorousFlowDictator UserObject. More...

const bool	_involves_fluid
	Whether this BC involves fluid (whether the user has supplied a fluid phase number) More...

const unsigned int	_ph
	The phase number. More...

const bool	_use_mass_fraction
	Whether the flux will be multiplied by the mass fraction. More...

const bool	_has_mass_fraction
	Whether there is a "mass_fraction" Material. This is just for error checking. More...

const unsigned int	_sp
	The component number (only used if _use_mass_fraction==true) More...

const bool	_use_mobility
	Whether to multiply the sink flux by permeability*density/viscosity. More...

const bool	_has_mobility
	Whether there are Materials that can form "mobility". This is just for error checking. More...

const bool	_use_relperm
	Whether to multiply the sink flux by relative permeability. More...

const bool	_has_relperm
	Whether there is a "relperm" Material. This is just for error checking. More...

const bool	_use_enthalpy
	Whether to multiply the sink flux by enthalpy. More...

const bool	_has_enthalpy
	Whether there is an "enthalpy" Material. This is just for error checking. More...

const bool	_use_internal_energy
	Whether to multiply the sink flux by internal_energy. More...

const bool	_has_internal_energy
	Whether there is an "internal_energy" Material. This is just for error checking. More...

const bool	_use_thermal_conductivity
	Whether to multiply the sink flux by thermal_conductivity. More...

const bool	_has_thermal_conductivity
	Whether there is an "thermal_conductivity" Material. This is just for error checking. More...

const Function &	_m_func
	The flux. More...

const MaterialProperty< RealTensorValue > *const	_permeability
	Permeability of porous material. More...

const MaterialProperty< std::vector< RealTensorValue > > *const	_dpermeability_dvar
	d(Permeability)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< std::vector< RealTensorValue > > > *const	_dpermeability_dgradvar
	d(Permeability)/d(grad(PorousFlow variable)) More...

const MaterialProperty< std::vector< Real > > *const	_fluid_density_node
	Fluid density for each phase (at the node) More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_dfluid_density_node_dvar
	d(Fluid density for each phase (at the node))/d(PorousFlow variable) More...

const MaterialProperty< std::vector< Real > > *const	_fluid_viscosity
	Viscosity of each component in each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_dfluid_viscosity_dvar
	d(Viscosity of each component in each phase)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< Real > > *const	_relative_permeability
	Relative permeability of each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_drelative_permeability_dvar
	d(Relative permeability of each phase)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_mass_fractions
	Mass fraction of each component in each phase. More...

const MaterialProperty< std::vector< std::vector< std::vector< Real > > > > *const	_dmass_fractions_dvar
	d(Mass fraction of each component in each phase)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< Real > > *const	_enthalpy
	Enthalpy of each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_denthalpy_dvar
	d(enthalpy of each phase)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< Real > > *const	_internal_energy
	Internal_Energy of each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_dinternal_energy_dvar
	d(internal_energy of each phase)/d(PorousFlow variable) More...

const MaterialProperty< RealTensorValue > *const	_thermal_conductivity
	Thermal_Conductivity of porous material. More...

const MaterialProperty< std::vector< RealTensorValue > > *const	_dthermal_conductivity_dvar
	d(Thermal_Conductivity)/d(PorousFlow variable) More...

const bool	_perm_derivs
	Flag to check whether permeabiity derivatives are non-zero. More...

MooseVariable &	_var

const MooseArray< Point > &	_normals

const VariablePhiValue &	_phi

const VariablePhiGradient &	_grad_phi

const VariableTestValue &	_test

const VariableTestGradient &	_grad_test

const VariableValue &	_u

const VariableGradient &	_grad_u

const Elem *const &	_current_elem

const Real &	_current_elem_volume

const unsigned int &	_current_side

const Elem *const &	_current_side_elem

const Real &	_current_side_volume

const BoundaryID &	_current_boundary_id

unsigned int	_qp

const QBase *const &	_qrule

const MooseArray< Point > &	_q_point

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

const bool	_skip_execution_outside_variable_domain

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

THREAD_ID	_tid

Assembly &	_assembly

MooseMesh &	_mesh

const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

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

GeometricSearchData &	_geometric_search_data

bool	_requires_geometric_search

const InputParameters &	_c_parameters

const std::string &	_c_name

const std::string &	_c_type

FEProblemBase &	_c_fe_problem

const SystemBase *const	_c_sys

std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> >	_coupled_vars

std::vector< MooseVariableFieldBase *>	_coupled_moose_vars

std::vector< MooseVariable *>	_coupled_standard_moose_vars

std::vector< VectorMooseVariable *>	_coupled_vector_moose_vars

std::vector< ArrayMooseVariable *>	_coupled_array_moose_vars

std::vector< MooseVariableFV< Real > *>	_coupled_standard_fv_moose_vars

std::vector< MooseLinearVariableFV< Real > *>	_coupled_standard_linear_fv_moose_vars

const std::unordered_map< std::string, std::string > &	_new_to_deprecated_coupled_vars

bool	_c_nodal

bool	_c_is_implicit

const bool	_c_allow_element_to_nodal_coupling

THREAD_ID	_c_tid

std::unordered_map< std::string, std::vector< std::unique_ptr< VariableValue > > >	_default_value

std::unordered_map< std::string, std::unique_ptr< MooseArray< ADReal > > >	_ad_default_value

std::unordered_map< std::string, std::unique_ptr< VectorVariableValue > >	_default_vector_value

std::unordered_map< std::string, std::unique_ptr< ArrayVariableValue > >	_default_array_value

std::unordered_map< std::string, std::unique_ptr< MooseArray< ADRealVectorValue > > >	_ad_default_vector_value

VariableValue	_default_value_zero

VariableGradient	_default_gradient

MooseArray< ADRealVectorValue >	_ad_default_gradient

MooseArray< ADRealTensorValue >	_ad_default_vector_gradient

VariableSecond	_default_second

MooseArray< ADRealTensorValue >	_ad_default_second

MooseArray< ADRealVectorValue >	_ad_default_curl

const VariableValue &	_zero

const VariablePhiValue &	_phi_zero

const MooseArray< ADReal > &	_ad_zero

const VariableGradient &	_grad_zero

const MooseArray< ADRealVectorValue > &	_ad_grad_zero

const VariablePhiGradient &	_grad_phi_zero

const VariableSecond &	_second_zero

const MooseArray< ADRealTensorValue > &	_ad_second_zero

const VariablePhiSecond &	_second_phi_zero

const VectorVariableValue &	_vector_zero

const VectorVariableCurl &	_vector_curl_zero

VectorVariableValue	_default_vector_value_zero

VectorVariableGradient	_default_vector_gradient

VectorVariableCurl	_default_vector_curl

VectorVariableDivergence	_default_div

ArrayVariableValue	_default_array_value_zero

ArrayVariableGradient	_default_array_gradient

bool	_coupleable_neighbor

FEProblemBase &	_sc_fe_problem

const THREAD_ID	_sc_tid

const Real &	_real_zero

const VariableValue &	_scalar_zero

const Point &	_point_zero

const InputParameters &	_mi_params

const std::string	_mi_name

const MooseObjectName	_mi_moose_object_name

FEProblemBase &	_mi_feproblem

SubProblem &	_mi_subproblem

const THREAD_ID	_mi_tid

const Moose::MaterialDataType	_material_data_type

MaterialData &	_material_data

bool	_stateful_allowed

bool	_get_material_property_called

std::vector< std::unique_ptr< PropertyValue > >	_default_properties

std::unordered_set< unsigned int >	_material_property_dependencies

const MaterialPropertyName	_get_suffix

const bool	_use_interpolated_state

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

Detailed Description

Applies a flux sink to a boundary.

The strength of the flux is specified by flux_function. In addition, this sink can be multiplied by: (1) the relative permeability of the fluid at the nodes (2) perm_nn*density/viscosity (the so-called mobility) where perm_nn is the permeability tensor projected to the normal direction. (3) the mass_fraction of a component at the nodes (4) the enthalpy of the phase (5) the internal energy of the phase (6) the thermal conductivity of the medium

Definition at line 29 of file PorousFlowSink.h.

Constructor & Destructor Documentation

◆ PorousFlowSink()

PorousFlowSink::PorousFlowSink ( const InputParameters & parameters )

Definition at line 79 of file PorousFlowSink.C.

   : IntegratedBC(parameters),
     _dictator(getUserObject<PorousFlowDictator>("PorousFlowDictator")),
     _involves_fluid(isParamValid("fluid_phase")),
     _ph(_involves_fluid ? getParam<unsigned int>("fluid_phase") : 0),
     _use_mass_fraction(isParamValid("mass_fraction_component")),
     _has_mass_fraction(
         hasMaterialProperty<std::vector<std::vector<Real>>>("PorousFlow_mass_frac_nodal") &&
         hasMaterialProperty<std::vector<std::vector<std::vector<Real>>>>(
             "dPorousFlow_mass_frac_nodal_dvar")),
     _sp(_use_mass_fraction ? getParam<unsigned int>("mass_fraction_component") : 0),
     _use_mobility(getParam<bool>("use_mobility")),
     _has_mobility(
         hasMaterialProperty<RealTensorValue>("PorousFlow_permeability_qp") &&
         hasMaterialProperty<std::vector<RealTensorValue>>("dPorousFlow_permeability_qp_dvar") &&
         hasMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_density_nodal") &&
         hasMaterialProperty<std::vector<std::vector<Real>>>(
             "dPorousFlow_fluid_phase_density_nodal_dvar") &&
         hasMaterialProperty<std::vector<Real>>("PorousFlow_viscosity_nodal") &&
         hasMaterialProperty<std::vector<std::vector<Real>>>("dPorousFlow_viscosity_nodal_dvar")),
     _use_relperm(getParam<bool>("use_relperm")),
     _has_relperm(hasMaterialProperty<std::vector<Real>>("PorousFlow_relative_permeability_nodal") &&
                  hasMaterialProperty<std::vector<std::vector<Real>>>(
                      "dPorousFlow_relative_permeability_nodal_dvar")),
     _use_enthalpy(getParam<bool>("use_enthalpy")),
     _has_enthalpy(hasMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_enthalpy_nodal") &&
                   hasMaterialProperty<std::vector<std::vector<Real>>>(
                       "dPorousFlow_fluid_phase_enthalpy_nodal_dvar")),
     _use_internal_energy(getParam<bool>("use_internal_energy")),
     _has_internal_energy(
         hasMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_internal_energy_nodal") &&
         hasMaterialProperty<std::vector<std::vector<Real>>>(
             "dPorousFlow_fluid_phase_internal_energy_nodal_dvar")),
     _use_thermal_conductivity(getParam<bool>("use_thermal_conductivity")),
     _has_thermal_conductivity(
         hasMaterialProperty<RealTensorValue>("PorousFlow_thermal_conductivity_qp") &&
         hasMaterialProperty<std::vector<RealTensorValue>>(
             "dPorousFlow_thermal_conductivity_qp_dvar")),
     _m_func(getFunction("flux_function")),
     _permeability(_has_mobility
                       ? &getMaterialProperty<RealTensorValue>("PorousFlow_permeability_qp")
                       : nullptr),
     _dpermeability_dvar(_has_mobility ? &getMaterialProperty<std::vector<RealTensorValue>>(
                                             "dPorousFlow_permeability_qp_dvar")
                                       : nullptr),
     _dpermeability_dgradvar(_has_mobility
                                 ? &getMaterialProperty<std::vector<std::vector<RealTensorValue>>>(
                                       "dPorousFlow_permeability_qp_dgradvar")
                                 : nullptr),
     _fluid_density_node(_has_mobility ? &getMaterialProperty<std::vector<Real>>(
                                             "PorousFlow_fluid_phase_density_nodal")
                                       : nullptr),
     _dfluid_density_node_dvar(_has_mobility ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                                   "dPorousFlow_fluid_phase_density_nodal_dvar")
                                             : nullptr),
     _fluid_viscosity(_has_mobility
                          ? &getMaterialProperty<std::vector<Real>>("PorousFlow_viscosity_nodal")
                          : nullptr),
     _dfluid_viscosity_dvar(_has_mobility ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                                "dPorousFlow_viscosity_nodal_dvar")
                                          : nullptr),
     _relative_permeability(_has_relperm ? &getMaterialProperty<std::vector<Real>>(
                                               "PorousFlow_relative_permeability_nodal")
                                         : nullptr),
     _drelative_permeability_dvar(_has_relperm
                                      ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                            "dPorousFlow_relative_permeability_nodal_dvar")
                                      : nullptr),
     _mass_fractions(_has_mass_fraction ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                              "PorousFlow_mass_frac_nodal")
                                        : nullptr),
     _dmass_fractions_dvar(_has_mass_fraction
                               ? &getMaterialProperty<std::vector<std::vector<std::vector<Real>>>>(
                                     "dPorousFlow_mass_frac_nodal_dvar")
                               : nullptr),
     _enthalpy(_has_enthalpy ? &getMaterialPropertyByName<std::vector<Real>>(
                                   "PorousFlow_fluid_phase_enthalpy_nodal")
                             : nullptr),
     _denthalpy_dvar(_has_enthalpy ? &getMaterialPropertyByName<std::vector<std::vector<Real>>>(
                                         "dPorousFlow_fluid_phase_enthalpy_nodal_dvar")
                                   : nullptr),
     _internal_energy(_has_internal_energy ? &getMaterialPropertyByName<std::vector<Real>>(
                                                 "PorousFlow_fluid_phase_internal_energy_nodal")
                                           : nullptr),
     _dinternal_energy_dvar(_has_internal_energy
                                ? &getMaterialPropertyByName<std::vector<std::vector<Real>>>(
                                      "dPorousFlow_fluid_phase_internal_energy_nodal_dvar")
                                : nullptr),
     _thermal_conductivity(_has_thermal_conductivity ? &getMaterialProperty<RealTensorValue>(
                                                           "PorousFlow_thermal_conductivity_qp")
                                                     : nullptr),
     _dthermal_conductivity_dvar(_has_thermal_conductivity
                                     ? &getMaterialProperty<std::vector<RealTensorValue>>(
                                           "dPorousFlow_thermal_conductivity_qp_dvar")
                                     : nullptr),
     _perm_derivs(_dictator.usePermDerivs())
 {
   if (_involves_fluid && _ph >= _dictator.numPhases())
     paramError("fluid_phase",
                "The Dictator proclaims that the maximum phase index in this simulation is ",
                _dictator.numPhases() - 1,
                " whereas you have used ",
                _ph,
                ". Remember that indexing starts at 0. You must try harder.");
 
   if (!_involves_fluid && (_use_mass_fraction || _use_mobility || _use_relperm || _use_enthalpy ||
                            _use_internal_energy))
     mooseError("PorousFlowSink: To use_mass_fraction, use_mobility, use_relperm, use_enthalpy or "
                "use_internal_energy, you must provide a fluid phase number");
 
   if (_use_mass_fraction && _sp >= _dictator.numComponents())
     paramError("mass_fraction_component",
                "The Dictator declares that the maximum fluid component index is ",
                _dictator.numComponents() - 1,
                ", but you have set mass_fraction_component to ",
                _sp,
                ". Remember that indexing starts at 0. Please be assured that the Dictator has "
                "noted your error.");
 
   if (_use_mass_fraction && !_has_mass_fraction)
     mooseError("PorousFlowSink: You have used the use_mass_fraction flag, but you have no "
                "mass_fraction Material");
 
   if (_use_mobility && !_has_mobility)
     mooseError("PorousFlowSink: You have used the use_mobility flag, but there are not the "
                "required Materials for this");
 
   if (_use_relperm && !_has_relperm)
     mooseError(
         "PorousFlowSink: You have used the use_relperm flag, but you have no relperm Material");
 
   if (_use_enthalpy && !_has_enthalpy)
     mooseError(
         "PorousFlowSink: You have used the use_enthalpy flag, but you have no enthalpy Material");
 
   if (_use_internal_energy && !_has_internal_energy)
     mooseError("PorousFlowSink: You have used the use_internal_energy flag, but you have no "
                "internal_energy Material");
 
   if (_use_thermal_conductivity && !_has_thermal_conductivity)
     mooseError("PorousFlowSink: You have used the use_thermal_conductivity flag, but you have no "
                "thermal_conductivity Material");
 }

Member Function Documentation

◆ computeQpJacobian()

Real PorousFlowSink::computeQpJacobian ( )

overrideprotectedvirtual

Reimplemented from IntegratedBC.

Definition at line 249 of file PorousFlowSink.C.

 {
   return jac(_var.number());
 }

◆ computeQpOffDiagJacobian()

Real PorousFlowSink::computeQpOffDiagJacobian ( unsigned int jvar )

overrideprotectedvirtual

Reimplemented from IntegratedBC.

Definition at line 255 of file PorousFlowSink.C.

 {
   return jac(jvar);
 }

◆ computeQpResidual()

Real PorousFlowSink::computeQpResidual ( )

overrideprotectedvirtual

Implements IntegratedBC.

Definition at line 224 of file PorousFlowSink.C.

 {
   Real flux = _test[_i][_qp] * multiplier();
   if (_use_mobility)
   {
     const Real k =
         ((*_permeability)[_qp] * _normals[_qp]) * _normals[_qp]; // do not upwind permeability
     flux *= (*_fluid_density_node)[_i][_ph] * k / (*_fluid_viscosity)[_i][_ph];
   }
   if (_use_relperm)
     flux *= (*_relative_permeability)[_i][_ph];
   if (_use_mass_fraction)
     flux *= (*_mass_fractions)[_i][_ph][_sp];
   if (_use_enthalpy)
     flux *= (*_enthalpy)[_i][_ph];
   if (_use_internal_energy)
     flux *= (*_internal_energy)[_i][_ph];
   if (_use_thermal_conductivity)
     flux *= ((*_thermal_conductivity)[_qp] * _normals[_qp]) *
             _normals[_qp]; // do not upwind thermal_conductivity
 
   return flux;
 }

◆ dmultiplier_dvar()

Real PorousFlowSink::dmultiplier_dvar ( unsigned int pvar ) const

protectedvirtual

d(multiplier)/d(Porous flow variable pvar)

Reimplemented in PorousFlowHalfCubicSink, PorousFlowHalfGaussianSink, and PorousFlowPiecewiseLinearSink.

Definition at line 343 of file PorousFlowSink.C.

Referenced by PorousFlowPiecewiseLinearSink::dmultiplier_dvar(), PorousFlowHalfGaussianSink::dmultiplier_dvar(), PorousFlowHalfCubicSink::dmultiplier_dvar(), and jac().

 {
   return 0.0;
 }

◆ jac()

Real PorousFlowSink::jac ( unsigned int jvar ) const

protected

Derivative of residual with respect to the jvar variable.

Definition at line 261 of file PorousFlowSink.C.

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

 {
   if (_dictator.notPorousFlowVariable(jvar))
     return 0.0;
   const unsigned int pvar = _dictator.porousFlowVariableNum(jvar);
 
   // For _i != _j, note:
   // since the only non-upwinded contribution to the residual is
   // from the permeability and thermal_conductivity, the only contribution
   // of the residual at node _i from changing jvar at node _j is through
   // the derivative of permeability or thermal_conductivity
 
   Real flux = _test[_i][_qp] * multiplier();
   Real deriv = _test[_i][_qp] * (_i != _j ? 0.0 : dmultiplier_dvar(pvar));
 
   if (_use_mobility)
   {
     const Real k = ((*_permeability)[_qp] * _normals[_qp]) * _normals[_qp];
     const Real mob = (*_fluid_density_node)[_i][_ph] * k / (*_fluid_viscosity)[_i][_ph];
 
     Real mobprime = 0.0;
     if (_perm_derivs)
     {
       RealTensorValue ktprime = (*_dpermeability_dvar)[_qp][pvar] * _phi[_j][_qp];
       for (const auto i : make_range(Moose::dim))
         ktprime += (*_dpermeability_dgradvar)[_qp][i][pvar] * _grad_phi[_j][_qp](i);
       const Real kprime = (ktprime * _normals[_qp]) * _normals[_qp];
 
       mobprime += (*_fluid_density_node)[_i][_ph] * kprime / (*_fluid_viscosity)[_i][_ph];
     }
 
     mobprime +=
         (_i != _j
              ? 0.0
              : (*_dfluid_density_node_dvar)[_i][_ph][pvar] * k / (*_fluid_viscosity)[_i][_ph] -
                    (*_fluid_density_node)[_i][_ph] * k * (*_dfluid_viscosity_dvar)[_i][_ph][pvar] /
                        std::pow((*_fluid_viscosity)[_i][_ph], 2));
     deriv = mob * deriv + mobprime * flux;
     flux *= mob;
   }
   if (_use_relperm)
   {
     const Real relperm_prime = (_i != _j ? 0.0 : (*_drelative_permeability_dvar)[_i][_ph][pvar]);
     deriv = (*_relative_permeability)[_i][_ph] * deriv + relperm_prime * flux;
     flux *= (*_relative_permeability)[_i][_ph];
   }
   if (_use_mass_fraction)
   {
     const Real mf_prime = (_i != _j ? 0.0 : (*_dmass_fractions_dvar)[_i][_ph][_sp][pvar]);
     deriv = (*_mass_fractions)[_i][_ph][_sp] * deriv + mf_prime * flux;
     flux *= (*_mass_fractions)[_i][_ph][_sp];
   }
   if (_use_enthalpy)
   {
     const Real en_prime = (_i != _j ? 0.0 : (*_denthalpy_dvar)[_i][_ph][pvar]);
     deriv = (*_enthalpy)[_i][_ph] * deriv + en_prime * flux;
     flux *= (*_enthalpy)[_i][_ph];
   }
   if (_use_internal_energy)
   {
     const Real ie_prime = (_i != _j ? 0.0 : (*_dinternal_energy_dvar)[_i][_ph][pvar]);
     deriv = (*_internal_energy)[_i][_ph] * deriv + ie_prime * flux;
     flux *= (*_internal_energy)[_i][_ph];
   }
   if (_use_thermal_conductivity)
   {
     const Real tc = ((*_thermal_conductivity)[_qp] * _normals[_qp]) * _normals[_qp];
     const RealTensorValue tctprime = (*_dthermal_conductivity_dvar)[_qp][pvar] * _phi[_j][_qp];
     const Real tcprime = (tctprime * _normals[_qp]) * _normals[_qp];
     deriv = tc * deriv + tcprime * flux;
     // don't need this: flux *= tc;
   }
   return deriv;
 }

◆ multiplier()

Real PorousFlowSink::multiplier ( ) const

protectedvirtual

The flux gets multiplied by this quantity.

Reimplemented in PorousFlowHalfCubicSink, PorousFlowHalfGaussianSink, and PorousFlowPiecewiseLinearSink.

Definition at line 337 of file PorousFlowSink.C.

Referenced by computeQpResidual(), PorousFlowPiecewiseLinearSink::dmultiplier_dvar(), PorousFlowHalfGaussianSink::dmultiplier_dvar(), PorousFlowHalfCubicSink::dmultiplier_dvar(), jac(), PorousFlowPiecewiseLinearSink::multiplier(), PorousFlowHalfGaussianSink::multiplier(), and PorousFlowHalfCubicSink::multiplier().

 {
   return _m_func.value(_t, _q_point[_qp]);
 }

◆ validParams()

InputParameters PorousFlowSink::validParams ( )

static

Definition at line 21 of file PorousFlowSink.C.

Referenced by PorousFlowSinkPTDefiner::validParams().

 {
   InputParameters params = IntegratedBC::validParams();
   params.addRequiredParam<UserObjectName>(
       "PorousFlowDictator", "The UserObject that holds the list of PorousFlow variable names");
   params.addParam<unsigned int>("fluid_phase",
                                 "If supplied, then this BC will potentially be a function of fluid "
                                 "pressure, and you can use mass_fraction_component, use_mobility, "
                                 "use_relperm, use_enthalpy and use_energy.  If not supplied, then "
                                 "this BC can only be a function of temperature");
   params.addParam<unsigned int>("mass_fraction_component",
                                 "The index corresponding to a fluid "
                                 "component.  If supplied, the flux will "
                                 "be multiplied by the nodal mass "
                                 "fraction for the component");
   params.addParam<bool>("use_mobility",
                         false,
                         "If true, then fluxes are multiplied by "
                         "(density*permeability_nn/viscosity), where the "
                         "'_nn' indicates the component normal to the "
                         "boundary.  In this case bare_flux is measured in "
                         "Pa.m^-1.  This can be used in conjunction with "
                         "other use_*");
   params.addParam<bool>("use_relperm",
                         false,
                         "If true, then fluxes are multiplied by relative "
                         "permeability.  This can be used in conjunction with "
                         "other use_*");
   params.addParam<bool>("use_enthalpy",
                         false,
                         "If true, then fluxes are multiplied by enthalpy.  "
                         "In this case bare_flux is measured in kg.m^-2.s^-1 "
                         "/ (J.kg).  This can be used in conjunction with "
                         "other use_*");
   params.addParam<bool>("use_internal_energy",
                         false,
                         "If true, then fluxes are multiplied by fluid internal energy. "
                         " In this case bare_flux is measured in kg.m^-2.s^-1 / (J.kg). "
                         " This can be used in conjunction with other use_*");
   params.addParam<bool>("use_thermal_conductivity",
                         false,
                         "If true, then fluxes are multiplied by "
                         "thermal conductivity projected onto "
                         "the normal direction.  This can be "
                         "used in conjunction with other use_*");
   params.addParam<FunctionName>(
       "flux_function",
       1.0,
       "The flux.  The flux is OUT of the medium: hence positive values of "
       "this function means this BC will act as a SINK, while negative values "
       "indicate this flux will be a SOURCE.  The functional form is useful "
       "for spatially or temporally varying sinks.  Without any use_*, this "
       "function is measured in kg.m^-2.s^-1 (or J.m^-2.s^-1 for the case "
       "with only heat and no fluids)");
   params.addClassDescription("Applies a flux sink to a boundary.");
   return params;
 }

Member Data Documentation

◆ _denthalpy_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowSink::_denthalpy_dvar

protected

d(enthalpy of each phase)/d(PorousFlow variable)

Definition at line 129 of file PorousFlowSink.h.

◆ _dfluid_density_node_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowSink::_dfluid_density_node_dvar

protected

d(Fluid density for each phase (at the node))/d(PorousFlow variable)

Definition at line 105 of file PorousFlowSink.h.

◆ _dfluid_viscosity_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowSink::_dfluid_viscosity_dvar

protected

d(Viscosity of each component in each phase)/d(PorousFlow variable)

Definition at line 111 of file PorousFlowSink.h.

◆ _dictator

const PorousFlowDictator& PorousFlowSink::_dictator

protected

PorousFlowDictator UserObject.

Definition at line 42 of file PorousFlowSink.h.

Referenced by jac(), and PorousFlowSink().

◆ _dinternal_energy_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowSink::_dinternal_energy_dvar

protected

d(internal_energy of each phase)/d(PorousFlow variable)

Definition at line 135 of file PorousFlowSink.h.

◆ _dmass_fractions_dvar

const MaterialProperty<std::vector<std::vector<std::vector<Real> > > >* const PorousFlowSink::_dmass_fractions_dvar

protected

d(Mass fraction of each component in each phase)/d(PorousFlow variable)

Definition at line 123 of file PorousFlowSink.h.

◆ _dpermeability_dgradvar

const MaterialProperty<std::vector<std::vector<RealTensorValue> > >* const PorousFlowSink::_dpermeability_dgradvar

protected

d(Permeability)/d(grad(PorousFlow variable))

Definition at line 99 of file PorousFlowSink.h.

Referenced by jac().

◆ _dpermeability_dvar

const MaterialProperty<std::vector<RealTensorValue> >* const PorousFlowSink::_dpermeability_dvar

protected

d(Permeability)/d(PorousFlow variable)

Definition at line 96 of file PorousFlowSink.h.

◆ _drelative_permeability_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowSink::_drelative_permeability_dvar

protected

d(Relative permeability of each phase)/d(PorousFlow variable)

Definition at line 117 of file PorousFlowSink.h.

◆ _dthermal_conductivity_dvar

const MaterialProperty<std::vector<RealTensorValue> >* const PorousFlowSink::_dthermal_conductivity_dvar

protected

d(Thermal_Conductivity)/d(PorousFlow variable)

Definition at line 141 of file PorousFlowSink.h.

◆ _enthalpy

const MaterialProperty<std::vector<Real> >* const PorousFlowSink::_enthalpy

protected

Enthalpy of each phase.

Definition at line 126 of file PorousFlowSink.h.

◆ _fluid_density_node

const MaterialProperty<std::vector<Real> >* const PorousFlowSink::_fluid_density_node

protected

Fluid density for each phase (at the node)

Definition at line 102 of file PorousFlowSink.h.

◆ _fluid_viscosity

const MaterialProperty<std::vector<Real> >* const PorousFlowSink::_fluid_viscosity

protected

Viscosity of each component in each phase.

Definition at line 108 of file PorousFlowSink.h.

Referenced by jac().

◆ _has_enthalpy

const bool PorousFlowSink::_has_enthalpy

protected

Whether there is an "enthalpy" Material. This is just for error checking.

Definition at line 75 of file PorousFlowSink.h.

Referenced by PorousFlowSink().

◆ _has_internal_energy

const bool PorousFlowSink::_has_internal_energy

protected

Whether there is an "internal_energy" Material. This is just for error checking.

Definition at line 81 of file PorousFlowSink.h.

Referenced by PorousFlowSink().

◆ _has_mass_fraction

const bool PorousFlowSink::_has_mass_fraction

protected

Whether there is a "mass_fraction" Material. This is just for error checking.

Definition at line 54 of file PorousFlowSink.h.

Referenced by PorousFlowSink().

◆ _has_mobility

const bool PorousFlowSink::_has_mobility

protected

Whether there are Materials that can form "mobility". This is just for error checking.

Definition at line 63 of file PorousFlowSink.h.

Referenced by PorousFlowSink().

◆ _has_relperm

const bool PorousFlowSink::_has_relperm

protected

Whether there is a "relperm" Material. This is just for error checking.

Definition at line 69 of file PorousFlowSink.h.

Referenced by PorousFlowSink().

◆ _has_thermal_conductivity

const bool PorousFlowSink::_has_thermal_conductivity

protected

Whether there is an "thermal_conductivity" Material. This is just for error checking.

Definition at line 87 of file PorousFlowSink.h.

Referenced by PorousFlowSink().

◆ _internal_energy

const MaterialProperty<std::vector<Real> >* const PorousFlowSink::_internal_energy

protected

Internal_Energy of each phase.

Definition at line 132 of file PorousFlowSink.h.

◆ _involves_fluid

const bool PorousFlowSink::_involves_fluid

protected

Whether this BC involves fluid (whether the user has supplied a fluid phase number)

Definition at line 45 of file PorousFlowSink.h.

Referenced by PorousFlowSinkPTDefiner::dptVar(), PorousFlowSink(), PorousFlowSinkPTDefiner::PorousFlowSinkPTDefiner(), and PorousFlowSinkPTDefiner::ptVar().

◆ _m_func

const Function& PorousFlowSink::_m_func

protected

The flux.

Definition at line 90 of file PorousFlowSink.h.

Referenced by multiplier().

◆ _mass_fractions

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowSink::_mass_fractions

protected

Mass fraction of each component in each phase.

Definition at line 120 of file PorousFlowSink.h.

◆ _perm_derivs

const bool PorousFlowSink::_perm_derivs

protected

Flag to check whether permeabiity derivatives are non-zero.

Definition at line 153 of file PorousFlowSink.h.

Referenced by jac().

◆ _permeability

const MaterialProperty<RealTensorValue>* const PorousFlowSink::_permeability

protected

Permeability of porous material.

Definition at line 93 of file PorousFlowSink.h.

◆ _ph

const unsigned int PorousFlowSink::_ph

protected

The phase number.

Definition at line 48 of file PorousFlowSink.h.

Referenced by computeQpResidual(), PorousFlowSinkPTDefiner::dptVar(), jac(), PorousFlowSink(), and PorousFlowSinkPTDefiner::ptVar().

◆ _relative_permeability

const MaterialProperty<std::vector<Real> >* const PorousFlowSink::_relative_permeability

protected

Relative permeability of each phase.

Definition at line 114 of file PorousFlowSink.h.

◆ _sp

const unsigned int PorousFlowSink::_sp

protected

The component number (only used if _use_mass_fraction==true)

Definition at line 57 of file PorousFlowSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowSink().

◆ _thermal_conductivity

const MaterialProperty<RealTensorValue>* const PorousFlowSink::_thermal_conductivity

protected

Thermal_Conductivity of porous material.

Definition at line 138 of file PorousFlowSink.h.

◆ _use_enthalpy

const bool PorousFlowSink::_use_enthalpy

protected

Whether to multiply the sink flux by enthalpy.

Definition at line 72 of file PorousFlowSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowSink().

◆ _use_internal_energy

const bool PorousFlowSink::_use_internal_energy

protected

Whether to multiply the sink flux by internal_energy.

Definition at line 78 of file PorousFlowSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowSink().

◆ _use_mass_fraction

const bool PorousFlowSink::_use_mass_fraction

protected

Whether the flux will be multiplied by the mass fraction.

Definition at line 51 of file PorousFlowSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowSink().

◆ _use_mobility

const bool PorousFlowSink::_use_mobility

protected

Whether to multiply the sink flux by permeability*density/viscosity.

Definition at line 60 of file PorousFlowSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowSink().

◆ _use_relperm

const bool PorousFlowSink::_use_relperm

protected

Whether to multiply the sink flux by relative permeability.

Definition at line 66 of file PorousFlowSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowSink().

◆ _use_thermal_conductivity

const bool PorousFlowSink::_use_thermal_conductivity

protected

Whether to multiply the sink flux by thermal_conductivity.

Definition at line 84 of file PorousFlowSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowSink().

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

porous_flow/include/bcs/PorousFlowSink.h
porous_flow/src/bcs/PorousFlowSink.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PorousFlowSink()

Member Function Documentation

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ dmultiplier_dvar()

◆ jac()

◆ multiplier()

◆ validParams()

Member Data Documentation

◆ _denthalpy_dvar

◆ _dfluid_density_node_dvar

◆ _dfluid_viscosity_dvar

◆ _dictator

◆ _dinternal_energy_dvar

◆ _dmass_fractions_dvar

◆ _dpermeability_dgradvar

◆ _dpermeability_dvar

◆ _drelative_permeability_dvar

◆ _dthermal_conductivity_dvar

◆ _enthalpy

◆ _fluid_density_node

◆ _fluid_viscosity

◆ _has_enthalpy

◆ _has_internal_energy

◆ _has_mass_fraction

◆ _has_mobility

◆ _has_relperm

◆ _has_thermal_conductivity

◆ _internal_energy

◆ _involves_fluid

◆ _m_func

◆ _mass_fractions

◆ _perm_derivs

◆ _permeability

◆ _ph

◆ _relative_permeability

◆ _sp

◆ _thermal_conductivity

◆ _use_enthalpy

◆ _use_internal_energy

◆ _use_mass_fraction

◆ _use_mobility

◆ _use_relperm

◆ _use_thermal_conductivity