A class that inherits the free-flow class's implementation of Rhie-Chow data gathering and adds the ability to perform repeated interpolations and reconstructions of the porosity in order to reduce non-physical oscillations that arise from property discontinuities in a collocated discretization of pressure and velocity. More...

#include <PINSFVRhieChowInterpolator.h>

Inheritance diagram for PINSFVRhieChowInterpolator:

[legend]

Public Types
typedef DataFileName	DataFileParameterType

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

Public Member Functions
	PINSFVRhieChowInterpolator (const InputParameters &params)

virtual void	meshChanged () override

virtual void	initialize () override

virtual void	execute () override

virtual void	finalize () override

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

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

virtual void	initialSetup () override

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

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

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

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

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

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

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

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

SubProblem &	getSubProblem () const

bool	shouldDuplicateInitialExecution () const

virtual Real	spatialValue (const Point &) const

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

void	gatherSum (T &value)

void	gatherMax (T &value)

void	gatherMin (T &value)

void	gatherProxyValueMax (T1 &proxy, T2 &value)

void	gatherProxyValueMin (T1 &proxy, T2 &value)

void	setPrimaryThreadCopy (UserObject *primary)

UserObject *	primaryThreadCopy ()

std::set< UserObjectName >	getDependObjects () const

virtual bool	needThreadedCopy () const

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

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

unsigned int	systemNumber () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

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

MooseApp &	getMooseApp () const

const std::string &	type () const

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	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	mooseWarningNonPrefixed (Args &&... args) const

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

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

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

const UserObject &	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)

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

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

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty ()

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

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

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

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

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

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

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

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

void	statefulPropertiesAllowed (bool)

bool	getMaterialPropertyCalled () const

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

bool	hasGenericMaterialProperty (const std::string &name)

bool	hasGenericMaterialPropertyByName (const std::string &name)

bool	hasGenericMaterialPropertyByName (const std::string &name)

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

const Function &	getFunctionByName (const FunctionName &name) const

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

bool	hasFunctionByName (const FunctionName &name) const

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

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

bool	hasPostprocessorByName (const PostprocessorName &name) const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name) const

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

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

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

T &	getSamplerByName (const SamplerName &name)

Sampler &	getSamplerByName (const SamplerName &name)

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

Static Public Member Functions
static InputParameters	validParams ()

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

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

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

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

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

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

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

Public Attributes
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 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
const Moose::FunctorBase< ADReal > &	epsilon (THREAD_ID tid) const override
	A virtual method that allows us to only implement getVelocity once for free and porous flows. More...

bool	isFaceGeometricallyRelevant (const FaceInfo &fi) const

void	insfvSetup ()
	perform the setup of this object More...

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`. More...

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

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &name) const override

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override

virtual void	addUserObjectDependencyHelper (const UserObject &uo) const override

void	addReporterDependencyHelper (const ReporterName &reporter_name) override

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

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)

Moose::CoordinateSystemType	getBlockCoordSystem ()

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 DenseVector< T > &residuals, const Indices &dof_indices, Real scaling_factor)

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

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

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

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

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

void	addJacobian (Assembly &assembly, DenseMatrix< Real > &local_k, const std::vector< dof_id_type > &row_indices, const std::vector< dof_id_type > &column_indices, Real scaling_factor)

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

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

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

void	addJacobianElement (Assembly &assembly, Real value, dof_id_type row_index, dof_id_type column_index, Real scaling_factor)

void	setResidual (SystemBase &sys, const T &residual, MooseVariableFE< T > &var)

void	setResidual (SystemBase &sys, Real residual, dof_id_type dof_index)

void	setResidual (SystemBase &sys, SetResidualFunctor set_residual_functor)

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)

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

Protected Attributes
const Moose::Functor< ADReal > &	_eps
	The thread 0 copy of the porosity functor held by the subproblem. More...

CellCenteredMapFunctor< ADReal, std::unordered_map< dof_id_type, ADReal > >	_smoothed_eps
	The smoothed porosity functor/field. More...

std::vector< const Moose::Functor< ADReal > * >	_epss
	All the thread copies of the problem's porosity functor. More...

std::vector< const Moose::Functor< ADReal > * >	_smoothed_epss
	All the thread copies of the problem's smoothed porosity functor. More...

const unsigned short	_smoothing_layers
	The number of interpolations and reconstructions that should be performed on the porosity functor/field. More...

std::vector< const FaceInfo * >	_geometric_fi
	All the face information that are "geometrically" accessible on this process. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

SubProblem &	_subproblem

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

const THREAD_ID	_tid

Assembly &	_assembly

const Moose::CoordinateSystemType &	_coord_sys

const bool	_duplicate_initial_execution

std::set< std::string >	_depend_uo

const bool &	_enabled

MooseApp &	_app

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 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'. More...

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

Static Protected Attributes
static const std::string	_interpolated_old

static const std::string	_interpolated_older

Private Member Functions
void	pinsfvSetup ()
	called during the first `initialize()` and upon `meshChanged()`, this method performs the interpolations and reconstructions of porosity. More...

Detailed Description

A class that inherits the free-flow class's implementation of Rhie-Chow data gathering and adds the ability to perform repeated interpolations and reconstructions of the porosity in order to reduce non-physical oscillations that arise from property discontinuities in a collocated discretization of pressure and velocity.

Definition at line 22 of file PINSFVRhieChowInterpolator.h.

Constructor & Destructor Documentation

◆ PINSFVRhieChowInterpolator()

PINSFVRhieChowInterpolator::PINSFVRhieChowInterpolator ( const InputParameters & params )

Definition at line 43 of file PINSFVRhieChowInterpolator.C.

   : INSFVRhieChowInterpolator(params),
     _eps(getFunctor<ADReal>(NS::porosity)),
     _smoothed_eps(_moose_mesh, NS::smoothed_porosity, /*extrapolated_boundary*/ true),
     _epss(libMesh::n_threads(), nullptr),
     _smoothed_epss(libMesh::n_threads(), nullptr),
     _smoothing_layers(getParam<unsigned short>("smoothing_layers"))
 {
   if (_smoothing_layers && _eps.wrapsType<MooseVariableBase>())
     paramError(
         NS::porosity,
         "If we are reconstructing porosity, then the input porosity to this user object cannot "
         "be a Moose variable. There are issues with reconstructing Moose variables: 1) initial "
         "conditions are run after user objects initial setup 2) reconstructing from a variable "
         "requires ghosting the solution vectors 3) it's difficult to restrict the face "
         "informations we evaluate interpolations and reconstructions on such that we never query "
         "an algebraically remote element due to things like two-term extrapolated boundary faces "
         "which trigger gradient evaluations which trigger neighbor element evaluation");
 
   const auto porosity_name = deduceFunctorName(NS::porosity);
 
   for (const auto tid : make_range(libMesh::n_threads()))
   {
     _epss[tid] = &UserObject::_subproblem.getFunctor<ADReal>(porosity_name, tid, name(), true);
 
     if (_smoothing_layers > 0)
     {
       if (!UserObject::_subproblem.hasFunctor(NS::smoothed_porosity, tid))
         // Smoothed porosity is only an envelope at this point, it will be set during pinsfvSetup()
         UserObject::_subproblem.addFunctor(NS::smoothed_porosity, _smoothed_eps, tid);
 
       _smoothed_epss[tid] =
           &UserObject::_subproblem.getFunctor<ADReal>(NS::smoothed_porosity, tid, name(), true);
     }
   }
 }

Member Function Documentation

◆ addToA()

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

inlineoverridevirtualinherited

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.

Referenced by INSFVRhieChowInterpolator::ghostADataOnBoundary().

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

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

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

 {
   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),
                  ")");
   }
 }

◆ epsilon()

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

inlineoverrideprotectedvirtual

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

Reimplemented from RhieChowInterpolatorBase.

Definition at line 77 of file PINSFVRhieChowInterpolator.h.

 {
   if (!_smoothing_layers)
     return *_epss[tid];
   else
     return *_smoothed_epss[tid];
 }

◆ execute()

void PINSFVRhieChowInterpolator::execute ( )

overridevirtual

Reimplemented from INSFVRhieChowInterpolator.

Definition at line 189 of file PINSFVRhieChowInterpolator.C.

 {
   // Cannot compute Rhie Chow coefficients on initial
   if (_current_execute_flag != EXEC_INITIAL)
     INSFVRhieChowInterpolator::execute();
 }

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

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

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

◆ finalize()

void PINSFVRhieChowInterpolator::finalize ( )

overridevirtual

Reimplemented from INSFVRhieChowInterpolator.

Definition at line 197 of file PINSFVRhieChowInterpolator.C.

 {
   // Cannot compute Rhie Chow coefficients on initial
   if (_current_execute_flag != EXEC_INITIAL)
     INSFVRhieChowInterpolator::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

overridevirtualinherited

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 522 of file INSFVRhieChowInterpolator.C.

Referenced by GetAllTheRCVelocities::execute().

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

◆ 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 143 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 )

overridevirtualinherited

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

Reimplemented from RhieChowInterpolatorBase.

Definition at line 494 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 PINSFVRhieChowInterpolator::initialize ( )

overridevirtual

Reimplemented from INSFVRhieChowInterpolator.

Definition at line 179 of file PINSFVRhieChowInterpolator.C.

 {
   if (_current_execute_flag == EXEC_INITIAL)
     pinsfvSetup();
   else
     // Cannot compute Rhie Chow coefficients on initial
     INSFVRhieChowInterpolator::initialize();
 }

◆ initialSetup()

void INSFVRhieChowInterpolator::initialSetup ( )

overridevirtualinherited

Reimplemented from GeneralUserObject.

Definition at line 265 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 ( )

protectedinherited

perform the setup of this object

Definition at line 324 of file INSFVRhieChowInterpolator.C.

Referenced by INSFVRhieChowInterpolator::initialSetup(), and INSFVRhieChowInterpolator::meshChanged().

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

◆ isFaceGeometricallyRelevant()

bool PINSFVRhieChowInterpolator::isFaceGeometricallyRelevant ( const FaceInfo & fi ) const

protected

Returns: whether this face is geometrically relevant to us

Definition at line 129 of file PINSFVRhieChowInterpolator.C.

Referenced by pinsfvSetup().

 {
   if (&fi.elem() == libMesh::remote_elem)
     return false;
 
   bool on_us = blockIDs().count(fi.elem().subdomain_id());
 
   if (fi.neighborPtr())
   {
     if (&fi.neighbor() == libMesh::remote_elem)
       return false;
 
     on_us = on_us || blockIDs().count(fi.neighbor().subdomain_id());
   }
 
   if (!on_us)
     // Neither the element nor neighbor has a subdomain id on which we are active, so this face is
     // not relevant
     return false;
 
   //
   // Ok, we've established that either the element or neighbor is active on our subdomains and
   // neither of them are remote elements, so this face is still in the running to be considered
   // relevant. There is one more caveat to be considered. In the case that we are a boundary face,
   // we will generally need a two term expansion to compute our value, which will require a
   // cell-gradient evaluation. If that is the case, then all of our surrounding neighbors cannot be
   // remote. If we are not a boundary face, then at this point we're safe
   //
 
   if (!Moose::FV::onBoundary(blockIDs(), fi))
     return true;
 
   const auto & boundary_elem = (fi.neighborPtr() && blockIDs().count(fi.neighbor().subdomain_id()))
                                    ? fi.neighbor()
                                    : fi.elem();
 
   for (auto * const neighbor : boundary_elem.neighbor_ptr_range())
   {
     if (!neighbor)
       continue;
 
     if ((neighbor == libMesh::remote_elem))
       return false;
   }
 
   // We made it through all the tests!
   return true;
 }

◆ listOfCommonParams()

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

staticinherited

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

Definition at line 65 of file INSFVRhieChowInterpolator.C.

Referenced by WCNSFVFlowPhysics::addRhieChowUserObjects().

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

◆ meshChanged()

void PINSFVRhieChowInterpolator::meshChanged ( )

overridevirtual

Reimplemented from INSFVRhieChowInterpolator.

Definition at line 81 of file PINSFVRhieChowInterpolator.C.

 {
   INSFVRhieChowInterpolator::meshChanged();
   pinsfvSetup();
 }

◆ pinsfvSetup()

void PINSFVRhieChowInterpolator::pinsfvSetup ( )

private

called during the first initialize() and upon meshChanged(), this method performs the interpolations and reconstructions of porosity.

Cannot be called in initialSetup() because UOs are initialized before Functions

Definition at line 88 of file PINSFVRhieChowInterpolator.C.

Referenced by initialize(), and meshChanged().

 {
   if (!_smoothing_layers)
     return;
 
   if (dynamic_cast<BernoulliPressureVariable *>(_p))
     paramError(
         NS::pressure,
         "If 'smoothing_layers' is non-zero, e.g. if the porosity is smooth(ed), "
         "then the pressure drop should be computed automatically. The "
         "'BernoulliPressureVariable' class enforces a pressure drop according to the Bernoulli "
         "equation on any face which has different pressure values on either side. This is "
         "undesirable when the porosity is varying smoothing and there may be pressure drops "
         "corresponding to viscous effects. Please just use the 'INSFVPressureVariable' "
         "class for pressure when the porosity is smooth.");
 
   const auto & all_fi = _moose_mesh.allFaceInfo();
   _geometric_fi.reserve(all_fi.size());
 
   for (const auto & fi : all_fi)
     if (isFaceGeometricallyRelevant(fi))
       _geometric_fi.push_back(&fi);
 
   _geometric_fi.shrink_to_fit();
 
   const auto saved_do_derivatives = ADReal::do_derivatives;
   ADReal::do_derivatives = true;
   Moose::FV::interpolateReconstruct(
       _smoothed_eps, _eps, _smoothing_layers, false, _geometric_fi, determineState());
   ADReal::do_derivatives = saved_do_derivatives;
 
   // Assign the new functor to all
   for (const auto tid : make_range((unsigned int)(1), libMesh::n_threads()))
   {
     auto & other_smoothed_epss = const_cast<Moose::Functor<ADReal> &>(
         UserObject::_subproblem.getFunctor<ADReal>(NS::smoothed_porosity, tid, name(), true));
     other_smoothed_epss.assign(_smoothed_eps);
   }
 }

◆ 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

inlineinherited

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

Definition at line 248 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator::getVelocity().

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

◆ pullAllNonlocal()

void INSFVRhieChowInterpolator::pullAllNonlocal ( )

inlineinherited

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.

Referenced by GetAllTheRCVelocities::GetAllTheRCVelocities().

99 { _pull_all_nonlocal = true; }

INSFVRhieChowInterpolator::_pull_all_nonlocal

bool _pull_all_nonlocal

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

Definition: INSFVRhieChowInterpolator.h:199

◆ segregated()

virtual bool INSFVRhieChowInterpolator::segregated ( ) const

inlineoverridevirtualinherited

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.

Referenced by VolumetricFlowRate::VolumetricFlowRate().

49 { return true; }

◆ uniqueParams()

InputParameters INSFVRhieChowInterpolator::uniqueParams ( )

staticinherited

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

Definition at line 40 of file INSFVRhieChowInterpolator.C.

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

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

◆ validParams()

InputParameters PINSFVRhieChowInterpolator::validParams ( )

static

Definition at line 19 of file PINSFVRhieChowInterpolator.C.

 {
   auto params = INSFVRhieChowInterpolator::validParams();
   params.addClassDescription("Performs interpolations and reconstructions of porosity and computes "
                              "the Rhie-Chow face velocities.");
   ExecFlagEnum & exec_enum = params.set<ExecFlagEnum>("execute_on", /*quiet=*/true);
   exec_enum.setAdditionalValue(EXEC_INITIAL);
   params.addRequiredParam<MooseFunctorName>(NS::porosity, "The porosity");
   params.addParam<unsigned short>(
       "smoothing_layers",
       0,
       "The number of interpolation-reconstruction operations to perform on the porosity");
   params.addRelationshipManager("ElementSideNeighborLayers",
                                 Moose::RelationshipManagerType::GEOMETRIC,
                                 [](const InputParameters & obj_params, InputParameters & rm_params)
                                 {
                                   rm_params.set<unsigned short>("layers") =
                                       obj_params.get<unsigned short>("smoothing_layers");
                                   rm_params.set<bool>("use_displaced_mesh") =
                                       obj_params.get<bool>("use_displaced_mesh");
                                 });
   return params;
 }

◆ vel()

const INSFVVelocityVariable* RhieChowInterpolatorBase::vel ( ) const

inlineinherited

Definition at line 83 of file RhieChowInterpolatorBase.h.

Referenced by INSFVRhieChowInterpolator::getVelocity().

83 { return _u; }

RhieChowInterpolatorBase::_u

INSFVVelocityVariable *const _u

The thread 0 copy of the x-velocity variable.

Definition: RhieChowInterpolatorBase.h:119

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

RhieChowInterpolatorBase::_velocity_interp_method

Moose::FV::InterpMethod _velocity_interp_method

The interpolation method to use for the velocity.

Definition: RhieChowInterpolatorBase.h:143

◆ velocitySkewCorrection()

bool INSFVRhieChowInterpolator::velocitySkewCorrection ( THREAD_ID tid ) const

inlineinherited

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.

Referenced by INSFVRhieChowInterpolator::getVelocity().

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

Member Data Documentation

◆ _a

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

protectedinherited

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

Definition at line 141 of file INSFVRhieChowInterpolator.h.

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

◆ _ax

Moose::VectorComponentFunctor<ADReal> INSFVRhieChowInterpolator::_ax

protectedinherited

The x-component of 'a'

Definition at line 151 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator::fillARead().

◆ _ay

Moose::VectorComponentFunctor<ADReal> INSFVRhieChowInterpolator::_ay

protectedinherited

The y-component of 'a'.

Definition at line 154 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator::fillARead().

◆ _az

Moose::VectorComponentFunctor<ADReal> INSFVRhieChowInterpolator::_az

protectedinherited

The z-component of 'a'.

Definition at line 157 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator::fillARead().

◆ _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(), INSFVRhieChowInterpolator::fillARead(), INSFVRhieChowInterpolator::getVelocity(), INSFVRhieChowInterpolator::INSFVRhieChowInterpolator(), INSFVRhieChowInterpolatorSegregated::INSFVRhieChowInterpolatorSegregated(), INSFVRhieChowInterpolatorSegregated::populateHbyA(), and RhieChowInterpolatorBase::RhieChowInterpolatorBase().

◆ _disp_xs

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

protectedinherited

All the thread copies of the x-displacement variable.

Definition at line 126 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator::INSFVRhieChowInterpolator().

◆ _disp_ys

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

protectedinherited

All the thread copies of the y-displacement variable.

Definition at line 129 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator::INSFVRhieChowInterpolator().

◆ _disp_zs

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

protectedinherited

All the thread copies of the z-displacement variable.

Definition at line 132 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator::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 INSFVRhieChowInterpolator::execute(), and INSFVRhieChowInterpolator::INSFVRhieChowInterpolator().

◆ _disps

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

protectedinherited

A functor for computing the displacement.

Definition at line 135 of file INSFVRhieChowInterpolator.h.

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

◆ _elem_range

std::unique_ptr<ConstElemRange> INSFVRhieChowInterpolator::_elem_range

protectedinherited

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 INSFVRhieChowInterpolator::execute(), INSFVRhieChowInterpolator::initialSetup(), and INSFVRhieChowInterpolator::insfvSetup().

◆ _eps

const Moose::Functor<ADReal>& PINSFVRhieChowInterpolator::_eps

protected

The thread 0 copy of the porosity functor held by the subproblem.

Initially this functor should be provided by a functor material property or function. We then perform repeated interpolations and reconstructions to create the resulting smoothed field

Definition at line 44 of file PINSFVRhieChowInterpolator.h.

Referenced by PINSFVRhieChowInterpolator(), and pinsfvSetup().

◆ _epss

std::vector<const Moose::Functor<ADReal> *> PINSFVRhieChowInterpolator::_epss

protected

All the thread copies of the problem's porosity functor.

Definition at line 50 of file PINSFVRhieChowInterpolator.h.

Referenced by epsilon(), and PINSFVRhieChowInterpolator().

◆ _geometric_fi

std::vector<const FaceInfo *> PINSFVRhieChowInterpolator::_geometric_fi

protected

All the face information that are "geometrically" accessible on this process.

For an internal face, we consider it to be geometrically accessible if neither element nor neighbor is a libMesh::remote_elem. For a boundary face, we consider the face to be geometrically accessible if the adjoining element and all its non-null neighbors are not libMesh::remote_elem. This is due to the need to be able to perform two-term expansions which require ability to compute a Green-Gauss gradient

Definition at line 65 of file PINSFVRhieChowInterpolator.h.

Referenced by pinsfvSetup().