Approximates a line sink by a sequence of Dirac Points. More...

#include <PorousFlowPolyLineSink.h>

Inheritance diagram for PorousFlowPolyLineSink:

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

typedef DataFileName	DataFileParameterType

Public Member Functions
	PorousFlowPolyLineSink (const InputParameters &parameters)

virtual void	initialSetup () override

virtual void	computeResidual () override

virtual void	computeJacobian () override

virtual void	computeOffDiagJacobian (unsigned int jvar) override

virtual const MooseVariableField< T > &	variable () const override

bool	hasPointsOnElem (const Elem *elem)

bool	isActiveAtPoint (const Elem *elem, const Point &p)

void	clearPoints ()

void	clearPointsCaches ()

virtual void	computeResidualAndJacobian ()

virtual void	computeOffDiagJacobianScalar (unsigned int)

virtual void	computeNonlocalJacobian ()

virtual void	computeNonlocalOffDiagJacobian (unsigned int)

const SubProblem &	subProblem () const

virtual void	prepareShapes (unsigned int var_num)

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 &	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 &name, const std::string *param=nullptr) const

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 ()

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)

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::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 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)

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

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)

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 (SubdomainID id) const

bool	hasBlocks (const std::vector< SubdomainID > &ids) const

bool	hasBlocks (const std::set< SubdomainID > &ids) const

bool	isBlockSubset (const std::set< SubdomainID > &ids) const

bool	isBlockSubset (const std::vector< SubdomainID > &ids) const

bool	hasBlockMaterialProperty (const std::string &prop_name)

const std::set< SubdomainID > &	meshBlockIDs () const

virtual bool	blockRestricted () const

virtual void	checkVariable (const MooseVariableFieldBase &variable) const

MooseVariableBase *	mooseVariableBase () const

MooseVariableField< T > &	mooseVariableField ()

MooseVariableFE< T > *	mooseVariable () const

MooseVariableFV< T > *	mooseVariableFV () const

MooseLinearVariableFV< T > *	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	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 ()

Public Attributes
const ConsoleStream	_console

Static Public Attributes
static constexpr PropertyValue::id_type	default_property_id

static constexpr PropertyValue::id_type	zero_property_id

Protected Types
enum	PorTchoice { PorTchoice::pressure, PorTchoice::temperature }
	whether the flux is a function of pressure or temperature More...

enum	PointNotFoundBehavior { PointNotFoundBehavior::ERROR, PointNotFoundBehavior::WARNING, PointNotFoundBehavior::IGNORE }

typedef std::map< unsigned, std::pair< const Elem *, Point > >	point_cache_t

typedef std::map< const Elem *, std::vector< std::pair< Point, unsigned > > >	reverse_cache_t

Protected Member Functions
virtual Real	computeQpBaseOutflow (unsigned current_dirac_ptid) const override
	Returns the flux from the line sink (before modification by mobility, etc). Derived classes should override this. More...

virtual void	computeQpBaseOutflowJacobian (unsigned jvar, unsigned current_dirac_ptid, Real &outflow, Real &outflowp) const override
	Calculates the BaseOutflow as well as its derivative wrt jvar. Derived classes should override this. More...

virtual Real	computeQpResidual () override

virtual Real	computeQpJacobian () override

virtual Real	computeQpOffDiagJacobian (unsigned int jvar) override

virtual void	addPoints () override
	Add Dirac Points to the borehole. More...

Real	jac (unsigned int jvar)
	Jacobian contribution for the derivative wrt the variable jvar. More...

Real	ptqp () const
	If _p_or_t==0, then returns the quadpoint porepressure, else returns the quadpoint temperature. More...

Real	dptqp (unsigned pvar) const
	If _p_or_t==0, then returns d(quadpoint porepressure)/d(PorousFlow variable), else returns d(quadpoint temperature)/d(PorousFlow variable) More...

virtual void	meshChanged () override
	regenerate points in each cell if using line_base More...

bool	parseNextLineReals (std::ifstream &ifs, std::vector< Real > &myvec)
	Reads a space-separated line of floats from ifs and puts in myvec. More...

void	addPoint (const Elem *elem, Point p, unsigned id=libMesh::invalid_uint)

const Elem *	addPoint (Point p, unsigned id=libMesh::invalid_uint)

unsigned	currentPointCachedID ()

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

Moose::StateArg	determineState () 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	addResidualsAndJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)

void	addJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)

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)

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

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

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

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

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

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

void	addMooseVariableDependency (MooseVariableFieldBase *var)

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

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

void	initializeBlockRestrictable (const MooseObject *moose_object)

Moose::CoordinateSystemType	getBlockCoordSystem ()

virtual const OutputTools< T >::VariableValue &	value ()

virtual const OutputTools< T >::VariableValue &	valueOld ()

virtual const OutputTools< T >::VariableValue &	valueOlder ()

virtual const OutputTools< T >::VariableValue &	dot ()

virtual const OutputTools< T >::VariableValue &	dotDot ()

virtual const OutputTools< T >::VariableValue &	dotOld ()

virtual const OutputTools< T >::VariableValue &	dotDotOld ()

virtual const VariableValue &	dotDu ()

virtual const VariableValue &	dotDotDu ()

virtual const OutputTools< T >::VariableGradient &	gradient ()

virtual const OutputTools< T >::VariableGradient &	gradientOld ()

virtual const OutputTools< T >::VariableGradient &	gradientOlder ()

virtual const OutputTools< T >::VariableSecond &	second ()

virtual const OutputTools< T >::VariableSecond &	secondOld ()

virtual const OutputTools< T >::VariableSecond &	secondOlder ()

virtual const OutputTools< T >::VariableTestSecond &	secondTest ()

virtual const OutputTools< T >::VariableTestSecond &	secondTestFace ()

virtual const OutputTools< T >::VariablePhiSecond &	secondPhi ()

virtual const OutputTools< T >::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)

const ReporterName &	getReporterName (const std::string &param_name) const

virtual void	addReporterDependencyHelper (const ReporterName &)

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

Protected Attributes
LinearInterpolation	_sink_func
	mass flux = _sink_func as a function of porepressure or temperature More...

const PorousFlowDictator &	_dictator
	PorousFlowDictator UserObject. More...

PorousFlowSumQuantity &	_total_outflow_mass
	This is used to hold the total fluid flowing into the line sink for each time step. More...

const bool	_has_porepressure
	Whether a quadpoint porepressure material exists (for error checking) More...

const bool	_has_temperature
	Whether a quadpoint temperature material exists (for error checking) More...

const bool	_has_mass_fraction
	Whether a mass_fraction material exists (for error checking) More...

const bool	_has_relative_permeability
	Whether a relative permeability material exists (for error checking) More...

const bool	_has_mobility
	Whether enough materials exist to form the mobility (for error checking) More...

const bool	_has_enthalpy
	Whether an enthalpy material exists (for error checking) More...

const bool	_has_internal_energy
	Whether an internal-energy material exists (for error checking) More...

enum PorousFlowLineSink::PorTchoice	_p_or_t

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

const bool	_use_relative_permeability
	Whether the flux will be multiplied by the relative permeability. More...

const bool	_use_mobility
	Whether the flux will be multiplied by the mobility. More...

const bool	_use_enthalpy
	Whether the flux will be multiplied by the enthalpy. More...

const bool	_use_internal_energy
	Whether the flux will be multiplied by the internal-energy. More...

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

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

const MaterialProperty< std::vector< Real > > *const	_pp
	Quadpoint pore pressure in each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_dpp_dvar
	d(quadpoint pore pressure in each phase)/d(PorousFlow variable) More...

const MaterialProperty< Real > *const	_temperature
	Quadpoint temperature. More...

const MaterialProperty< std::vector< Real > > *const	_dtemperature_dvar
	d(quadpoint temperature)/d(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 VariableValue &	_multiplying_var
	mass flux is multiplied by this variable evaluated at quadpoints More...

const Real	_line_length
	Line length. This is only used if there is only one borehole point. More...

const RealVectorValue	_line_direction
	Line direction. This is only used if there is only one borehole point. More...

const std::string	_point_file
	File defining the geometry of the borehole. More...

std::vector< Real >	_rs
	Radii of the borehole. More...

std::vector< Real >	_xs
	x points of the borehole More...

std::vector< Real >	_ys
	y points of the borehole More...

std::vector< Real >	_zs
	z points of borehole More...

Point	_bottom_point
	The bottom point of the borehole (where bottom_pressure is defined) More...

std::vector< Real >	_half_seg_len
	0.5*(length of polyline segments between points) More...

MooseVariableField< T > &	_var

const OutputTools< T >::VariablePhiValue &	_phi

const OutputTools< T >::VariablePhiGradient &	_grad_phi

const OutputTools< T >::VariableTestValue &	_test

const OutputTools< T >::VariableTestGradient &	_grad_test

const OutputTools< T >::VariableValue &	_u

const OutputTools< T >::VariableGradient &	_grad_u

const bool	_drop_duplicate_points

const Elem *const &	_current_elem

const Moose::CoordinateSystemType &	_coord_sys

DiracKernelInfo &	_dirac_kernel_info

DiracKernelInfo	_local_dirac_kernel_info

Point	_current_point

unsigned int	_qp

const MooseArray< Point > &	_q_point

const MooseArray< Point > &	_physical_point

const QBase *const &	_qrule

const MooseArray< Real > &	_JxW

unsigned int	_i

unsigned int	_j

const bool	_allow_moving_sources

point_cache_t	_point_cache

reverse_cache_t	_reverse_point_cache

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

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 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< DualReal > > >	_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

const VariableValue &	_zero

const VariablePhiValue &	_phi_zero

const MooseArray< DualReal > &	_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

GeometricSearchData &	_geometric_search_data

bool	_requires_geometric_search

const MaterialData *	_blk_material_data

bool	_nodal

MooseVariableFE< T > *	_variable

MooseVariableFV< T > *	_fv_variable

MooseLinearVariableFV< T > *	_linear_fv_variable

MooseVariableField< T > *	_field_variable

Assembly *	_mvi_assembly

const PointNotFoundBehavior	_point_not_found_behavior

const Parallel::Communicator &	_communicator


const std::vector< Real > *const	_x_coord

const std::vector< Real > *const	_y_coord

const std::vector< Real > *const	_z_coord

const std::vector< Real > *const	_weight

const bool	_usingReporter

Static Protected Attributes
static const std::string	_interpolated_old

static const std::string	_interpolated_older

Detailed Description

Approximates a line sink by a sequence of Dirac Points.

Definition at line 18 of file PorousFlowPolyLineSink.h.

Member Enumeration Documentation

◆ PorTchoice

enum PorousFlowLineSink::PorTchoice

strongprotectedinherited

whether the flux is a function of pressure or temperature

Enumerator
pressure
temperature

Definition at line 88 of file PorousFlowLineSink.h.

88 { pressure, temperature } _p_or_t;

NS::temperature

static const std::string temperature

Definition: NS.h:57

NS::pressure

static const std::string pressure

Definition: NS.h:56

PorousFlowLineSink::_p_or_t

enum PorousFlowLineSink::PorTchoice _p_or_t

Constructor & Destructor Documentation

◆ PorousFlowPolyLineSink()

PorousFlowPolyLineSink::PorousFlowPolyLineSink ( const InputParameters & parameters )

Definition at line 40 of file PorousFlowPolyLineSink.C.

   : PorousFlowLineSink(parameters),
     _sink_func(getParam<std::vector<Real>>("p_or_t_vals"), getParam<std::vector<Real>>("fluxes"))
 {
 }

Member Function Documentation

◆ addPoints()

void PorousFlowLineSink::addPoints ( )

overrideprotectedvirtualinherited

Add Dirac Points to the borehole.

Reimplemented from PorousFlowLineGeometry.

Definition at line 218 of file PorousFlowLineSink.C.

 {
   // This function gets called just before the DiracKernel is evaluated
   // so this is a handy place to zero this out.
   _total_outflow_mass.zero();
 
   PorousFlowLineGeometry::addPoints();
 }

◆ computeQpBaseOutflow()

Real PorousFlowPolyLineSink::computeQpBaseOutflow ( unsigned current_dirac_ptid ) const

overrideprotectedvirtual

Returns the flux from the line sink (before modification by mobility, etc). Derived classes should override this.

Implements PorousFlowLineSink.

Definition at line 47 of file PorousFlowPolyLineSink.C.

 {
   Real outflow = 0.0;
 
   if (current_dirac_ptid > 0)
     // contribution from half-segment "behind" this point (must have >1 point for
     // current_dirac_ptid>0)
     outflow += _half_seg_len[current_dirac_ptid - 1];
 
   if (current_dirac_ptid + 1 < _zs.size() || _zs.size() == 1)
     // contribution from half-segment "ahead of" this point, or we only have one point
     outflow += _half_seg_len[current_dirac_ptid];
 
   return outflow * _test[_i][_qp] * _sink_func.sample(ptqp()) * _weight->at(current_dirac_ptid);
 }

◆ computeQpBaseOutflowJacobian()

void PorousFlowPolyLineSink::computeQpBaseOutflowJacobian	(	unsigned	jvar,
		unsigned	current_dirac_ptid,
		Real &	outflow,
		Real &	outflowp
	)		const

overrideprotectedvirtual

Calculates the BaseOutflow as well as its derivative wrt jvar. Derived classes should override this.

Implements PorousFlowLineSink.

Definition at line 64 of file PorousFlowPolyLineSink.C.

 {
   outflow = 0.0;
   outflowp = 0.0;
 
   if (_dictator.notPorousFlowVariable(jvar))
     return;
   const unsigned pvar = _dictator.porousFlowVariableNum(jvar);
 
   if (current_dirac_ptid > 0)
     // contribution from half-segment "behind" this point (must have >1 point for
     // current_dirac_ptid>0)
     outflow += _half_seg_len[current_dirac_ptid - 1];
 
   if (current_dirac_ptid + 1 < _zs.size() || _zs.size() == 1)
     // contribution from half-segment "ahead of" this point, or we only have one point
     outflow += _half_seg_len[current_dirac_ptid];
 
   outflowp = outflow * _test[_i][_qp] * _sink_func.sampleDerivative(ptqp()) * dptqp(pvar) *
              _phi[_j][_qp] * _weight->at(current_dirac_ptid);
   outflow *= _test[_i][_qp] * _sink_func.sample(ptqp()) * _weight->at(current_dirac_ptid);
 }

◆ computeQpJacobian()

Real PorousFlowLineSink::computeQpJacobian ( )

overrideprotectedvirtualinherited

Reimplemented from DiracKernelTempl< class >.

Definition at line 261 of file PorousFlowLineSink.C.

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

◆ computeQpOffDiagJacobian()

Real PorousFlowLineSink::computeQpOffDiagJacobian ( unsigned int jvar )

overrideprotectedvirtualinherited

Reimplemented from DiracKernelTempl< class >.

Definition at line 267 of file PorousFlowLineSink.C.

 {
   return jac(jvar);
 }

◆ computeQpResidual()

Real PorousFlowLineSink::computeQpResidual ( )

overrideprotectedvirtualinherited

Implements DiracKernelTempl< class >.

Definition at line 228 of file PorousFlowLineSink.C.

 {
   // Get the ID we initially assigned to this point
   const unsigned current_dirac_ptid = currentPointCachedID();
   Real outflow = computeQpBaseOutflow(current_dirac_ptid);
   if (outflow == 0.0)
     return 0.0;
 
   outflow *= _multiplying_var[_qp];
 
   if (_use_relative_permeability)
     outflow *= (*_relative_permeability)[_i][_ph];
 
   if (_use_mobility)
     outflow *= (*_relative_permeability)[_i][_ph] * (*_fluid_density_node)[_i][_ph] /
                (*_fluid_viscosity)[_i][_ph];
 
   if (_use_mass_fraction)
     outflow *= (*_mass_fractions)[_i][_ph][_sp];
 
   if (_use_enthalpy)
     outflow *= (*_enthalpy)[_i][_ph];
 
   if (_use_internal_energy)
     outflow *= (*_internal_energy)[_i][_ph];
 
   _total_outflow_mass.add(
       outflow * _dt); // this is not thread safe, but DiracKernel's aren't currently threaded
 
   return outflow;
 }

◆ dptqp()

Real PorousFlowLineSink::dptqp ( unsigned pvar ) const

protectedinherited

If _p_or_t==0, then returns d(quadpoint porepressure)/d(PorousFlow variable), else returns d(quadpoint temperature)/d(PorousFlow variable)

Parameters

pvar	The PorousFlow variable number

Definition at line 347 of file PorousFlowLineSink.C.

Referenced by computeQpBaseOutflowJacobian(), and PorousFlowPeacemanBorehole::computeQpBaseOutflowJacobian().

 {
   return (_p_or_t == PorTchoice::pressure ? (*_dpp_dvar)[_qp][_ph][pvar]
                                           : (*_dtemperature_dvar)[_qp][pvar]);
 }

◆ initialSetup()

void PorousFlowLineGeometry::initialSetup ( )

overridevirtualinherited

Reimplemented from DiracKernelTempl< class >.

Reimplemented in PorousFlowPeacemanBorehole.

Definition at line 106 of file PorousFlowLineGeometry.C.

Referenced by PorousFlowPeacemanBorehole::initialSetup().

 {
   if (!_point_file.empty())
   {
     // open file
     std::ifstream file(_point_file.c_str());
     if (!file.good())
       paramError("point_file", "PorousFlowLineGeometry: Error opening file " + _point_file);
 
     // construct the arrays of weight, x, y and z
     std::vector<Real> scratch;
     while (parseNextLineReals(file, scratch))
     {
       if (scratch.size() >= 2)
       {
         _rs.push_back(scratch[0]);
         _xs.push_back(scratch[1]);
         if (scratch.size() >= 3)
           _ys.push_back(scratch[2]);
         else
           _ys.push_back(0.0);
         if (scratch.size() >= 4)
           _zs.push_back(scratch[3]);
         else
           _zs.push_back(0.0);
       }
     }
     file.close();
     calcLineLengths();
   }
   else if (_usingReporter)
   {
     if (_weight->size() != _x_coord->size() || _weight->size() != _y_coord->size() ||
         _weight->size() != _z_coord->size())
     {
       std::string errMsg =
           "The value and coordinate vectors are a different size.  \n"
           "There must be one value per coordinate.  If the sizes are \n"
           "zero, the reporter or reporter may not have been initialized with data \n"
           "before the Dirac Kernel is called.  \n"
           "Try setting \"execute_on = timestep_begin\" in the reporter being read. \n"
           "weight size = " +
           std::to_string(_weight->size()) +
           ";  x_coord size = " + std::to_string(_x_coord->size()) +
           ";  y_coord size = " + std::to_string(_y_coord->size()) +
           ";  z_coord size = " + std::to_string(_z_coord->size());
 
       mooseError(errMsg);
     }
 
     for (std::size_t i = 0; i < _x_coord->size(); ++i)
     {
       _rs.push_back(_weight->at(i));
       _xs.push_back(_x_coord->at(i));
       _ys.push_back(_y_coord->at(i));
       _zs.push_back(_z_coord->at(i));
     }
     calcLineLengths();
   }
   else
   {
     _line_base = getParam<std::vector<Real>>("line_base");
     if (_line_base.size() != _mesh.dimension() + 1)
       paramError("line_base",
                  "PorousFlowLineGeometry: wrong number of arguments - got ",
                  _line_base.size(),
                  ", expected ",
                  _mesh.dimension() + 1,
                  " '<weight> <x> [<y> [z]]'");
 
     for (size_t i = _line_base.size(); i < 4; i++)
       _line_base.push_back(0); // fill out zeros up to weight+3 dimensions
 
     // make sure line base point is inside the mesh
     Point start(_line_base[1], _line_base[2], _line_base[3]);
     Point end = start + _line_length * _line_direction / _line_direction.norm();
     auto pl = _subproblem.mesh().getPointLocator();
     pl->enable_out_of_mesh_mode();
 
     auto * elem = (*pl)(start);
     auto elem_id = elem ? elem->id() : DofObject::invalid_id;
     _communicator.min(elem_id);
     if (elem_id == DofObject::invalid_id)
       paramError("line_base", "base point ", start, " lies outside the mesh");
 
     elem = (*pl)(end);
     elem_id = elem ? elem->id() : DofObject::invalid_id;
     _communicator.min(elem_id);
     if (elem_id == DofObject::invalid_id)
       paramError("line_length", "length causes end point ", end, " to lie outside the mesh");
 
     regenPoints();
   }
 }

◆ jac()

Real PorousFlowLineSink::jac ( unsigned int jvar )

protectedinherited

Jacobian contribution for the derivative wrt the variable jvar.

Definition at line 273 of file PorousFlowLineSink.C.

Referenced by PorousFlowLineSink::computeQpJacobian(), and PorousFlowLineSink::computeQpOffDiagJacobian().

 {
   if (_dictator.notPorousFlowVariable(jvar))
     return 0.0;
   const unsigned pvar = _dictator.porousFlowVariableNum(jvar);
 
   Real outflow;
   Real outflowp;
   const unsigned current_dirac_ptid = currentPointCachedID();
   computeQpBaseOutflowJacobian(jvar, current_dirac_ptid, outflow, outflowp);
   if (outflow == 0.0 && outflowp == 0.0)
     return 0.0;
 
   outflow *= _multiplying_var[_qp];
   outflowp *= _multiplying_var[_qp];
 
   if (_use_relative_permeability)
   {
     const Real relperm_prime = (_i != _j ? 0.0 : (*_drelative_permeability_dvar)[_i][_ph][pvar]);
     outflowp = (*_relative_permeability)[_i][_ph] * outflowp + relperm_prime * outflow;
     outflow *= (*_relative_permeability)[_i][_ph];
   }
 
   if (_use_mobility)
   {
     const Real mob = (*_relative_permeability)[_i][_ph] * (*_fluid_density_node)[_i][_ph] /
                      (*_fluid_viscosity)[_i][_ph];
     const Real mob_prime =
         (_i != _j
              ? 0.0
              : (*_drelative_permeability_dvar)[_i][_ph][pvar] * (*_fluid_density_node)[_i][_ph] /
                        (*_fluid_viscosity)[_i][_ph] +
                    (*_relative_permeability)[_i][_ph] *
                        (*_dfluid_density_node_dvar)[_i][_ph][pvar] / (*_fluid_viscosity)[_i][_ph] -
                    (*_relative_permeability)[_i][_ph] * (*_fluid_density_node)[_i][_ph] *
                        (*_dfluid_viscosity_dvar)[_i][_ph][pvar] /
                        Utility::pow<2>((*_fluid_viscosity)[_i][_ph]));
     outflowp = mob * outflowp + mob_prime * outflow;
     outflow *= mob;
   }
 
   if (_use_mass_fraction)
   {
     const Real mass_fractions_prime =
         (_i != _j ? 0.0 : (*_dmass_fractions_dvar)[_i][_ph][_sp][pvar]);
     outflowp = (*_mass_fractions)[_i][_ph][_sp] * outflowp + mass_fractions_prime * outflow;
     outflow *= (*_mass_fractions)[_i][_ph][_sp];
   }
 
   if (_use_enthalpy)
   {
     const Real enthalpy_prime = (_i != _j ? 0.0 : (*_denthalpy_dvar)[_i][_ph][pvar]);
     outflowp = (*_enthalpy)[_i][_ph] * outflowp + enthalpy_prime * outflow;
     outflow *= (*_enthalpy)[_i][_ph];
   }
 
   if (_use_internal_energy)
   {
     const Real internal_energy_prime = (_i != _j ? 0.0 : (*_dinternal_energy_dvar)[_i][_ph][pvar]);
     outflowp = (*_internal_energy)[_i][_ph] * outflowp + internal_energy_prime * outflow;
     // this multiplication was performed, but the code does not need to know: outflow *=
     // (*_internal_energy)[_i][_ph];
   }
 
   return outflowp;
 }

◆ meshChanged()

void PorousFlowLineGeometry::meshChanged ( )

overrideprotectedvirtualinherited

regenerate points in each cell if using line_base

Reimplemented from DiracKernelTempl< class >.

Definition at line 285 of file PorousFlowLineGeometry.C.

 {
   DiracKernel::meshChanged();
   regenPoints();
 }

◆ parseNextLineReals()

bool PorousFlowLineGeometry::parseNextLineReals	(	std::ifstream &	ifs,
		std::vector< Real > &	myvec
	)

protectedinherited

Reads a space-separated line of floats from ifs and puts in myvec.

Definition at line 292 of file PorousFlowLineGeometry.C.

Referenced by PorousFlowLineGeometry::initialSetup().

 {
   std::string line;
   myvec.clear();
   bool gotline(false);
   if (getline(ifs, line))
   {
     gotline = true;
 
     // Harvest floats separated by whitespace
     std::istringstream iss(line);
     Real f;
     while (iss >> f)
     {
       myvec.push_back(f);
     }
   }
   return gotline;
 }

◆ ptqp()

Real PorousFlowLineSink::ptqp ( ) const

protectedinherited

If _p_or_t==0, then returns the quadpoint porepressure, else returns the quadpoint temperature.

Definition at line 341 of file PorousFlowLineSink.C.

Referenced by computeQpBaseOutflow(), PorousFlowPeacemanBorehole::computeQpBaseOutflow(), computeQpBaseOutflowJacobian(), and PorousFlowPeacemanBorehole::computeQpBaseOutflowJacobian().

 {
   return (_p_or_t == PorTchoice::pressure ? (*_pp)[_qp][_ph] : (*_temperature)[_qp]);
 }

◆ validParams()

InputParameters PorousFlowPolyLineSink::validParams ( )

static

Definition at line 15 of file PorousFlowPolyLineSink.C.

 {
   InputParameters params = PorousFlowLineSink::validParams();
   params.addRequiredParam<std::vector<Real>>(
       "p_or_t_vals",
       "Tuple of pressure (or temperature) values.  Must be monotonically increasing.");
   params.addRequiredParam<std::vector<Real>>(
       "fluxes",
       "Tuple of flux values (measured in kg.m^-1.s^-1 if no 'use_*' are employed).  "
       "These flux values are multiplied by the line-segment length to achieve a flux in "
       "kg.s^-1.  A piecewise-linear fit is performed to the (p_or_t_vals,flux) pairs to "
       "obtain the flux at any arbitrary pressure (or temperature).  If a quad-point "
       "pressure is less than the first pressure value, the first flux value is used.  If "
       "quad-point pressure exceeds the final pressure value, the final flux value is "
       "used.  This flux is OUT of the medium: hence positive values of flux means this "
       "will be a SINK, while negative values indicate this flux will be a SOURCE.");
   params.addClassDescription(
       "Approximates a polyline sink by using a number of point sinks with "
       "given weighting whose positions are read from a file.  NOTE: if you are using "
       "PorousFlowPorosity that depends on volumetric strain, you should set "
       "strain_at_nearest_qp=true in your GlobalParams, to ensure the nodal Porosity Material uses "
       "the volumetric strain at the Dirac quadpoints, and can therefore be computed");
   return params;
 }

Member Data Documentation

◆ _bottom_point

Point PorousFlowLineGeometry::_bottom_point

protectedinherited

The bottom point of the borehole (where bottom_pressure is defined)

Definition at line 61 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowLineGeometry::calcLineLengths(), PorousFlowPeacemanBorehole::computeQpBaseOutflow(), and PorousFlowPeacemanBorehole::computeQpBaseOutflowJacobian().

◆ _denthalpy_dvar

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

protectedinherited

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

Definition at line 151 of file PorousFlowLineSink.h.

◆ _dfluid_density_node_dvar

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

protectedinherited

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

Definition at line 127 of file PorousFlowLineSink.h.

◆ _dfluid_viscosity_dvar

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

protectedinherited

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

Definition at line 133 of file PorousFlowLineSink.h.

◆ _dictator

const PorousFlowDictator& PorousFlowLineSink::_dictator

protectedinherited

PorousFlowDictator UserObject.

Definition at line 57 of file PorousFlowLineSink.h.

Referenced by computeQpBaseOutflowJacobian(), PorousFlowPeacemanBorehole::computeQpBaseOutflowJacobian(), PorousFlowLineSink::jac(), and PorousFlowLineSink::PorousFlowLineSink().

◆ _dinternal_energy_dvar

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

protectedinherited

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

Definition at line 157 of file PorousFlowLineSink.h.

◆ _dmass_fractions_dvar

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

protectedinherited

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

Definition at line 145 of file PorousFlowLineSink.h.

◆ _dpp_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowLineSink::_dpp_dvar

protectedinherited

d(quadpoint pore pressure in each phase)/d(PorousFlow variable)

Definition at line 115 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::dptqp().

◆ _drelative_permeability_dvar

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

protectedinherited

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

Definition at line 139 of file PorousFlowLineSink.h.

◆ _dtemperature_dvar

const MaterialProperty<std::vector<Real> >* const PorousFlowLineSink::_dtemperature_dvar

protectedinherited

d(quadpoint temperature)/d(PorousFlow variable)

Definition at line 121 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::dptqp().

◆ _enthalpy

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

protectedinherited

Enthalpy of each phase.

Definition at line 148 of file PorousFlowLineSink.h.

◆ _fluid_density_node

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

protectedinherited

Fluid density for each phase (at the node)

Definition at line 124 of file PorousFlowLineSink.h.

◆ _fluid_viscosity

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

protectedinherited

Viscosity of each component in each phase.

Definition at line 130 of file PorousFlowLineSink.h.

◆ _half_seg_len

std::vector<Real> PorousFlowLineGeometry::_half_seg_len

protectedinherited

0.5*(length of polyline segments between points)

Definition at line 64 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowLineGeometry::calcLineLengths(), computeQpBaseOutflow(), PorousFlowPeacemanBorehole::computeQpBaseOutflow(), computeQpBaseOutflowJacobian(), and PorousFlowPeacemanBorehole::computeQpBaseOutflowJacobian().

◆ _has_enthalpy

const bool PorousFlowLineSink::_has_enthalpy

protectedinherited

Whether an enthalpy material exists (for error checking)

Definition at line 82 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::PorousFlowLineSink().

◆ _has_internal_energy

const bool PorousFlowLineSink::_has_internal_energy

protectedinherited

Whether an internal-energy material exists (for error checking)

Definition at line 85 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::PorousFlowLineSink().

◆ _has_mass_fraction

const bool PorousFlowLineSink::_has_mass_fraction

protectedinherited

Whether a mass_fraction material exists (for error checking)

Definition at line 73 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::PorousFlowLineSink().

◆ _has_mobility

const bool PorousFlowLineSink::_has_mobility

protectedinherited

Whether enough materials exist to form the mobility (for error checking)

Definition at line 79 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::PorousFlowLineSink().

◆ _has_porepressure

const bool PorousFlowLineSink::_has_porepressure

protectedinherited

Whether a quadpoint porepressure material exists (for error checking)

Definition at line 67 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::PorousFlowLineSink().

◆ _has_relative_permeability

const bool PorousFlowLineSink::_has_relative_permeability

protectedinherited

Whether a relative permeability material exists (for error checking)

Definition at line 76 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::PorousFlowLineSink().

◆ _has_temperature

const bool PorousFlowLineSink::_has_temperature

protectedinherited

Whether a quadpoint temperature material exists (for error checking)

Definition at line 70 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::PorousFlowLineSink().

◆ _internal_energy

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

protectedinherited

Internal_Energy of each phase.

Definition at line 154 of file PorousFlowLineSink.h.

◆ _line_direction

const RealVectorValue PorousFlowLineGeometry::_line_direction

protectedinherited

Line direction. This is only used if there is only one borehole point.

Definition at line 39 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowLineGeometry::initialSetup(), PorousFlowPeacemanBorehole::initialSetup(), and PorousFlowLineGeometry::regenPoints().

◆ _line_length

const Real PorousFlowLineGeometry::_line_length

protectedinherited

Line length. This is only used if there is only one borehole point.

Definition at line 36 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowLineGeometry::calcLineLengths(), PorousFlowLineGeometry::initialSetup(), and PorousFlowLineGeometry::regenPoints().

◆ _mass_fractions

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

protectedinherited

Mass fraction of each component in each phase.

Definition at line 142 of file PorousFlowLineSink.h.

◆ _multiplying_var

const VariableValue& PorousFlowLineSink::_multiplying_var

protectedinherited

mass flux is multiplied by this variable evaluated at quadpoints

Definition at line 160 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::computeQpResidual(), and PorousFlowLineSink::jac().

◆ _p_or_t

enum PorousFlowLineSink::PorTchoice PorousFlowLineSink::_p_or_t

protectedinherited

Referenced by PorousFlowLineSink::dptqp(), PorousFlowLineSink::PorousFlowLineSink(), PorousFlowPeacemanBorehole::PorousFlowPeacemanBorehole(), and PorousFlowLineSink::ptqp().

◆ _ph

const unsigned int PorousFlowLineSink::_ph

protectedinherited

The phase number.

Definition at line 106 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::computeQpResidual(), PorousFlowLineSink::dptqp(), PorousFlowLineSink::jac(), PorousFlowLineSink::PorousFlowLineSink(), and PorousFlowLineSink::ptqp().

◆ _point_file

const std::string PorousFlowLineGeometry::_point_file

protectedinherited

File defining the geometry of the borehole.

Each row has format weight x y z and the list of such points defines a polyline that is the line sink

Definition at line 46 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowLineGeometry::initialSetup(), PorousFlowPeacemanBorehole::initialSetup(), PorousFlowLineGeometry::PorousFlowLineGeometry(), and PorousFlowLineGeometry::regenPoints().

◆ _pp

const MaterialProperty<std::vector<Real> >* const PorousFlowLineSink::_pp

protectedinherited

Quadpoint pore pressure in each phase.

Definition at line 112 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::ptqp().

◆ _relative_permeability

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

protectedinherited

Relative permeability of each phase.

Definition at line 136 of file PorousFlowLineSink.h.

◆ _rs

std::vector<Real> PorousFlowLineGeometry::_rs

protectedinherited

Radii of the borehole.

Definition at line 49 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowLineGeometry::initialSetup(), and PorousFlowLineGeometry::regenPoints().

◆ _sink_func

LinearInterpolation PorousFlowPolyLineSink::_sink_func

protected

mass flux = _sink_func as a function of porepressure or temperature

Definition at line 27 of file PorousFlowPolyLineSink.h.

Referenced by computeQpBaseOutflow(), and computeQpBaseOutflowJacobian().

◆ _sp

const unsigned int PorousFlowLineSink::_sp

protectedinherited

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

Definition at line 109 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::computeQpResidual(), PorousFlowLineSink::jac(), and PorousFlowLineSink::PorousFlowLineSink().

◆ _temperature

const MaterialProperty<Real>* const PorousFlowLineSink::_temperature

protectedinherited

Quadpoint temperature.

Definition at line 118 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::ptqp().

◆ _total_outflow_mass

PorousFlowSumQuantity& PorousFlowLineSink::_total_outflow_mass

protectedinherited

This is used to hold the total fluid flowing into the line sink for each time step.

Hence, it is positive for production wells where fluid is flowing from porespace into the line sink (and hence removed from the model)

Definition at line 64 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::addPoints(), PorousFlowLineSink::computeQpResidual(), and PorousFlowLineSink::PorousFlowLineSink().

◆ _use_enthalpy

const bool PorousFlowLineSink::_use_enthalpy

protectedinherited

Whether the flux will be multiplied by the enthalpy.

Definition at line 100 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::computeQpResidual(), PorousFlowLineSink::jac(), and PorousFlowLineSink::PorousFlowLineSink().

◆ _use_internal_energy

const bool PorousFlowLineSink::_use_internal_energy

protectedinherited

Whether the flux will be multiplied by the internal-energy.

Definition at line 103 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::computeQpResidual(), PorousFlowLineSink::jac(), and PorousFlowLineSink::PorousFlowLineSink().

◆ _use_mass_fraction

const bool PorousFlowLineSink::_use_mass_fraction

protectedinherited

Whether the flux will be multiplied by the mass fraction.

Definition at line 91 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::computeQpResidual(), PorousFlowLineSink::jac(), and PorousFlowLineSink::PorousFlowLineSink().

◆ _use_mobility

const bool PorousFlowLineSink::_use_mobility

protectedinherited

Whether the flux will be multiplied by the mobility.

Definition at line 97 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::computeQpResidual(), PorousFlowLineSink::jac(), and PorousFlowLineSink::PorousFlowLineSink().

◆ _use_relative_permeability

const bool PorousFlowLineSink::_use_relative_permeability

protectedinherited

Whether the flux will be multiplied by the relative permeability.

Definition at line 94 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink::computeQpResidual(), PorousFlowLineSink::jac(), and PorousFlowLineSink::PorousFlowLineSink().

◆ _usingReporter

const bool PorousFlowLineGeometry::_usingReporter

protectedinherited

Definition at line 81 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowLineGeometry::initialSetup(), PorousFlowLineGeometry::PorousFlowLineGeometry(), and PorousFlowLineGeometry::regenPoints().

◆ _weight

const std::vector<Real>* const PorousFlowLineGeometry::_weight

protectedinherited

Definition at line 80 of file PorousFlowLineGeometry.h.

Referenced by computeQpBaseOutflow(), PorousFlowPeacemanBorehole::computeQpBaseOutflow(), computeQpBaseOutflowJacobian(), PorousFlowPeacemanBorehole::computeQpBaseOutflowJacobian(), and PorousFlowLineGeometry::initialSetup().

◆ _x_coord

const std::vector<Real>* const PorousFlowLineGeometry::_x_coord

protectedinherited

reporter input alternative (to the point file and line_base data)

Definition at line 77 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowLineGeometry::addPoints(), and PorousFlowLineGeometry::initialSetup().

◆ _xs

std::vector<Real> PorousFlowLineGeometry::_xs

protectedinherited

x points of the borehole

Definition at line 52 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowLineGeometry::calcLineLengths(), PorousFlowPeacemanBorehole::initialSetup(), PorousFlowLineGeometry::initialSetup(), and PorousFlowLineGeometry::regenPoints().

◆ _y_coord

const std::vector<Real>* const PorousFlowLineGeometry::_y_coord

protectedinherited

Definition at line 78 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowLineGeometry::addPoints(), and PorousFlowLineGeometry::initialSetup().

◆ _ys

std::vector<Real> PorousFlowLineGeometry::_ys

protectedinherited

y points of the borehole

Definition at line 55 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowLineGeometry::calcLineLengths(), PorousFlowPeacemanBorehole::initialSetup(), PorousFlowLineGeometry::initialSetup(), and PorousFlowLineGeometry::regenPoints().

◆ _z_coord

const std::vector<Real>* const PorousFlowLineGeometry::_z_coord

protectedinherited

Definition at line 79 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowLineGeometry::addPoints(), and PorousFlowLineGeometry::initialSetup().

◆ _zs

std::vector<Real> PorousFlowLineGeometry::_zs

protectedinherited

z points of borehole

Definition at line 58 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowLineGeometry::calcLineLengths(), computeQpBaseOutflow(), PorousFlowPeacemanBorehole::computeQpBaseOutflow(), computeQpBaseOutflowJacobian(), PorousFlowPeacemanBorehole::computeQpBaseOutflowJacobian(), PorousFlowPeacemanBorehole::initialSetup(), PorousFlowLineGeometry::initialSetup(), and PorousFlowLineGeometry::regenPoints().

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

porous_flow/include/dirackernels/PorousFlowPolyLineSink.h
porous_flow/src/dirackernels/PorousFlowPolyLineSink.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ PorTchoice

Constructor & Destructor Documentation

◆ PorousFlowPolyLineSink()

Member Function Documentation

◆ addPoints()

◆ computeQpBaseOutflow()

◆ computeQpBaseOutflowJacobian()

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ dptqp()

◆ initialSetup()

◆ jac()

◆ meshChanged()

◆ parseNextLineReals()

◆ ptqp()

◆ validParams()

Member Data Documentation

◆ _bottom_point

◆ _denthalpy_dvar

◆ _dfluid_density_node_dvar

◆ _dfluid_viscosity_dvar

◆ _dictator

◆ _dinternal_energy_dvar

◆ _dmass_fractions_dvar

◆ _dpp_dvar

◆ _drelative_permeability_dvar

◆ _dtemperature_dvar

◆ _enthalpy

◆ _fluid_density_node

◆ _fluid_viscosity

◆ _half_seg_len

◆ _has_enthalpy

◆ _has_internal_energy

◆ _has_mass_fraction

◆ _has_mobility

◆ _has_porepressure

◆ _has_relative_permeability

◆ _has_temperature

◆ _internal_energy

◆ _line_direction

◆ _line_length

◆ _mass_fractions

◆ _multiplying_var

◆ _p_or_t

◆ _ph

◆ _point_file

◆ _pp

◆ _relative_permeability

◆ _rs

◆ _sink_func

◆ _sp

◆ _temperature

◆ _total_outflow_mass

◆ _use_enthalpy

◆ _use_internal_energy

◆ _use_mass_fraction

◆ _use_mobility

◆ _use_relative_permeability

◆ _usingReporter

◆ _weight

◆ _x_coord

◆ _xs

◆ _y_coord

◆ _ys

◆ _z_coord

◆ _zs