Approximates a borehole by a sequence of Dirac Points. More...

#include <RichardsBorehole.h>

Inheritance diagram for RichardsBorehole:

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

typedef DataFileName	DataFileParameterType

Public Member Functions
	RichardsBorehole (const InputParameters &parameters)

virtual void	computeResidual ()
	Computes the residual. More...

virtual Real	computeQpResidual ()
	Computes the Qp residual. More...

virtual void	computeJacobian ()
	Computes the Jacobian. More...

virtual Real	computeQpJacobian ()
	Computes the diagonal part of the jacobian. More...

virtual Real	computeQpOffDiagJacobian (unsigned int jvar)
	Computes the off-diagonal part of the jacobian Note: at March2014 this is never called since moose does not have this functionality. More...

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

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

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 ()
	Creates a new RichardsBorehole This sets all the variables, but also reads the file containing the lines of the form radius x y z that defines the borehole geometry. More...

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	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
void	prepareNodalValues ()
	calculates the nodal values of pressure, mobility, and derivatives thereof More...

Real	jac (unsigned int wrt_num)
	Calculates Jacobian. More...

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

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

Real	wellConstant (const RealTensorValue &perm, const RealTensorValue &rot, const Real &half_len, const Elem *ele, const Real &rad)
	Calculates Peaceman's form of the borehole well constant Z Chen, Y Zhang, Well flow models for various numerical methods, Int J Num Analysis and Modeling, 3 (2008) 375-388. 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)

Protected Attributes
const bool	_fully_upwind
	Whether to use full upwinding. More...

const RichardsVarNames &	_richards_name_UO
	Defines the richards variables in the simulation. More...

const unsigned int	_num_p
	number of richards variables More...

const unsigned int	_pvar
	The moose internal variable number of the richards variable of this Dirac Kernel. More...

const RichardsDensity *const	_density_UO
	user object defining the density. Only used if _fully_upwind = true More...

const RichardsSeff *const	_seff_UO
	user object defining the effective saturation. Only used if _fully_upwind = true More...

const RichardsRelPerm *const	_relperm_UO
	user object defining the relative permeability. Only used if _fully_upwind = true More...

unsigned int	_num_nodes
	number of nodes in this element. Only used if _fully_upwind = true More...

std::vector< Real >	_mobility
	nodal values of mobility = density*relperm/viscosity These are used if _fully_upwind = true More...

std::vector< std::vector< Real > >	_dmobility_dv
	d(_mobility)/d(variable_ph) (variable_ph is the variable for phase=ph) These are used in the jacobian calculations if _fully_upwind = true More...

const MaterialProperty< std::vector< Real > > &	_pp
	fluid porepressure (or porepressures in case of multiphase) More...

const MaterialProperty< std::vector< std::vector< Real > > > &	_dpp_dv
	d(porepressure_i)/d(variable_j) More...

const MaterialProperty< std::vector< Real > > &	_viscosity
	fluid viscosity More...

const MaterialProperty< RealTensorValue > &	_permeability
	material permeability More...

const MaterialProperty< std::vector< std::vector< Real > > > &	_dseff_dv
	deriviatves of Seff wrt variables More...

const MaterialProperty< std::vector< Real > > &	_rel_perm
	relative permeability More...

const MaterialProperty< std::vector< std::vector< Real > > > &	_drel_perm_dv
	d(relperm_i)/d(variable_j) More...

const MaterialProperty< std::vector< Real > > &	_density
	fluid density More...

const MaterialProperty< std::vector< std::vector< Real > > > &	_ddensity_dv
	d(density_i)/d(variable_j) More...

std::vector< const VariableValue * >	_ps_at_nodes
	Holds the values of pressures at all the nodes of the element Only used if _fully_upwind = true Eg: _ps_at_nodes[_pvar] is a pointer to this variable's nodal porepressure values So: (*_ps_at_nodes[_pvar])[i] = _var.dofValues()[i] = porepressure of pressure-variable _pvar at node i. More...

const Function &	_character
	If positive then the borehole acts as a sink (producion well) for porepressure > borehole pressure, and does nothing otherwise If negative then the borehole acts as a source (injection well) for porepressure < borehole pressure, and does nothing otherwise The flow rate to/from the borehole is multiplied by \|character\|, so usually character = +/- 1. More...

const Real	_p_bot
	bottomhole pressure of borehole More...

const RealVectorValue	_unit_weight
	unit weight of fluid in borehole (for calculating bottomhole pressure at each Dirac Point) More...

RichardsSumQuantity &	_total_outflow_mass
	This is used to hold the total fluid flowing into the borehole Hence, it is positive for production wells where fluid is flowing from porespace into the borehole and removed from the model. 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...

std::vector< RealTensorValue >	_rot_matrix
	rotation matrix used in well_constant calculation 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

Static Protected Attributes
static const std::string	_interpolated_old

static const std::string	_interpolated_older

Detailed Description

Approximates a borehole by a sequence of Dirac Points.

Definition at line 22 of file RichardsBorehole.h.

Constructor & Destructor Documentation

◆ RichardsBorehole()

RichardsBorehole::RichardsBorehole ( const InputParameters & parameters )

Definition at line 40 of file RichardsBorehole.C.

   : PeacemanBorehole(parameters),
     _fully_upwind(getParam<bool>("fully_upwind")),
     _richards_name_UO(getUserObject<RichardsVarNames>("richardsVarNames_UO")),
     _num_p(_richards_name_UO.num_v()),
     _pvar(_richards_name_UO.richards_var_num(_var.number())),
 
     // in the following, getUserObjectByName returns a reference (an alias) to a RichardsBLAH user
     // object, and the & turns it into a pointer
     _density_UO(_fully_upwind ? &getUserObjectByName<RichardsDensity>(
                                     getParam<std::vector<UserObjectName>>("density_UO")[_pvar])
                               : NULL),
     _seff_UO(_fully_upwind ? &getUserObjectByName<RichardsSeff>(
                                  getParam<std::vector<UserObjectName>>("seff_UO")[_pvar])
                            : NULL),
     _relperm_UO(_fully_upwind ? &getUserObjectByName<RichardsRelPerm>(
                                     getParam<std::vector<UserObjectName>>("relperm_UO")[_pvar])
                               : NULL),
 
     _num_nodes(0),
     _mobility(0),
     _dmobility_dv(0),
     _pp(getMaterialProperty<std::vector<Real>>("porepressure")),
     _dpp_dv(getMaterialProperty<std::vector<std::vector<Real>>>("dporepressure_dv")),
     _viscosity(getMaterialProperty<std::vector<Real>>("viscosity")),
     _permeability(getMaterialProperty<RealTensorValue>("permeability")),
     _dseff_dv(getMaterialProperty<std::vector<std::vector<Real>>>("ds_eff_dv")),
     _rel_perm(getMaterialProperty<std::vector<Real>>("rel_perm")),
     _drel_perm_dv(getMaterialProperty<std::vector<std::vector<Real>>>("drel_perm_dv")),
     _density(getMaterialProperty<std::vector<Real>>("density")),
     _ddensity_dv(getMaterialProperty<std::vector<std::vector<Real>>>("ddensity_dv"))
 {
   _ps_at_nodes.resize(_num_p);
   for (unsigned int pnum = 0; pnum < _num_p; ++pnum)
     _ps_at_nodes[pnum] = _richards_name_UO.nodal_var(pnum);
 
   // To correctly compute the Jacobian terms,
   // tell MOOSE that this DiracKernel depends on all the Richards Vars
   const std::vector<MooseVariableFEBase *> & coupled_vars = _richards_name_UO.getCoupledMooseVars();
   for (unsigned int i = 0; i < coupled_vars.size(); i++)
     addMooseVariableDependency(coupled_vars[i]);
 }

Member Function Documentation

◆ addPoints()

void PeacemanBorehole::addPoints ( )

protectedvirtualinherited

Add Dirac Points to the borehole.

Implements DiracKernelTempl< class >.

Definition at line 179 of file PeacemanBorehole.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();
 
   // Add point using the unique ID "i", let the DiracKernel take
   // care of the caching.  This should be fast after the first call,
   // as long as the points don't move around.
   for (unsigned int i = 0; i < _zs.size(); i++)
     addPoint(Point(_xs[i], _ys[i], _zs[i]), i);
 }

◆ computeJacobian()

void RichardsBorehole::computeJacobian ( )

virtual

Computes the Jacobian.

This just calls prepareNodalValues, if _fully_upwind then calls DiracKernel::computeJacobian

Reimplemented from DiracKernelTempl< class >.

Definition at line 200 of file RichardsBorehole.C.

 {
   if (_fully_upwind)
     prepareNodalValues();
   DiracKernel::computeJacobian();
 }

◆ computeQpJacobian()

Real RichardsBorehole::computeQpJacobian ( )

virtual

Computes the diagonal part of the jacobian.

Reimplemented from DiracKernelTempl< class >.

Definition at line 208 of file RichardsBorehole.C.

 {
   const Real character = _character.value(_t, _q_point[_qp]);
   if (character == 0.0)
     return 0.0;
   return jac(_pvar);
 }

◆ computeQpOffDiagJacobian()

Real RichardsBorehole::computeQpOffDiagJacobian ( unsigned int jvar )

virtual

Computes the off-diagonal part of the jacobian Note: at March2014 this is never called since moose does not have this functionality.

Hence as of March2014 this has never been tested.

Reimplemented from DiracKernelTempl< class >.

Definition at line 217 of file RichardsBorehole.C.

 {
   if (_richards_name_UO.not_richards_var(jvar))
     return 0.0;
   const unsigned int dvar = _richards_name_UO.richards_var_num(jvar);
   return jac(dvar);
 }

◆ computeQpResidual()

Real RichardsBorehole::computeQpResidual ( )

virtual

Computes the Qp residual.

Implements DiracKernelTempl< class >.

Definition at line 132 of file RichardsBorehole.C.

 {
   const Real character = _character.value(_t, _q_point[_qp]);
   if (character == 0.0)
     return 0.0;
 
   const Real bh_pressure =
       _p_bot +
       _unit_weight *
           (_q_point[_qp] -
            _bottom_point); // really want to use _q_point instaed of _current_point, i think?!
 
   Real pp;
   Real mob;
   if (!_fully_upwind)
   {
     pp = _pp[_qp][_pvar];
     mob = _rel_perm[_qp][_pvar] * _density[_qp][_pvar] / _viscosity[_qp][_pvar];
   }
   else
   {
     pp = (*_ps_at_nodes[_pvar])[_i];
     mob = _mobility[_i];
   }
 
   // Get the ID we initially assigned to this point
   const unsigned current_dirac_ptid = currentPointCachedID();
 
   // If getting the ID failed, fall back to the old bodge!
   // if (current_dirac_ptid == libMesh::invalid_uint)
   //  current_dirac_ptid = (_zs.size() > 2) ? 1 : 0;
 
   Real outflow(0.0); // this is the flow rate from porespace out of the system
 
   Real wc(0.0);
   if (current_dirac_ptid > 0)
   // contribution from half-segment "behind" this point (must have >1 point for
   // current_dirac_ptid>0)
   {
     wc = wellConstant(_permeability[_qp],
                       _rot_matrix[current_dirac_ptid - 1],
                       _half_seg_len[current_dirac_ptid - 1],
                       _current_elem,
                       _rs[current_dirac_ptid]);
     if ((character < 0.0 && pp < bh_pressure) || (character > 0.0 && pp > bh_pressure))
       // injection, so outflow<0 || // production, so outflow>0
       outflow += _test[_i][_qp] * std::abs(character) * wc * mob * (pp - bh_pressure);
   }
 
   if (current_dirac_ptid + 1 < _zs.size() || _zs.size() == 1)
   // contribution from half-segment "ahead of" this point, or we only have one point
   {
     wc = wellConstant(_permeability[_qp],
                       _rot_matrix[current_dirac_ptid],
                       _half_seg_len[current_dirac_ptid],
                       _current_elem,
                       _rs[current_dirac_ptid]);
     if ((character < 0.0 && pp < bh_pressure) || (character > 0.0 && pp > bh_pressure))
       // injection, so outflow<0 || // production, so outflow>0
       outflow += _test[_i][_qp] * std::abs(character) * wc * mob * (pp - bh_pressure);
   }
 
   _total_outflow_mass.add(
       outflow * _dt); // this is not thread safe, but DiracKernel's aren't currently threaded
   return outflow;
 }

◆ computeResidual()

void RichardsBorehole::computeResidual ( )

virtual

Computes the residual.

This just calls prepareNodalValues, if _fully_upwind then calls DiracKernel::computeResidual

Reimplemented from DiracKernelTempl< class >.

Definition at line 124 of file RichardsBorehole.C.

 {
   if (_fully_upwind)
     prepareNodalValues();
   DiracKernel::computeResidual();
 }

◆ jac()

Real RichardsBorehole::jac ( unsigned int wrt_num )

protected

Calculates Jacobian.

Parameters

wrt_num differentiate the residual wrt this Richards variable

Definition at line 226 of file RichardsBorehole.C.

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

 {
   const Real character = _character.value(_t, _q_point[_qp]);
   if (character == 0.0)
     return 0.0;
 
   const Real bh_pressure =
       _p_bot +
       _unit_weight *
           (_q_point[_qp] -
            _bottom_point); // really want to use _q_point instaed of _current_point, i think?!
 
   Real pp;
   Real dpp_dv;
   Real mob;
   Real dmob_dv;
   Real phi;
   if (!_fully_upwind)
   {
     pp = _pp[_qp][_pvar];
     dpp_dv = _dpp_dv[_qp][_pvar][wrt_num];
     mob = _rel_perm[_qp][_pvar] * _density[_qp][_pvar] / _viscosity[_qp][_pvar];
     dmob_dv = (_drel_perm_dv[_qp][_pvar][wrt_num] * _density[_qp][_pvar] +
                _rel_perm[_qp][_pvar] * _ddensity_dv[_qp][_pvar][wrt_num]) /
               _viscosity[_qp][_pvar];
     phi = _phi[_j][_qp];
   }
   else
   {
     if (_i != _j)
       return 0.0; // residual at node _i only depends on variables at that node
     pp = (*_ps_at_nodes[_pvar])[_i];
     dpp_dv =
         (_pvar == wrt_num ? 1 : 0); // NOTE: i'm assuming that the variables are pressure variables
     mob = _mobility[_i];
     dmob_dv = _dmobility_dv[_i][wrt_num];
     phi = 1;
   }
 
   // Get the ID we initially assigned to this point
   const unsigned current_dirac_ptid = currentPointCachedID();
 
   // If getting the ID failed, fall back to the old bodge!
   // if (current_dirac_ptid == libMesh::invalid_uint)
   //  current_dirac_ptid = (_zs.size() > 2) ? 1 : 0;
 
   Real outflowp(0.0);
 
   Real wc(0.0);
   if (current_dirac_ptid > 0)
   // contribution from half-segment "behind" this point
   {
     wc = wellConstant(_permeability[_qp],
                       _rot_matrix[current_dirac_ptid - 1],
                       _half_seg_len[current_dirac_ptid - 1],
                       _current_elem,
                       _rs[current_dirac_ptid]);
     if ((character < 0.0 && pp < bh_pressure) || (character > 0.0 && pp > bh_pressure))
       // injection, so outflow<0 || // production, so outflow>0
       outflowp += _test[_i][_qp] * std::abs(character) * wc *
                   (mob * phi * dpp_dv + dmob_dv * phi * (pp - bh_pressure));
   }
 
   if (current_dirac_ptid < _zs.size() - 1 || _zs.size() == 1)
   // contribution from half-segment "ahead of" this point
   {
     wc = wellConstant(_permeability[_qp],
                       _rot_matrix[current_dirac_ptid],
                       _half_seg_len[current_dirac_ptid],
                       _current_elem,
                       _rs[current_dirac_ptid]);
     if ((character < 0.0 && pp < bh_pressure) || (character > 0.0 && pp > bh_pressure))
       // injection, so outflow<0 || // production, so outflow>0
       outflowp += _test[_i][_qp] * std::abs(character) * wc *
                   (mob * phi * dpp_dv + dmob_dv * phi * (pp - bh_pressure));
   }
 
   return outflowp;
 }

◆ parseNextLineReals()

bool PeacemanBorehole::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 157 of file PeacemanBorehole.C.

Referenced by PeacemanBorehole::PeacemanBorehole().

 {
   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;
 }

◆ prepareNodalValues()

void RichardsBorehole::prepareNodalValues ( )

protected

calculates the nodal values of pressure, mobility, and derivatives thereof

Definition at line 84 of file RichardsBorehole.C.

Referenced by computeJacobian(), and computeResidual().

 {
   // NOTE: i'm assuming that all the richards variables are pressure values
 
   _num_nodes = (*_ps_at_nodes[_pvar]).size();
 
   Real p;
   Real density;
   Real ddensity_dp;
   Real seff;
   std::vector<Real> dseff_dp;
   Real relperm;
   Real drelperm_ds;
   _mobility.resize(_num_nodes);
   _dmobility_dv.resize(_num_nodes);
   dseff_dp.resize(_num_p);
   for (unsigned int nodenum = 0; nodenum < _num_nodes; ++nodenum)
   {
     // retrieve and calculate basic things at the node
     p = (*_ps_at_nodes[_pvar])[nodenum];    // pressure of fluid _pvar at node nodenum
     density = _density_UO->density(p);      // density of fluid _pvar at node nodenum
     ddensity_dp = _density_UO->ddensity(p); // d(density)/dP
     seff = _seff_UO->seff(_ps_at_nodes,
                           nodenum); // effective saturation of fluid _pvar at node nodenum
     _seff_UO->dseff(
         _ps_at_nodes, nodenum, dseff_dp); // d(seff)/d(P_ph), for ph = 0, ..., _num_p - 1
     relperm = _relperm_UO->relperm(seff); // relative permeability of fluid _pvar at node nodenum
     drelperm_ds = _relperm_UO->drelperm(seff); // d(relperm)/dseff
 
     // calculate the mobility and its derivatives wrt (variable_ph = porepressure_ph)
     _mobility[nodenum] =
         density * relperm / _viscosity[0][_pvar]; // assume viscosity is constant throughout element
     _dmobility_dv[nodenum].resize(_num_p);
     for (unsigned int ph = 0; ph < _num_p; ++ph)
       _dmobility_dv[nodenum][ph] = density * drelperm_ds * dseff_dp[ph] / _viscosity[0][_pvar];
     _dmobility_dv[nodenum][_pvar] += ddensity_dp * relperm / _viscosity[0][_pvar];
   }
 }

◆ validParams()

InputParameters RichardsBorehole::validParams ( )

static

Creates a new RichardsBorehole This sets all the variables, but also reads the file containing the lines of the form radius x y z that defines the borehole geometry.

It also calculates segment-lengths and rotation matrices needed for computing the borehole well constant

Definition at line 16 of file RichardsBorehole.C.

 {
   InputParameters params = PeacemanBorehole::validParams();
   params.addRequiredParam<UserObjectName>(
       "richardsVarNames_UO", "The UserObject that holds the list of Richards variable names.");
   params.addParam<std::vector<UserObjectName>>("relperm_UO",
                                                "List of names of user objects that "
                                                "define relative permeability.  Only "
                                                "needed if fully_upwind is used");
   params.addParam<std::vector<UserObjectName>>(
       "seff_UO",
       "List of name of user objects that define effective saturation as a function of "
       "pressure list.  Only needed if fully_upwind is used");
   params.addParam<std::vector<UserObjectName>>("density_UO",
                                                "List of names of user objects that "
                                                "define the fluid density.  Only "
                                                "needed if fully_upwind is used");
   params.addParam<bool>("fully_upwind", false, "Fully upwind the flux");
   params.addClassDescription("Approximates a borehole in the mesh with given bottomhole pressure, "
                              "and radii using a number of point sinks whose positions are read "
                              "from a file");
   return params;
 }

◆ wellConstant()

Real PeacemanBorehole::wellConstant	(	const RealTensorValue &	perm,
		const RealTensorValue &	rot,
		const Real &	half_len,
		const Elem *	ele,
		const Real &	rad
	)

protectedinherited

Calculates Peaceman's form of the borehole well constant Z Chen, Y Zhang, Well flow models for various numerical methods, Int J Num Analysis and Modeling, 3 (2008) 375-388.

Definition at line 193 of file PeacemanBorehole.C.

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

 {
   if (_well_constant > 0)
     return _well_constant;
 
   // rot_perm has its "2" component lying along the half segment
   // we want to determine the eigenvectors of rot(0:1, 0:1), since, when
   // rotated back to the original frame we will determine the element
   // lengths along these directions
   const RealTensorValue rot_perm = (rot * perm) * rot.transpose();
   const Real trace2D = rot_perm(0, 0) + rot_perm(1, 1);
   const Real det2D = rot_perm(0, 0) * rot_perm(1, 1) - rot_perm(0, 1) * rot_perm(1, 0);
   const Real sq = std::sqrt(std::max(0.25 * trace2D * trace2D - det2D,
                                      0.0)); // the std::max accounts for wierdo precision loss
   const Real eig_val1 = 0.5 * trace2D + sq;
   const Real eig_val2 = 0.5 * trace2D - sq;
   RealVectorValue eig_vec1, eig_vec2;
   if (sq > std::abs(trace2D) * 1E-7) // matrix is not a multiple of the identity (1E-7 accounts for
                                      // precision in a crude way)
   {
     if (rot_perm(1, 0) != 0)
     {
       eig_vec1(0) = eig_val1 - rot_perm(1, 1);
       eig_vec1(1) = rot_perm(1, 0);
       eig_vec2(0) = eig_val2 - rot_perm(1, 1);
       eig_vec2(1) = rot_perm(1, 0);
     }
     else if (rot_perm(0, 1) != 0)
     {
       eig_vec1(0) = rot_perm(0, 1);
       eig_vec1(1) = eig_val1 - rot_perm(0, 0);
       eig_vec2(0) = rot_perm(0, 1);
       eig_vec2(1) = eig_val2 - rot_perm(0, 0);
     }
     else // off diagonal terms are both zero
     {
       eig_vec1(0) = 1;
       eig_vec2(1) = 1;
     }
   }
   else // matrix is basically a multiple of the identity
   {
     eig_vec1(0) = 1;
     eig_vec2(1) = 1;
   }
 
   // finally, rotate these to original frame and normalise
   eig_vec1 = rot.transpose() * eig_vec1;
   eig_vec1 /= std::sqrt(eig_vec1 * eig_vec1);
   eig_vec2 = rot.transpose() * eig_vec2;
   eig_vec2 /= std::sqrt(eig_vec2 * eig_vec2);
 
   // find the "length" of the element in these directions
   // TODO - probably better to use variance than max&min
   Real max1 = eig_vec1 * ele->point(0);
   Real max2 = eig_vec2 * ele->point(0);
   Real min1 = max1;
   Real min2 = max2;
   Real proj;
   for (unsigned int i = 1; i < ele->n_nodes(); i++)
   {
     proj = eig_vec1 * ele->point(i);
     max1 = (max1 < proj) ? proj : max1;
     min1 = (min1 < proj) ? min1 : proj;
 
     proj = eig_vec2 * ele->point(i);
     max2 = (max2 < proj) ? proj : max2;
     min2 = (min2 < proj) ? min2 : proj;
   }
   const Real ll1 = max1 - min1;
   const Real ll2 = max2 - min2;
 
   const Real r0 = _re_constant *
                   std::sqrt(std::sqrt(eig_val1 / eig_val2) * std::pow(ll2, 2) +
                             std::sqrt(eig_val2 / eig_val1) * std::pow(ll1, 2)) /
                   (std::pow(eig_val1 / eig_val2, 0.25) + std::pow(eig_val2 / eig_val1, 0.25));
 
   const Real effective_perm = std::sqrt(det2D);
 
   const Real halfPi = acos(0.0);
 
   if (r0 <= rad)
     mooseError("The effective element size (about 0.2-times-true-ele-size) for an element "
                "containing a Peaceman-type borehole must be (much) larger than the borehole radius "
                "for the Peaceman formulation to be correct.  Your element has effective size ",
                r0,
                " and the borehole radius is ",
                rad,
                "\n");
 
   return 4 * halfPi * effective_perm * half_len / std::log(r0 / rad);
 }

Member Data Documentation

◆ _bottom_point

Point PeacemanBorehole::_bottom_point

protectedinherited

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

Definition at line 91 of file PeacemanBorehole.h.

Referenced by Q2PBorehole::computeQpResidual(), computeQpResidual(), Q2PBorehole::jac(), jac(), and PeacemanBorehole::PeacemanBorehole().

◆ _character

const Function& PeacemanBorehole::_character

protectedinherited

If positive then the borehole acts as a sink (producion well) for porepressure > borehole pressure, and does nothing otherwise If negative then the borehole acts as a source (injection well) for porepressure < borehole pressure, and does nothing otherwise The flow rate to/from the borehole is multiplied by |character|, so usually character = +/- 1.

Definition at line 63 of file PeacemanBorehole.h.

Referenced by computeQpJacobian(), Q2PBorehole::computeQpResidual(), computeQpResidual(), Q2PBorehole::jac(), and jac().

◆ _ddensity_dv

const MaterialProperty<std::vector<std::vector<Real> > >& RichardsBorehole::_ddensity_dv

protected

d(density_i)/d(variable_j)

Definition at line 132 of file RichardsBorehole.h.

Referenced by jac().

◆ _density

const MaterialProperty<std::vector<Real> >& RichardsBorehole::_density

protected

fluid density

Definition at line 129 of file RichardsBorehole.h.

Referenced by computeQpResidual(), and jac().

◆ _density_UO

const RichardsDensity* const RichardsBorehole::_density_UO

protected

user object defining the density. Only used if _fully_upwind = true

Definition at line 84 of file RichardsBorehole.h.

Referenced by prepareNodalValues().

◆ _dmobility_dv

std::vector<std::vector<Real> > RichardsBorehole::_dmobility_dv

protected

d(_mobility)/d(variable_ph) (variable_ph is the variable for phase=ph) These are used in the jacobian calculations if _fully_upwind = true

Definition at line 105 of file RichardsBorehole.h.

Referenced by jac(), and prepareNodalValues().

◆ _dpp_dv

const MaterialProperty<std::vector<std::vector<Real> > >& RichardsBorehole::_dpp_dv

protected

d(porepressure_i)/d(variable_j)

Definition at line 111 of file RichardsBorehole.h.

Referenced by jac().

◆ _drel_perm_dv

const MaterialProperty<std::vector<std::vector<Real> > >& RichardsBorehole::_drel_perm_dv

protected

d(relperm_i)/d(variable_j)

Definition at line 126 of file RichardsBorehole.h.

Referenced by jac().

◆ _dseff_dv

const MaterialProperty<std::vector<std::vector<Real> > >& RichardsBorehole::_dseff_dv

protected

deriviatves of Seff wrt variables

Definition at line 120 of file RichardsBorehole.h.

◆ _fully_upwind

const bool RichardsBorehole::_fully_upwind

protected

Whether to use full upwinding.

Definition at line 72 of file RichardsBorehole.h.

Referenced by computeJacobian(), computeQpResidual(), computeResidual(), and jac().

◆ _half_seg_len

std::vector<Real> PeacemanBorehole::_half_seg_len

protectedinherited

0.5*(length of polyline segments between points)

Definition at line 94 of file PeacemanBorehole.h.

Referenced by Q2PBorehole::computeQpResidual(), computeQpResidual(), Q2PBorehole::jac(), jac(), and PeacemanBorehole::PeacemanBorehole().

◆ _mobility

std::vector<Real> RichardsBorehole::_mobility

protected

nodal values of mobility = density*relperm/viscosity These are used if _fully_upwind = true

Definition at line 99 of file RichardsBorehole.h.

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

◆ _num_nodes

unsigned int RichardsBorehole::_num_nodes

protected

number of nodes in this element. Only used if _fully_upwind = true

Definition at line 93 of file RichardsBorehole.h.

Referenced by prepareNodalValues().

◆ _num_p

const unsigned int RichardsBorehole::_num_p

protected

number of richards variables

Definition at line 78 of file RichardsBorehole.h.

Referenced by prepareNodalValues(), and RichardsBorehole().

◆ _p_bot

const Real PeacemanBorehole::_p_bot

protectedinherited

bottomhole pressure of borehole

Definition at line 66 of file PeacemanBorehole.h.

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

◆ _permeability

const MaterialProperty<RealTensorValue>& RichardsBorehole::_permeability

protected

material permeability

Definition at line 117 of file RichardsBorehole.h.

Referenced by computeQpResidual(), and jac().

◆ _pp

const MaterialProperty<std::vector<Real> >& RichardsBorehole::_pp

protected

fluid porepressure (or porepressures in case of multiphase)

Definition at line 108 of file RichardsBorehole.h.

Referenced by computeQpResidual(), and jac().

◆ _ps_at_nodes

std::vector<const VariableValue *> RichardsBorehole::_ps_at_nodes

protected

Holds the values of pressures at all the nodes of the element Only used if _fully_upwind = true Eg: _ps_at_nodes[_pvar] is a pointer to this variable's nodal porepressure values So: (*_ps_at_nodes[_pvar])[i] = _var.dofValues()[i] = porepressure of pressure-variable _pvar at node i.

Definition at line 142 of file RichardsBorehole.h.

Referenced by computeQpResidual(), jac(), prepareNodalValues(), and RichardsBorehole().

◆ _pvar

const unsigned int RichardsBorehole::_pvar

protected

The moose internal variable number of the richards variable of this Dirac Kernel.

Definition at line 81 of file RichardsBorehole.h.

Referenced by computeQpJacobian(), computeQpResidual(), jac(), and prepareNodalValues().

◆ _rel_perm

const MaterialProperty<std::vector<Real> >& RichardsBorehole::_rel_perm

protected

relative permeability

Definition at line 123 of file RichardsBorehole.h.

Referenced by computeQpResidual(), and jac().

◆ _relperm_UO

const RichardsRelPerm* const RichardsBorehole::_relperm_UO

protected

user object defining the relative permeability. Only used if _fully_upwind = true

Definition at line 90 of file RichardsBorehole.h.

Referenced by prepareNodalValues().

◆ _richards_name_UO

const RichardsVarNames& RichardsBorehole::_richards_name_UO

protected

Defines the richards variables in the simulation.

Definition at line 75 of file RichardsBorehole.h.

Referenced by computeQpOffDiagJacobian(), and RichardsBorehole().

◆ _rot_matrix

std::vector<RealTensorValue> PeacemanBorehole::_rot_matrix

protectedinherited

rotation matrix used in well_constant calculation

Definition at line 97 of file PeacemanBorehole.h.

Referenced by Q2PBorehole::computeQpResidual(), computeQpResidual(), Q2PBorehole::jac(), jac(), and PeacemanBorehole::PeacemanBorehole().

◆ _rs

std::vector<Real> PeacemanBorehole::_rs

protectedinherited

radii of the borehole

Definition at line 79 of file PeacemanBorehole.h.

Referenced by Q2PBorehole::computeQpResidual(), computeQpResidual(), Q2PBorehole::jac(), jac(), and PeacemanBorehole::PeacemanBorehole().

◆ _seff_UO

const RichardsSeff* const RichardsBorehole::_seff_UO

protected

user object defining the effective saturation. Only used if _fully_upwind = true

Definition at line 87 of file RichardsBorehole.h.

Referenced by prepareNodalValues().

◆ _total_outflow_mass

RichardsSumQuantity& PeacemanBorehole::_total_outflow_mass

protectedinherited

This is used to hold the total fluid flowing into the borehole Hence, it is positive for production wells where fluid is flowing from porespace into the borehole and removed from the model.

Definition at line 76 of file PeacemanBorehole.h.

Referenced by PeacemanBorehole::addPoints(), Q2PBorehole::computeQpResidual(), computeQpResidual(), and PeacemanBorehole::PeacemanBorehole().

◆ _unit_weight

const RealVectorValue PeacemanBorehole::_unit_weight

protectedinherited

unit weight of fluid in borehole (for calculating bottomhole pressure at each Dirac Point)

Definition at line 69 of file PeacemanBorehole.h.

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

◆ _viscosity

const MaterialProperty<std::vector<Real> >& RichardsBorehole::_viscosity

protected

fluid viscosity

Definition at line 114 of file RichardsBorehole.h.

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

◆ _xs

std::vector<Real> PeacemanBorehole::_xs

protectedinherited

x points of the borehole

Definition at line 82 of file PeacemanBorehole.h.

Referenced by PeacemanBorehole::addPoints(), and PeacemanBorehole::PeacemanBorehole().

◆ _ys

std::vector<Real> PeacemanBorehole::_ys

protectedinherited

y points of the borehole

Definition at line 85 of file PeacemanBorehole.h.

Referenced by PeacemanBorehole::addPoints(), and PeacemanBorehole::PeacemanBorehole().

◆ _zs

std::vector<Real> PeacemanBorehole::_zs

protectedinherited

z points of borehole

Definition at line 88 of file PeacemanBorehole.h.

Referenced by PeacemanBorehole::addPoints(), Q2PBorehole::computeQpResidual(), computeQpResidual(), Q2PBorehole::jac(), jac(), and PeacemanBorehole::PeacemanBorehole().

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

richards/include/dirackernels/RichardsBorehole.h
richards/src/dirackernels/RichardsBorehole.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

Constructor & Destructor Documentation

◆ RichardsBorehole()

Member Function Documentation

◆ addPoints()

◆ computeJacobian()

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ computeResidual()

◆ jac()

◆ parseNextLineReals()

◆ prepareNodalValues()

◆ validParams()

◆ wellConstant()

Member Data Documentation

◆ _bottom_point

◆ _character

◆ _ddensity_dv

◆ _density

◆ _density_UO

◆ _dmobility_dv

◆ _dpp_dv

◆ _drel_perm_dv

◆ _dseff_dv

◆ _fully_upwind

◆ _half_seg_len

◆ _mobility

◆ _num_nodes

◆ _num_p

◆ _p_bot

◆ _permeability

◆ _pp

◆ _ps_at_nodes

◆ _pvar

◆ _rel_perm

◆ _relperm_UO

◆ _richards_name_UO

◆ _rot_matrix

◆ _rs

◆ _seff_UO

◆ _total_outflow_mass

◆ _unit_weight

◆ _viscosity

◆ _xs

◆ _ys

◆ _zs