This user-object gathers 'a' (on-diagonal velocity coefficients) data. More...

#include <INSFVRhieChowInterpolator.h>

Inheritance diagram for INSFVRhieChowInterpolator:

Public Types
typedef DataFileName	DataFileParameterType

enum	ResidualTagType

Public Member Functions
	INSFVRhieChowInterpolator (const InputParameters &params)

virtual void	addToA (const libMesh::Elem *elem, unsigned int component, const ADReal &value) override
	API that momentum residual objects that have on-diagonals for velocity call.

virtual VectorValue< ADReal >	getVelocity (const Moose::FV::InterpMethod m, const FaceInfo &fi, const Moose::StateArg &time, const THREAD_ID tid, bool subtract_mesh_velocity) const override
	Retrieve a face velocity.

virtual void	initialSetup () override

virtual void	meshChanged () override

virtual void	initialize () override

virtual void	execute () override

virtual void	finalize () override

virtual bool	segregated () const override
	Bool of the Rhie Chow user object is used in monolithic/segregated approaches.

virtual void	ghostADataOnBoundary (const BoundaryID boundary_id) override
	makes sure coefficient data gets communicated on both sides of a given boundary

void	pullAllNonlocal ()
	Whether to pull all 'a' coefficient data from the owning process for all nonlocal elements we have access to (e.g.

bool	velocitySkewCorrection (THREAD_ID tid) const
	Whether central differencing face interpolations of velocity should include a skewness correction Also used for the face interpolation of the D coefficient and the face interpolation of volumetric forces for for the volume correction method and the face interpolation of porosity.

bool	pressureSkewCorrection (THREAD_ID tid) const
	Whether central differencing face interpolations of pressure should include a skewness correction.

virtual Real	getVolumetricFaceFlux (const Moose::FV::InterpMethod m, const FaceInfo &fi, const Moose::StateArg &time, const THREAD_ID tid, bool subtract_mesh_velocity) const override
	Retrieve the volumetric face flux, will not include derivatives.

Moose::FV::InterpMethod	velocityInterpolationMethod () const
	Return the interpolation method used for velocity.

const INSFVPressureVariable &	pressure (THREAD_ID tid) const

const INSFVVelocityVariable *	vel () const

bool	hasFaceSide (const FaceInfo &fi, const bool fi_elem_side) const override

virtual bool	supportMeshVelocity () const
	Returns whether the UO can support mesh velocity advection.

virtual Real	spatialValue (const Point &) const

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

void	setPrimaryThreadCopy (UserObject *primary)

UserObject *	primaryThreadCopy ()

SubProblem &	getSubProblem () const

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

std::set< UserObjectName >	getDependObjects () const

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

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

unsigned int	systemNumber () const

virtual bool	needThreadedCopy () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

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

bool	isKokkosObject () const

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

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

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

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

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

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

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

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

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

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

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

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

void	paramWarning (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

std::string	messagePrefix (const bool hit_prefix=true) const

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

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

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

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

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

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

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

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

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

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

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

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

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) 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	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 UserObjectBase &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const

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

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

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

const std::set< TagID > &	getScalarVariableCoupleableMatrixTags () 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)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyByName (const std::string &prop_name_in)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOldByName (const std::string &prop_name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOlderByName (const std::string &prop_name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialProperty (const std::string &name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOld (const std::string &name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOlder (const std::string &name)

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

std::pair< Moose::Kokkos::MaterialProperty< T, dimension >, std::set< SubdomainID > >	getKokkosBlockMaterialProperty (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)

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

bool	isImplicit ()

Moose::StateArg	determineState () const

virtual void	threadJoin (const UserObject &) override

virtual void	threadJoin (const UserObject &) override

virtual void	subdomainSetup () override

virtual void	subdomainSetup () override

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

bool	hasKokkosMaterialProperty (const std::string &name)

bool	hasKokkosMaterialPropertyByName (const std::string &name)

bool	hasKokkosMaterialPropertyByName (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

Moose::Kokkos::Function	getKokkosFunction (const std::string &name) const

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

Moose::Kokkos::Function	getKokkosFunctionByName (const FunctionName &name) const

const T &	getKokkosFunctionByName (const FunctionName &name) const

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

bool	hasKokkosFunctionByName (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	meshDisplaced ()

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

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

void	useVectorTag (const TagName &tag_name, VectorTagsKey)

void	useVectorTag (TagID tag_id, VectorTagsKey)

void	useMatrixTag (const TagName &tag_name, MatrixTagsKey)

void	useMatrixTag (TagID tag_id, MatrixTagsKey)

bool	isVectorTagged ()

bool	isMatrixTagged ()

bool	hasVectorTags () const

const std::set< TagID > &	getVectorTags (VectorTagsKey) const

const std::set< TagID > &	getMatrixTags (MatrixTagsKey) const

const Moose::Functor< Real > *	defaultFunctor (const std::string &name)

const Moose::Functor< ADReal > *	defaultFunctor (const std::string &name)

Static Public Member Functions
static InputParameters	uniqueParams ()
	Parameters of this object that should be added to the NSFV action that are unique to this object.

static std::vector< std::string >	listOfCommonParams ()

static InputParameters	validParams ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

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, NameFunc &&name_func)

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

static std::string	deduceFunctorName (const std::string &name, const InputParameters &params)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

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
void	insfvSetup ()
	perform the setup of this object

virtual const Moose::FunctorBase< ADReal > &	epsilon (THREAD_ID tid) const
	A virtual method that allows us to only implement getVelocity once for free and porous flows.

template<typename Container >
void	fillContainer (const std::string &var_name, Container &container)
	Fill the passed-in variable container with the thread copies of `var_name`.

template<typename VarType >
void	checkBlocks (const VarType &var) const
	Check the block consistency between the passed in `var` and us.

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &name) const override

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override

virtual void	addUserObjectDependencyHelper (const UserObjectBase &uo) const override

void	addReporterDependencyHelper (const ReporterName &reporter_name) override

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

const ReporterContextBase &	getReporterContextBaseByName (const ReporterName &reporter_name) const

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	isCoupledScalar (const std::string &var_name, unsigned int i=0) const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	getKokkosMaterialPropertyHook (const std::string &, const unsigned int)

void	markMatPropRequested (const std::string &)

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

void	checkExecutionStage ()

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)

virtual bool	hasBlockMaterialPropertyHelper (const std::string &prop_name)

void	initializeBlockRestrictable (const MooseObject *moose_object)

void	initializeKokkosBlockRestrictable ()

Moose::CoordinateSystemType	getBlockCoordSystem ()

KOKKOS_FUNCTION dof_id_type	numKokkosBlockElements () const

KOKKOS_FUNCTION dof_id_type	numKokkosBlockNodes () const

KOKKOS_FUNCTION dof_id_type	numKokkosBlockSides () const

KOKKOS_FUNCTION ContiguousElementID	kokkosBlockElementID (Moose::Kokkos::ThreadID tid) const

KOKKOS_FUNCTION ContiguousElementID	kokkosBlockNodeID (Moose::Kokkos::ThreadID tid) const

KOKKOS_FUNCTION auto	kokkosBlockElementSideID (Moose::Kokkos::ThreadID tid) const

void	prepareVectorTag (Assembly &assembly, unsigned int ivar)

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 Residuals &residuals, const Indices &dof_indices, const std::vector< Real > &scaling_factors)

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 Residuals &residuals, const Indices &dof_indices, const std::vector< Real > &scaling_factors)

void	addJacobian (Assembly &assembly, const ADResidualsPacket &packet)

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

std::string	deduceFunctorName (const std::string &name) const

const Moose::Functor< T > &	getFunctor (const std::string &name)

const Moose::Functor< T > &	getFunctor (const std::string &name, THREAD_ID tid)

const Moose::Functor< T > &	getFunctor (const std::string &name, SubProblem &subproblem)

const Moose::Functor< T > &	getFunctor (const std::string &name, SubProblem &subproblem, THREAD_ID tid)

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

bool	isFunctor (const std::string &name, const SubProblem &subproblem) const

Moose::ElemArg	makeElemArg (const Elem *elem, bool correct_skewnewss=false) const

void	checkFunctorSupportsSideIntegration (const std::string &name, bool qp_integration)

const Moose::Functor< T > &	getFunctorByName (const std::string &name)

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

Protected Attributes
std::vector< std::unique_ptr< PiecewiseByBlockLambdaFunctor< ADRealVectorValue > > >	_vel
	A functor for computing the (non-RC corrected) velocity.

std::vector< MooseVariableField< Real > * >	_disp_xs
	All the thread copies of the x-displacement variable.

std::vector< MooseVariableField< Real > * >	_disp_ys
	All the thread copies of the y-displacement variable.

std::vector< MooseVariableField< Real > * >	_disp_zs
	All the thread copies of the z-displacement variable.

std::vector< std::unique_ptr< Moose::VectorCompositeFunctor< ADReal > > >	_disps
	A functor for computing the displacement.

std::unique_ptr< ConstElemRange >	_elem_range
	All the active and elements local to this process that exist on this object's subdomains.

CellCenteredMapFunctor< ADRealVectorValue, std::unordered_map< dof_id_type, ADRealVectorValue > >	_a
	A map from element IDs to 'a' coefficient data.

const unsigned int	_momentum_sys_number
	The number of the nonlinear system in which the monolithic momentum and continuity equations are located.

MooseMesh &	_moose_mesh
	The `MooseMesh` that this user object operates on.

const libMesh::MeshBase &	_mesh
	The `libMesh` mesh that this object acts on.

const unsigned int	_dim
	The dimension of the mesh, e.g. 3 for hexes and tets, 2 for quads and tris.

INSFVPressureVariable *const	_p
	The thread 0 copy of the pressure variable.

INSFVVelocityVariable *const	_u
	The thread 0 copy of the x-velocity variable.

INSFVVelocityVariable *const	_v
	The thread 0 copy of the y-velocity variable (null if the problem is 1D)

INSFVVelocityVariable *const	_w
	The thread 0 copy of the z-velocity variable (null if the problem is not 3D)

std::vector< MooseVariableFVReal * >	_ps
	All the thread copies of the pressure variable.

std::vector< MooseVariableFVReal * >	_us
	All the thread copies of the x-velocity variable.

std::vector< MooseVariableFVReal * >	_vs
	All the thread copies of the y-velocity variable.

std::vector< MooseVariableFVReal * >	_ws
	All the thread copies of the z-velocity variable.

std::vector< unsigned int >	_var_numbers
	The velocity variable numbers.

Moose::FV::InterpMethod	_velocity_interp_method
	The interpolation method to use for the velocity.

const bool	_displaced
	Whether this object is operating on the displaced mesh.

const Moose::CoordinateSystemType &	_coord_sys

const THREAD_ID	_tid

SubProblem &	_subproblem

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

Assembly &	_assembly

const bool	_duplicate_initial_execution

std::set< std::string >	_depend_uo

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

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

FEProblemBase &	_mdi_feproblem

MooseApp &	_pg_moose_app

const std::string	_prefix

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 bool	_is_kokkos_object

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

const MaterialData *	_blk_material_data

DenseVector< Number >	_local_re

DenseMatrix< Number >	_local_ke

DenseMatrix< Number >	_nonlocal_ke

'a' component functors
These vector component functors are not used anywhere within this class but they can be used for outputting, to auxiliary variables, the on-diagonal 'a' coefficients for use in visualization or transfer to other applications
Moose::VectorComponentFunctor< ADReal >	_ax

Moose::VectorComponentFunctor< ADReal >	_ay
	The y-component of 'a'.

Moose::VectorComponentFunctor< ADReal >	_az
	The z-component of 'a'.

Static Protected Attributes
static const std::string	_interpolated_old

static const std::string	_interpolated_older

Private Member Functions
void	fillARead ()
	Fills the _a_read data member at construction time with the appropriate functors.

bool	needAComputation () const
	Whether we need 'a' coefficient computation.

const Moose::FunctionBase *	getKokkosFunctionByNameHelper (const FunctionName &name) const

const UserObjectBase &	getUserObjectFromFEProblem (const UserObjectName &object_name, const THREAD_ID tid=0) const

const T &	castUserObject (const UserObjectBase &uo_base, const std::string &param_name="") const

void	mooseObjectError (const std::string &param_name, std::stringstream &oss) const

const std::string &	userObjectType (const UserObjectBase &uo) const

const std::string &	userObjectName (const UserObjectBase &uo) const

const PostprocessorName &	getPostprocessorNameInternal (const std::string &param_name, const unsigned int index, const bool allow_default_value=true) const

bool	isDefaultPostprocessorValueByName (const PostprocessorName &name) const

PostprocessorValue	getDefaultPostprocessorValueByName (const PostprocessorName &name) const

void	checkParam (const std::string &param_name, const unsigned int index=std::numeric_limits< unsigned int >::max()) const

bool	postprocessorsAdded () const

const VectorPostprocessorValue &	getVectorPostprocessorByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name, bool broadcast, std::size_t t_index) const

const VectorPostprocessorContext< VectorPostprocessorValue > &	getVectorPostprocessorContextByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	vectorPostprocessorsAdded () const

bool	reportersAdded () const

void	possiblyCheckHasReporter (const ReporterName &reporter_name, const std::string &param_name="") const

RestartableDataValue &	registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const

void	registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)

RestartableData< T > &	declareRestartableDataHelper (const std::string &data_name, void *context, Args &&... args) const

virtual std::string	meshPropertyPrefix (const std::string &data_name) const

const RestartableDataValue &	getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const

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

const VariableValue *	getDefaultValue (const std::string &var_name) const

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

void	checkVar (const std::string &var_name) const

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

Moose::MaterialDataType	getMaterialDataType (const std::set< BoundaryID > &boundary_ids) const

unsigned int	getMaxQps () const

void	addConsumedPropertyName (const MooseObjectName &obj_name, const std::string &prop_name)

const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const

void	possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

void	possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

void	possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

void	possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

void	prepareVectorTagInternal (Assembly &assembly, unsigned int ivar, const std::set< TagID > &vector_tags, const std::set< TagID > &absolute_value_vector_tags)

void	checkForNans () const

const Moose::Functor< T > *	defaultFunctor (const std::string &name)

const Moose::Functor< Real > *	defaultFunctor (const std::string &name)

const Moose::Functor< ADReal > *	defaultFunctor (const std::string &name)

const Moose::Functor< T > &	getFunctorByName (const std::string &name, SubProblem &subproblem, THREAD_ID tid)

virtual bool	isADObject () const override

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
std::unordered_set< const Elem * >	_elements_to_push_pull
	Non-local elements that we should push and pull data for across processes.

const VectorValue< ADReal >	_example
	An example datum used to help communicate AD vector information in parallel.

Threads::spin_mutex	_a_mutex
	Mutex that prevents multiple threads from saving into the 'a' coefficients at the same time.

std::vector< const Moose::FunctorBase< VectorValue< ADReal > > * >	_a_read
	A vector sized according to the number of threads that holds the 'a' data we will read from when computing the Rhie-Chow velocity.

std::vector< std::unique_ptr< Moose::FunctorBase< VectorValue< ADReal > > > >	_a_aux
	A vector sized according to the number of threads that holds vector composites of 'a' component functors.

bool	_a_data_provided
	Whether 'a' data has been provided by the user.

bool	_pull_all_nonlocal
	Whether we want to pull all nonlocal 'a' coefficient data.

const bool &	_bool_correct_vf
	Correct Rhie-Chow coefficients for volumetric force flag.

const MooseEnum	_volume_force_correction_method
	– Method used for computing the properties average

const std::vector< MooseFunctorName > *	_volumetric_force_functors
	Names of the functors storing the volumetric forces.

std::vector< const Moose::Functor< Real > * >	_volumetric_force
	Values of the functors storing the volumetric forces.

Real	_baseline_volume_force
	Minimum absolute RC force over the domain.

const Moose::ConstantFunctor< ADReal >	_zero_functor {0}
	A zero functor potentially used in _a_read.

const Moose::ConstantFunctor< ADReal >	_unity_functor {1}
	A unity functor used in the epsilon virtual method.

UserObject *	_primary_thread_copy

std::set< std::string >	_supplied_uo

const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

ExecFlagEnum	_empty_execute_enum

const MooseObject &	_fni_object

const InputParameters &	_fni_params

FEProblemBase &	_fni_feproblem

const THREAD_ID	_fni_tid

const MooseObject &	_uoi_moose_object

const FEProblemBase &	_uoi_feproblem

const THREAD_ID	_uoi_tid

const MooseObject &	_ppi_moose_object

const InputParameters &	_ppi_params

const FEProblemBase &	_ppi_feproblem

std::map< PostprocessorName, std::unique_ptr< PostprocessorValue > >	_default_values

const bool	_broadcast_by_default

const MooseObject &	_vpi_moose_object

const FEProblemBase &	_vpi_feproblem

const THREAD_ID	_vpi_tid

const InputParameters &	_ri_params

FEProblemBase &	_ri_fe_problem_base

const ReporterData &	_ri_reporter_data

const MooseObject &	_ri_moose_object

const InputParameters &	_dni_params

FEProblemBase &	_dni_feproblem

const MooseObject *const	_dni_moose_object_ptr

const InputParameters &	_si_params

FEProblemBase &	_si_feproblem

THREAD_ID	_si_tid

const RestartableDataMapName	_metaname

std::string	_restartable_name

MooseApp &	_meta_data_app

const MooseObject *const	_meta_data_object

const InputParameters &	_sc_parameters

const std::string &	_sc_name

const bool	_sc_is_implicit

std::unordered_map< std::string, std::vector< MooseVariableScalar * > >	_coupled_scalar_vars

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

std::unordered_map< std::string, std::unique_ptr< ADVariableValue > >	_dual_default_value

std::vector< MooseVariableScalar * >	_coupled_moose_scalar_vars

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

std::set< TagID >	_sc_coupleable_vector_tags

std::set< TagID >	_sc_coupleable_matrix_tags

const MooseObject &	_mi_moose_object

const bool	_mi_boundary_restricted

const std::set< SubdomainID > &	_mi_block_ids

const std::set< BoundaryID > &	_mi_boundary_ids

std::vector< std::unique_ptr< OptionalMaterialPropertyProxyBase< MaterialPropertyInterface > > >	_optional_property_proxies

const std::string	_ti_name

std::set< SubdomainID >	_blk_ids

std::vector< SubdomainID >	_vec_ids

std::vector< SubdomainName >	_blocks

const bool	_blk_dual_restrictable

FEProblemBase *	_blk_feproblem

const MooseMesh *	_blk_mesh

const std::set< BoundaryID >	_empty_boundary_ids

const std::set< BoundaryID > &	_boundary_ids

THREAD_ID	_blk_tid

const std::string &	_blk_name

unsigned int	_blk_dim

const MooseObject *	_moose_object

Moose::Kokkos::Array< ContiguousElementID >	_kokkos_element_ids

Moose::Kokkos::Array< ContiguousNodeID >	_kokkos_node_ids

Moose::Kokkos::Array< Moose::Kokkos::Pair< ContiguousElementID, unsigned int > >	_kokkos_element_side_ids

std::set< TagID >	_vector_tags

std::set< TagID >	_abs_vector_tags

std::set< TagID >	_matrix_tags

std::set< TagID >	_non_ref_vector_tags

std::set< TagID >	_non_ref_abs_vector_tags

std::set< TagID >	_ref_vector_tags

std::set< TagID >	_ref_abs_vector_tags

const InputParameters &	_tag_params

std::vector< DenseVector< Number > * >	_re_blocks

std::vector< DenseVector< Number > * >	_absre_blocks

std::vector< DenseMatrix< Number > * >	_ke_blocks

std::vector< Real >	_absolute_residuals

const InputParameters &	_fi_params

const std::string	_fi_name

SubProblem *const	_fi_subproblem

const THREAD_ID	_fi_tid

std::vector< std::unique_ptr< Moose::Functor< Real > > >	_default_real_functors

std::vector< std::unique_ptr< Moose::Functor< ADReal > > >	_default_ad_real_functors

Detailed Description

This user-object gathers 'a' (on-diagonal velocity coefficients) data.

Having the gathered 'a' data, this object is responsible for the computation of the Rhie-Chow velocity, which can be used in advection kernels and postprocessors. This class also supports computation of an average face velocity although this is generally not encouraged as it will lead to a checkerboard in the pressure field

Definition at line 38 of file INSFVRhieChowInterpolator.h.

Constructor & Destructor Documentation

◆ INSFVRhieChowInterpolator()

INSFVRhieChowInterpolator::INSFVRhieChowInterpolator ( const InputParameters & params )

Definition at line 113 of file INSFVRhieChowInterpolator.C.

  : RhieChowInterpolatorBase(params),
    _vel(libMesh::n_threads()),
    _a(_moose_mesh, blockIDs(), "a", /*extrapolated_boundary*/ true),
    _ax(_a, 0),
    _ay(_a, 1),
    _az(_a, 2),
    _momentum_sys_number(_fe_problem.systemNumForVariable(getParam<VariableName>("u"))),
    _example(0),
    _a_data_provided(false),
    _pull_all_nonlocal(getParam<bool>("pull_all_nonlocal_a")),
    _bool_correct_vf(getParam<bool>("correct_volumetric_force")),
    _volume_force_correction_method(getParam<MooseEnum>("volume_force_correction_method")),
    _volumetric_force_functors(
        isParamValid("volumetric_force_functors")
            ? &getParam<std::vector<MooseFunctorName>>("volumetric_force_functors")
            : nullptr)
{
  auto process_displacement = [this](const auto & disp_name, auto & disp_container)
  {
    if (!_displaced)
      paramError(disp_name,
                 "Displacement provided but we are not running on the displaced mesh. If you "
                 "really want this object to run on the displaced mesh, then set "
                 "'use_displaced_mesh = true', otherwise remove this displacement parameter");
    disp_container.resize(libMesh::n_threads());
    fillContainer(disp_name, disp_container);
    checkBlocks(*disp_container[0]);
  };
 
  if (isParamValid("disp_x"))
    process_displacement("disp_x", _disp_xs);
 
  if (_dim >= 2)
  {
    if (isParamValid("disp_y"))
      process_displacement("disp_y", _disp_ys);
    else if (isParamValid("disp_x"))
      paramError("disp_y", "If 'disp_x' is provided, then 'disp_y' must be as well");
  }
 
  if (_dim >= 3)
  {
    if (isParamValid("disp_z"))
      process_displacement("disp_z", _disp_zs);
    else if (isParamValid("disp_x"))
      paramError("disp_z", "If 'disp_x' is provided, then 'disp_z' must be as well");
  }
 
  for (const auto tid : make_range(libMesh::n_threads()))
  {
    _vel[tid] = std::make_unique<PiecewiseByBlockLambdaFunctor<ADRealVectorValue>>(
        name() + std::to_string(tid),
        [this, tid](const auto & r, const auto & t) -> ADRealVectorValue
        {
          ADRealVectorValue velocity((*_us[tid])(r, t));
          if (_dim >= 2)
            velocity(1) = (*_vs[tid])(r, t);
          if (_dim >= 3)
            velocity(2) = (*_ws[tid])(r, t);
          return velocity;
        },
        std::set<ExecFlagType>({EXEC_ALWAYS}),
        _moose_mesh,
        blockIDs());
 
    if (_disp_xs.size())
      _disps.push_back(std::make_unique<Moose::VectorCompositeFunctor<ADReal>>(
          name() + "_disp_" + std::to_string(tid),
          *_disp_xs[tid],
          _dim >= 2 ? static_cast<const Moose::FunctorBase<ADReal> &>(*_disp_ys[tid])
                    : static_cast<const Moose::FunctorBase<ADReal> &>(_zero_functor),
          _dim >= 3 ? static_cast<const Moose::FunctorBase<ADReal> &>(*_disp_zs[tid])
                    : static_cast<const Moose::FunctorBase<ADReal> &>(_zero_functor)));
  }
 
  if (_velocity_interp_method == Moose::FV::InterpMethod::Average && isParamValid("a_u"))
    paramError("a_u",
               "Rhie Chow coefficients may not be specified for average velocity interpolation");
 
  if (_velocity_interp_method != Moose::FV::InterpMethod::Average)
    fillARead();
 
  if (_bool_correct_vf && !_volumetric_force_functors)
    paramError("volumetric_force_functors",
               "At least one volumetric force functor must be specified if "
               "'correct_volumetric_force' is true.");
 
  // Volume correction related
  if (_bool_correct_vf)
  {
    const unsigned int num_volume_forces = (*_volumetric_force_functors).size();
    _volumetric_force.resize(num_volume_forces);
    for (const auto i : make_range(num_volume_forces))
      _volumetric_force[i] = &getFunctor<Real>((*_volumetric_force_functors)[i]);
  }
}

Member Function Documentation

◆ addToA()

void INSFVRhieChowInterpolator::addToA	(	const libMesh::Elem *	elem,
		unsigned int	component,
		const ADReal &	value
	)

inlineoverridevirtual

API that momentum residual objects that have on-diagonals for velocity call.

Parameters

The	element we are adding 'a' coefficient data for
component	The velocity component we are adding 'a' coefficient data for
value	The value of 'a' that we are adding

Implements RhieChowInterpolatorBase.

Definition at line 221 of file INSFVRhieChowInterpolator.h.

{
  Threads::spin_mutex::scoped_lock lock(_a_mutex);
 
  if (elem->processor_id() != this->processor_id())
    _elements_to_push_pull.insert(elem);
 
  _a[elem->id()](component) += value;
}

Referenced by ghostADataOnBoundary().

◆ checkBlocks()

template<typename VarType >

void RhieChowInterpolatorBase::checkBlocks ( const VarType & var ) const

protectedinherited

Check the block consistency between the passed in var and us.

Definition at line 181 of file RhieChowInterpolatorBase.h.

{
  const auto & var_blocks = var.blockIDs();
  const auto & uo_blocks = blockIDs();
 
  // Error if this UO has any blocks that the variable does not
  std::set<SubdomainID> uo_blocks_minus_var_blocks;
  std::set_difference(uo_blocks.begin(),
                      uo_blocks.end(),
                      var_blocks.begin(),
                      var_blocks.end(),
                      std::inserter(uo_blocks_minus_var_blocks, uo_blocks_minus_var_blocks.end()));
  if (uo_blocks_minus_var_blocks.size() > 0)
    mooseError("Block restriction of interpolator user object '",
               this->name(),
               "' (",
               Moose::stringify(blocks()),
               ") includes blocks not in the block restriction of variable '",
               var.name(),
               "' (",
               Moose::stringify(var.blocks()),
               ")");
 
  // Get the blocks in the variable but not this UO
  std::set<SubdomainID> var_blocks_minus_uo_blocks;
  std::set_difference(var_blocks.begin(),
                      var_blocks.end(),
                      uo_blocks.begin(),
                      uo_blocks.end(),
                      std::inserter(var_blocks_minus_uo_blocks, var_blocks_minus_uo_blocks.end()));
 
  // For each block in the variable but not this UO, error if there is connection
  // to any blocks on the UO.
  for (auto & block_id : var_blocks_minus_uo_blocks)
  {
    const auto connected_blocks = _moose_mesh.getBlockConnectedBlocks(block_id);
    std::set<SubdomainID> connected_blocks_on_uo;
    std::set_intersection(connected_blocks.begin(),
                          connected_blocks.end(),
                          uo_blocks.begin(),
                          uo_blocks.end(),
                          std::inserter(connected_blocks_on_uo, connected_blocks_on_uo.end()));
    if (connected_blocks_on_uo.size() > 0)
      mooseError("Block restriction of interpolator user object '",
                 this->name(),
                 "' (",
                 Moose::stringify(uo_blocks),
                 ") doesn't match the block restriction of variable '",
                 var.name(),
                 "' (",
                 Moose::stringify(var_blocks),
                 ")");
  }
}

Referenced by INSFVRhieChowInterpolator(), and RhieChowInterpolatorBase::RhieChowInterpolatorBase().

◆ epsilon()

const Moose::FunctorBase< ADReal > & RhieChowInterpolatorBase::epsilon ( THREAD_ID tid ) const

inlineprotectedvirtualinherited

A virtual method that allows us to only implement getVelocity once for free and porous flows.

Reimplemented in PINSFVRhieChowInterpolator, and PINSFVRhieChowInterpolatorSegregated.

Definition at line 154 of file RhieChowInterpolatorBase.h.

{
  return _unity_functor;
}

Referenced by INSFVRhieChowInterpolatorSegregated::computeHbyA(), and getVelocity().

◆ execute()

void INSFVRhieChowInterpolator::execute ( )

overridevirtual

Implements GeneralUserObject.

Reimplemented in PINSFVRhieChowInterpolator.

Definition at line 370 of file INSFVRhieChowInterpolator.C.

{
  // Either we provided the RC coefficients using aux-variable, or we are solving for another
  // system than the momentum equations are in, in a multi-system setup for example
  if (_fe_problem.currentNlSysNum() != _momentum_sys_number)
    return;
 
  mooseAssert(!_a_data_provided,
              "a-coefficient data should not be provided if the velocity variables are in the "
              "nonlinear system and we are running kernels that compute said a-coefficients");
  // One might think that we should do a similar assertion for
  // (_velocity_interp_method == Moose::FV::InterpMethod::RhieChow). However, even if we are not
  // using the generated a-coefficient data in that case, some kernels have been optimized to
  // add their residuals into the global system during the generation of the a-coefficient data.
  // Hence if we were to skip the kernel execution we would drop those residuals
 
  TIME_SECTION("execute", 1, "Computing Rhie-Chow coefficients");
 
  // A lot of RC data gathering leverages the automatic differentiation system, e.g. for linear
  // operators we pull out the 'a' coefficients by querying the ADReal residual derivatives
  // member at the element or neighbor dof locations. Consequently we need to enable derivative
  // computation. We do this here outside the threaded regions
  const auto saved_do_derivatives = ADReal::do_derivatives;
  ADReal::do_derivatives = true;
 
  PARALLEL_TRY
  {
    GatherRCDataElementThread et(_fe_problem, _momentum_sys_number, _var_numbers);
    Threads::parallel_reduce(*_elem_range, et);
  }
  PARALLEL_CATCH;
 
  PARALLEL_TRY
  {
    using FVRange = StoredRange<MooseMesh::const_face_info_iterator, const FaceInfo *>;
    GatherRCDataFaceThread<FVRange> fvr(
        _fe_problem, _momentum_sys_number, _var_numbers, _displaced);
    FVRange faces(_moose_mesh.ownedFaceInfoBegin(), _moose_mesh.ownedFaceInfoEnd());
    Threads::parallel_reduce(faces, fvr);
  }
  PARALLEL_CATCH;
 
  ADReal::do_derivatives = saved_do_derivatives;
}

Referenced by PINSFVRhieChowInterpolator::execute().

◆ fillARead()

void INSFVRhieChowInterpolator::fillARead ( )

private

Fills the _a_read data member at construction time with the appropriate functors.

_a_read will be used later when computing the Rhie-Chow velocity

Definition at line 212 of file INSFVRhieChowInterpolator.C.

{
  _a_read.resize(libMesh::n_threads());
 
  if (isParamValid("a_u"))
  {
    if (_dim > 1 && !isParamValid("a_v"))
      mooseError("If a_u is provided, then a_v must be provided");
 
    if (_dim > 2 && !isParamValid("a_w"))
      mooseError("If a_u is provided, then a_w must be provided");
 
    _a_data_provided = true;
    _a_aux.resize(libMesh::n_threads());
  }
  else if (isParamValid("a_v"))
    paramError("a_v", "If the a_v coefficients are provided, then a_u must be provided");
  else if (isParamValid("a_w"))
    paramError("a_w", "If the a_w coefficients are provided, then a_u must be provided");
 
  if (_a_data_provided)
  {
    for (const auto tid : make_range(libMesh::n_threads()))
    {
      const Moose::FunctorBase<ADReal> *v_comp, *w_comp;
      if (_dim > 1)
        v_comp = &UserObject::_subproblem.getFunctor<ADReal>(
            deduceFunctorName("a_v"), tid, name(), true);
      else
        v_comp = &_zero_functor;
      if (_dim > 2)
        w_comp = &UserObject::_subproblem.getFunctor<ADReal>(
            deduceFunctorName("a_w"), tid, name(), true);
      else
        w_comp = &_zero_functor;
 
      _a_aux[tid] = std::make_unique<Moose::VectorCompositeFunctor<ADReal>>(
          "RC_a_coeffs",
          UserObject::_subproblem.getFunctor<ADReal>(deduceFunctorName("a_u"), tid, name(), true),
          *v_comp,
          *w_comp);
      _a_read[tid] = _a_aux[tid].get();
    }
  }
  else
    for (const auto tid : make_range(libMesh::n_threads()))
    {
      _a_read[tid] = &_a;
 
      // We are the fluid flow application, so we should make sure users have the ability to
      // write 'a' out to aux variables for possible transfer to other applications
      UserObject::_subproblem.addFunctor("ax", _ax, tid);
      UserObject::_subproblem.addFunctor("ay", _ay, tid);
      UserObject::_subproblem.addFunctor("az", _az, tid);
    }
}

Referenced by INSFVRhieChowInterpolator().

◆ fillContainer()

template<typename Container >

void RhieChowInterpolatorBase::fillContainer	(	const std::string &	var_name,
		Container &	container
	)

protectedinherited

Fill the passed-in variable container with the thread copies of var_name.

Definition at line 168 of file RhieChowInterpolatorBase.h.

{
  typedef typename Container::value_type ContainedType;
  for (const auto tid : make_range(libMesh::n_threads()))
  {
    auto * const var = static_cast<ContainedType>(
        &UserObject::_subproblem.getVariable(tid, getParam<VariableName>(name)));
    container[tid] = var;
  }
}

Referenced by INSFVRhieChowInterpolator(), and RhieChowInterpolatorBase::RhieChowInterpolatorBase().

◆ finalize()

void INSFVRhieChowInterpolator::finalize ( )

overridevirtual

Implements GeneralUserObject.

Reimplemented in PINSFVRhieChowInterpolator.

Definition at line 416 of file INSFVRhieChowInterpolator.C.

{
  if (!needAComputation() || this->n_processors() == 1)
    return;
 
  // If advecting with auxiliary variables, no need to synchronize data
  // Same if not solving for the velocity variables at the moment
  if (_fe_problem.currentNlSysNum() != _momentum_sys_number)
    return;
 
  using Datum = std::pair<dof_id_type, VectorValue<ADReal>>;
  std::unordered_map<processor_id_type, std::vector<Datum>> push_data;
  std::unordered_map<processor_id_type, std::vector<dof_id_type>> pull_requests;
  static const VectorValue<ADReal> example;
 
  // Create push data
  for (const auto * const elem : _elements_to_push_pull)
  {
    const auto id = elem->id();
    const auto pid = elem->processor_id();
    auto it = _a.find(id);
    mooseAssert(it != _a.end(), "We definitely should have found something");
    push_data[pid].push_back(std::make_pair(id, it->second));
  }
 
  // Create pull data
  if (_pull_all_nonlocal)
  {
    for (const auto * const elem :
         as_range(_mesh.active_not_local_elements_begin(), _mesh.active_not_local_elements_end()))
      if (blockIDs().count(elem->subdomain_id()))
        pull_requests[elem->processor_id()].push_back(elem->id());
  }
  else
  {
    for (const auto * const elem : _elements_to_push_pull)
      pull_requests[elem->processor_id()].push_back(elem->id());
  }
 
  // First push
  {
    auto action_functor =
        [this](const processor_id_type libmesh_dbg_var(pid), const std::vector<Datum> & sent_data)
    {
      mooseAssert(pid != this->processor_id(), "We do not send messages to ourself here");
      for (const auto & pr : sent_data)
        _a[pr.first] += pr.second;
    };
    TIMPI::push_parallel_vector_data(_communicator, push_data, action_functor);
  }
 
  // Then pull
  {
    auto gather_functor = [this](const processor_id_type libmesh_dbg_var(pid),
                                 const std::vector<dof_id_type> & elem_ids,
                                 std::vector<VectorValue<ADReal>> & data_to_fill)
    {
      mooseAssert(pid != this->processor_id(), "We shouldn't be gathering from ourselves.");
      data_to_fill.resize(elem_ids.size());
      for (const auto i : index_range(elem_ids))
      {
        const auto id = elem_ids[i];
        auto it = _a.find(id);
        mooseAssert(it != _a.end(), "We should hold the value for this locally");
        data_to_fill[i] = it->second;
      }
    };
 
    auto action_functor = [this](const processor_id_type libmesh_dbg_var(pid),
                                 const std::vector<dof_id_type> & elem_ids,
                                 const std::vector<VectorValue<ADReal>> & filled_data)
    {
      mooseAssert(pid != this->processor_id(), "The request filler shouldn't have been ourselves");
      mooseAssert(elem_ids.size() == filled_data.size(), "I think these should be the same size");
      for (const auto i : index_range(elem_ids))
        _a[elem_ids[i]] = filled_data[i];
    };
    TIMPI::pull_parallel_vector_data(
        _communicator, pull_requests, gather_functor, action_functor, &example);
  }
}

Referenced by PINSFVRhieChowInterpolator::finalize().

◆ getVelocity()

VectorValue< ADReal > INSFVRhieChowInterpolator::getVelocity	(	const Moose::FV::InterpMethod	m,
		const FaceInfo &	fi,
		const Moose::StateArg &	time,
		const THREAD_ID	tid,
		bool	subtract_mesh_velocity
	)		const

overridevirtual

Retrieve a face velocity.

Parameters

m	The velocity interpolation method. This is either Rhie-Chow or Average. Rhie-Chow is recommended as it avoids checkerboards in the pressure field
fi	The face that we wish to retrieve the velocity for
time	The time at which to evaluate the velocity
tid	The thread ID
subtract_mesh_velocity	Whether to subtract the mesh velocity if running on a displaced mesh

Returns: The face velocity

Implements RhieChowInterpolatorBase.

Definition at line 527 of file INSFVRhieChowInterpolator.C.

{
  const Elem * const elem = &fi.elem();
  const Elem * const neighbor = fi.neighborPtr();
  auto & vel = *_vel[tid];
  auto & p = *_ps[tid];
  auto * const u = _us[tid];
  MooseVariableFVReal * const v = _v ? _vs[tid] : nullptr;
  MooseVariableFVReal * const w = _w ? _ws[tid] : nullptr;
  // Check if skewness-correction is necessary
  const bool correct_skewness = velocitySkewCorrection(tid);
  auto incorporate_mesh_velocity =
      [this, tid, subtract_mesh_velocity, &time](const auto & space, auto & velocity)
  {
    if (_disps.size() && subtract_mesh_velocity)
      velocity -= _disps[tid]->dot(space, time);
  };
 
  if (Moose::FV::onBoundary(*this, fi))
  {
    const Elem * const boundary_elem = hasBlocks(elem->subdomain_id()) ? elem : neighbor;
    const Moose::FaceArg boundary_face{&fi,
                                       Moose::FV::LimiterType::CentralDifference,
                                       true,
                                       correct_skewness,
                                       boundary_elem,
                                       nullptr};
    auto velocity = vel(boundary_face, time);
    incorporate_mesh_velocity(boundary_face, velocity);
 
    // If not solving for velocity, clear derivatives
    if (_fe_problem.currentNlSysNum() != _momentum_sys_number)
      return MetaPhysicL::raw_value(velocity);
    else
      return velocity;
  }
 
  VectorValue<ADReal> velocity;
 
  Moose::FaceArg face{
      &fi, Moose::FV::LimiterType::CentralDifference, true, correct_skewness, nullptr, nullptr};
  // Create the average face velocity (not corrected using RhieChow yet)
  velocity(0) = (*u)(face, time);
  if (v)
    velocity(1) = (*v)(face, time);
  if (w)
    velocity(2) = (*w)(face, time);
 
  incorporate_mesh_velocity(face, velocity);
 
  // If not solving for velocity, clear derivatives
  if (_fe_problem.currentNlSysNum() != _momentum_sys_number)
    velocity = MetaPhysicL::raw_value(velocity);
 
  // Return if Rhie-Chow was not requested or if we have a porosity jump
  if (m == Moose::FV::InterpMethod::Average ||
      std::get<0>(NS::isPorosityJumpFace(epsilon(tid), fi, time)))
    return velocity;
 
  // Rhie-Chow coefficients are not available on initial
  if (_fe_problem.getCurrentExecuteOnFlag() == EXEC_INITIAL)
  {
    mooseDoOnce(mooseWarning("Cannot compute Rhie Chow coefficients on initial. Returning linearly "
                             "interpolated velocities"););
    return velocity;
  }
  if (!_fe_problem.shouldSolve())
  {
    mooseDoOnce(mooseWarning("Cannot compute Rhie Chow coefficients if not solving. Returning "
                             "linearly interpolated velocities"););
    return velocity;
  }
 
  mooseAssert(((m == Moose::FV::InterpMethod::RhieChow) &&
               (_velocity_interp_method == Moose::FV::InterpMethod::RhieChow)) ||
                  _a_data_provided,
              "The 'a' coefficients have not been generated or provided for "
              "Rhie Chow velocity interpolation.");
 
  mooseAssert(neighbor && this->hasBlocks(neighbor->subdomain_id()),
              "We should be on an internal face...");
 
  // Get pressure gradient. This is the uncorrected gradient plus a correction from cell
  // centroid values on either side of the face
  const auto correct_skewness_p = pressureSkewCorrection(tid);
  const auto & grad_p = p.adGradSln(fi, time, correct_skewness_p);
 
  // Get uncorrected pressure gradient. This will use the element centroid gradient if we are
  // along a boundary face
  const auto & unc_grad_p = p.uncorrectedAdGradSln(fi, time, correct_skewness_p);
 
  // Volumetric Correction Method #1: pressure-based correction
  // Function that allows us to mark the face for which the Rhie-Chow interpolation is
  // inconsistent Normally, we should apply a reconstructed volume correction to the Rhie-Chow
  // coefficients However, since the fluxes at the face are given by the volume force we will
  // simply mark the face add the reverse pressure interpolation for these faces In brief, this
  // function is just marking the faces where the Rhie-Chow interpolation is inconsistent
  auto vf_indicator_pressure_based =
      [this, &elem, &neighbor, &time, &fi, &correct_skewness](const Point & unit_basis_vector)
  {
    // Holders for the interpolated corrected and uncorrected volume force
    Real interp_vf;
    Real uncorrected_interp_vf;
 
    // Compute the corrected interpolated face value
    Moose::FaceArg face{
        &fi, Moose::FV::LimiterType::CentralDifference, true, correct_skewness, nullptr, nullptr};
 
    interp_vf = 0.0;
    for (const auto i : make_range(_volumetric_force.size()))
      interp_vf += (*this->_volumetric_force[i])(face, time);
 
    // Compute the uncorrected interpolated face value
    // For it to be consistent with the pressure gradient interpolation `uncorrectedAdGradSln`
    // the uncorrected volume force computation should follow the same Green-Gauss process
 
    Real elem_value = 0.0;
    Real neigh_value = 0.0;
 
    // Uncorrected interpolation - Step 1: loop over the faces of the element to compute
    // face-average cell value
    Real coord_multiplier;
    const auto coord_type = _fe_problem.getCoordSystem(elem->subdomain_id());
    const unsigned int rz_radial_coord =
        Moose::COORD_RZ ? _fe_problem.getAxisymmetricRadialCoord() : libMesh::invalid_uint;
 
    for (const auto side : make_range(elem->n_sides()))
    {
      const Elem * const loc_neighbor = elem->neighbor_ptr(side);
      const bool elem_has_fi = Moose::FV::elemHasFaceInfo(*elem, loc_neighbor);
      const FaceInfo * const fi_loc =
          _moose_mesh.faceInfo(elem_has_fi ? elem : loc_neighbor,
                               elem_has_fi ? side : loc_neighbor->which_neighbor_am_i(elem));
 
      Moose::FaceArg loc_face{
          fi_loc, Moose::FV::LimiterType::CentralDifference, true, correct_skewness, elem, nullptr};
 
      MooseMeshUtils::coordTransformFactor(
          elem->vertex_average(), coord_multiplier, coord_type, rz_radial_coord);
 
      Real face_volume_contribution = fi_loc->faceArea() *
                                      (neighbor->vertex_average() - elem->vertex_average()).norm() *
                                      coord_multiplier;
 
      for (const auto i : make_range(_volumetric_force.size()))
      {
        // Add which side (can be both, then we use a nullptr) of the face info the force is defined
        // on
        loc_face.face_side =
            this->_volumetric_force[i]->hasFaceSide(*fi_loc, true)
                ? (this->_volumetric_force[i]->hasFaceSide(*fi_loc, false) ? nullptr
                                                                           : fi_loc->elemPtr())
                : fi_loc->neighborPtr();
        elem_value += (*this->_volumetric_force[i])(loc_face, time) * face_volume_contribution *
                      (fi_loc->normal() * unit_basis_vector);
      }
    }
    elem_value = elem_value / elem->volume();
 
    // Uncorrected interpolation - Step 2: loop over the face of the neighbor to compute
    // face-average cell value
    for (const auto side : make_range(neighbor->n_sides()))
    {
      const Elem * const loc_elem = neighbor->neighbor_ptr(side);
      const bool elem_has_fi = Moose::FV::elemHasFaceInfo(*neighbor, loc_elem);
      const FaceInfo * const fi_loc =
          _moose_mesh.faceInfo(elem_has_fi ? neighbor : loc_elem,
                               elem_has_fi ? side : loc_elem->which_neighbor_am_i(neighbor));
 
      Moose::FaceArg loc_face{
          fi_loc, Moose::FV::LimiterType::CentralDifference, true, correct_skewness, elem, nullptr};
 
      MooseMeshUtils::coordTransformFactor(
          neighbor->vertex_average(), coord_multiplier, coord_type, rz_radial_coord);
 
      Real face_volume_contribution = fi_loc->faceArea() *
                                      (elem->vertex_average() - neighbor->vertex_average()).norm() *
                                      coord_multiplier;
 
      for (const auto i : make_range(_volumetric_force.size()))
      {
        loc_face.face_side =
            this->_volumetric_force[i]->hasFaceSide(*fi_loc, true)
                ? (this->_volumetric_force[i]->hasFaceSide(*fi_loc, false) ? nullptr
                                                                           : fi_loc->elemPtr())
                : fi_loc->neighborPtr();
        neigh_value += (*this->_volumetric_force[i])(loc_face, time) * face_volume_contribution *
                       (fi_loc->normal() * unit_basis_vector);
      }
    }
    neigh_value = neigh_value / neighbor->volume();
 
    // Uncorrected interpolation - Step 3: interpolate element and neighbor reconstructed values
    // to the face
    MooseMeshUtils::coordTransformFactor(
        fi.faceCentroid(), coord_multiplier, coord_type, rz_radial_coord);
    interpolate(
        Moose::FV::InterpMethod::Average, uncorrected_interp_vf, elem_value, neigh_value, fi, true);
 
    // Return the flag indicator on which face the volume force correction is inconsistent
    return MooseUtils::relativeFuzzyEqual(interp_vf, uncorrected_interp_vf, 1e-10) ? 0.0 : 1.0;
  };
 
  // Volumetric Correction Method #2: volume-based correction
  // In thery, pressure and velocity cannot be decoupled when a body force is present
  // Hence, we can de-activate the RC cofficient in faces that have a normal volume force
  // In the method we mark the faces with a non-zero volume force with recpect to the baseline
  auto vf_indicator_force_based = [this, &time, &fi, &correct_skewness](Point & face_normal)
  {
    Real value = 0.0;
    Moose::FaceArg loc_face{
        &fi, Moose::FV::LimiterType::CentralDifference, true, correct_skewness, nullptr, nullptr};
 
    for (const auto i : make_range(_volumetric_force.size()))
      value += (*_volumetric_force[i])(loc_face, time) * (face_normal * fi.normal());
    if ((std::abs(value) - _baseline_volume_force) > 0)
      return 1.0;
    else
      return 0.0;
  };
 
  const Point & elem_centroid = fi.elemCentroid();
  const Point & neighbor_centroid = fi.neighborCentroid();
  Real elem_volume = fi.elemVolume();
  Real neighbor_volume = fi.neighborVolume();
 
  // Now we need to perform the computations of D
  const auto elem_a = (*_a_read[tid])(makeElemArg(elem), time);
 
  mooseAssert(UserObject::_subproblem.getCoordSystem(elem->subdomain_id()) ==
                  UserObject::_subproblem.getCoordSystem(neighbor->subdomain_id()),
              "Coordinate systems must be the same between the two elements");
 
  Real coord;
  coordTransformFactor(UserObject::_subproblem, elem->subdomain_id(), elem_centroid, coord);
 
  elem_volume *= coord;
 
  VectorValue<ADReal> elem_D = 0;
  for (const auto i : make_range(_dim))
  {
    mooseAssert(elem_a(i).value() != 0, "We should not be dividing by zero");
    elem_D(i) = elem_volume / elem_a(i);
  }
 
  VectorValue<ADReal> face_D;
 
  const auto neighbor_a = (*_a_read[tid])(makeElemArg(neighbor), time);
 
  coordTransformFactor(UserObject::_subproblem, neighbor->subdomain_id(), neighbor_centroid, coord);
  neighbor_volume *= coord;
 
  VectorValue<ADReal> neighbor_D = 0;
  for (const auto i : make_range(_dim))
  {
    mooseAssert(neighbor_a(i).value() != 0, "We should not be dividing by zero");
    neighbor_D(i) = neighbor_volume / neighbor_a(i);
  }
 
  // We require this to ensure that the correct interpolation weights are used.
  // This will change once the traditional weights are replaced by the weights
  // that are used by the skewness-correction.
  Moose::FV::InterpMethod coeff_interp_method = correct_skewness
                                                    ? Moose::FV::InterpMethod::SkewCorrectedAverage
                                                    : Moose::FV::InterpMethod::Average;
  Moose::FV::interpolate(coeff_interp_method, face_D, elem_D, neighbor_D, fi, true);
 
  // evaluate face porosity, see (18) in Hanimann 2021 or (11) in Nordlund 2016
  const auto face_eps = epsilon(tid)(face, time);
 
  // Perform the pressure correction. We don't use skewness-correction on the pressure since
  // it only influences the averaged cell gradients which cancel out in the correction
  // below.
  for (const auto i : make_range(_dim))
  {
    // "Standard" pressure-based RC interpolation
    velocity(i) -= face_D(i) * face_eps * (grad_p(i) - unc_grad_p(i));
 
    if (_bool_correct_vf)
    {
      // To solve the volume force incorrect interpolation, we add back the pressure gradient to the
      // RC-inconsistent faces regarding the marking method
      Point unit_basis_vector;
      unit_basis_vector(i) = 1.0;
 
      // Get the value of the correction face indicator
      Real correction_indicator;
      if (_volume_force_correction_method == "force-consistent")
        correction_indicator = vf_indicator_force_based(unit_basis_vector);
      else
        correction_indicator = vf_indicator_pressure_based(unit_basis_vector);
 
      // Correct back the velocity
      velocity(i) += face_D(i) * face_eps * (grad_p(i) - unc_grad_p(i)) * correction_indicator;
    }
  }
 
  // If not solving for velocity, clear derivatives
  if (_fe_problem.currentNlSysNum() != _momentum_sys_number)
    return MetaPhysicL::raw_value(velocity);
  else
    return velocity;
}

Referenced by GetAllTheRCVelocities::execute().

◆ getVolumetricFaceFlux()

Real RhieChowInterpolatorBase::getVolumetricFaceFlux	(	const Moose::FV::InterpMethod	m,
		const FaceInfo &	fi,
		const Moose::StateArg &	time,
		const THREAD_ID	tid,
		bool	subtract_mesh_velocity
	)		const

overridevirtualinherited

Retrieve the volumetric face flux, will not include derivatives.

Parameters

m	The velocity interpolation method. This is either Rhie-Chow or Average. Rhie-Chow is recommended as it avoids checkerboards in the pressure field
fi	The face that we wish to retrieve the velocity for
tid	The thread ID

Returns: The face velocity

Implements RhieChowFaceFluxProvider.

Definition at line 133 of file RhieChowInterpolatorBase.C.

{
  return raw_value(this->getVelocity(m, fi, time, tid, subtract_mesh_velocity)) * fi.normal();
}

◆ ghostADataOnBoundary()

void INSFVRhieChowInterpolator::ghostADataOnBoundary ( const BoundaryID boundary_id )

overridevirtual

makes sure coefficient data gets communicated on both sides of a given boundary

Reimplemented from RhieChowInterpolatorBase.

Definition at line 499 of file INSFVRhieChowInterpolator.C.

{
  if (!needAComputation() || this->n_processors() == 1)
    return;
 
  // Ghost a for the elements on the boundary
  for (auto elem_id : _moose_mesh.getBoundaryActiveSemiLocalElemIds(boundary_id))
  {
    const auto & elem = _moose_mesh.elemPtr(elem_id);
    // no need to ghost if locally owned or far from local process
    if (elem->processor_id() != this->processor_id() && elem->is_semilocal(this->processor_id()))
      // Adding to the a coefficient will make sure the final result gets communicated
      addToA(elem, 0, 0);
  }
 
  // Ghost a for the neighbors of the elements on the boundary
  for (auto neighbor_id : _moose_mesh.getBoundaryActiveNeighborElemIds(boundary_id))
  {
    const auto & neighbor = _moose_mesh.queryElemPtr(neighbor_id);
    // no need to ghost if locally owned or far from local process
    if (neighbor->processor_id() != this->processor_id() &&
        neighbor->is_semilocal(this->processor_id()))
      // Adding to the a coefficient will make sure the final result gets communicated
      addToA(neighbor, 0, 0);
  }
}

◆ hasFaceSide()

bool RhieChowFaceFluxProvider::hasFaceSide	(	const FaceInfo &	fi,
		const bool	fi_elem_side
	)		const

overridevirtualinherited

Implements FaceArgInterface.

Definition at line 29 of file RhieChowFaceFluxProvider.C.

{
  if (fi_elem_side)
    return hasBlocks(fi.elem().subdomain_id());
  else
    return fi.neighborPtr() && hasBlocks(fi.neighbor().subdomain_id());
}

◆ initialize()

void INSFVRhieChowInterpolator::initialize ( )

overridevirtual

Implements GeneralUserObject.

Reimplemented in PINSFVRhieChowInterpolator.

Definition at line 349 of file INSFVRhieChowInterpolator.C.

{
  if (!needAComputation())
    return;
 
  // Reset map of coefficients to zero.
  // The keys should not have changed unless the mesh has changed
  // Dont reset if not in current system
  // IDEA: clear them derivatives
  if (_momentum_sys_number == _fe_problem.currentNlSysNum())
    for (auto & pair : _a)
      pair.second = 0;
  else
    for (auto & pair : _a)
    {
      auto & a_val = pair.second;
      a_val = MetaPhysicL::raw_value(a_val);
    }
}

Referenced by PINSFVRhieChowInterpolator::initialize().

◆ initialSetup()

void INSFVRhieChowInterpolator::initialSetup ( )

overridevirtual

Reimplemented from GeneralUserObject.

Definition at line 270 of file INSFVRhieChowInterpolator.C.

{
  insfvSetup();
 
  if (_velocity_interp_method == Moose::FV::InterpMethod::Average)
    return;
  for (const auto var_num : _var_numbers)
  {
    std::vector<MooseObject *> var_objects;
    _fe_problem.theWarehouse()
        .query()
        .template condition<AttribVar>(static_cast<int>(var_num))
        .template condition<AttribResidualObject>(true)
        .template condition<AttribSysNum>(_u->sys().number())
        .queryInto(var_objects);
    for (auto * const var_object : var_objects)
    {
      // Allow FVElementalKernel that are not INSFVMomentumResidualObject for now, refs #20695
      if (!dynamic_cast<INSFVMomentumResidualObject *>(var_object) &&
          !dynamic_cast<FVElementalKernel *>(var_object))
        mooseError("Object ",
                   var_object->name(),
                   " is not a INSFVMomentumResidualObject. Make sure that all the objects applied "
                   "to the momentum equation are INSFV or derived objects.");
      else if (!dynamic_cast<INSFVMomentumResidualObject *>(var_object) &&
               dynamic_cast<FVElementalKernel *>(var_object))
        mooseWarning(
            "Elemental kernel ",
            var_object->name(),
            " is not a INSFVMomentumResidualObject. Make sure that all the objects applied "
            "to the momentum equation are INSFV or derived objects.");
    }
 
    if (var_objects.size() == 0 && !_a_data_provided)
      mooseError("No INSFVKernels detected for the velocity variables. If you are trying to use "
                 "auxiliary variables for advection, please specify the a_u/v/w coefficients. If "
                 "not, please specify INSFVKernels for the momentum equations.");
  }
 
  // Get baseline force if force-correction method is used for volumetric correction
  if (_bool_correct_vf && _volume_force_correction_method == "force-consistent")
  {
    _baseline_volume_force = 1e10;
    for (const auto & loc_elem : *_elem_range)
    {
      Real elem_value = 0.0;
      for (const auto i : make_range(_volumetric_force.size()))
        elem_value += (*_volumetric_force[i])(makeElemArg(loc_elem), determineState());
 
      if (std::abs(elem_value) < _baseline_volume_force)
        _baseline_volume_force = std::abs(elem_value);
      if (_baseline_volume_force == 0)
        break;
    }
    _communicator.min(_baseline_volume_force);
  }
}

◆ insfvSetup()

void INSFVRhieChowInterpolator::insfvSetup ( )

protected

perform the setup of this object

Definition at line 329 of file INSFVRhieChowInterpolator.C.

{
  _elem_range =
      std::make_unique<ConstElemRange>(_mesh.active_local_subdomain_set_elements_begin(blockIDs()),
                                       _mesh.active_local_subdomain_set_elements_end(blockIDs()));
}

Referenced by initialSetup(), and meshChanged().

◆ listOfCommonParams()

std::vector< std::string > INSFVRhieChowInterpolator::listOfCommonParams ( )

static

Returns: A list of the parameters that are common between this object and the NSFV action

Definition at line 70 of file INSFVRhieChowInterpolator.C.

{
  return {"pull_all_nonlocal_a",
          "correct_volumetric_force",
          "volume_force_correction_method",
          "volumetric_force_functors"};
}

Referenced by WCNSFVFlowPhysics::addRhieChowUserObjects().

◆ meshChanged()

void INSFVRhieChowInterpolator::meshChanged ( )

overridevirtual

Reimplemented from GeneralUserObject.

Reimplemented in PINSFVRhieChowInterpolator.

Definition at line 337 of file INSFVRhieChowInterpolator.C.

{
  insfvSetup();
 
  // If the mesh has been modified:
  // - the boundary elements may have changed
  // - some elements may have been refined
  _elements_to_push_pull.clear();
  _a.clear();
}

Referenced by PINSFVRhieChowInterpolator::meshChanged().

◆ needAComputation()

bool INSFVRhieChowInterpolator::needAComputation ( ) const

inlineprivate

Whether we need 'a' coefficient computation.

Definition at line 234 of file INSFVRhieChowInterpolator.h.

{
  // We dont check for "a"s being in another nonlinear system here, only being auxiliary
  return !_a_data_provided && _velocity_interp_method == Moose::FV::InterpMethod::RhieChow;
}

Referenced by finalize(), ghostADataOnBoundary(), and initialize().

◆ pressure()

const INSFVPressureVariable & RhieChowInterpolatorBase::pressure ( THREAD_ID tid ) const

inlineinherited

Returns: The pressure variable corresponding to the provided thread ID

Definition at line 160 of file RhieChowInterpolatorBase.h.

{
  mooseAssert(tid < _ps.size(), "Attempt to access out-of-bounds in pressure variable container");
  return *static_cast<INSFVPressureVariable *>(_ps[tid]);
}

◆ pressureSkewCorrection()

bool INSFVRhieChowInterpolator::pressureSkewCorrection ( THREAD_ID tid ) const

inline

Whether central differencing face interpolations of pressure should include a skewness correction.

Definition at line 248 of file INSFVRhieChowInterpolator.h.

{
  const auto * const p = _ps[tid];
  return (p->faceInterpolationMethod() == Moose::FV::InterpMethod::SkewCorrectedAverage);
}

Referenced by getVelocity().

◆ pullAllNonlocal()

void INSFVRhieChowInterpolator::pullAllNonlocal ( )

inline

Whether to pull all 'a' coefficient data from the owning process for all nonlocal elements we have access to (e.g.

all of our nonlocal elements we have pointers to)

Definition at line 99 of file INSFVRhieChowInterpolator.h.

99{ _pull_all_nonlocal = true; }

Referenced by GetAllTheRCVelocities::GetAllTheRCVelocities().

◆ segregated()

virtual bool INSFVRhieChowInterpolator::segregated ( ) const

inlineoverridevirtual

Bool of the Rhie Chow user object is used in monolithic/segregated approaches.

Implements RhieChowInterpolatorBase.

Definition at line 88 of file INSFVRhieChowInterpolator.h.

88{ return false; };

◆ supportMeshVelocity()

virtual bool RhieChowFaceFluxProvider::supportMeshVelocity ( ) const

inlinevirtualinherited

Returns whether the UO can support mesh velocity advection.

Reimplemented in RhieChowMassFlux.

Definition at line 49 of file RhieChowFaceFluxProvider.h.

49{ return true; }

Referenced by VolumetricFlowRate::VolumetricFlowRate().

◆ uniqueParams()

InputParameters INSFVRhieChowInterpolator::uniqueParams ( )

static

Parameters of this object that should be added to the NSFV action that are unique to this object.

Definition at line 45 of file INSFVRhieChowInterpolator.C.

{
  auto params = emptyInputParameters();
  params.addParam<bool>(
      "pull_all_nonlocal_a",
      false,
      "Whether to pull all nonlocal 'a' coefficient data to our process. Note that 'nonlocal' "
      "means elements that we have access to (this may not be all the elements in the mesh if the "
      "mesh is distributed) but that we do not own.");
  params.addParamNamesToGroup("pull_all_nonlocal_a", "Parallel Execution Tuning");
 
  params.addParam<bool>(
      "correct_volumetric_force", false, "Flag to activate volume force corrections.");
  MooseEnum volume_force_correction_method("force-consistent pressure-consistent",
                                           "force-consistent");
  params.addParam<MooseEnum>(
      "volume_force_correction_method",
      volume_force_correction_method,
      "The method used for correcting the Rhie-Chow coefficients for a volume force.");
  params.addParam<std::vector<MooseFunctorName>>(
      "volumetric_force_functors", "The names of the functors with the volumetric force sources.");
  return params;
}

Referenced by NSFVBase::validParams(), and validParams().

◆ validParams()

InputParameters INSFVRhieChowInterpolator::validParams ( )

static

Definition at line 79 of file INSFVRhieChowInterpolator.C.

{
  auto params = RhieChowInterpolatorBase::validParams();
  params += INSFVRhieChowInterpolator::uniqueParams();
 
  params.addClassDescription(
      "Computes the Rhie-Chow velocity based on gathered 'a' coefficient data.");
 
  ExecFlagEnum & exec_enum = params.set<ExecFlagEnum>("execute_on", true);
  exec_enum.addAvailableFlags(EXEC_PRE_KERNELS);
  exec_enum = {EXEC_PRE_KERNELS};
  params.suppressParameter<ExecFlagEnum>("execute_on");
 
  params.addParam<MooseFunctorName>(
      "a_u",
      "For simulations in which the advecting velocities are aux variables, this parameter must be "
      "supplied. It represents the on-diagonal coefficients for the 'x' component velocity, solved "
      "via the Navier-Stokes equations.");
  params.addParam<MooseFunctorName>(
      "a_v",
      "For simulations in which the advecting velocities are aux variables, this parameter must be "
      "supplied when the mesh dimension is greater than 1. It represents the on-diagonal "
      "coefficients for the 'y' component velocity, solved via the Navier-Stokes equations.");
  params.addParam<MooseFunctorName>(
      "a_w",
      "For simulations in which the advecting velocities are aux variables, this parameter must be "
      "supplied when the mesh dimension is greater than 2. It represents the on-diagonal "
      "coefficients for the 'z' component velocity, solved via the Navier-Stokes equations.");
  params.addParam<VariableName>("disp_x", "The x-component of displacement");
  params.addParam<VariableName>("disp_y", "The y-component of displacement");
  params.addParam<VariableName>("disp_z", "The z-component of displacement");
  return params;
}

Referenced by PINSFVRhieChowInterpolator::validParams().

◆ vel()

const INSFVVelocityVariable * RhieChowInterpolatorBase::vel ( ) const

inlineinherited

Definition at line 83 of file RhieChowInterpolatorBase.h.

83{ return _u; }

Referenced by getVelocity().

◆ velocityInterpolationMethod()

Moose::FV::InterpMethod RhieChowInterpolatorBase::velocityInterpolationMethod ( ) const

inlineinherited

Return the interpolation method used for velocity.

Definition at line 70 of file RhieChowInterpolatorBase.h.

70{ return _velocity_interp_method; }

◆ velocitySkewCorrection()

bool INSFVRhieChowInterpolator::velocitySkewCorrection ( THREAD_ID tid ) const

inline

Whether central differencing face interpolations of velocity should include a skewness correction Also used for the face interpolation of the D coefficient and the face interpolation of volumetric forces for for the volume correction method and the face interpolation of porosity.

Definition at line 241 of file INSFVRhieChowInterpolator.h.

{
  const auto * const u = _us[tid];
  return (u->faceInterpolationMethod() == Moose::FV::InterpMethod::SkewCorrectedAverage);
}

Referenced by getVelocity().

Member Data Documentation

◆ _a

CellCenteredMapFunctor<ADRealVectorValue, std::unordered_map<dof_id_type, ADRealVectorValue> > INSFVRhieChowInterpolator::_a

protected

A map from element IDs to 'a' coefficient data.

Definition at line 141 of file INSFVRhieChowInterpolator.h.

Referenced by addToA(), fillARead(), finalize(), initialize(), and meshChanged().

◆ _a_aux

std::vector<std::unique_ptr<Moose::FunctorBase<VectorValue<ADReal> > > > INSFVRhieChowInterpolator::_a_aux

private

A vector sized according to the number of threads that holds vector composites of 'a' component functors.

This member is leveraged when advecting velocities are auxiliary variables and the 'a' data has been transferred from another application

Definition at line 191 of file INSFVRhieChowInterpolator.h.

Referenced by fillARead().

◆ _a_data_provided

bool INSFVRhieChowInterpolator::_a_data_provided

private

Whether 'a' data has been provided by the user.

This can happen if we are running in an application solving precursor advection, and another application has computed the fluid flow field

Definition at line 196 of file INSFVRhieChowInterpolator.h.

Referenced by execute(), fillARead(), getVelocity(), initialSetup(), and needAComputation().

◆ _a_mutex

Threads::spin_mutex INSFVRhieChowInterpolator::_a_mutex

private

Mutex that prevents multiple threads from saving into the 'a' coefficients at the same time.

Definition at line 182 of file INSFVRhieChowInterpolator.h.

Referenced by addToA().

◆ _a_read

std::vector<const Moose::FunctorBase<VectorValue<ADReal> > *> INSFVRhieChowInterpolator::_a_read

private

A vector sized according to the number of threads that holds the 'a' data we will read from when computing the Rhie-Chow velocity.

Definition at line 186 of file INSFVRhieChowInterpolator.h.

Referenced by fillARead(), and getVelocity().

◆ _ax

Moose::VectorComponentFunctor<ADReal> INSFVRhieChowInterpolator::_ax

protected

The x-component of 'a'

Definition at line 151 of file INSFVRhieChowInterpolator.h.

Referenced by fillARead().

◆ _ay

Moose::VectorComponentFunctor<ADReal> INSFVRhieChowInterpolator::_ay

protected

The y-component of 'a'.

Definition at line 154 of file INSFVRhieChowInterpolator.h.

Referenced by fillARead().

◆ _az

Moose::VectorComponentFunctor<ADReal> INSFVRhieChowInterpolator::_az

protected

The z-component of 'a'.

Definition at line 157 of file INSFVRhieChowInterpolator.h.

Referenced by fillARead().

◆ _baseline_volume_force

Real INSFVRhieChowInterpolator::_baseline_volume_force

private

Minimum absolute RC force over the domain.

Definition at line 214 of file INSFVRhieChowInterpolator.h.

Referenced by getVelocity(), and initialSetup().

◆ _bool_correct_vf

const bool& INSFVRhieChowInterpolator::_bool_correct_vf

private

Correct Rhie-Chow coefficients for volumetric force flag.

Definition at line 202 of file INSFVRhieChowInterpolator.h.

Referenced by getVelocity(), initialSetup(), and INSFVRhieChowInterpolator().

◆ _dim

const unsigned int RhieChowInterpolatorBase::_dim

protectedinherited

The dimension of the mesh, e.g. 3 for hexes and tets, 2 for quads and tris.

Definition at line 113 of file RhieChowInterpolatorBase.h.

Referenced by INSFVRhieChowInterpolatorSegregated::computeCellVelocity(), INSFVRhieChowInterpolatorSegregated::computeFaceVelocity(), fillARead(), getVelocity(), INSFVRhieChowInterpolator(), INSFVRhieChowInterpolatorSegregated::INSFVRhieChowInterpolatorSegregated(), INSFVRhieChowInterpolatorSegregated::populateHbyA(), and RhieChowInterpolatorBase::RhieChowInterpolatorBase().

◆ _disp_xs

std::vector<MooseVariableField<Real> *> INSFVRhieChowInterpolator::_disp_xs

protected

All the thread copies of the x-displacement variable.

Definition at line 126 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator().

◆ _disp_ys

std::vector<MooseVariableField<Real> *> INSFVRhieChowInterpolator::_disp_ys

protected

All the thread copies of the y-displacement variable.

Definition at line 129 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator().

◆ _disp_zs

std::vector<MooseVariableField<Real> *> INSFVRhieChowInterpolator::_disp_zs

protected

All the thread copies of the z-displacement variable.

Definition at line 132 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator().

◆ _displaced

const bool RhieChowInterpolatorBase::_displaced

protectedinherited

Whether this object is operating on the displaced mesh.

Definition at line 146 of file RhieChowInterpolatorBase.h.

Referenced by execute(), and INSFVRhieChowInterpolator().

◆ _disps

std::vector<std::unique_ptr<Moose::VectorCompositeFunctor<ADReal> > > INSFVRhieChowInterpolator::_disps

protected

A functor for computing the displacement.

Definition at line 135 of file INSFVRhieChowInterpolator.h.

Referenced by getVelocity(), and INSFVRhieChowInterpolator().

◆ _elem_range

std::unique_ptr<ConstElemRange> INSFVRhieChowInterpolator::_elem_range

protected

All the active and elements local to this process that exist on this object's subdomains.

Definition at line 138 of file INSFVRhieChowInterpolator.h.

Referenced by execute(), initialSetup(), and insfvSetup().

◆ _elements_to_push_pull

std::unordered_set<const Elem *> INSFVRhieChowInterpolator::_elements_to_push_pull

private

Non-local elements that we should push and pull data for across processes.

Definition at line 176 of file INSFVRhieChowInterpolator.h.

Referenced by addToA(), finalize(), and meshChanged().

◆ _example

const VectorValue<ADReal> INSFVRhieChowInterpolator::_example

private

An example datum used to help communicate AD vector information in parallel.

Definition at line 179 of file INSFVRhieChowInterpolator.h.

◆ _mesh

const libMesh::MeshBase& RhieChowInterpolatorBase::_mesh

protectedinherited

The libMesh mesh that this object acts on.

Definition at line 110 of file RhieChowInterpolatorBase.h.

Referenced by INSFVRhieChowInterpolatorSegregated::computeCellVelocity(), INSFVRhieChowInterpolatorSegregated::computeHbyA(), finalize(), and insfvSetup().

◆ _momentum_sys_number

const unsigned int INSFVRhieChowInterpolator::_momentum_sys_number

protected

The number of the nonlinear system in which the monolithic momentum and continuity equations are located.

Definition at line 161 of file INSFVRhieChowInterpolator.h.

Referenced by execute(), finalize(), getVelocity(), and initialize().

◆ _moose_mesh

MooseMesh& RhieChowInterpolatorBase::_moose_mesh

protectedinherited

The MooseMesh that this user object operates on.

Definition at line 107 of file RhieChowInterpolatorBase.h.

Referenced by RhieChowInterpolatorBase::checkBlocks(), INSFVRhieChowInterpolatorSegregated::computeHbyA(), execute(), getVelocity(), ghostADataOnBoundary(), INSFVRhieChowInterpolator(), and PINSFVRhieChowInterpolator::pinsfvSetup().

◆ _p

INSFVPressureVariable* const RhieChowInterpolatorBase::_p

protectedinherited

The thread 0 copy of the pressure variable.

Definition at line 116 of file RhieChowInterpolatorBase.h.

Referenced by INSFVRhieChowInterpolatorSegregated::computeCellVelocity(), INSFVRhieChowInterpolatorSegregated::computeFaceVelocity(), PINSFVRhieChowInterpolator::pinsfvSetup(), and RhieChowInterpolatorBase::RhieChowInterpolatorBase().

◆ _ps

std::vector<MooseVariableFVReal *> RhieChowInterpolatorBase::_ps

protectedinherited

All the thread copies of the pressure variable.

Definition at line 128 of file RhieChowInterpolatorBase.h.

Referenced by getVelocity(), RhieChowInterpolatorBase::pressure(), pressureSkewCorrection(), and RhieChowInterpolatorBase::RhieChowInterpolatorBase().

◆ _pull_all_nonlocal

bool INSFVRhieChowInterpolator::_pull_all_nonlocal

private

Whether we want to pull all nonlocal 'a' coefficient data.

Definition at line 199 of file INSFVRhieChowInterpolator.h.

Referenced by finalize(), and pullAllNonlocal().

◆ _u

INSFVVelocityVariable* const RhieChowInterpolatorBase::_u

protectedinherited

The thread 0 copy of the x-velocity variable.

Definition at line 119 of file RhieChowInterpolatorBase.h.

Referenced by INSFVRhieChowInterpolatorSegregated::computeCellVelocity(), INSFVRhieChowInterpolatorSegregated::computeFaceVelocity(), INSFVRhieChowInterpolatorSegregated::computeHbyA(), INSFVRhieChowInterpolatorSegregated::initFaceVelocities(), initialSetup(), INSFVRhieChowInterpolatorSegregated::INSFVRhieChowInterpolatorSegregated(), INSFVRhieChowInterpolatorSegregated::populateHbyA(), RhieChowInterpolatorBase::RhieChowInterpolatorBase(), and RhieChowInterpolatorBase::vel().

◆ _unity_functor

const Moose::ConstantFunctor<ADReal> RhieChowInterpolatorBase::_unity_functor {1}

privateinherited

A unity functor used in the epsilon virtual method.

Definition at line 150 of file RhieChowInterpolatorBase.h.

150{1};

Referenced by RhieChowInterpolatorBase::epsilon().

◆ _us

std::vector<MooseVariableFVReal *> RhieChowInterpolatorBase::_us

protectedinherited

All the thread copies of the x-velocity variable.

Definition at line 131 of file RhieChowInterpolatorBase.h.

Referenced by getVelocity(), INSFVRhieChowInterpolator(), RhieChowInterpolatorBase::RhieChowInterpolatorBase(), and velocitySkewCorrection().

◆ _v

INSFVVelocityVariable* const RhieChowInterpolatorBase::_v

protectedinherited

The thread 0 copy of the y-velocity variable (null if the problem is 1D)

Definition at line 122 of file RhieChowInterpolatorBase.h.

Referenced by INSFVRhieChowInterpolatorSegregated::computeCellVelocity(), INSFVRhieChowInterpolatorSegregated::computeHbyA(), getVelocity(), and RhieChowInterpolatorBase::RhieChowInterpolatorBase().

◆ _var_numbers

std::vector<unsigned int> RhieChowInterpolatorBase::_var_numbers

protectedinherited

The velocity variable numbers.

Definition at line 140 of file RhieChowInterpolatorBase.h.

Referenced by execute(), initialSetup(), and RhieChowInterpolatorBase::RhieChowInterpolatorBase().

◆ _vel

std::vector<std::unique_ptr<PiecewiseByBlockLambdaFunctor<ADRealVectorValue> > > INSFVRhieChowInterpolator::_vel

protected

A functor for computing the (non-RC corrected) velocity.

Definition at line 123 of file INSFVRhieChowInterpolator.h.

Referenced by getVelocity(), and INSFVRhieChowInterpolator().

◆ _velocity_interp_method

Moose::FV::InterpMethod RhieChowInterpolatorBase::_velocity_interp_method

protectedinherited

The interpolation method to use for the velocity.

Definition at line 143 of file RhieChowInterpolatorBase.h.

Referenced by getVelocity(), initialSetup(), INSFVRhieChowInterpolator(), needAComputation(), RhieChowInterpolatorBase::RhieChowInterpolatorBase(), and RhieChowInterpolatorBase::velocityInterpolationMethod().

◆ _volume_force_correction_method

const MooseEnum INSFVRhieChowInterpolator::_volume_force_correction_method

private

– Method used for computing the properties average

Definition at line 205 of file INSFVRhieChowInterpolator.h.

Referenced by getVelocity(), and initialSetup().

◆ _volumetric_force

std::vector<const Moose::Functor<Real> *> INSFVRhieChowInterpolator::_volumetric_force

private

Values of the functors storing the volumetric forces.

Definition at line 211 of file INSFVRhieChowInterpolator.h.

Referenced by getVelocity(), initialSetup(), and INSFVRhieChowInterpolator().

◆ _volumetric_force_functors

const std::vector<MooseFunctorName>* INSFVRhieChowInterpolator::_volumetric_force_functors

private

Names of the functors storing the volumetric forces.

Definition at line 208 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator().

◆ _vs

std::vector<MooseVariableFVReal *> RhieChowInterpolatorBase::_vs

protectedinherited

All the thread copies of the y-velocity variable.

Definition at line 134 of file RhieChowInterpolatorBase.h.

Referenced by getVelocity(), INSFVRhieChowInterpolator(), and RhieChowInterpolatorBase::RhieChowInterpolatorBase().

◆ _w

INSFVVelocityVariable* const RhieChowInterpolatorBase::_w

protectedinherited

The thread 0 copy of the z-velocity variable (null if the problem is not 3D)

Definition at line 125 of file RhieChowInterpolatorBase.h.

Referenced by INSFVRhieChowInterpolatorSegregated::computeCellVelocity(), INSFVRhieChowInterpolatorSegregated::computeHbyA(), getVelocity(), and RhieChowInterpolatorBase::RhieChowInterpolatorBase().

◆ _ws

std::vector<MooseVariableFVReal *> RhieChowInterpolatorBase::_ws

protectedinherited

All the thread copies of the z-velocity variable.

Definition at line 137 of file RhieChowInterpolatorBase.h.

Referenced by getVelocity(), INSFVRhieChowInterpolator(), and RhieChowInterpolatorBase::RhieChowInterpolatorBase().

◆ _zero_functor

const Moose::ConstantFunctor<ADReal> INSFVRhieChowInterpolator::_zero_functor {0}

private

A zero functor potentially used in _a_read.

Definition at line 217 of file INSFVRhieChowInterpolator.h.

217{0};

Referenced by fillARead(), and INSFVRhieChowInterpolator().

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

navier_stokes/include/userobjects/INSFVRhieChowInterpolator.h
navier_stokes/src/userobjects/INSFVRhieChowInterpolator.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ INSFVRhieChowInterpolator()

Member Function Documentation

◆ addToA()

◆ checkBlocks()

◆ epsilon()

◆ execute()

◆ fillARead()

◆ fillContainer()

◆ finalize()

◆ getVelocity()

◆ getVolumetricFaceFlux()

◆ ghostADataOnBoundary()

◆ hasFaceSide()

◆ initialize()

◆ initialSetup()

◆ insfvSetup()

◆ listOfCommonParams()

◆ meshChanged()

◆ needAComputation()

◆ pressure()

◆ pressureSkewCorrection()

◆ pullAllNonlocal()

◆ segregated()

◆ supportMeshVelocity()

◆ uniqueParams()

◆ validParams()

◆ vel()

◆ velocityInterpolationMethod()

◆ velocitySkewCorrection()

Member Data Documentation

◆ _a

◆ _a_aux

◆ _a_data_provided

◆ _a_mutex

◆ _a_read

◆ _ax

◆ _ay

◆ _az

◆ _baseline_volume_force

◆ _bool_correct_vf

◆ _dim

◆ _disp_xs

◆ _disp_ys

◆ _disp_zs

◆ _displaced

◆ _disps

◆ _elem_range

◆ _elements_to_push_pull

◆ _example

◆ _mesh

◆ _momentum_sys_number

◆ _moose_mesh

◆ _p

◆ _ps

◆ _pull_all_nonlocal

◆ _u

◆ _unity_functor

◆ _us

◆ _v

◆ _var_numbers

◆ _vel

◆ _velocity_interp_method

◆ _volume_force_correction_method

◆ _volumetric_force

◆ _volumetric_force_functors

◆ _vs