https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
PorousFlowLineSink Class Referenceabstract

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

#include <PorousFlowLineSink.h>

Inheritance diagram for PorousFlowLineSink:
[legend]

Public Types

enum  ResidualTagType { ResidualTagType::NonReference, ResidualTagType::Reference }
 
typedef DataFileName DataFileParameterType
 

Public Member Functions

 PorousFlowLineSink (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 SubProblemsubProblem () const
 
virtual void prepareShapes (unsigned int var_num)
 
virtual std::set< std::string > additionalROVariables ()
 
virtual bool enabled () const
 
std::shared_ptr< MooseObjectgetSharedPtr ()
 
std::shared_ptr< const MooseObjectgetSharedPtr () const
 
MooseAppgetMooseApp () 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 InputParametersparameters () const
 
MooseObjectName uniqueName () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &nm) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
virtual void timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void subdomainSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnumgetExecuteOnEnum () const
 
const FunctiongetFunction (const std::string &name) const
 
const FunctiongetFunctionByName (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 UserObjectgetUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObjectgetUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
 
bool isImplicit ()
 
Moose::StateArg determineState () const
 
bool isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessor (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessorByName (const PostprocessorName &name) const
 
std::size_t coupledPostprocessors (const std::string &param_name) const
 
const PostprocessorName & getPostprocessorName (const std::string &param_name, const unsigned int index=0) const
 
const VectorPostprocessorValuegetVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValueOldByName (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
 
virtual const VariableValuecoupledValueByName (const std::string &var_name)
 
virtual const ArrayVariableValuecoupledArrayValueByName (const std::string &var_name)
 
const std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> > & getCoupledVars () const
 
const std::vector< MooseVariableFieldBase *> & getCoupledMooseVars () const
 
const std::vector< MooseVariable *> & getCoupledStandardMooseVars () const
 
const std::vector< VectorMooseVariable *> & getCoupledVectorMooseVars () const
 
const std::vector< ArrayMooseVariable *> & getCoupledArrayMooseVars () const
 
void addFEVariableCoupleableVectorTag (TagID tag)
 
void addFEVariableCoupleableMatrixTag (TagID tag)
 
std::set< TagID > & getFEVariableCoupleableVectorTags ()
 
const std::set< TagID > & getFEVariableCoupleableVectorTags () const
 
std::set< TagID > & getFEVariableCoupleableMatrixTags ()
 
const std::set< TagID > & getFEVariableCoupleableMatrixTags () const
 
auto & getWritableCoupledVariables () const
 
bool hasWritableCoupledVariables () const
 
const ADVariableValuegetADDefaultValue (const std::string &var_name) const
 
const ADVectorVariableValuegetADDefaultVectorValue (const std::string &var_name) const
 
const ADVariableGradientgetADDefaultGradient () const
 
const ADVectorVariableGradientgetADDefaultVectorGradient () const
 
const ADVariableSecondgetADDefaultSecond () const
 
const ADVectorVariableCurlgetADDefaultCurl () const
 
const std::vector< MooseVariableScalar *> & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
const std::set< MooseVariableFieldBase *> & getMooseVariableDependencies () const
 
std::set< MooseVariableFieldBase *> checkAllVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_omit={})
 
std::set< MooseVariableFieldBase *> checkVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
void addMooseVariableDependency (MooseVariableFieldBase *var)
 
void addMooseVariableDependency (const std::vector< MooseVariableFieldBase * > &vars)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty (const MaterialPropertyName &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty ()
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialPropertyByName (const std::string &prop_name)
 
const MaterialProperty< T > & getZeroMaterialProperty (Ts... args)
 
std::set< SubdomainIDgetMaterialPropertyBlocks (const std::string &name)
 
std::vector< SubdomainName > getMaterialPropertyBlockNames (const std::string &name)
 
std::set< BoundaryIDgetMaterialPropertyBoundaryIDs (const std::string &name)
 
std::vector< BoundaryName > getMaterialPropertyBoundaryNames (const std::string &name)
 
void checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)
 
std::unordered_map< SubdomainID, std::vector< MaterialBase *> > buildRequiredMaterials (bool allow_stateful=true)
 
void statefulPropertiesAllowed (bool)
 
bool getMaterialPropertyCalled () const
 
virtual const std::unordered_set< unsigned int > & getMatPropDependencies () const
 
virtual void resolveOptionalProperties ()
 
const GenericMaterialProperty< T, is_ad > & getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)
 
const std::vector< SubdomainName > & blocks () const
 
unsigned int numBlocks () const
 
virtual const std::set< SubdomainID > & blockIDs () const
 
unsigned int blocksMaxDimension () const
 
bool hasBlocks (const SubdomainName &name) const
 
bool hasBlocks (const std::vector< SubdomainName > &names) const
 
bool hasBlocks (const std::set< SubdomainName > &names) const
 
bool hasBlocks (SubdomainID id) const
 
bool hasBlocks (const std::vector< SubdomainID > &ids) const
 
bool hasBlocks (const std::set< SubdomainID > &ids) const
 
bool isBlockSubset (const std::set< SubdomainID > &ids) const
 
bool isBlockSubset (const std::vector< SubdomainID > &ids) const
 
bool hasBlockMaterialProperty (const std::string &prop_name)
 
const std::set< SubdomainID > & meshBlockIDs () const
 
virtual bool blockRestricted () const
 
virtual void checkVariable (const MooseVariableFieldBase &variable) const
 
MooseVariableBasemooseVariableBase () 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 PostprocessorValuegetPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValuegetPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValuegetPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOlderByName (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)
 
MaterialBasegetMaterial (const std::string &name)
 
MaterialBasegetMaterial (const std::string &name)
 
MaterialBasegetMaterialByName (const std::string &name, bool no_warn=false)
 
MaterialBasegetMaterialByName (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)
 
PenetrationLocatorgetPenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
 
PenetrationLocatorgetQuadraturePenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
 
NearestNodeLocatorgetNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
 
NearestNodeLocatorgetQuadratureNearestNodeLocator (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 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 Real computeQpBaseOutflow (unsigned current_dirac_ptid) const =0
 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 =0
 Calculates the BaseOutflow as well as its derivative wrt jvar. Derived classes should override this. 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 MooseVariableFieldBasegetVariable (unsigned int jvar_num) const
 
virtual void addUserObjectDependencyHelper (const UserObject &) const
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &) const
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) const
 
T & declareRestartableData (const std::string &data_name, Args &&... args)
 
ManagedValue< T > declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
const T & getRestartableData (const std::string &data_name) const
 
T & declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
T & declareRecoverableData (const std::string &data_name, Args &&... args)
 
T & declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
 
T & declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
 
std::string restartableName (const std::string &data_name) const
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTagNeighbor (Assembly &assembly, unsigned int ivar)
 
void prepareVectorTagLower (Assembly &assembly, unsigned int ivar)
 
void prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar)
 
void prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar, DenseMatrix< Number > &k) const
 
void prepareMatrixTagNonlocal (Assembly &assembly, unsigned int ivar, unsigned int jvar)
 
void prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type)
 
void prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, DenseMatrix< Number > &k) const
 
void prepareMatrixTagLower (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::ConstraintJacobianType type)
 
void accumulateTaggedLocalResidual ()
 
void assignTaggedLocalResidual ()
 
void accumulateTaggedLocalMatrix ()
 
void accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, const DenseMatrix< Number > &k)
 
void accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, const DenseMatrix< Number > &k)
 
void accumulateTaggedNonlocalMatrix ()
 
void assignTaggedLocalMatrix ()
 
void addResiduals (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResiduals (Assembly &assembly, const DenseVector< T > &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResiduals (Assembly &assembly, const ADResidualsPacket &packet)
 
void addResidualsAndJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResidualsAndJacobian (Assembly &assembly, const ADResidualsPacket &packet)
 
void addJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobian (Assembly &assembly, const ADResidualsPacket &packet)
 
void addJacobian (Assembly &assembly, DenseMatrix< Real > &local_k, const std::vector< dof_id_type > &row_indices, const std::vector< dof_id_type > &column_indices, Real scaling_factor)
 
void addResidualsWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResidualsAndJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobianElement (Assembly &assembly, Real value, dof_id_type row_index, dof_id_type column_index, Real scaling_factor)
 
void setResidual (SystemBase &sys, const T &residual, MooseVariableFE< T > &var)
 
void setResidual (SystemBase &sys, Real residual, dof_id_type dof_index)
 
void setResidual (SystemBase &sys, SetResidualFunctor set_residual_functor)
 
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 intcoupledIndices (const std::string &var_name) const
 
virtual const VariableValuecoupledValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValues (const std::string &var_name) const
 
std::vector< const VectorVariableValue *> coupledVectorValues (const std::string &var_name) const
 
const GenericVariableValue< is_ad > & coupledGenericValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericValue (const std::string &var_name, unsigned int comp) const
 
const GenericVectorVariableValue< is_ad > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVectorVariableValue< false > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp) const
 
const GenericVectorVariableValue< true > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp) const
 
std::vector< const GenericVariableValue< is_ad > *> coupledGenericValues (const std::string &var_name) const
 
std::vector< const GenericVariableValue< false > *> coupledGenericValues (const std::string &var_name) const
 
std::vector< const GenericVariableValue< true > *> coupledGenericValues (const std::string &var_name) const
 
const GenericVariableValue< is_ad > & coupledGenericDofValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDofValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDofValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< is_ad > & coupledGenericDot (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< is_ad > & coupledGenericDotDot (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDotDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDotDot (const std::string &var_name, unsigned int comp) const
 
virtual const VariableValuecoupledValueLower (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadCoupledValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableValue *> adCoupledValues (const std::string &var_name) const
 
const ADVariableValueadCoupledLowerValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableValueadCoupledVectorValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVectorVariableValue *> adCoupledVectorValues (const std::string &var_name) const
 
virtual const VariableValuecoupledVectorTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableValuecoupledVectorTagValue (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 ArrayVariableValuecoupledVectorTagArrayValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const ArrayVariableValuecoupledVectorTagArrayValue (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 VariableGradientcoupledVectorTagGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableGradientcoupledVectorTagGradient (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 ArrayVariableGradientcoupledVectorTagArrayGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const ArrayVariableGradientcoupledVectorTagArrayGradient (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 VariableValuecoupledVectorTagDofValue (const std::string &var_name, TagID tag, unsigned int index=0) const
 
virtual const VariableValuecoupledVectorTagDofValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
const ArrayVariableValuecoupledVectorTagArrayDofValue (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 VariableValuecoupledMatrixTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableValuecoupledMatrixTagValue (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 VectorVariableValuecoupledVectorValue (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ArrayVariableValue *> coupledArrayValues (const std::string &var_name) const
 
MooseWritableVariablewritableVariable (const std::string &var_name, unsigned int comp=0)
 
virtual VariableValuewritableCoupledValue (const std::string &var_name, unsigned int comp=0)
 
void checkWritableVar (MooseWritableVariable *var)
 
virtual const VariableValuecoupledValueOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValuesOld (const std::string &var_name) const
 
std::vector< const VectorVariableValue *> coupledVectorValuesOld (const std::string &var_name) const
 
virtual const VariableValuecoupledValueOlder (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValuesOlder (const std::string &var_name) const
 
virtual const VariableValuecoupledValuePreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorValueOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorValueOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayValueOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayValueOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradient (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableGradient *> coupledGradients (const std::string &var_name) const
 
const ADVariableGradientadCoupledGradient (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableGradientadCoupledGradientDot (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 ADVectorVariableGradientadCoupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableSecondadCoupledSecond (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableSecondadCoupledVectorSecond (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradientOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableGradient *> coupledGradientsOld (const std::string &var_name) const
 
virtual const VariableGradientcoupledGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradientPreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradientDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradientDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradientcoupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradientcoupledVectorGradientOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradientcoupledVectorGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradientcoupledArrayGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradientcoupledArrayGradientOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradientcoupledArrayGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradientcoupledArrayGradientDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurlcoupledCurl (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurlcoupledCurlOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurlcoupledCurlOlder (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableCurladCoupledCurl (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergencecoupledDiv (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergencecoupledDivOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergencecoupledDivOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecondcoupledSecond (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecondcoupledSecondOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecondcoupledSecondOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecondcoupledSecondPreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledDots (const std::string &var_name) const
 
virtual const VariableValuecoupledDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadCoupledDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableValue *> adCoupledDots (const std::string &var_name) const
 
const ADVariableValueadCoupledDotDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableValueadCoupledVectorDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledVectorDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledVectorDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledArrayDotDu (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 >::typeadCoupledNodalValue (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 VariableValuecoupledNodalDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledNodalDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledNodalDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDofValues (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValues (const std::string &var_name) const
 
virtual const VariableValuecoupledDofValuesOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValuesOld (const std::string &var_name) const
 
virtual const VariableValuecoupledDofValuesOlder (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValuesOlder (const std::string &var_name) const
 
virtual const ArrayVariableValuecoupledArrayDofValues (const std::string &var_name, unsigned int comp=0) const
 
virtual const ADVariableValueadCoupledDofValues (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadZeroValue () const
 
const ADVariableGradientadZeroGradient () const
 
const ADVariableSecondadZeroSecond () 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 MooseVariableFieldBasegetFEVar (const std::string &var_name, unsigned int comp) const
 
const MooseVariableFieldBasegetFieldVar (const std::string &var_name, unsigned int comp) const
 
MooseVariableFieldBasegetFieldVar (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)
 
MooseVariablegetVar (const std::string &var_name, unsigned int comp)
 
const MooseVariablegetVar (const std::string &var_name, unsigned int comp) const
 
VectorMooseVariablegetVectorVar (const std::string &var_name, unsigned int comp)
 
const VectorMooseVariablegetVectorVar (const std::string &var_name, unsigned int comp) const
 
ArrayMooseVariablegetArrayVar (const std::string &var_name, unsigned int comp)
 
const ArrayMooseVariablegetArrayVar (const std::string &var_name, unsigned int comp) const
 
void validateExecutionerType (const std::string &name, const std::string &fn_name) const
 
std::vector< T > coupledVectorHelper (const std::string &var_name, const Func &func) const
 
bool isCoupledScalar (const std::string &var_name, unsigned int i=0) const
 
unsigned int coupledScalarComponents (const std::string &var_name) const
 
unsigned int coupledScalar (const std::string &var_name, unsigned int comp=0) const
 
libMesh::Order coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadCoupledScalarValue (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 VariableValuecoupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValuecoupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValuecoupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const MooseVariableScalargetScalarVar (const std::string &var_name, unsigned int comp) const
 
virtual void checkMaterialProperty (const std::string &name, const unsigned int state)
 
void markMatPropRequested (const std::string &)
 
MaterialPropertyName getMaterialPropertyName (const std::string &name) const
 
void checkExecutionStage ()
 
virtual bool hasBlockMaterialPropertyHelper (const std::string &prop_name)
 
void initializeBlockRestrictable (const MooseObject *moose_object)
 
Moose::CoordinateSystemType getBlockCoordSystem ()
 
virtual const OutputTools< T >::VariableValuevalue ()
 
virtual const OutputTools< T >::VariableValuevalueOld ()
 
virtual const OutputTools< T >::VariableValuevalueOlder ()
 
virtual const OutputTools< T >::VariableValuedot ()
 
virtual const OutputTools< T >::VariableValuedotDot ()
 
virtual const OutputTools< T >::VariableValuedotOld ()
 
virtual const OutputTools< T >::VariableValuedotDotOld ()
 
virtual const VariableValuedotDu ()
 
virtual const VariableValuedotDotDu ()
 
virtual const OutputTools< T >::VariableGradientgradient ()
 
virtual const OutputTools< T >::VariableGradientgradientOld ()
 
virtual const OutputTools< T >::VariableGradientgradientOlder ()
 
virtual const OutputTools< T >::VariableSecondsecond ()
 
virtual const OutputTools< T >::VariableSecondsecondOld ()
 
virtual const OutputTools< T >::VariableSecondsecondOlder ()
 
virtual const OutputTools< T >::VariableTestSecondsecondTest ()
 
virtual const OutputTools< T >::VariableTestSecondsecondTestFace ()
 
virtual const OutputTools< T >::VariablePhiSecondsecondPhi ()
 
virtual const OutputTools< T >::VariablePhiSecondsecondPhiFace ()
 
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 ReporterNamegetReporterName (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

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
 
const Real_t_old
 
int_t_step
 
Real_dt
 
Real_dt_old
 
bool _is_transient
 
MooseApp_restartable_app
 
const std::string _restartable_system_name
 
const THREAD_ID _restartable_tid
 
const bool _restartable_read_only
 
FEProblemBase_mci_feproblem
 
DenseVector< Number_local_re
 
DenseMatrix< Number_local_ke
 
DenseMatrix< Number_nonlocal_ke
 
const InputParameters_c_parameters
 
const std::string & _c_name
 
const std::string & _c_type
 
FEProblemBase_c_fe_problem
 
const SystemBase *const _c_sys
 
std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> > _coupled_vars
 
std::vector< MooseVariableFieldBase *> _coupled_moose_vars
 
std::vector< MooseVariable *> _coupled_standard_moose_vars
 
std::vector< VectorMooseVariable *> _coupled_vector_moose_vars
 
std::vector< ArrayMooseVariable *> _coupled_array_moose_vars
 
std::vector< MooseVariableFV< Real > *> _coupled_standard_fv_moose_vars
 
std::vector< MooseLinearVariableFV< Real > *> _coupled_standard_linear_fv_moose_vars
 
const std::unordered_map< std::string, std::string > & _new_to_deprecated_coupled_vars
 
bool _c_nodal
 
bool _c_is_implicit
 
const bool _c_allow_element_to_nodal_coupling
 
THREAD_ID _c_tid
 
std::unordered_map< std::string, std::vector< std::unique_ptr< VariableValue > > > _default_value
 
std::unordered_map< std::string, std::unique_ptr< MooseArray< ADReal > > > _ad_default_value
 
std::unordered_map< std::string, std::unique_ptr< VectorVariableValue > > _default_vector_value
 
std::unordered_map< std::string, std::unique_ptr< ArrayVariableValue > > _default_array_value
 
std::unordered_map< std::string, std::unique_ptr< MooseArray< ADRealVectorValue > > > _ad_default_vector_value
 
VariableValue _default_value_zero
 
VariableGradient _default_gradient
 
MooseArray< ADRealVectorValue_ad_default_gradient
 
MooseArray< ADRealTensorValue_ad_default_vector_gradient
 
VariableSecond _default_second
 
MooseArray< ADRealTensorValue_ad_default_second
 
MooseArray< ADRealVectorValue_ad_default_curl
 
const VariableValue_zero
 
const VariablePhiValue_phi_zero
 
const MooseArray< ADReal > & _ad_zero
 
const VariableGradient_grad_zero
 
const MooseArray< ADRealVectorValue > & _ad_grad_zero
 
const VariablePhiGradient_grad_phi_zero
 
const VariableSecond_second_zero
 
const MooseArray< ADRealTensorValue > & _ad_second_zero
 
const VariablePhiSecond_second_phi_zero
 
const VectorVariableValue_vector_zero
 
const VectorVariableCurl_vector_curl_zero
 
VectorVariableValue _default_vector_value_zero
 
VectorVariableGradient _default_vector_gradient
 
VectorVariableCurl _default_vector_curl
 
VectorVariableDivergence _default_div
 
ArrayVariableValue _default_array_value_zero
 
ArrayVariableGradient _default_array_gradient
 
bool _coupleable_neighbor
 
FEProblemBase_sc_fe_problem
 
const THREAD_ID _sc_tid
 
const Real_real_zero
 
const VariableValue_scalar_zero
 
const Point & _point_zero
 
const InputParameters_mi_params
 
const std::string _mi_name
 
const MooseObjectName _mi_moose_object_name
 
FEProblemBase_mi_feproblem
 
SubProblem_mi_subproblem
 
const THREAD_ID _mi_tid
 
const Moose::MaterialDataType _material_data_type
 
MaterialData_material_data
 
bool _stateful_allowed
 
bool _get_material_property_called
 
std::vector< std::unique_ptr< PropertyValue > > _default_properties
 
std::unordered_set< unsigned int_material_property_dependencies
 
const MaterialPropertyName _get_suffix
 
const bool _use_interpolated_state
 
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 a sequence of Dirac Points.

Definition at line 19 of file PorousFlowLineSink.h.

Member Enumeration Documentation

◆ PorTchoice

enum PorousFlowLineSink::PorTchoice
strongprotected

whether the flux is a function of pressure or temperature

Enumerator
pressure 
temperature 

Definition at line 88 of file PorousFlowLineSink.h.

static const std::string temperature
Definition: NS.h:59
static const std::string pressure
Definition: NS.h:56
enum PorousFlowLineSink::PorTchoice _p_or_t

Constructor & Destructor Documentation

◆ PorousFlowLineSink()

PorousFlowLineSink::PorousFlowLineSink ( const InputParameters parameters)

Definition at line 53 of file PorousFlowLineSink.C.

55  _dictator(getUserObject<PorousFlowDictator>("PorousFlowDictator")),
57  const_cast<PorousFlowSumQuantity &>(getUserObject<PorousFlowSumQuantity>("SumQuantityUO"))),
58 
60  hasMaterialProperty<std::vector<Real>>("PorousFlow_porepressure_qp") &&
61  hasMaterialProperty<std::vector<std::vector<Real>>>("dPorousFlow_porepressure_qp_dvar")),
62  _has_temperature(hasMaterialProperty<Real>("PorousFlow_temperature_qp") &&
63  hasMaterialProperty<std::vector<Real>>("dPorousFlow_temperature_qp_dvar")),
65  hasMaterialProperty<std::vector<std::vector<Real>>>("PorousFlow_mass_frac_nodal") &&
66  hasMaterialProperty<std::vector<std::vector<std::vector<Real>>>>(
67  "dPorousFlow_mass_frac_nodal_dvar")),
69  hasMaterialProperty<std::vector<Real>>("PorousFlow_relative_permeability_nodal") &&
70  hasMaterialProperty<std::vector<std::vector<Real>>>(
71  "dPorousFlow_relative_permeability_nodal_dvar")),
73  hasMaterialProperty<std::vector<Real>>("PorousFlow_relative_permeability_nodal") &&
74  hasMaterialProperty<std::vector<std::vector<Real>>>(
75  "dPorousFlow_relative_permeability_nodal_dvar") &&
76  hasMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_density_nodal") &&
77  hasMaterialProperty<std::vector<std::vector<Real>>>(
78  "dPorousFlow_fluid_phase_density_nodal_dvar") &&
79  hasMaterialProperty<std::vector<Real>>("PorousFlow_viscosity_nodal") &&
80  hasMaterialProperty<std::vector<std::vector<Real>>>("dPorousFlow_viscosity_nodal_dvar")),
81  _has_enthalpy(hasMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_enthalpy_nodal") &&
82  hasMaterialProperty<std::vector<std::vector<Real>>>(
83  "dPorousFlow_fluid_phase_enthalpy_nodal_dvar")),
85  hasMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_internal_energy_nodal") &&
86  hasMaterialProperty<std::vector<std::vector<Real>>>(
87  "dPorousFlow_fluid_phase_internal_energy_nodal_dvar")),
88 
89  _p_or_t(getParam<MooseEnum>("function_of").getEnum<PorTchoice>()),
90  _use_mass_fraction(isParamValid("mass_fraction_component")),
91  _use_relative_permeability(getParam<bool>("use_relative_permeability")),
92  _use_mobility(getParam<bool>("use_mobility")),
93  _use_enthalpy(getParam<bool>("use_enthalpy")),
94  _use_internal_energy(getParam<bool>("use_internal_energy")),
95 
96  _ph(getParam<unsigned int>("fluid_phase")),
97  _sp(_use_mass_fraction ? getParam<unsigned int>("mass_fraction_component") : 0),
98 
100  ? &getMaterialProperty<std::vector<Real>>("PorousFlow_porepressure_qp")
101  : nullptr),
103  ? &getMaterialProperty<std::vector<std::vector<Real>>>(
104  "dPorousFlow_porepressure_qp_dvar")
105  : nullptr),
107  ? &getMaterialProperty<Real>("PorousFlow_temperature_qp")
108  : nullptr),
111  ? &getMaterialProperty<std::vector<Real>>("dPorousFlow_temperature_qp_dvar")
112  : nullptr),
115  ? &getMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_density_nodal")
116  : nullptr),
118  ? &getMaterialProperty<std::vector<std::vector<Real>>>(
119  "dPorousFlow_fluid_phase_density_nodal_dvar")
120  : nullptr),
122  ? &getMaterialProperty<std::vector<Real>>("PorousFlow_viscosity_nodal")
123  : nullptr),
125  ? &getMaterialProperty<std::vector<std::vector<Real>>>(
126  "dPorousFlow_viscosity_nodal_dvar")
127  : nullptr),
131  ? &getMaterialProperty<std::vector<Real>>("PorousFlow_relative_permeability_nodal")
132  : nullptr),
135  ? &getMaterialProperty<std::vector<std::vector<Real>>>(
136  "dPorousFlow_relative_permeability_nodal_dvar")
137  : nullptr),
140  ? &getMaterialProperty<std::vector<std::vector<Real>>>("PorousFlow_mass_frac_nodal")
141  : nullptr),
143  ? &getMaterialProperty<std::vector<std::vector<std::vector<Real>>>>(
144  "dPorousFlow_mass_frac_nodal_dvar")
145  : nullptr),
146  _enthalpy(_has_enthalpy ? &getMaterialPropertyByName<std::vector<Real>>(
147  "PorousFlow_fluid_phase_enthalpy_nodal")
148  : nullptr),
149  _denthalpy_dvar(_has_enthalpy ? &getMaterialPropertyByName<std::vector<std::vector<Real>>>(
150  "dPorousFlow_fluid_phase_enthalpy_nodal_dvar")
151  : nullptr),
153  "PorousFlow_fluid_phase_internal_energy_nodal")
154  : nullptr),
156  ? &getMaterialPropertyByName<std::vector<std::vector<Real>>>(
157  "dPorousFlow_fluid_phase_internal_energy_nodal_dvar")
158  : nullptr),
159  _multiplying_var(coupledValue("multiplying_var"))
160 {
161  // zero the outflow mass
163 
164  if (_ph >= _dictator.numPhases())
165  paramError("fluid_phase",
166  "The Dictator proclaims that the maximum phase index in this simulation is ",
167  _dictator.numPhases() - 1,
168  " whereas you have used ",
169  _ph,
170  ". Remember that indexing starts at 0. You must try harder.");
171 
173  paramError(
174  "mass_fraction_component",
175  "The Dictator proclaims that the maximum fluid component index in this simulation is ",
176  _dictator.numComponents() - 1,
177  " whereas you have used ",
178  _sp,
179  ". Remember that indexing starts at 0. Please be assured that the Dictator has noted your "
180  "error.");
181 
183  mooseError("PorousFlowLineSink: You have specified function_of=porepressure, but you do not "
184  "have a quadpoint porepressure material");
185 
187  mooseError("PorousFlowLineSink: You have specified function_of=temperature, but you do not "
188  "have a quadpoint temperature material");
189 
191  mooseError("PorousFlowLineSink: You have specified a fluid component, but do not have a nodal "
192  "mass-fraction material");
193 
195  mooseError("PorousFlowLineSink: You have set use_relative_permeability=true, but do not have a "
196  "nodal relative permeability material");
197 
199  mooseError("PorousFlowLineSink: You have set use_mobility=true, but do not have nodal density, "
200  "relative permeability or viscosity material");
201 
203  mooseError("PorousFlowLineSink: You have set use_enthalpy=true, but do not have a nodal "
204  "enthalpy material");
205 
207  mooseError("PorousFlowLineSink: You have set use_internal_energy=true, but do not have a nodal "
208  "internal-energy material");
209 
210  // To correctly compute the Jacobian terms,
211  // tell MOOSE that this DiracKernel depends on all the PorousFlow Variables
212  const std::vector<MooseVariableFEBase *> & coupled_vars = _dictator.getCoupledMooseVars();
213  for (unsigned int i = 0; i < coupled_vars.size(); i++)
214  addMooseVariableDependency(coupled_vars[i]);
215 }
const bool _has_internal_energy
Whether an internal-energy material exists (for error checking)
const bool _use_enthalpy
Whether the flux will be multiplied by the enthalpy.
const unsigned int _ph
The phase number.
const PorousFlowDictator & _dictator
PorousFlowDictator UserObject.
const bool _has_enthalpy
Whether an enthalpy material exists (for error checking)
const MaterialProperty< std::vector< Real > > *const _fluid_density_node
Fluid density for each phase (at the node)
const bool _has_temperature
Whether a quadpoint temperature material exists (for error checking)
const bool _has_relative_permeability
Whether a relative permeability material exists (for error checking)
const MaterialProperty< T > & getMaterialPropertyByName(const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
const MaterialProperty< std::vector< std::vector< Real > > > *const _dfluid_viscosity_dvar
d(Viscosity of each component in each phase)/d(PorousFlow variable)
const MaterialProperty< std::vector< Real > > *const _fluid_viscosity
Viscosity of each component in each phase.
unsigned int numComponents() const
The number of fluid components.
const bool _use_relative_permeability
Whether the flux will be multiplied by the relative permeability.
const MaterialProperty< std::vector< Real > > *const _relative_permeability
Relative permeability of each phase.
void zero()
Sets _total = 0.
const bool _has_porepressure
Whether a quadpoint porepressure material exists (for error checking)
bool isParamValid(const std::string &name) const
const MaterialProperty< std::vector< Real > > *const _dtemperature_dvar
d(quadpoint temperature)/d(PorousFlow variable)
virtual const VariableValue & coupledValue(const std::string &var_name, unsigned int comp=0) const
const MaterialProperty< std::vector< std::vector< Real > > > *const _dpp_dvar
d(quadpoint pore pressure in each phase)/d(PorousFlow variable)
const MaterialProperty< std::vector< std::vector< Real > > > *const _mass_fractions
Mass fraction of each component in each phase.
const bool _has_mobility
Whether enough materials exist to form the mobility (for error checking)
PorousFlowLineGeometry(const InputParameters &parameters)
const MaterialProperty< std::vector< std::vector< Real > > > *const _dinternal_energy_dvar
d(internal_energy of each phase)/d(PorousFlow variable)
void paramError(const std::string &param, Args... args) const
const MaterialProperty< std::vector< Real > > *const _enthalpy
Enthalpy of each phase.
unsigned int numPhases() const
The number of fluid phases.
const MaterialProperty< std::vector< std::vector< Real > > > *const _drelative_permeability_dvar
d(Relative permeability of each phase)/d(PorousFlow variable)
const MaterialProperty< std::vector< std::vector< Real > > > *const _dfluid_density_node_dvar
d(Fluid density for each phase (at the node))/d(PorousFlow variable)
const MaterialProperty< std::vector< Real > > *const _pp
Quadpoint pore pressure in each phase.
const std::vector< MooseVariableFieldBase *> & getCoupledMooseVars() const
PorousFlowSumQuantity & _total_outflow_mass
This is used to hold the total fluid flowing into the line sink for each time step.
bool hasMaterialProperty(const std::string &name)
const bool _use_mass_fraction
Whether the flux will be multiplied by the mass fraction.
void addMooseVariableDependency(MooseVariableFieldBase *var)
const MaterialProperty< std::vector< Real > > *const _internal_energy
Internal_Energy of each phase.
const MaterialProperty< T > & getMaterialProperty(const std::string &name, MaterialData &material_data, const unsigned int state=0)
const bool _use_internal_energy
Whether the flux will be multiplied by the internal-energy.
const MaterialProperty< std::vector< std::vector< Real > > > *const _denthalpy_dvar
d(enthalpy of each phase)/d(PorousFlow variable)
void mooseError(Args &&... args) const
const bool _has_mass_fraction
Whether a mass_fraction material exists (for error checking)
const InputParameters & parameters() const
const VariableValue & _multiplying_var
mass flux is multiplied by this variable evaluated at quadpoints
const unsigned int _sp
The component number (only used if _use_mass_fraction==true)
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)
enum PorousFlowLineSink::PorTchoice _p_or_t
const bool _use_mobility
Whether the flux will be multiplied by the mobility.
const MaterialProperty< Real > *const _temperature
Quadpoint temperature.

Member Function Documentation

◆ addPoints()

void PorousFlowLineSink::addPoints ( )
overrideprotectedvirtual

Add Dirac Points to the borehole.

Reimplemented from PorousFlowLineGeometry.

Definition at line 218 of file PorousFlowLineSink.C.

219 {
220  // This function gets called just before the DiracKernel is evaluated
221  // so this is a handy place to zero this out.
223 
225 }
virtual void addPoints() override
Add Dirac Points to the line sink.
void zero()
Sets _total = 0.
PorousFlowSumQuantity & _total_outflow_mass
This is used to hold the total fluid flowing into the line sink for each time step.

◆ computeQpBaseOutflow()

virtual Real PorousFlowLineSink::computeQpBaseOutflow ( unsigned  current_dirac_ptid) const
protectedpure virtual

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

Implemented in PorousFlowPeacemanBorehole, and PorousFlowPolyLineSink.

Referenced by computeQpResidual().

◆ computeQpBaseOutflowJacobian()

virtual void PorousFlowLineSink::computeQpBaseOutflowJacobian ( unsigned  jvar,
unsigned  current_dirac_ptid,
Real outflow,
Real outflowp 
) const
protectedpure virtual

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

Implemented in PorousFlowPeacemanBorehole, and PorousFlowPolyLineSink.

Referenced by jac().

◆ computeQpJacobian()

Real PorousFlowLineSink::computeQpJacobian ( )
overrideprotectedvirtual

Reimplemented from DiracKernelTempl< class >.

Definition at line 261 of file PorousFlowLineSink.C.

262 {
263  return jac(_var.number());
264 }
unsigned int number() const
MooseVariableField< T > & _var
Real jac(unsigned int jvar)
Jacobian contribution for the derivative wrt the variable jvar.

◆ computeQpOffDiagJacobian()

Real PorousFlowLineSink::computeQpOffDiagJacobian ( unsigned int  jvar)
overrideprotectedvirtual

Reimplemented from DiracKernelTempl< class >.

Definition at line 267 of file PorousFlowLineSink.C.

268 {
269  return jac(jvar);
270 }
Real jac(unsigned int jvar)
Jacobian contribution for the derivative wrt the variable jvar.

◆ computeQpResidual()

Real PorousFlowLineSink::computeQpResidual ( )
overrideprotectedvirtual

Implements DiracKernelTempl< class >.

Definition at line 228 of file PorousFlowLineSink.C.

229 {
230  // Get the ID we initially assigned to this point
231  const unsigned current_dirac_ptid = currentPointCachedID();
232  Real outflow = computeQpBaseOutflow(current_dirac_ptid);
233  if (outflow == 0.0)
234  return 0.0;
235 
236  outflow *= _multiplying_var[_qp];
237 
239  outflow *= (*_relative_permeability)[_i][_ph];
240 
241  if (_use_mobility)
242  outflow *= (*_relative_permeability)[_i][_ph] * (*_fluid_density_node)[_i][_ph] /
243  (*_fluid_viscosity)[_i][_ph];
244 
245  if (_use_mass_fraction)
246  outflow *= (*_mass_fractions)[_i][_ph][_sp];
247 
248  if (_use_enthalpy)
249  outflow *= (*_enthalpy)[_i][_ph];
250 
252  outflow *= (*_internal_energy)[_i][_ph];
253 
255  outflow * _dt); // this is not thread safe, but DiracKernel's aren't currently threaded
256 
257  return outflow;
258 }
void add(Real contrib)
Adds contrib to _total.
const bool _use_enthalpy
Whether the flux will be multiplied by the enthalpy.
const unsigned int _ph
The phase number.
const bool _use_relative_permeability
Whether the flux will be multiplied by the relative permeability.
unsigned currentPointCachedID()
virtual Real computeQpBaseOutflow(unsigned current_dirac_ptid) const =0
Returns the flux from the line sink (before modification by mobility, etc). Derived classes should ov...
PorousFlowSumQuantity & _total_outflow_mass
This is used to hold the total fluid flowing into the line sink for each time step.
const bool _use_mass_fraction
Whether the flux will be multiplied by the mass fraction.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
unsigned int _qp
const bool _use_internal_energy
Whether the flux will be multiplied by the internal-energy.
const VariableValue & _multiplying_var
mass flux is multiplied by this variable evaluated at quadpoints
const unsigned int _sp
The component number (only used if _use_mass_fraction==true)
unsigned int _i
const bool _use_mobility
Whether the flux will be multiplied by the mobility.

◆ dptqp()

Real PorousFlowLineSink::dptqp ( unsigned  pvar) const
protected

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

Parameters
pvarThe PorousFlow variable number

Definition at line 347 of file PorousFlowLineSink.C.

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

348 {
349  return (_p_or_t == PorTchoice::pressure ? (*_dpp_dvar)[_qp][_ph][pvar]
350  : (*_dtemperature_dvar)[_qp][pvar]);
351 }
const unsigned int _ph
The phase number.
const MaterialProperty< std::vector< Real > > *const _dtemperature_dvar
d(quadpoint temperature)/d(PorousFlow variable)
const MaterialProperty< std::vector< std::vector< Real > > > *const _dpp_dvar
d(quadpoint pore pressure in each phase)/d(PorousFlow variable)
unsigned int _qp
enum PorousFlowLineSink::PorTchoice _p_or_t

◆ initialSetup()

void PorousFlowLineGeometry::initialSetup ( )
overridevirtualinherited

Reimplemented from DiracKernelTempl< class >.

Reimplemented in PorousFlowPeacemanBorehole.

Definition at line 106 of file PorousFlowLineGeometry.C.

Referenced by PorousFlowPeacemanBorehole::initialSetup().

107 {
108  if (!_point_file.empty())
109  {
110  // open file
111  std::ifstream file(_point_file.c_str());
112  if (!file.good())
113  paramError("point_file", "PorousFlowLineGeometry: Error opening file " + _point_file);
114 
115  // construct the arrays of weight, x, y and z
116  std::vector<Real> scratch;
117  while (parseNextLineReals(file, scratch))
118  {
119  if (scratch.size() >= 2)
120  {
121  _rs.push_back(scratch[0]);
122  _xs.push_back(scratch[1]);
123  if (scratch.size() >= 3)
124  _ys.push_back(scratch[2]);
125  else
126  _ys.push_back(0.0);
127  if (scratch.size() >= 4)
128  _zs.push_back(scratch[3]);
129  else
130  _zs.push_back(0.0);
131  }
132  }
133  file.close();
134  calcLineLengths();
135  }
136  else if (_usingReporter)
137  {
138  if (_weight->size() != _x_coord->size() || _weight->size() != _y_coord->size() ||
139  _weight->size() != _z_coord->size())
140  {
141  std::string errMsg =
142  "The value and coordinate vectors are a different size. \n"
143  "There must be one value per coordinate. If the sizes are \n"
144  "zero, the reporter or reporter may not have been initialized with data \n"
145  "before the Dirac Kernel is called. \n"
146  "Try setting \"execute_on = timestep_begin\" in the reporter being read. \n"
147  "weight size = " +
148  std::to_string(_weight->size()) +
149  "; x_coord size = " + std::to_string(_x_coord->size()) +
150  "; y_coord size = " + std::to_string(_y_coord->size()) +
151  "; z_coord size = " + std::to_string(_z_coord->size());
152 
153  mooseError(errMsg);
154  }
155 
156  for (std::size_t i = 0; i < _x_coord->size(); ++i)
157  {
158  _rs.push_back(_weight->at(i));
159  _xs.push_back(_x_coord->at(i));
160  _ys.push_back(_y_coord->at(i));
161  _zs.push_back(_z_coord->at(i));
162  }
163  calcLineLengths();
164  }
165  else
166  {
167  _line_base = getParam<std::vector<Real>>("line_base");
168  if (_line_base.size() != _mesh.dimension() + 1)
169  paramError("line_base",
170  "PorousFlowLineGeometry: wrong number of arguments - got ",
171  _line_base.size(),
172  ", expected ",
173  _mesh.dimension() + 1,
174  " '<weight> <x> [<y> [z]]'");
175 
176  for (size_t i = _line_base.size(); i < 4; i++)
177  _line_base.push_back(0); // fill out zeros up to weight+3 dimensions
178 
179  // make sure line base point is inside the mesh
180  Point start(_line_base[1], _line_base[2], _line_base[3]);
181  Point end = start + _line_length * _line_direction / _line_direction.norm();
182  auto pl = _subproblem.mesh().getPointLocator();
183  pl->enable_out_of_mesh_mode();
184 
185  auto * elem = (*pl)(start);
186  auto elem_id = elem ? elem->id() : libMesh::DofObject::invalid_id;
187  _communicator.min(elem_id);
188  if (elem_id == libMesh::DofObject::invalid_id)
189  paramError("line_base", "base point ", start, " lies outside the mesh");
190 
191  elem = (*pl)(end);
192  elem_id = elem ? elem->id() : libMesh::DofObject::invalid_id;
193  _communicator.min(elem_id);
194  if (elem_id == libMesh::DofObject::invalid_id)
195  paramError("line_length", "length causes end point ", end, " to lie outside the mesh");
196 
197  regenPoints();
198  }
199 }
MooseMesh & _mesh
virtual MooseMesh & mesh()=0
const std::vector< Real > *const _weight
auto norm() const -> decltype(std::norm(Real()))
const std::vector< Real > *const _y_coord
bool parseNextLineReals(std::ifstream &ifs, std::vector< Real > &myvec)
Reads a space-separated line of floats from ifs and puts in myvec.
const Real _line_length
Line length. This is only used if there is only one borehole point.
std::vector< Real > _ys
y points of the borehole
const Parallel::Communicator & _communicator
const RealVectorValue _line_direction
Line direction. This is only used if there is only one borehole point.
void min(const T &r, T &o, Request &req) const
virtual unsigned int dimension() const
std::vector< Real > _zs
z points of borehole
SubProblem & _subproblem
static const dof_id_type invalid_id
void paramError(const std::string &param, Args... args) const
std::vector< Real > _line_base
alternative (to the point file data) line weight and start point.
const std::vector< Real > *const _x_coord
const std::vector< Real > *const _z_coord
const std::string _point_file
File defining the geometry of the borehole.
void mooseError(Args &&... args) const
virtual std::unique_ptr< libMesh::PointLocatorBase > getPointLocator() const
std::vector< Real > _xs
x points of the borehole
std::vector< Real > _rs
Radii of the borehole.

◆ jac()

Real PorousFlowLineSink::jac ( unsigned int  jvar)
protected

Jacobian contribution for the derivative wrt the variable jvar.

Definition at line 273 of file PorousFlowLineSink.C.

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

274 {
276  return 0.0;
277  const unsigned pvar = _dictator.porousFlowVariableNum(jvar);
278 
279  Real outflow;
280  Real outflowp;
281  const unsigned current_dirac_ptid = currentPointCachedID();
282  computeQpBaseOutflowJacobian(jvar, current_dirac_ptid, outflow, outflowp);
283  if (outflow == 0.0 && outflowp == 0.0)
284  return 0.0;
285 
286  outflow *= _multiplying_var[_qp];
287  outflowp *= _multiplying_var[_qp];
288 
290  {
291  const Real relperm_prime = (_i != _j ? 0.0 : (*_drelative_permeability_dvar)[_i][_ph][pvar]);
292  outflowp = (*_relative_permeability)[_i][_ph] * outflowp + relperm_prime * outflow;
293  outflow *= (*_relative_permeability)[_i][_ph];
294  }
295 
296  if (_use_mobility)
297  {
298  const Real mob = (*_relative_permeability)[_i][_ph] * (*_fluid_density_node)[_i][_ph] /
299  (*_fluid_viscosity)[_i][_ph];
300  const Real mob_prime =
301  (_i != _j
302  ? 0.0
303  : (*_drelative_permeability_dvar)[_i][_ph][pvar] * (*_fluid_density_node)[_i][_ph] /
304  (*_fluid_viscosity)[_i][_ph] +
305  (*_relative_permeability)[_i][_ph] *
306  (*_dfluid_density_node_dvar)[_i][_ph][pvar] / (*_fluid_viscosity)[_i][_ph] -
307  (*_relative_permeability)[_i][_ph] * (*_fluid_density_node)[_i][_ph] *
308  (*_dfluid_viscosity_dvar)[_i][_ph][pvar] /
309  Utility::pow<2>((*_fluid_viscosity)[_i][_ph]));
310  outflowp = mob * outflowp + mob_prime * outflow;
311  outflow *= mob;
312  }
313 
314  if (_use_mass_fraction)
315  {
316  const Real mass_fractions_prime =
317  (_i != _j ? 0.0 : (*_dmass_fractions_dvar)[_i][_ph][_sp][pvar]);
318  outflowp = (*_mass_fractions)[_i][_ph][_sp] * outflowp + mass_fractions_prime * outflow;
319  outflow *= (*_mass_fractions)[_i][_ph][_sp];
320  }
321 
322  if (_use_enthalpy)
323  {
324  const Real enthalpy_prime = (_i != _j ? 0.0 : (*_denthalpy_dvar)[_i][_ph][pvar]);
325  outflowp = (*_enthalpy)[_i][_ph] * outflowp + enthalpy_prime * outflow;
326  outflow *= (*_enthalpy)[_i][_ph];
327  }
328 
330  {
331  const Real internal_energy_prime = (_i != _j ? 0.0 : (*_dinternal_energy_dvar)[_i][_ph][pvar]);
332  outflowp = (*_internal_energy)[_i][_ph] * outflowp + internal_energy_prime * outflow;
333  // this multiplication was performed, but the code does not need to know: outflow *=
334  // (*_internal_energy)[_i][_ph];
335  }
336 
337  return outflowp;
338 }
const bool _use_enthalpy
Whether the flux will be multiplied by the enthalpy.
const unsigned int _ph
The phase number.
bool notPorousFlowVariable(unsigned int moose_var_num) const
Returns true if moose_var_num is not a porous flow variabe.
const PorousFlowDictator & _dictator
PorousFlowDictator UserObject.
const bool _use_relative_permeability
Whether the flux will be multiplied by the relative permeability.
unsigned currentPointCachedID()
const bool _use_mass_fraction
Whether the flux will be multiplied by the mass fraction.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
unsigned int _j
unsigned int _qp
const bool _use_internal_energy
Whether the flux will be multiplied by the internal-energy.
unsigned int porousFlowVariableNum(unsigned int moose_var_num) const
The PorousFlow variable number.
const VariableValue & _multiplying_var
mass flux is multiplied by this variable evaluated at quadpoints
const unsigned int _sp
The component number (only used if _use_mass_fraction==true)
unsigned int _i
virtual void computeQpBaseOutflowJacobian(unsigned jvar, unsigned current_dirac_ptid, Real &outflow, Real &outflowp) const =0
Calculates the BaseOutflow as well as its derivative wrt jvar. Derived classes should override this...
const bool _use_mobility
Whether the flux will be multiplied by the mobility.

◆ 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.

286 {
288  regenPoints();
289 }
virtual void meshChanged() override

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

294 {
295  std::string line;
296  myvec.clear();
297  bool gotline(false);
298  if (getline(ifs, line))
299  {
300  gotline = true;
301 
302  // Harvest floats separated by whitespace
303  std::istringstream iss(line);
304  Real f;
305  while (iss >> f)
306  {
307  myvec.push_back(f);
308  }
309  }
310  return gotline;
311 }
Real f(Real x)
Test function for Brents method.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

◆ ptqp()

Real PorousFlowLineSink::ptqp ( ) const
protected

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 PorousFlowPolyLineSink::computeQpBaseOutflow(), PorousFlowPeacemanBorehole::computeQpBaseOutflow(), PorousFlowPolyLineSink::computeQpBaseOutflowJacobian(), and PorousFlowPeacemanBorehole::computeQpBaseOutflowJacobian().

342 {
343  return (_p_or_t == PorTchoice::pressure ? (*_pp)[_qp][_ph] : (*_temperature)[_qp]);
344 }
const unsigned int _ph
The phase number.
const MaterialProperty< std::vector< Real > > *const _pp
Quadpoint pore pressure in each phase.
unsigned int _qp
enum PorousFlowLineSink::PorTchoice _p_or_t
const MaterialProperty< Real > *const _temperature
Quadpoint temperature.

◆ validParams()

InputParameters PorousFlowLineSink::validParams ( )
static

Definition at line 14 of file PorousFlowLineSink.C.

Referenced by PorousFlowPolyLineSink::validParams(), and PorousFlowPeacemanBorehole::validParams().

15 {
17  MooseEnum p_or_t_choice("pressure=0 temperature=1", "pressure");
18  params.addParam<MooseEnum>("function_of",
19  p_or_t_choice,
20  "Modifying functions will be a function of either pressure and "
21  "permeability (eg, for boreholes that pump fluids) or "
22  "temperature and thermal conductivity (eg, for boreholes that "
23  "pump pure heat with no fluid flow)");
24  params.addRequiredParam<UserObjectName>(
25  "SumQuantityUO",
26  "User Object of type=PorousFlowSumQuantity in which to place the total "
27  "outflow from the line sink for each time step.");
28  params.addRequiredParam<UserObjectName>(
29  "PorousFlowDictator", "The UserObject that holds the list of PorousFlow variable names");
30  params.addParam<unsigned int>(
31  "fluid_phase",
32  0,
33  "The fluid phase whose pressure (and potentially mobility, enthalpy, etc) "
34  "controls the flux to the line sink. For p_or_t=temperature, and without "
35  "any use_*, this parameter is irrelevant");
36  params.addParam<unsigned int>("mass_fraction_component",
37  "The index corresponding to a fluid "
38  "component. If supplied, the flux will "
39  "be multiplied by the nodal mass "
40  "fraction for the component");
41  params.addParam<bool>(
42  "use_relative_permeability", false, "Multiply the flux by the fluid relative permeability");
43  params.addParam<bool>("use_mobility", false, "Multiply the flux by the fluid mobility");
44  params.addParam<bool>("use_enthalpy", false, "Multiply the flux by the fluid enthalpy");
45  params.addParam<bool>(
46  "use_internal_energy", false, "Multiply the flux by the fluid internal energy");
47  params.addCoupledVar("multiplying_var", 1.0, "Fluxes will be moultiplied by this variable");
48  params.addClassDescription("Approximates a line sink in the mesh by a sequence of weighted Dirac "
49  "points whose positions are read from a file");
50  return params;
51 }
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
void addRequiredParam(const std::string &name, const std::string &doc_string)
static InputParameters validParams()
Creates a new PorousFlowLineGeometry This reads the file containing the lines of the form weight x y ...
void addCoupledVar(const std::string &name, const std::string &doc_string)
void addClassDescription(const std::string &doc_string)

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
protected

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
protected

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
protected

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

Definition at line 133 of file PorousFlowLineSink.h.

◆ _dictator

const PorousFlowDictator& PorousFlowLineSink::_dictator
protected

◆ _dinternal_energy_dvar

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

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
protected

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
protected

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

Definition at line 115 of file PorousFlowLineSink.h.

Referenced by dptqp().

◆ _drelative_permeability_dvar

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

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
protected

d(quadpoint temperature)/d(PorousFlow variable)

Definition at line 121 of file PorousFlowLineSink.h.

Referenced by dptqp().

◆ _enthalpy

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

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
protected

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
protected

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

◆ _has_enthalpy

const bool PorousFlowLineSink::_has_enthalpy
protected

Whether an enthalpy material exists (for error checking)

Definition at line 82 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink().

◆ _has_internal_energy

const bool PorousFlowLineSink::_has_internal_energy
protected

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

Definition at line 85 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink().

◆ _has_mass_fraction

const bool PorousFlowLineSink::_has_mass_fraction
protected

Whether a mass_fraction material exists (for error checking)

Definition at line 73 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink().

◆ _has_mobility

const bool PorousFlowLineSink::_has_mobility
protected

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

Definition at line 79 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink().

◆ _has_porepressure

const bool PorousFlowLineSink::_has_porepressure
protected

Whether a quadpoint porepressure material exists (for error checking)

Definition at line 67 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink().

◆ _has_relative_permeability

const bool PorousFlowLineSink::_has_relative_permeability
protected

Whether a relative permeability material exists (for error checking)

Definition at line 76 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink().

◆ _has_temperature

const bool PorousFlowLineSink::_has_temperature
protected

Whether a quadpoint temperature material exists (for error checking)

Definition at line 70 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink().

◆ _internal_energy

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

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
protected

Mass fraction of each component in each phase.

Definition at line 142 of file PorousFlowLineSink.h.

◆ _multiplying_var

const VariableValue& PorousFlowLineSink::_multiplying_var
protected

mass flux is multiplied by this variable evaluated at quadpoints

Definition at line 160 of file PorousFlowLineSink.h.

Referenced by computeQpResidual(), and jac().

◆ _p_or_t

enum PorousFlowLineSink::PorTchoice PorousFlowLineSink::_p_or_t
protected

◆ _ph

const unsigned int PorousFlowLineSink::_ph
protected

The phase number.

Definition at line 106 of file PorousFlowLineSink.h.

Referenced by computeQpResidual(), dptqp(), jac(), PorousFlowLineSink(), and 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
protected

Quadpoint pore pressure in each phase.

Definition at line 112 of file PorousFlowLineSink.h.

Referenced by ptqp().

◆ _relative_permeability

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

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

◆ _sp

const unsigned int PorousFlowLineSink::_sp
protected

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

Definition at line 109 of file PorousFlowLineSink.h.

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

◆ _temperature

const MaterialProperty<Real>* const PorousFlowLineSink::_temperature
protected

Quadpoint temperature.

Definition at line 118 of file PorousFlowLineSink.h.

Referenced by ptqp().

◆ _total_outflow_mass

PorousFlowSumQuantity& PorousFlowLineSink::_total_outflow_mass
protected

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 addPoints(), computeQpResidual(), and PorousFlowLineSink().

◆ _use_enthalpy

const bool PorousFlowLineSink::_use_enthalpy
protected

Whether the flux will be multiplied by the enthalpy.

Definition at line 100 of file PorousFlowLineSink.h.

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

◆ _use_internal_energy

const bool PorousFlowLineSink::_use_internal_energy
protected

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

Definition at line 103 of file PorousFlowLineSink.h.

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

◆ _use_mass_fraction

const bool PorousFlowLineSink::_use_mass_fraction
protected

Whether the flux will be multiplied by the mass fraction.

Definition at line 91 of file PorousFlowLineSink.h.

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

◆ _use_mobility

const bool PorousFlowLineSink::_use_mobility
protected

Whether the flux will be multiplied by the mobility.

Definition at line 97 of file PorousFlowLineSink.h.

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

◆ _use_relative_permeability

const bool PorousFlowLineSink::_use_relative_permeability
protected

Whether the flux will be multiplied by the relative permeability.

Definition at line 94 of file PorousFlowLineSink.h.

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

◆ _usingReporter

const bool PorousFlowLineGeometry::_usingReporter
protectedinherited

◆ _weight

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

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

◆ _y_coord

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

◆ _ys

std::vector<Real> PorousFlowLineGeometry::_ys
protectedinherited

◆ _z_coord

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

◆ _zs

std::vector<Real> PorousFlowLineGeometry::_zs
protectedinherited

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