Computes and caches flux and residual vectors for a 1-phase pump. More...

#include <ADPump1PhaseUserObject.h>

Inheritance diagram for ADPump1PhaseUserObject:

Public Types
enum	TEST_TYPE

typedef DataFileName	DataFileParameterType

Public Member Functions
	ADPump1PhaseUserObject (const InputParameters &params)

virtual void	finalize () override

virtual void	initialSetup () override

virtual void	initialize () override

virtual void	execute () override

virtual void	threadJoin (const UserObject &uo) override

const std::vector< ADReal > &	getResidual () const
	Returns the residual vector for the scalar variables. More...

const std::vector< ADReal > &	getFlux (const unsigned int &connection_index) const override
	Gets the flux vector for a connection. More...

unsigned int	getNumberOfConnections () const
	Gets the number of connected flow channels. More...

SubProblem &	getSubProblem () const

bool	shouldDuplicateInitialExecution () const

virtual Real	spatialValue (const Point &) const

virtual const std::vector< Point >	spatialPoints () const

void	gatherSum (T &value)

void	gatherMax (T &value)

void	gatherMin (T &value)

void	gatherProxyValueMax (T1 &proxy, T2 &value)

void	gatherProxyValueMin (T1 &proxy, T2 &value)

void	setPrimaryThreadCopy (UserObject *primary)

UserObject *	primaryThreadCopy ()

std::set< UserObjectName >	getDependObjects () const

virtual bool	needThreadedCopy () const

const std::set< std::string > &	getRequestedItems () override

const std::set< std::string > &	getSuppliedItems () override

unsigned int	systemNumber () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

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

MooseApp &	getMooseApp () const

const std::string &	type () const

virtual const std::string &	name () const

std::string	typeAndName () const

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

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

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

const InputParameters &	parameters () const

MooseObjectName	uniqueName () const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

std::string	getDataFileNameByName (const std::string &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 ExecFlagEnum &	getExecuteOnEnum () const

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

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

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

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

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

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

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

unsigned int	numBoundaryIDs () const

bool	hasBoundary (const BoundaryName &name) const

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

bool	hasBoundary (const BoundaryID &id) const

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

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

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

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

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

virtual bool	boundaryRestricted () const

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

virtual bool	checkVariableBoundaryIntegrity () const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty ()

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

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

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

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

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

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

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

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

void	statefulPropertiesAllowed (bool)

bool	getMaterialPropertyCalled () const

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

virtual void	resolveOptionalProperties ()

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

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

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

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

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

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

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

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

void	addFEVariableCoupleableVectorTag (TagID tag)

void	addFEVariableCoupleableMatrixTag (TagID tag)

std::set< TagID > &	getFEVariableCoupleableVectorTags ()

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

std::set< TagID > &	getFEVariableCoupleableMatrixTags ()

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

auto &	getWritableCoupledVariables () const

bool	hasWritableCoupledVariables () const

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

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

const ADVariableGradient &	getADDefaultGradient () const

const ADVectorVariableGradient &	getADDefaultVectorGradient () const

const ADVariableSecond &	getADDefaultSecond () const

const ADVectorVariableCurl &	getADDefaultCurl () const

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

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

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

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

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

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

bool	isImplicit ()

Moose::StateArg	determineState () const

virtual unsigned int	getElementIDIndex (const std::string &id_parameter_name, unsigned int comp=0) const

virtual unsigned int	getElementIDIndexByName (const std::string &id_name) const

virtual const dof_id_type &	getElementID (const std::string &id_parameter_name, unsigned int comp=0) const

dof_id_type	getElementID (const Elem *elem, unsigned int elem_id_index) const

virtual const dof_id_type &	getElementIDNeighbor (const std::string &id_parameter_name, unsigned int comp=0) const

virtual const dof_id_type &	getElementIDByName (const std::string &id_name) const

virtual const dof_id_type &	getElementIDNeighborByName (const std::string &id_name) const

bool	hasElementID (const std::string &id_name) const

dof_id_type	maxElementID (unsigned int elem_id_index) const

dof_id_type	minElementID (unsigned int elem_id_index) const

bool	areElemIDsIdentical (const std::string &id_name1, const std::string &id_name2) const

std::unordered_map< dof_id_type, std::set< dof_id_type > >	getElemIDMapping (const std::string &id_name1, const std::string &id_name2) const

std::set< dof_id_type >	getAllElemIDs (unsigned int elem_id_index) const

std::set< dof_id_type >	getElemIDsOnBlocks (unsigned int elem_id_index, const std::set< SubdomainID > &blks) const

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 GenericOptionalMaterialProperty< T, is_ad > &	getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

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

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

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

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

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

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

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

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

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

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

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

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

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

bool	hasMaterialProperty (const std::string &name)

bool	hasMaterialProperty (const std::string &name)

bool	hasMaterialPropertyByName (const std::string &name)

bool	hasMaterialPropertyByName (const std::string &name)

bool	hasADMaterialProperty (const std::string &name)

bool	hasADMaterialProperty (const std::string &name)

bool	hasADMaterialPropertyByName (const std::string &name)

bool	hasADMaterialPropertyByName (const std::string &name)

bool	hasGenericMaterialProperty (const std::string &name)

bool	hasGenericMaterialProperty (const std::string &name)

bool	hasGenericMaterialPropertyByName (const std::string &name)

bool	hasGenericMaterialPropertyByName (const std::string &name)

const Function &	getFunction (const std::string &name) const

const Function &	getFunctionByName (const FunctionName &name) const

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

bool	hasFunctionByName (const FunctionName &name) const

bool	isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessor (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessorByName (const PostprocessorName &name) const

std::size_t	coupledPostprocessors (const std::string &param_name) const

const PostprocessorName &	getPostprocessorName (const std::string &param_name, const unsigned int index=0) const

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

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

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name) const

const VectorPostprocessorName &	getVectorPostprocessorName (const std::string &param_name) const

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

Sampler &	getSampler (const std::string &name)

T &	getSamplerByName (const SamplerName &name)

Sampler &	getSamplerByName (const SamplerName &name)

virtual void	meshChanged ()

PerfGraph &	perfGraph ()

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

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

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

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

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

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

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

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

const Distribution &	getDistributionByName (const DistributionName &name) const

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

const Distribution &	getDistributionByName (const DistributionName &name) const

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

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static void	sort (typename std::vector< T > &vector)

static void	sortDFS (typename std::vector< T > &vector)

static void	cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)

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

Public Attributes
	ALL

	ANY

const ConsoleStream	_console

Static Public Attributes
static constexpr PropertyValue::id_type	default_property_id

static constexpr PropertyValue::id_type	zero_property_id

static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
virtual void	computeFluxesAndResiduals (const unsigned int &c) override
	Computes and stores the fluxes, the scalar residuals, and their Jacobians. More...

virtual void	storeConnectionData ()
	Stores data (connection index, face shape functions, DoFs associated with flow channel variables) related to a connection. More...

virtual std::vector< const MooseVariableBase * >	getJunctionVariables () const
	Gets the junction variables. More...

const MooseVariableBase *	getJunctionVar (const std::string &var_name, unsigned int i=0) const
	Gets a junction variable. More...

const ADVariableValue &	coupledJunctionValue (const std::string &var_name, unsigned int i=0) const
	Gets an AD junction variable value. More...

unsigned int	getBoundaryIDIndex ()
	Gets the index of the currently executing boundary within the vector of boundary IDs given to this SideUserObject. More...

void	checkValidConnectionIndex (const unsigned int &connection_index) const
	Checks that a connection index is valid. More...

void	getFaceInfos ()

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &name) const override

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override

virtual void	addUserObjectDependencyHelper (const UserObject &uo) const override

void	addReporterDependencyHelper (const ReporterName &reporter_name) override

const ReporterName &	getReporterName (const std::string &param_name) 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

const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)

const T &	getMeshProperty (const std::string &data_name)

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

bool	hasMeshProperty (const std::string &data_name) const

std::string	meshPropertyName (const std::string &data_name) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

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

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

virtual bool	isCoupledConstant (const std::string &var_name) const

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

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

std::vector< VariableName >	coupledNames (const std::string &var_name) const

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

std::vector< unsigned int >	coupledIndices (const std::string &var_name) const

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

std::vector< const VariableValue *>	coupledValues (const std::string &var_name) const

std::vector< const VectorVariableValue *>	coupledVectorValues (const std::string &var_name) const

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

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

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

std::vector< const GenericVariableValue< is_ad > *>	coupledGenericValues (const std::string &var_name) const

std::vector< const GenericVariableValue< false > *>	coupledGenericValues (const std::string &var_name) const

std::vector< const GenericVariableValue< true > *>	coupledGenericValues (const std::string &var_name) const

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

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

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

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

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

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

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

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

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

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

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

std::vector< const ADVariableValue *>	adCoupledValues (const std::string &var_name) const

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

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

std::vector< const ADVectorVariableValue *>	adCoupledVectorValues (const std::string &var_name) const

virtual const VariableValue &	coupledVectorTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const

virtual const VariableValue &	coupledVectorTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const VariableValue *>	coupledVectorTagValues (const std::string &var_names, TagID tag) const

std::vector< const VariableValue *>	coupledVectorTagValues (const std::string &var_names, const std::string &tag_name) const

virtual const ArrayVariableValue &	coupledVectorTagArrayValue (const std::string &var_names, TagID tag, unsigned int index=0) const

virtual const ArrayVariableValue &	coupledVectorTagArrayValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const ArrayVariableValue *>	coupledVectorTagArrayValues (const std::string &var_names, TagID tag) const

std::vector< const ArrayVariableValue *>	coupledVectorTagArrayValues (const std::string &var_names, const std::string &tag_name) const

virtual const VariableGradient &	coupledVectorTagGradient (const std::string &var_names, TagID tag, unsigned int index=0) const

virtual const VariableGradient &	coupledVectorTagGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const VariableGradient *>	coupledVectorTagGradients (const std::string &var_names, TagID tag) const

std::vector< const VariableGradient *>	coupledVectorTagGradients (const std::string &var_names, const std::string &tag_name) const

virtual const ArrayVariableGradient &	coupledVectorTagArrayGradient (const std::string &var_names, TagID tag, unsigned int index=0) const

virtual const ArrayVariableGradient &	coupledVectorTagArrayGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const ArrayVariableGradient *>	coupledVectorTagArrayGradients (const std::string &var_names, TagID tag) const

std::vector< const ArrayVariableGradient *>	coupledVectorTagArrayGradients (const std::string &var_names, const std::string &tag_name) const

virtual const VariableValue &	coupledVectorTagDofValue (const std::string &var_name, TagID tag, unsigned int index=0) const

virtual const VariableValue &	coupledVectorTagDofValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

const ArrayVariableValue &	coupledVectorTagArrayDofValue (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const

std::vector< const VariableValue *>	coupledVectorTagDofValues (const std::string &var_names, TagID tag) const

std::vector< const VariableValue *>	coupledVectorTagDofValues (const std::string &var_names, const std::string &tag_name) const

virtual const VariableValue &	coupledMatrixTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const

virtual const VariableValue &	coupledMatrixTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const VariableValue *>	coupledMatrixTagValues (const std::string &var_names, TagID tag) const

std::vector< const VariableValue *>	coupledMatrixTagValues (const std::string &var_names, const std::string &tag_name) const

virtual const VectorVariableValue &	coupledVectorValue (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayValue (const std::string &var_name, unsigned int comp=0) const

std::vector< const ArrayVariableValue *>	coupledArrayValues (const std::string &var_name) const

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

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

void	checkWritableVar (MooseWritableVariable *var)

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

std::vector< const VariableValue *>	coupledValuesOld (const std::string &var_name) const

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

std::vector< const VariableValue *>	coupledValuesOlder (const std::string &var_name) const

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

virtual const VectorVariableValue &	coupledVectorValueOld (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableValue &	coupledVectorValueOlder (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayValueOld (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayValueOlder (const std::string &var_name, unsigned int comp=0) const

virtual const VariableGradient &	coupledGradient (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableGradient *>	coupledGradients (const std::string &var_name) const

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

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

std::vector< const ADVariableGradient *>	adCoupledGradients (const std::string &var_name) const

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

const GenericVariableGradient< false > &	coupledGenericGradient (const std::string &var_name, unsigned int comp) const

const GenericVariableGradient< true > &	coupledGenericGradient (const std::string &var_name, unsigned int comp) const

std::vector< const GenericVariableGradient< is_ad > *>	coupledGenericGradients (const std::string &var_name) const

std::vector< const GenericVariableGradient< false > *>	coupledGenericGradients (const std::string &var_name) const

std::vector< const GenericVariableGradient< true > *>	coupledGenericGradients (const std::string &var_name) const

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

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

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

virtual const VariableGradient &	coupledGradientOld (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableGradient *>	coupledGradientsOld (const std::string &var_name) const

virtual const VariableGradient &	coupledGradientOlder (const std::string &var_name, unsigned int comp=0) const

virtual const VariableGradient &	coupledGradientPreviousNL (const std::string &var_name, unsigned int comp=0) const

virtual const VariableGradient &	coupledGradientDot (const std::string &var_name, unsigned int comp=0) const

virtual const VariableGradient &	coupledGradientDotDot (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableGradient &	coupledVectorGradient (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableGradient &	coupledVectorGradientOld (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableGradient &	coupledVectorGradientOlder (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableGradient &	coupledArrayGradient (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableGradient &	coupledArrayGradientOld (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableGradient &	coupledArrayGradientOlder (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableGradient &	coupledArrayGradientDot (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableCurl &	coupledCurl (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableCurl &	coupledCurlOld (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableCurl &	coupledCurlOlder (const std::string &var_name, unsigned int comp=0) const

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

virtual const VectorVariableDivergence &	coupledDiv (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableDivergence &	coupledDivOld (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableDivergence &	coupledDivOlder (const std::string &var_name, unsigned int comp=0) const

virtual const VariableSecond &	coupledSecond (const std::string &var_name, unsigned int comp=0) const

virtual const VariableSecond &	coupledSecondOld (const std::string &var_name, unsigned int comp=0) const

virtual const VariableSecond &	coupledSecondOlder (const std::string &var_name, unsigned int comp=0) const

virtual const VariableSecond &	coupledSecondPreviousNL (const std::string &var_name, unsigned int comp=0) const

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

std::vector< const VariableValue *>	coupledDots (const std::string &var_name) const

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

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

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

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

std::vector< const ADVariableValue *>	adCoupledDots (const std::string &var_name) const

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

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

virtual const VectorVariableValue &	coupledVectorDot (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableValue &	coupledVectorDotDot (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableValue &	coupledVectorDotOld (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableValue &	coupledVectorDotDotOld (const std::string &var_name, unsigned int comp=0) const

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

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

virtual const ArrayVariableValue &	coupledArrayDot (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayDotDot (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayDotOld (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayDotDotOld (const std::string &var_name, unsigned int comp=0) const

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

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

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

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

const Moose::ADType< T >::type &	adCoupledNodalValue (const std::string &var_name, unsigned int comp=0) const

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

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

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

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

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

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

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

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

std::vector< const VariableValue *>	coupledAllDofValues (const std::string &var_name) const

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

std::vector< const VariableValue *>	coupledAllDofValuesOld (const std::string &var_name) const

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

std::vector< const VariableValue *>	coupledAllDofValuesOlder (const std::string &var_name) const

virtual const ArrayVariableValue &	coupledArrayDofValues (const std::string &var_name, unsigned int comp=0) const

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

const ADVariableValue &	adZeroValue () const

const ADVariableGradient &	adZeroGradient () const

const ADVariableSecond &	adZeroSecond () const

const GenericVariableValue< is_ad > &	genericZeroValue ()

const GenericVariableValue< false > &	genericZeroValue ()

const GenericVariableValue< true > &	genericZeroValue ()

const GenericVariableGradient< is_ad > &	genericZeroGradient ()

const GenericVariableGradient< false > &	genericZeroGradient ()

const GenericVariableGradient< true > &	genericZeroGradient ()

const GenericVariableSecond< is_ad > &	genericZeroSecond ()

const GenericVariableSecond< false > &	genericZeroSecond ()

const GenericVariableSecond< true > &	genericZeroSecond ()

bool	checkVar (const std::string &var_name, unsigned int comp=0, unsigned int comp_bound=0) const

const MooseVariableFieldBase *	getFEVar (const std::string &var_name, unsigned int comp) const

const MooseVariableFieldBase *	getFieldVar (const std::string &var_name, unsigned int comp) const

MooseVariableFieldBase *	getFieldVar (const std::string &var_name, unsigned int comp)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	addMooseVariableDependency (MooseVariableFieldBase *var)

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

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

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)

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
const Real &	_head
	Pump head, [m]. More...

const Real &	_g
	Gravity constant, i.e., 9.8 [m/s^2]. More...

const ADVariableValue &	_A
	Cross-sectional area of connected flow channels. More...

const ADVariableValue &	_rhoA
	rho*A of the connected flow channels More...

const ADVariableValue &	_rhouA
	rhouA of the connected flow channels More...

const ADVariableValue &	_rhoEA
	rhoEA of the connected flow channels More...

const Real &	_K
	Form loss coefficient. More...

const Real &	_A_ref
	Reference area. More...

const bool	_apply_velocity_scaling
	Apply velocity scaling? More...

const SinglePhaseFluidProperties &	_fp
	Single-phase fluid properties user object. More...

std::vector< const ADNumericalFlux3EqnBase * >	_numerical_flux_uo
	Vector of numerical flux user objects for each connected flow channel. More...

const bool	_use_scalar_variables
	True if the junction variables are scalar variables. More...

const subdomain_id_type	_junction_subdomain_id
	Junction subdomain ID. More...

const Real &	_volume
	Volume of the junction. More...

std::vector< std::string >	_flow_variable_names
	Vector of coupled variable names for each flow variable. More...

std::vector< std::string >	_scalar_variable_names
	Vector of coupled variable names for each scalar variable. More...

unsigned int	_n_flux_eq
	Number of flow channel flux components. More...

unsigned int	_n_scalar_eq
	Number of scalar residual components. More...

std::vector< const ADVariableValue * >	_junction_var_values

std::vector< ADReal >	_cached_junction_var_values

const std::vector< UserObjectName > &	_numerical_flux_names
	Names of numerical flux user objects for each connected flow channel. More...

std::vector< unsigned int >	_connection_indices
	Connection indices for this thread. More...

std::vector< dof_id_type >	_scalar_dofs
	Degrees of freedom for scalar variables. More...

std::vector< std::vector< dof_id_type > >	_flow_channel_dofs
	Degrees of freedom for flow channel variables, for each connection. More...

std::vector< std::vector< ADReal > >	_flux
	Cached flux vector for each connection. More...

std::vector< ADReal >	_residual
	Cached scalar residual vector. More...

const std::vector< BoundaryID >	_bnd_ids_vector
	Vector of boundary IDs for this side user object; note that BoundaryRestrictable stores these same boundary IDs in _bnd_ids, but they are stored privately and in a set instead of a vector, so ordering is not preserved. More...

const unsigned int	_n_bnd_ids

std::map< std::pair< const Elem *, const unsigned short int >, unsigned int >	_elem_side_to_bnd_id_index

const std::vector< Real > &	_normal
	Flow channel outward normals or junction inward normals. More...

const MaterialProperty< RealVectorValue > &	_dir
	Direction of the element connected to the junction. More...

const unsigned int	_n_connections
	Number of connected flow channels. More...

std::vector< unsigned int >	_processor_ids
	Owners of each side of the junction. More...

MooseMesh &	_mesh

const MooseArray< Point > &	_q_point

const QBase *const &	_qrule

const MooseArray< Real > &	_JxW

const MooseArray< Real > &	_coord

const MooseArray< Point > &	_normals

const Elem *const &	_current_elem

const unsigned int &	_current_side

const Elem *const &	_current_side_elem

const Real &	_current_side_volume

const BoundaryID &	_current_boundary_id

std::vector< const FaceInfo *>	_face_infos

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

const THREAD_ID	_tid

Assembly &	_assembly

const Moose::CoordinateSystemType &	_coord_sys

const bool	_duplicate_initial_execution

std::set< std::string >	_depend_uo

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

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

FEProblemBase &	_mci_feproblem

MooseApp &	_pg_moose_app

const std::string	_prefix

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

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

const Parallel::Communicator &	_communicator

Static Protected Attributes
static const std::string	_interpolated_old

static const std::string	_interpolated_older

Detailed Description

Computes and caches flux and residual vectors for a 1-phase pump.

This class computes and caches the following quantities:

residuals for the scalar variables associated with the pump, and
fluxes between the flow channels and the pump.

Definition at line 21 of file ADPump1PhaseUserObject.h.

Constructor & Destructor Documentation

◆ ADPump1PhaseUserObject()

ADPump1PhaseUserObject::ADPump1PhaseUserObject ( const InputParameters & params )

Definition at line 34 of file ADPump1PhaseUserObject.C.

   : ADVolumeJunction1PhaseUserObject(params),
     _head(getParam<Real>("head")),
     _g(getParam<Real>("gravity_magnitude"))
 {
 }

Member Function Documentation

◆ checkValidConnectionIndex()

void ADFlowJunctionUserObject::checkValidConnectionIndex ( const unsigned int & connection_index ) const

protectedinherited

Checks that a connection index is valid.

Parameters

[in] connection_index Connection index

Definition at line 116 of file ADFlowJunctionUserObject.C.

Referenced by ADVolumeJunctionBaseUserObject::getFlux().

 {
   if (connection_index >= _n_connections)
     mooseError(name(),
                ": The connection index '",
                connection_index,
                "' is invalid; the range of valid indices is (0, ",
                _n_connections - 1,
                ").");
 }

◆ computeFluxesAndResiduals()

void ADPump1PhaseUserObject::computeFluxesAndResiduals ( const unsigned int & c )

overrideprotectedvirtual

Computes and stores the fluxes, the scalar residuals, and their Jacobians.

Parameters

[in] c Connection index

Reimplemented from ADVolumeJunction1PhaseUserObject.

Definition at line 42 of file ADPump1PhaseUserObject.C.

 {
   ADVolumeJunction1PhaseUserObject::computeFluxesAndResiduals(c);
 
   const auto & rhoV = _cached_junction_var_values[VolumeJunction1Phase::RHOV_INDEX];
   const auto & rhouV = _cached_junction_var_values[VolumeJunction1Phase::RHOUV_INDEX];
   const auto & rhovV = _cached_junction_var_values[VolumeJunction1Phase::RHOVV_INDEX];
   const auto & rhowV = _cached_junction_var_values[VolumeJunction1Phase::RHOWV_INDEX];
 
   const ADRealVectorValue di = _dir[0];
   const ADReal rho = rhoV / _volume;
   const ADRealVectorValue uvec(rhouV / rhoV, rhovV / rhoV, rhowV / rhoV);
 
   // compute momentum and energy source terms
   const ADRealVectorValue S_momentum = 0.5 * rho * _g * _head * _A_ref * di;
   const ADReal S_energy = S_momentum * uvec;
 
   _residual[VolumeJunction1Phase::RHOUV_INDEX] -= S_momentum(0);
   _residual[VolumeJunction1Phase::RHOVV_INDEX] -= S_momentum(1);
   _residual[VolumeJunction1Phase::RHOWV_INDEX] -= S_momentum(2);
   _residual[VolumeJunction1Phase::RHOEV_INDEX] -= S_energy;
 }

◆ coupledJunctionValue()

const ADVariableValue & ADVolumeJunctionBaseUserObject::coupledJunctionValue	(	const std::string &	var_name,
		unsigned int	i = `0`
	)		const

protectedinherited

Gets an AD junction variable value.

Definition at line 218 of file ADVolumeJunctionBaseUserObject.C.

Referenced by ADVolumeJunction1PhaseUserObject::ADVolumeJunction1PhaseUserObject().

 {
   return _use_scalar_variables ? adCoupledScalarValue(var_name, i) : adCoupledValue(var_name, i);
 }

◆ execute()

void ADVolumeJunctionBaseUserObject::execute ( )

overridevirtualinherited

Implements SideUserObject.

Reimplemented in ADShaftConnectedPump1PhaseUserObject, ADShaftConnectedCompressor1PhaseUserObject, and ADShaftConnectedTurbine1PhaseUserObject.

Definition at line 153 of file ADVolumeJunctionBaseUserObject.C.

 {
   storeConnectionData();
 
   const unsigned int c = getBoundaryIDIndex();
   computeFluxesAndResiduals(c);
 }

◆ finalize()

void ADVolumeJunction1PhaseUserObject::finalize ( )

overridevirtualinherited

Reimplemented from ADFlowJunctionUserObject.

Reimplemented in ADShaftConnectedCompressor1PhaseUserObject, ADShaftConnectedTurbine1PhaseUserObject, ADShaftConnectedPump1PhaseUserObject, and ADJunctionParallelChannels1PhaseUserObject.

Definition at line 221 of file ADVolumeJunction1PhaseUserObject.C.

Referenced by ADShaftConnectedPump1PhaseUserObject::finalize(), ADShaftConnectedTurbine1PhaseUserObject::finalize(), and ADShaftConnectedCompressor1PhaseUserObject::finalize().

 {
   ADVolumeJunctionBaseUserObject::finalize();
   for (unsigned int i = 0; i < _n_scalar_eq; i++)
     comm().sum(_residual[i]);
 }

◆ getBoundaryIDIndex()

unsigned int ADFlowJunctionUserObject::getBoundaryIDIndex ( )

protectedinherited

Gets the index of the currently executing boundary within the vector of boundary IDs given to this SideUserObject.

Definition at line 56 of file ADFlowJunctionUserObject.C.

Referenced by ADGateValve1PhaseUserObject::execute(), ADJunctionOneToOne1PhaseUserObject::execute(), ADShaftConnectedTurbine1PhaseUserObject::execute(), ADShaftConnectedCompressor1PhaseUserObject::execute(), ADShaftConnectedPump1PhaseUserObject::execute(), ADVolumeJunctionBaseUserObject::execute(), and ADVolumeJunctionBaseUserObject::storeConnectionData().

 {
   auto elem_side = std::make_pair(_current_elem, _current_side);
   auto it = _elem_side_to_bnd_id_index.find(elem_side);
   if (it == _elem_side_to_bnd_id_index.end())
   {
     // Get the boundary IDs associated with this (elem,side). In general, there
     // may be more than one boundary ID associated with an (elem,side), but
     // there should be exactly one of these boundary IDs that is seen by this
     // user object.
     const std::vector<BoundaryID> elem_side_bnd_ids =
         _mesh.getBoundaryIDs(_current_elem, _current_side);
 
     // Loop over the boundary IDs for this (elem,side) pair and over the
     // boundary IDs for this side user object; there should be exactly one match.
     bool found_matching_boundary_id = false;
     unsigned int boundary_id_index = 0;
     for (unsigned int i = 0; i < elem_side_bnd_ids.size(); i++)
       for (unsigned int j = 0; j < _n_bnd_ids; j++)
         if (elem_side_bnd_ids[i] == _bnd_ids_vector[j])
         {
           if (found_matching_boundary_id)
             mooseError(name(), ": Multiple matches for boundary ID were found");
           else
           {
             found_matching_boundary_id = true;
             boundary_id_index = j;
           }
         }
 
     if (!found_matching_boundary_id)
     {
       std::stringstream ss;
       ss << name() << ": No matching boundary ID was found for (elem,side) = ("
          << _current_elem->id() << "," << _current_side << ").";
       mooseError(ss.str());
     }
 
     // Check that this boundary ID index was not already found by an earlier (elem,side)
     for (auto it_other = _elem_side_to_bnd_id_index.begin();
          it_other != _elem_side_to_bnd_id_index.end();
          it_other++)
     {
       if (it_other->second == boundary_id_index)
         mooseError(name(), ": Multiple (elem,side) pairs had the same boundary ID index");
     }
 
     // Store boundary index for future use
     _elem_side_to_bnd_id_index[elem_side] = boundary_id_index;
 
     return boundary_id_index;
   }
   else
   {
     // get the boundary ID that is already stored in the map
     return _elem_side_to_bnd_id_index[elem_side];
   }
 }

◆ getFlux()

const std::vector< ADReal > & ADVolumeJunctionBaseUserObject::getFlux ( const unsigned int & connection_index ) const

overridevirtualinherited

Gets the flux vector for a connection.

Parameters

[in] connection_index Index for the connection

Implements ADFlowJunctionUserObject.

Definition at line 189 of file ADVolumeJunctionBaseUserObject.C.

Referenced by ADVolumeJunction1PhaseBC::computeQpResidual().

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
 
   checkValidConnectionIndex(connection_index);
   return _flux[connection_index];
 }

◆ getJunctionVar()

const MooseVariableBase * ADVolumeJunctionBaseUserObject::getJunctionVar	(	const std::string &	var_name,
		unsigned int	i = `0`
	)		const

protectedinherited

Gets a junction variable.

Definition at line 207 of file ADVolumeJunctionBaseUserObject.C.

Referenced by ADVolumeJunctionBaseUserObject::getJunctionVariables().

 {
   const MooseVariableBase * var;
   if (_use_scalar_variables)
     var = getScalarVar(var_name, i);
   else
     var = getVar(var_name, i);
   return var;
 }

◆ getJunctionVariables()

std::vector< const MooseVariableBase * > ADVolumeJunctionBaseUserObject::getJunctionVariables ( ) const

protectedvirtualinherited

Gets the junction variables.

Definition at line 198 of file ADVolumeJunctionBaseUserObject.C.

Referenced by ADVolumeJunctionBaseUserObject::initialize().

 {
   std::vector<const MooseVariableBase *> vars(_scalar_variable_names.size());
   for (unsigned int i = 0; i < _scalar_variable_names.size(); i++)
     vars[i] = getJunctionVar(_scalar_variable_names[i], 0);
   return vars;
 }

◆ getNumberOfConnections()

unsigned int ADFlowJunctionUserObject::getNumberOfConnections ( ) const

inlineinherited

Gets the number of connected flow channels.

Definition at line 34 of file ADFlowJunctionUserObject.h.

34 { return _n_connections; }

ADFlowJunctionUserObject::_n_connections

const unsigned int _n_connections

Number of connected flow channels.

Definition: ADFlowJunctionUserObject.h:65

◆ getResidual()

const std::vector< ADReal > & ADVolumeJunctionBaseUserObject::getResidual ( ) const

inherited

Returns the residual vector for the scalar variables.

Definition at line 181 of file ADVolumeJunctionBaseUserObject.C.

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
 
   return _residual;
 }

◆ initialize()

void ADVolumeJunctionBaseUserObject::initialize ( )

overridevirtualinherited

Implements SideUserObject.

Reimplemented in ADShaftConnectedPump1PhaseUserObject, ADShaftConnectedCompressor1PhaseUserObject, ADShaftConnectedTurbine1PhaseUserObject, and ADJunctionParallelChannels1PhaseUserObject.

Definition at line 70 of file ADVolumeJunctionBaseUserObject.C.

Referenced by ADJunctionParallelChannels1PhaseUserObject::initialize(), ADShaftConnectedTurbine1PhaseUserObject::initialize(), ADShaftConnectedCompressor1PhaseUserObject::initialize(), and ADShaftConnectedPump1PhaseUserObject::initialize().

 {
   _flux.assign(_n_connections, std::vector<ADReal>(_n_flux_eq, 0.0));
   for (auto & i : _residual)
   {
     i.value() = 0;
     i.derivatives() = DNDerivativeType();
   }
   _connection_indices.clear();
 
   auto junction_vars = getJunctionVariables();
 
   // Cache the junction variable values and get their dof indices
   if (!_use_scalar_variables)
   {
     for (unsigned int i = 0; i < _n_scalar_eq; i++)
     {
       _cached_junction_var_values[i] = 0;
       _scalar_dofs[i] = 0;
     }
 
     for (const Elem * elem : *_mesh.getActiveLocalElementRange())
     {
       if (elem->subdomain_id() == _junction_subdomain_id)
       {
         // Reinitialize the element
         _fe_problem.setCurrentSubdomainID(elem, _tid);
         _fe_problem.prepare(elem, _tid);
         _fe_problem.reinitElem(elem, _tid);
 
         // Cache the junction variable values and Dof indices
         for (unsigned int i = 0; i < _n_scalar_eq; i++)
         {
           _cached_junction_var_values[i] = (*_junction_var_values[i])[0];
 
           auto && dofs = junction_vars[i]->dofIndices();
           mooseAssert(dofs.size() == 1,
                       "There should be exactly 1 coupled DoF index for the variable '" +
                           junction_vars[i]->name() + "'.");
           _scalar_dofs[i] = dofs[0];
         }
       }
     }
 
     comm().sum(_cached_junction_var_values);
     comm().sum(_scalar_dofs);
   }
   else
   {
     for (unsigned int i = 0; i < _junction_var_values.size(); i++)
       _cached_junction_var_values[i] = (*_junction_var_values[i])[0];
 
     for (unsigned int i = 0; i < _n_scalar_eq; i++)
     {
       auto && dofs = junction_vars[i]->dofIndices();
       mooseAssert(dofs.size() == 1,
                   "There should be exactly 1 coupled DoF index for the variable '" +
                       junction_vars[i]->name() + "'.");
       _scalar_dofs[i] = dofs[0];
     }
   }
 }

◆ initialSetup()

void ADVolumeJunctionBaseUserObject::initialSetup ( )

overridevirtualinherited

Reimplemented from SideUserObject.

Reimplemented in ADShaftConnectedPump1PhaseUserObject, ADShaftConnectedCompressor1PhaseUserObject, and ADShaftConnectedTurbine1PhaseUserObject.

Definition at line 58 of file ADVolumeJunctionBaseUserObject.C.

Referenced by ADShaftConnectedCompressor1PhaseUserObject::initialSetup(), ADShaftConnectedTurbine1PhaseUserObject::initialSetup(), and ADShaftConnectedPump1PhaseUserObject::initialSetup().

 {
   _n_flux_eq = _flow_variable_names.size();
   _n_scalar_eq = _scalar_variable_names.size();
 
   _scalar_dofs.resize(_n_scalar_eq);
   _cached_junction_var_values.resize(_n_scalar_eq);
   _flow_channel_dofs.resize(_n_connections);
   _residual.resize(_n_scalar_eq);
 }

◆ storeConnectionData()

void ADVolumeJunctionBaseUserObject::storeConnectionData ( )

protectedvirtualinherited

Stores data (connection index, face shape functions, DoFs associated with flow channel variables) related to a connection.

Should be called in execute()

Definition at line 134 of file ADVolumeJunctionBaseUserObject.C.

Referenced by ADShaftConnectedCompressor1PhaseUserObject::execute(), ADShaftConnectedTurbine1PhaseUserObject::execute(), ADShaftConnectedPump1PhaseUserObject::execute(), and ADVolumeJunctionBaseUserObject::execute().

 {
   // Get the connection index
   const unsigned int c = getBoundaryIDIndex();
   _connection_indices.push_back(c);
 
   // Get flow channel Dofs and basic function values
   _flow_channel_dofs[c].clear();
   for (unsigned int j = 0; j < _n_flux_eq; j++)
   {
     MooseVariable * var = getVar(_flow_variable_names[j], 0);
 
     auto && dofs = var->dofIndices();
     for (unsigned int k = 0; k < dofs.size(); k++)
       _flow_channel_dofs[c].push_back(dofs[k]);
   }
 }

◆ threadJoin()

void ADVolumeJunctionBaseUserObject::threadJoin ( const UserObject & uo )

overridevirtualinherited

Implements SideUserObject.

Reimplemented in ADShaftConnectedCompressor1PhaseUserObject, ADShaftConnectedTurbine1PhaseUserObject, ADShaftConnectedPump1PhaseUserObject, and ADJunctionParallelChannels1PhaseUserObject.

Definition at line 162 of file ADVolumeJunctionBaseUserObject.C.

Referenced by ADJunctionParallelChannels1PhaseUserObject::threadJoin(), ADShaftConnectedPump1PhaseUserObject::threadJoin(), ADShaftConnectedTurbine1PhaseUserObject::threadJoin(), and ADShaftConnectedCompressor1PhaseUserObject::threadJoin().

 {
   const auto & volume_junction_uo = static_cast<const ADVolumeJunctionBaseUserObject &>(uo);
 
   // Store the data computed/retrieved in the other threads
   for (unsigned int i = 0; i < volume_junction_uo._connection_indices.size(); i++)
   {
     const unsigned int c = volume_junction_uo._connection_indices[i];
 
     _flux[c] = volume_junction_uo._flux[c];
     _flow_channel_dofs[c] = volume_junction_uo._flow_channel_dofs[c];
   }
 
   // Add the scalar residuals from the other threads
   for (unsigned int i = 0; i < _n_scalar_eq; i++)
     _residual[i] += volume_junction_uo._residual[i];
 }

◆ validParams()

InputParameters ADPump1PhaseUserObject::validParams ( )

static

Definition at line 20 of file ADPump1PhaseUserObject.C.

 {
   InputParameters params = ADVolumeJunction1PhaseUserObject::validParams();
 
   params.addRequiredParam<Real>("head", "Pump head, [m]");
   params.addRequiredParam<Real>("gravity_magnitude", "Gravity constant, [m/s^2]");
 
   params.addClassDescription("Computes and caches flux and residual vectors for a 1-phase pump");
 
   params.declareControllable("head");
 
   return params;
 }

Member Data Documentation

◆ _A

const ADVariableValue& ADVolumeJunction1PhaseUserObject::_A

protectedinherited

Cross-sectional area of connected flow channels.

Definition at line 35 of file ADVolumeJunction1PhaseUserObject.h.

Referenced by ADSimpleTurbine1PhaseUserObject::computeFluxesAndResiduals(), ADVolumeJunction1PhaseUserObject::computeFluxesAndResiduals(), ADJunctionParallelChannels1PhaseUserObject::computeFluxesAndResiduals(), ADShaftConnectedPump1PhaseUserObject::computeFluxesAndResiduals(), ADShaftConnectedTurbine1PhaseUserObject::computeFluxesAndResiduals(), and ADShaftConnectedCompressor1PhaseUserObject::computeFluxesAndResiduals().

◆ _A_ref

const Real& ADVolumeJunction1PhaseUserObject::_A_ref

protectedinherited

Reference area.

Definition at line 46 of file ADVolumeJunction1PhaseUserObject.h.

Referenced by computeFluxesAndResiduals(), ADVolumeJunction1PhaseUserObject::computeFluxesAndResiduals(), ADShaftConnectedPump1PhaseUserObject::computeFluxesAndResiduals(), ADShaftConnectedTurbine1PhaseUserObject::computeFluxesAndResiduals(), and ADShaftConnectedCompressor1PhaseUserObject::computeFluxesAndResiduals().

◆ _apply_velocity_scaling

const bool ADVolumeJunction1PhaseUserObject::_apply_velocity_scaling

protectedinherited

Apply velocity scaling?

Definition at line 49 of file ADVolumeJunction1PhaseUserObject.h.

Referenced by ADVolumeJunction1PhaseUserObject::computeFluxesAndResiduals().

◆ _bnd_ids_vector

const std::vector<BoundaryID> ADFlowJunctionUserObject::_bnd_ids_vector

protectedinherited

Vector of boundary IDs for this side user object; note that BoundaryRestrictable stores these same boundary IDs in _bnd_ids, but they are stored privately and in a set instead of a vector, so ordering is not preserved.

Definition at line 55 of file ADFlowJunctionUserObject.h.

Referenced by ADFlowJunctionUserObject::getBoundaryIDIndex().