An advection kernel that implements interpolation schemes specific to Navier-Stokes flow physics. More...

#include <INSFVMomentumAdvection.h>

Inheritance diagram for INSFVMomentumAdvection:

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

typedef DataFileName	DataFileParameterType

Public Member Functions
	INSFVMomentumAdvection (const InputParameters &params)

void	gatherRCData (const Elem &) override final
	Should be a non-empty implementation if the residual object is a `FVElementalKernel` and introduces residuals that are a function of the velocity, e.g. More...

void	gatherRCData (const FaceInfo &fi) override final
	Should be a non-empty implementation if the residual object is a `FVFluxKernel` and introduces residuals that are a function of the velocity, e.g. More...

void	initialSetup () override

void	computeResidual (const FaceInfo &fi) override final

void	computeJacobian (const FaceInfo &fi) override final

void	computeResidual () override

void	computeJacobian () override

void	computeResidualAndJacobian () override

void	computeResidualAndJacobian (const FaceInfo &fi) override

const MooseVariableFV< Real > &	variable () const override

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

virtual void	computeOffDiagJacobian (unsigned int)

virtual void	computeOffDiagJacobianScalar (unsigned int)

virtual void	computeNonlocalJacobian ()

virtual void	computeNonlocalOffDiagJacobian (unsigned int)

const SubProblem &	subProblem () const

virtual void	prepareShapes (unsigned int var_num)

virtual std::set< std::string >	additionalROVariables ()

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

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

MooseApp &	getMooseApp () const

const std::string &	type () const

virtual const std::string &	name () const

std::string	typeAndName () const

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

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

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

const InputParameters &	parameters () const

MooseObjectName	uniqueName () const

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

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

const T *	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 &nm) const

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

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

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

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

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

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

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

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

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

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

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

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

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	subdomainSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

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

const Function &	getFunctionByName (const FunctionName &name) const

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

bool	hasFunctionByName (const FunctionName &name) const

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

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

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

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

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

bool	isImplicit ()

Moose::StateArg	determineState () const

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

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

bool	hasPostprocessorByName (const PostprocessorName &name) const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name) const

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

void	setRandomResetFrequency (ExecFlagType exec_flag)

unsigned long	getRandomLong () const

Real	getRandomReal () const

unsigned int	getSeed (std::size_t id)

unsigned int	getMasterSeed () const

bool	isNodal () const

ExecFlagType	getResetOnTime () const

void	setRandomDataPointer (RandomData *random_data)

virtual void	meshChanged ()

void	useVectorTag (const TagName &tag_name, VectorTagsKey)

void	useVectorTag (TagID tag_id, VectorTagsKey)

void	useMatrixTag (const TagName &tag_name, MatrixTagsKey)

void	useMatrixTag (TagID tag_id, MatrixTagsKey)

bool	isVectorTagged ()

bool	isMatrixTagged ()

bool	hasVectorTags () const

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

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

const std::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

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)

MooseVariableBase *	mooseVariableBase () const

MooseVariableField< Real > &	mooseVariableField ()

MooseVariableFE< Real > *	mooseVariable () const

MooseVariableFV< Real > *	mooseVariableFV () const

MooseLinearVariableFV< Real > *	mooseLinearVariableFV () const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual const VariableSecond &	coupledNeighborSecond (const std::string &var_name, unsigned int i=0) const

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

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

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

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

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

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

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

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

void	addFEVariableCoupleableVectorTag (TagID tag)

void	addFEVariableCoupleableMatrixTag (TagID tag)

std::set< TagID > &	getFEVariableCoupleableVectorTags ()

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

std::set< TagID > &	getFEVariableCoupleableMatrixTags ()

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

auto &	getWritableCoupledVariables () const

bool	hasWritableCoupledVariables () const

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

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

const ADVariableGradient &	getADDefaultGradient () const

const ADVectorVariableGradient &	getADDefaultVectorGradient () const

const ADVariableSecond &	getADDefaultSecond () const

const ADVectorVariableCurl &	getADDefaultCurl () const

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

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

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

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

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

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

void	addMooseVariableDependency (MooseVariableFieldBase *var)

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

Moose::FaceArg	makeFace (const FaceInfo &fi, const Moose::FV::LimiterType limiter_type, const bool elem_is_upwind, const bool correct_skewness=false, const Moose::StateArg *state_limiter=nullptr) const

Moose::FaceArg	makeCDFace (const FaceInfo &fi, const bool correct_skewness=false) const

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

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

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

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

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

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

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

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

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

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

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

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

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

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

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

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

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () 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 std::string	deduceFunctorName (const std::string &name, const InputParameters &params)

static void	setRMParamsAdvection (const InputParameters &obj_params, InputParameters &rm_params, const unsigned short conditional_extended_layers)

static void	setRMParamsDiffusion (const InputParameters &obj_params, InputParameters &rm_params, const unsigned short conditional_extended_layers)

Public Attributes
const ConsoleStream	_console

Static Public Attributes
static constexpr PropertyValue::id_type	default_property_id

static constexpr PropertyValue::id_type	zero_property_id

Protected Member Functions
virtual ADReal	computeQpResidual () override final

virtual bool	hasMaterialTimeDerivative () const override

virtual const Moose::FunctorBase< ADReal > &	epsilon () const
	A virtual method that allows us to reuse all the code from free-flow for porous. More...

virtual void	computeResidualsAndAData (const FaceInfo &fi)
	Helper method that computes the 'a' coefficients and AD residuals. More...

template<typename T >
void	initialSetup (T &insfv_fk)
	setup all the boundary condition member information More...

bool	skipForBoundary (const FaceInfo &fi) const override

ADRealVectorValue	velocity () const

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

virtual ADReal	gradUDotNormal (const Moose::StateArg &time, const bool correct_skewness) const

const RealVectorValue &	normal () const

bool	onBoundary (const FaceInfo &fi) const

Moose::ElemArg	elemArg (bool correct_skewness=false) const

Moose::ElemArg	neighborArg (bool correct_skewness=false) const

Moose::FaceArg	singleSidedFaceArg (const FaceInfo fi=nullptr, Moose::FV::LimiterType limiter_type=Moose::FV::LimiterType::CentralDifference, bool correct_skewness=false, const Moose::StateArg state_limiter=nullptr) const

bool	avoidBoundary (const FaceInfo &fi) const

virtual void	precalculateResidual ()

virtual void	precalculateJacobian ()

virtual void	precalculateOffDiagJacobian (unsigned int)

const MooseVariableFieldBase &	getVariable (unsigned int jvar_num) const

virtual void	addUserObjectDependencyHelper (const UserObject &) const

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &) const

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) const

T &	declareRestartableData (const std::string &data_name, Args &&... args)

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

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

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

T &	declareRecoverableData (const std::string &data_name, Args &&... args)

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

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

void	prepareVectorTag (Assembly &assembly, unsigned int ivar)

void	prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)

void	prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)

void	prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)

void	prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)

void	prepareVectorTagNeighbor (Assembly &assembly, unsigned int ivar)

void	prepareVectorTagLower (Assembly &assembly, unsigned int ivar)

void	prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar)

void	prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar, DenseMatrix< Number > &k) const

void	prepareMatrixTagNonlocal (Assembly &assembly, unsigned int ivar, unsigned int jvar)

void	prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type)

void	prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, DenseMatrix< Number > &k) const

void	prepareMatrixTagLower (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::ConstraintJacobianType type)

void	accumulateTaggedLocalResidual ()

void	assignTaggedLocalResidual ()

void	accumulateTaggedLocalMatrix ()

void	accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, const DenseMatrix< Number > &k)

void	accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, const DenseMatrix< Number > &k)

void	accumulateTaggedNonlocalMatrix ()

void	assignTaggedLocalMatrix ()

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

void	addResiduals (Assembly &assembly, const DenseVector< T > &residuals, const Indices &dof_indices, Real scaling_factor)

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

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

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

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

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

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

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

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

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

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

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

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

void	setResidual (SystemBase &sys, SetResidualFunctor set_residual_functor)

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

void	initializeBlockRestrictable (const MooseObject *moose_object)

Moose::CoordinateSystemType	getBlockCoordSystem ()

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)

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

void	markMatPropRequested (const std::string &)

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

void	checkExecutionStage ()

virtual const OutputTools< Real >::VariableValue &	neighborValue ()

const VectorVariableValue &	neighborValue ()

virtual const OutputTools< Real >::VariableValue &	neighborValueOld ()

const VectorVariableValue &	neighborValueOld ()

virtual const OutputTools< Real >::VariableValue &	neighborValueOlder ()

const VectorVariableValue &	neighborValueOlder ()

virtual const OutputTools< Real >::VariableGradient &	neighborGradient ()

virtual const OutputTools< Real >::VariableGradient &	neighborGradientOld ()

virtual const OutputTools< Real >::VariableGradient &	neighborGradientOlder ()

virtual const OutputTools< Real >::VariableSecond &	neighborSecond ()

virtual const OutputTools< Real >::VariableSecond &	neighborSecondOld ()

virtual const OutputTools< Real >::VariableSecond &	neighborSecondOlder ()

virtual const OutputTools< Real >::VariableTestSecond &	neighborSecondTest ()

virtual const OutputTools< Real >::VariablePhiSecond &	neighborSecondPhi ()

virtual const OutputTools< Real >::VariableValue &	value ()

virtual const OutputTools< Real >::VariableValue &	valueOld ()

virtual const OutputTools< Real >::VariableValue &	valueOlder ()

virtual const OutputTools< Real >::VariableValue &	dot ()

virtual const OutputTools< Real >::VariableValue &	dotDot ()

virtual const OutputTools< Real >::VariableValue &	dotOld ()

virtual const OutputTools< Real >::VariableValue &	dotDotOld ()

virtual const VariableValue &	dotDu ()

virtual const VariableValue &	dotDotDu ()

virtual const OutputTools< Real >::VariableGradient &	gradient ()

virtual const OutputTools< Real >::VariableGradient &	gradientOld ()

virtual const OutputTools< Real >::VariableGradient &	gradientOlder ()

virtual const OutputTools< Real >::VariableSecond &	second ()

virtual const OutputTools< Real >::VariableSecond &	secondOld ()

virtual const OutputTools< Real >::VariableSecond &	secondOlder ()

virtual const OutputTools< Real >::VariableTestSecond &	secondTest ()

virtual const OutputTools< Real >::VariableTestSecond &	secondTestFace ()

virtual const OutputTools< Real >::VariablePhiSecond &	secondPhi ()

virtual const OutputTools< Real >::VariablePhiSecond &	secondPhiFace ()

virtual void	coupledCallback (const std::string &, bool) const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

const GenericVectorVariableValue< false > &	coupledGenericVectorValue (const std::string &var_name, unsigned int comp) const

const GenericVectorVariableValue< true > &	coupledGenericVectorValue (const std::string &var_name, unsigned int comp) const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	checkWritableVar (MooseWritableVariable *var)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

const ADVariableValue &	adZeroValue () const

const ADVariableGradient &	adZeroGradient () const

const ADVariableSecond &	adZeroSecond () const

const GenericVariableValue< is_ad > &	genericZeroValue ()

const GenericVariableValue< false > &	genericZeroValue ()

const GenericVariableValue< true > &	genericZeroValue ()

const GenericVariableGradient< is_ad > &	genericZeroGradient ()

const GenericVariableGradient< false > &	genericZeroGradient ()

const GenericVariableGradient< true > &	genericZeroGradient ()

const GenericVariableSecond< is_ad > &	genericZeroSecond ()

const GenericVariableSecond< false > &	genericZeroSecond ()

const GenericVariableSecond< true > &	genericZeroSecond ()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Attributes
const Moose::Functor< ADReal > &	_rho
	Density. More...

const bool	_approximate_as
	Whether to approximately calculate the 'a' coefficients. More...

const Real	_cs
	Characteristic speed. More...

std::unique_ptr< PiecewiseByBlockLambdaFunctor< ADReal > >	_rho_u
	Our local momentum functor. More...

ADReal	_ae = 0
	The a coefficient for the element. More...

ADReal	_an = 0
	The a coefficient for the neighbor. More...

ADReal	_elem_residual = 0
	The element residual. More...

ADReal	_neighbor_residual = 0
	The neighbor residual. More...

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

Moose::FV::InterpMethod	_advected_interp_method
	The interpolation method to use for the advected quantity. More...

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

const RhieChowInterpolatorBase &	_rc_vel_provider
	The Rhie-Chow user object that provides us with the velocity. More...

MooseVariableFV< Real > &	_var

const unsigned int	_qp

const ADVariableValue &	_u_elem

const ADVariableValue &	_u_neighbor

RealVectorValue	_normal

const FaceInfo *	_face_info

FaceInfo::VarFaceNeighbors	_face_type

std::unordered_set< BoundaryID >	_boundaries_to_force

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

THREAD_ID	_tid

Assembly &	_assembly

MooseMesh &	_mesh

const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

const InputParameters &	_ti_params

FEProblemBase &	_ti_feproblem

bool	_is_implicit

Real &	_t

const Real &	_t_old

int &	_t_step

Real &	_dt

Real &	_dt_old

bool	_is_transient

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

FEProblemBase &	_mci_feproblem

DenseVector< Number >	_local_re

DenseMatrix< Number >	_local_ke

DenseMatrix< Number >	_nonlocal_ke

const MaterialData *	_blk_material_data

MaterialData &	_neighbor_material_data

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

bool	_nodal

MooseVariableFE< Real > *	_variable

MooseVariableFV< Real > *	_fv_variable

MooseLinearVariableFV< Real > *	_linear_fv_variable

MooseVariableField< Real > *	_field_variable

Assembly *	_mvi_assembly

bool	_neighbor_nodal

const InputParameters &	_c_parameters

const std::string &	_c_name

const std::string &	_c_type

FEProblemBase &	_c_fe_problem

const SystemBase *const	_c_sys

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

std::vector< MooseVariableFieldBase *>	_coupled_moose_vars

std::vector< MooseVariable *>	_coupled_standard_moose_vars

std::vector< VectorMooseVariable *>	_coupled_vector_moose_vars

std::vector< ArrayMooseVariable *>	_coupled_array_moose_vars

std::vector< MooseVariableFV< Real > *>	_coupled_standard_fv_moose_vars

std::vector< MooseLinearVariableFV< Real > *>	_coupled_standard_linear_fv_moose_vars

const std::unordered_map< std::string, std::string > &	_new_to_deprecated_coupled_vars

bool	_c_nodal

bool	_c_is_implicit

const bool	_c_allow_element_to_nodal_coupling

THREAD_ID	_c_tid

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

std::unordered_map< std::string, std::unique_ptr< MooseArray< ADReal > > >	_ad_default_value

std::unordered_map< std::string, std::unique_ptr< VectorVariableValue > >	_default_vector_value

std::unordered_map< std::string, std::unique_ptr< ArrayVariableValue > >	_default_array_value

std::unordered_map< std::string, std::unique_ptr< MooseArray< ADRealVectorValue > > >	_ad_default_vector_value

VariableValue	_default_value_zero

VariableGradient	_default_gradient

MooseArray< ADRealVectorValue >	_ad_default_gradient

MooseArray< ADRealTensorValue >	_ad_default_vector_gradient

VariableSecond	_default_second

MooseArray< ADRealTensorValue >	_ad_default_second

MooseArray< ADRealVectorValue >	_ad_default_curl

const VariableValue &	_zero

const VariablePhiValue &	_phi_zero

const MooseArray< ADReal > &	_ad_zero

const VariableGradient &	_grad_zero

const MooseArray< ADRealVectorValue > &	_ad_grad_zero

const VariablePhiGradient &	_grad_phi_zero

const VariableSecond &	_second_zero

const MooseArray< ADRealTensorValue > &	_ad_second_zero

const VariablePhiSecond &	_second_phi_zero

const VectorVariableValue &	_vector_zero

const VectorVariableCurl &	_vector_curl_zero

VectorVariableValue	_default_vector_value_zero

VectorVariableGradient	_default_vector_gradient

VectorVariableCurl	_default_vector_curl

VectorVariableDivergence	_default_div

ArrayVariableValue	_default_array_value_zero

ArrayVariableGradient	_default_array_gradient

bool	_coupleable_neighbor

FEProblemBase &	_sc_fe_problem

const THREAD_ID	_sc_tid

const Real &	_real_zero

const VariableValue &	_scalar_zero

const Point &	_point_zero

const Parallel::Communicator &	_communicator

std::set< BoundaryID >	_no_slip_wall_boundaries
	Boundary IDs with no slip walls. More...

std::set< BoundaryID >	_slip_wall_boundaries
	Boundary IDs with slip walls. More...

std::set< BoundaryID >	_free_surface_boundaries
	Boundary IDs for free surfaces. More...

std::set< BoundaryID >	_flow_boundaries
	Flow Boundary IDs. More...

std::set< BoundaryID >	_fully_developed_flow_boundaries
	Fully Developed Flow Boundary IDs. This is a subset of `_flow_boundaries`. More...

std::set< BoundaryID >	_symmetry_boundaries
	Symmetry Boundary IDs. More...

std::set< BoundaryID >	_all_boundaries
	All the BoundaryIDs covered by our different types of INSFVBCs. More...

RhieChowInterpolatorBase &	_rc_uo
	The Rhie Chow user object that is responsible for generating face velocities for advection terms. More...

const unsigned int	_index
	index x\|y\|z More...

Static Protected Attributes
static const std::string	_interpolated_old

static const std::string	_interpolated_older

Detailed Description

An advection kernel that implements interpolation schemes specific to Navier-Stokes flow physics.

Definition at line 20 of file INSFVMomentumAdvection.h.

Constructor & Destructor Documentation

◆ INSFVMomentumAdvection()

INSFVMomentumAdvection::INSFVMomentumAdvection ( const InputParameters & params )

Definition at line 47 of file INSFVMomentumAdvection.C.

   : INSFVAdvectionKernel(params),
     INSFVMomentumResidualObject(*this),
     _rho(getFunctor<ADReal>(NS::density)),
     _approximate_as(isParamValid("characteristic_speed")),
     _cs(_approximate_as ? getParam<Real>("characteristic_speed") : 0)
 {
 }

Member Function Documentation

◆ computeJacobian()

void INSFVMomentumAdvection::computeJacobian ( const FaceInfo & fi )

finaloverridevirtual

Reimplemented from FVFluxKernel.

Definition at line 238 of file INSFVMomentumAdvection.C.

 {
   if (skipForBoundary(fi))
     return;
 
   computeResidualsAndAData(fi);
 
   if (_face_type == FaceInfo::VarFaceNeighbors::ELEM ||
       _face_type == FaceInfo::VarFaceNeighbors::BOTH)
   {
     mooseAssert(_var.dofIndices().size() == 1, "We're currently built to use CONSTANT MONOMIALS");
 
     addResidualsAndJacobian(_assembly,
                             std::array<ADReal, 1>{{_elem_residual}},
                             _var.dofIndices(),
                             _var.scalingFactor());
   }
 
   if (_face_type == FaceInfo::VarFaceNeighbors::NEIGHBOR ||
       _face_type == FaceInfo::VarFaceNeighbors::BOTH)
   {
     mooseAssert((_face_type == FaceInfo::VarFaceNeighbors::NEIGHBOR) ==
                     (_var.dofIndices().size() == 0),
                 "If the variable is only defined on the neighbor hand side of the face, then that "
                 "means it should have no dof indices on the elem element. Conversely if "
                 "the variable is defined on both sides of the face, then it should have a non-zero "
                 "number of degrees of freedom on the elem element");
 
     mooseAssert(_var.dofIndicesNeighbor().size() == 1,
                 "We're currently built to use CONSTANT MONOMIALS");
 
     addResidualsAndJacobian(_assembly,
                             std::array<ADReal, 1>{{_neighbor_residual}},
                             _var.dofIndicesNeighbor(),
                             _var.scalingFactor());
   }
 }

◆ computeQpResidual()

ADReal INSFVMomentumAdvection::computeQpResidual ( )

finaloverrideprotectedvirtual

Implements FVFluxKernel.

Definition at line 71 of file INSFVMomentumAdvection.C.

 {
   mooseError("Should never be called");
 }

◆ computeResidual()

void INSFVMomentumAdvection::computeResidual ( const FaceInfo & fi )

finaloverridevirtual

Reimplemented from FVFluxKernel.

Definition at line 211 of file INSFVMomentumAdvection.C.

 {
   if (skipForBoundary(fi))
     return;
 
   computeResidualsAndAData(fi);
 
   if (_face_type == FaceInfo::VarFaceNeighbors::ELEM ||
       _face_type == FaceInfo::VarFaceNeighbors::BOTH)
   {
     // residual contribution of this kernel to the elem element
     prepareVectorTag(_assembly, _var.number());
     _local_re(0) = MetaPhysicL::raw_value(_elem_residual);
     accumulateTaggedLocalResidual();
   }
 
   if (_face_type == FaceInfo::VarFaceNeighbors::NEIGHBOR ||
       _face_type == FaceInfo::VarFaceNeighbors::BOTH)
   {
     // residual contribution of this kernel to the neighbor element
     prepareVectorTagNeighbor(_assembly, _var.number());
     _local_re(0) = MetaPhysicL::raw_value(_neighbor_residual);
     accumulateTaggedLocalResidual();
   }
 }

◆ computeResidualsAndAData()

void INSFVMomentumAdvection::computeResidualsAndAData ( const FaceInfo & fi )

protectedvirtual

Helper method that computes the 'a' coefficients and AD residuals.

Reimplemented in WCNSFV2PMomentumAdvectionSlip.

Definition at line 77 of file INSFVMomentumAdvection.C.

Referenced by computeJacobian(), computeResidual(), and gatherRCData().

 {
   mooseAssert(!skipForBoundary(fi),
               "We shouldn't get in here if we're supposed to skip for a boundary");
 
   _face_info = &fi;
   _normal = fi.normal();
   _face_type = fi.faceType(std::make_pair(_var.number(), _var.sys().number()));
   const auto state = determineState();
 
   using namespace Moose::FV;
 
   const bool correct_skewness = _advected_interp_method == InterpMethod::SkewCorrectedAverage;
   const bool on_boundary = onBoundary(fi);
 
   _elem_residual = 0, _neighbor_residual = 0, _ae = 0, _an = 0;
 
   const auto v_face = velocity();
   const auto vdotn = _normal * v_face;
 
   if (on_boundary)
   {
     const auto ssf = singleSidedFaceArg();
     const Elem * const sided_elem = ssf.face_side;
     const auto dof_number = sided_elem->dof_number(_sys.number(), _var.number(), 0);
     const auto rho_face = _rho(ssf, state);
     const auto eps_face = epsilon()(ssf, state);
     const auto u_face = _var(ssf, state);
     const Real d_u_face_d_dof = u_face.derivatives()[dof_number];
     const auto coeff = vdotn * rho_face / eps_face;
 
     if (sided_elem == fi.elemPtr())
     {
       _ae = coeff * d_u_face_d_dof;
       _elem_residual = coeff * u_face;
       if (_approximate_as)
         _ae = _cs / fi.elem().n_sides() * rho_face / eps_face;
     }
     else
     {
       _an = -coeff * d_u_face_d_dof;
       _neighbor_residual = -coeff * u_face;
       if (_approximate_as)
         _an = _cs / fi.neighborPtr()->n_sides() * rho_face / eps_face;
     }
   }
   else // we are an internal fluid flow face
   {
     const bool elem_is_upwind = MetaPhysicL::raw_value(v_face) * _normal > 0;
     const auto & limiter_time = _subproblem.isTransient()
                                     ? Moose::StateArg(1, Moose::SolutionIterationType::Time)
                                     : Moose::StateArg(1, Moose::SolutionIterationType::Nonlinear);
     const Moose::FaceArg advected_face_arg{&fi,
                                            limiterType(_advected_interp_method),
                                            elem_is_upwind,
                                            correct_skewness,
                                            nullptr,
                                            &limiter_time};
     if (const auto [is_jump, eps_elem_face, eps_neighbor_face] =
             NS::isPorosityJumpFace(epsilon(), fi, state);
         is_jump)
     {
       // For a weakly compressible formulation, the density should not depend on pressure and
       // consequently the density should not be impacted by the pressure jump that occurs at a
       // porosity jump. Consequently we will allow evaluation of the density using both upstream and
       // downstream information
       const auto rho_face = _rho(advected_face_arg, state);
 
       // We set the + and - sides of the superficial velocity equal to the interpolated value
       const auto & var_elem_face = v_face(_index);
       const auto & var_neighbor_face = v_face(_index);
 
       const auto elem_dof_number = fi.elem().dof_number(_sys.number(), _var.number(), 0);
       const auto neighbor_dof_number = fi.neighbor().dof_number(_sys.number(), _var.number(), 0);
 
       const auto d_var_elem_face_d_elem_dof = var_elem_face.derivatives()[elem_dof_number];
       const auto d_var_neighbor_face_d_neighbor_dof =
           var_neighbor_face.derivatives()[neighbor_dof_number];
 
       // We allow a discontintuity in the advective momentum flux at the jump face. Mainly the
       // advective flux is:
       // elem side:
       // rho * v_superficial / eps_elem * v_superficial = rho * v_interstitial_elem * v_superficial
       // neighbor side:
       // rho * v_superficial / eps_neigh * v_superficial = rho * v_interstitial_neigh *
       // v_superficial
       const auto elem_coeff = vdotn * rho_face / eps_elem_face;
       const auto neighbor_coeff = vdotn * rho_face / eps_neighbor_face;
       _ae = elem_coeff * d_var_elem_face_d_elem_dof;
       _elem_residual = elem_coeff * var_elem_face;
       _an = -neighbor_coeff * d_var_neighbor_face_d_neighbor_dof;
       _neighbor_residual = -neighbor_coeff * var_neighbor_face;
       if (_approximate_as)
       {
         _ae = _cs / fi.elem().n_sides() * rho_face / eps_elem_face;
         _an = _cs / fi.neighborPtr()->n_sides() * rho_face / eps_elem_face;
       }
     }
     else
     {
       const auto [interp_coeffs, advected] =
           interpCoeffsAndAdvected(*_rho_u, advected_face_arg, state);
 
       const auto elem_arg = elemArg();
       const auto neighbor_arg = neighborArg();
 
       const auto rho_elem = _rho(elem_arg, state), rho_neighbor = _rho(neighbor_arg, state);
       const auto eps_elem = epsilon()(elem_arg, state),
                  eps_neighbor = epsilon()(neighbor_arg, state);
       const auto var_elem = advected.first / rho_elem * eps_elem,
                  var_neighbor = advected.second / rho_neighbor * eps_neighbor;
 
       _ae = vdotn * rho_elem / eps_elem * interp_coeffs.first;
       // Minus sign because we apply a minus sign to the residual in computeResidual
       _an = -vdotn * rho_neighbor / eps_neighbor * interp_coeffs.second;
 
       _elem_residual = _ae * var_elem - _an * var_neighbor;
       _neighbor_residual = -_elem_residual;
 
       if (_approximate_as)
       {
         _ae = _cs / fi.elem().n_sides() * rho_elem / eps_elem;
         _an = _cs / fi.neighborPtr()->n_sides() * rho_neighbor / eps_neighbor;
       }
     }
   }
 
   _ae *= fi.faceArea() * fi.faceCoord();
   _an *= fi.faceArea() * fi.faceCoord();
   _elem_residual *= fi.faceArea() * fi.faceCoord();
   _neighbor_residual *= fi.faceArea() * fi.faceCoord();
 }

◆ epsilon()

virtual const Moose::FunctorBase<ADReal>& INSFVMomentumAdvection::epsilon ( ) const

inlineprotectedvirtual

A virtual method that allows us to reuse all the code from free-flow for porous.

Reimplemented in PINSFVMomentumAdvection.

Definition at line 52 of file INSFVMomentumAdvection.h.

Referenced by WCNSFV2PMomentumAdvectionSlip::computeResidualsAndAData(), computeResidualsAndAData(), and initialSetup().

52 { return _unity_functor; }

INSFVMomentumAdvection::_unity_functor

const Moose::ConstantFunctor< ADReal > _unity_functor

A unity functor used in the epsilon virtual method.

Definition: INSFVMomentumAdvection.h:84

◆ gatherRCData() [1/2]

void INSFVMomentumAdvection::gatherRCData ( const Elem & elem )

inlinefinaloverridevirtual

Should be a non-empty implementation if the residual object is a FVElementalKernel and introduces residuals that are a function of the velocity, e.g.

friction and time-derivative terms.

Implements INSFVMomentumResidualObject.

Definition at line 37 of file INSFVMomentumAdvection.h.

37 {}

◆ gatherRCData() [2/2]

void INSFVMomentumAdvection::gatherRCData ( const FaceInfo & fi )

finaloverridevirtual

Should be a non-empty implementation if the residual object is a FVFluxKernel and introduces residuals that are a function of the velocity, e.g.

advection, viscosity/diffusion, symmetry boundary conditions, etc.

Implements INSFVMomentumResidualObject.

Definition at line 277 of file INSFVMomentumAdvection.C.

 {
   if (skipForBoundary(fi))
     return;
 
   const auto saved_velocity_interp_method = _velocity_interp_method;
   _velocity_interp_method = Moose::FV::InterpMethod::Average;
   // Fill-in the coefficients _ae and _an
   computeResidualsAndAData(fi);
   _velocity_interp_method = saved_velocity_interp_method;
 
   if (_face_type == FaceInfo::VarFaceNeighbors::ELEM ||
       _face_type == FaceInfo::VarFaceNeighbors::BOTH)
     _rc_uo.addToA(&fi.elem(), _index, _ae);
   if (_face_type == FaceInfo::VarFaceNeighbors::NEIGHBOR ||
       _face_type == FaceInfo::VarFaceNeighbors::BOTH)
     _rc_uo.addToA(fi.neighborPtr(), _index, _an);
 }

◆ hasMaterialTimeDerivative()

virtual bool INSFVMomentumAdvection::hasMaterialTimeDerivative ( ) const

inlineoverrideprotectedvirtual

Returns: whether the equation this object adds to has a material time derivative. An instance when this will be false is the mass equation for incompressible flows

Implements INSFVAdvectionKernel.

Definition at line 47 of file INSFVMomentumAdvection.h.

47 { return true; }

◆ initialSetup() [1/2]

template<typename T >

void INSFVBCInterface::initialSetup ( T & insfv_fk )

protectedinherited

setup all the boundary condition member information

Definition at line 79 of file INSFVBCInterface.h.

Referenced by INSFVAdvectionKernel::initialSetup().

 {
   const auto & mesh = insfv_fk.subProblem().mesh();
 
   std::set<BoundaryID> all_connected_boundaries;
   const auto & blk_ids = insfv_fk.blockRestricted() ? insfv_fk.blockIDs() : mesh.meshSubdomains();
   for (const auto blk_id : blk_ids)
   {
     const auto & connected_boundaries = mesh.getSubdomainInterfaceBoundaryIds(blk_id);
     for (const auto bnd_id : connected_boundaries)
       all_connected_boundaries.insert(bnd_id);
   }
 
   for (const auto bnd_id : all_connected_boundaries)
   {
     setupFlowBoundaries(insfv_fk, bnd_id);
     setupBoundaries<INSFVNoSlipWallBC>(
         insfv_fk, bnd_id, INSFVBCs::INSFVNoSlipWallBC, _no_slip_wall_boundaries);
     setupBoundaries<INSFVSlipWallBC>(
         insfv_fk, bnd_id, INSFVBCs::INSFVSlipWallBC, _slip_wall_boundaries);
     setupBoundaries<INSFVFreeSurfaceBC>(
         insfv_fk, bnd_id, INSFVBCs::INSFVFreeSurfaceBC, _free_surface_boundaries);
     setupBoundaries<INSFVSymmetryBC>(
         insfv_fk, bnd_id, INSFVBCs::INSFVSymmetryBC, _symmetry_boundaries);
   }
 }

◆ initialSetup() [2/2]

void INSFVMomentumAdvection::initialSetup ( )

overridevirtual

Reimplemented from INSFVAdvectionKernel.

Definition at line 57 of file INSFVMomentumAdvection.C.

 {
   INSFVAdvectionKernel::initialSetup();
 
   _rho_u = std::make_unique<PiecewiseByBlockLambdaFunctor<ADReal>>(
       "rho_u",
       [this](const auto & r, const auto & t) -> ADReal
       { return _rho(r, t) * _var(r, t) / epsilon()(r, t); },
       std::set<ExecFlagType>({EXEC_ALWAYS}),
       _mesh,
       this->blockIDs());
 }

◆ listOfCommonParams()

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

static

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

Definition at line 31 of file INSFVMomentumAdvection.C.

Referenced by WCNSFVFlowPhysics::addMomentumAdvectionKernels().

 {
   return {"characteristic_speed"};
 }

◆ skipForBoundary()

bool INSFVAdvectionKernel::skipForBoundary ( const FaceInfo & fi ) const

overrideprotectedvirtualinherited

Reimplemented from FVFluxKernel.

Definition at line 98 of file INSFVAdvectionKernel.C.

Referenced by INSFVTurbulentAdvection::computeJacobian(), computeJacobian(), INSFVTurbulentAdvection::computeResidual(), computeResidual(), WCNSFV2PMomentumAdvectionSlip::computeResidualsAndAData(), computeResidualsAndAData(), and gatherRCData().

 {
   // Boundaries to avoid come first, since they are always obeyed
   if (avoidBoundary(fi))
     return true;
 
   // We get this to check if we are on a kernel boundary or not
   const bool on_boundary = onBoundary(fi);
 
   // We are either on a kernel boundary or on an internal sideset
   // which is handled as a boundary
   if (on_boundary || !fi.boundaryIDs().empty())
   {
     // Selected boundaries to force
     for (const auto bnd_to_force : _boundaries_to_force)
       if (fi.boundaryIDs().count(bnd_to_force))
         return false;
 
     // If we have flux bcs then we do skip
     const auto & [have_flux_bcs, flux_bcs] = _var.getFluxBCs(fi);
     libmesh_ignore(have_flux_bcs);
     for (const auto * const flux_bc : flux_bcs)
       // If we have something like an average-value pressure constraint on a flow boundary, then we
       // still want to execute this advection kernel on the boundary to ensure we're enforcing local
       // conservation (mass in this example)
       if (!dynamic_cast<const FVBoundaryScalarLagrangeMultiplierConstraint *>(flux_bc))
         return true;
 
     // If we have a flow boundary without a replacement flux BC, then we must not skip. Mass and
     // momentum are transported via advection across boundaries
     for (const auto bc_id : fi.boundaryIDs())
       if (_flow_boundaries.find(bc_id) != _flow_boundaries.end())
         return false;
   }
 
   // If not a flow boundary, then there should be no advection/flow in the normal direction, e.g. we
   // should not contribute any advective flux. If we are on an internal face though, we still
   // execute.
   return on_boundary;
 }

◆ uniqueParams()

InputParameters INSFVMomentumAdvection::uniqueParams ( )

static

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

Definition at line 20 of file INSFVMomentumAdvection.C.

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

 {
   auto params = emptyInputParameters();
   params.addParam<Real>(
       "characteristic_speed",
       "The characteristic speed. For porous medium simulations, this characteristic speed should "
       "correspond to the superficial velocity, not the interstitial.");
   return params;
 }

◆ validParams()

InputParameters INSFVMomentumAdvection::validParams ( )

static

Definition at line 37 of file INSFVMomentumAdvection.C.

Referenced by PINSFVMomentumAdvection::validParams(), WCNSFVFlowPhysics::validParams(), and WCNSFV2PMomentumAdvectionSlip::validParams().

 {
   InputParameters params = INSFVAdvectionKernel::validParams();
   params += INSFVMomentumResidualObject::validParams();
   params += INSFVMomentumAdvection::uniqueParams();
   params.addRequiredParam<MooseFunctorName>(NS::density, "Density functor");
   params.addClassDescription("Object for advecting momentum, e.g. rho*u");
   return params;
 }

◆ velocity()

ADRealVectorValue INSFVAdvectionKernel::velocity ( ) const

inlineprotectedinherited

Returns: the advecting velocity

Definition at line 51 of file INSFVAdvectionKernel.h.

Referenced by INSFVMassAdvection::computeQpResidual(), INSFVScalarFieldAdvection::computeQpResidual(), INSFVEnergyAdvection::computeQpResidual(), and computeResidualsAndAData().

 {
   return _rc_vel_provider.getVelocity(
       _velocity_interp_method, *_face_info, determineState(), _tid, hasMaterialTimeDerivative());
 }

Member Data Documentation

◆ _advected_interp_method

Moose::FV::InterpMethod INSFVAdvectionKernel::_advected_interp_method

protectedinherited

The interpolation method to use for the advected quantity.

Definition at line 41 of file INSFVAdvectionKernel.h.

Referenced by INSFVMassAdvection::computeQpResidual(), INSFVScalarFieldAdvection::computeQpResidual(), INSFVEnergyAdvection::computeQpResidual(), INSFVTurbulentAdvection::computeQpResidual(), WCNSFV2PMomentumAdvectionSlip::computeResidualsAndAData(), computeResidualsAndAData(), and INSFVAdvectionKernel::INSFVAdvectionKernel().

◆ _ae

ADReal INSFVMomentumAdvection::_ae = 0

protected

The a coefficient for the element.

Definition at line 72 of file INSFVMomentumAdvection.h.

Referenced by WCNSFV2PMomentumAdvectionSlip::computeResidualsAndAData(), computeResidualsAndAData(), and gatherRCData().

◆ _all_boundaries

std::set<BoundaryID> INSFVBCInterface::_all_boundaries

protectedinherited

All the BoundaryIDs covered by our different types of INSFVBCs.

Definition at line 58 of file INSFVBCInterface.h.

Referenced by INSFVBCInterface::setupBoundaries(), and INSFVBCInterface::setupFlowBoundaries().

◆ _an

ADReal INSFVMomentumAdvection::_an = 0

protected

The a coefficient for the neighbor.

Definition at line 75 of file INSFVMomentumAdvection.h.

Referenced by WCNSFV2PMomentumAdvectionSlip::computeResidualsAndAData(), computeResidualsAndAData(), and gatherRCData().

◆ _approximate_as

const bool INSFVMomentumAdvection::_approximate_as

protected

Whether to approximately calculate the 'a' coefficients.

Definition at line 63 of file INSFVMomentumAdvection.h.

Referenced by WCNSFV2PMomentumAdvectionSlip::computeResidualsAndAData(), and computeResidualsAndAData().

◆ _cs

const Real INSFVMomentumAdvection::_cs

protected

Characteristic speed.

Definition at line 66 of file INSFVMomentumAdvection.h.

Referenced by WCNSFV2PMomentumAdvectionSlip::computeResidualsAndAData(), and computeResidualsAndAData().

◆ _elem_residual

ADReal INSFVMomentumAdvection::_elem_residual = 0

protected

The element residual.

Definition at line 78 of file INSFVMomentumAdvection.h.

Referenced by computeJacobian(), computeResidual(), WCNSFV2PMomentumAdvectionSlip::computeResidualsAndAData(), and computeResidualsAndAData().

◆ _flow_boundaries

std::set<BoundaryID> INSFVBCInterface::_flow_boundaries

protectedinherited

Flow Boundary IDs.

Definition at line 49 of file INSFVBCInterface.h.

Referenced by INSFVBCInterface::setupFlowBoundaries(), and INSFVAdvectionKernel::skipForBoundary().

◆ _free_surface_boundaries

std::set<BoundaryID> INSFVBCInterface::_free_surface_boundaries

protectedinherited

Boundary IDs for free surfaces.

Definition at line 46 of file INSFVBCInterface.h.

Referenced by INSFVBCInterface::initialSetup().

◆ _fully_developed_flow_boundaries

std::set<BoundaryID> INSFVBCInterface::_fully_developed_flow_boundaries

protectedinherited

Fully Developed Flow Boundary IDs. This is a subset of _flow_boundaries.

Definition at line 52 of file INSFVBCInterface.h.

Referenced by INSFVBCInterface::setupFlowBoundaries().

◆ _index

const unsigned int INSFVMomentumResidualObject::_index

protectedinherited

index x|y|z

Definition at line 58 of file INSFVMomentumResidualObject.h.

Referenced by PINSFVMomentumFriction::computeFrictionWCoefficient(), INSFVMomentumGravity::computeQpResidual(), INSFVMomentumBoussinesq::computeQpResidual(), INSFVMomentumPressureFlux::computeQpResidual(), WCNSFVMomentumFluxBC::computeQpResidual(), WCNSFV2PMomentumAdvectionSlip::computeResidualsAndAData(), computeResidualsAndAData(), INSFVSymmetryVelocityBC::computeSegregatedContribution(), INSFVWallFunctionBC::computeStrongResidual(), WCNSFV2PMomentumDriftFlux::computeStrongResidual(), INSFVMomentumDiffusion::computeStrongResidual(), INSFVMixingLengthReynoldsStress::computeStrongResidual(), PINSFVMomentumFrictionCorrection::gatherRCData(), INSFVMomentumTimeDerivative::gatherRCData(), PINSFVMomentumFriction::gatherRCData(), INSFVMomentumMeshAdvection::gatherRCData(), WCNSFVMomentumTimeDerivative::gatherRCData(), WCNSFV2PMomentumDriftFlux::gatherRCData(), INSFVVaporRecoilPressureMomentumFluxBC::gatherRCData(), INSFVWallFunctionBC::gatherRCData(), INSFVSymmetryVelocityBC::gatherRCData(), INSFVMixingLengthReynoldsStress::gatherRCData(), INSFVMomentumDiffusion::gatherRCData(), INSFVMomentumAdvectionOutflowBC::gatherRCData(), and gatherRCData().

◆ _neighbor_residual

ADReal INSFVMomentumAdvection::_neighbor_residual = 0

protected

The neighbor residual.

Definition at line 81 of file INSFVMomentumAdvection.h.

Referenced by computeJacobian(), computeResidual(), WCNSFV2PMomentumAdvectionSlip::computeResidualsAndAData(), and computeResidualsAndAData().

◆ _no_slip_wall_boundaries

std::set<BoundaryID> INSFVBCInterface::_no_slip_wall_boundaries

protectedinherited

Boundary IDs with no slip walls.

Definition at line 40 of file INSFVBCInterface.h.

Referenced by INSFVBCInterface::initialSetup().

◆ _rc_uo

RhieChowInterpolatorBase& INSFVMomentumResidualObject::_rc_uo

protectedinherited

The Rhie Chow user object that is responsible for generating face velocities for advection terms.

In monolithic solvers, it also collects data from kernels to determine suitable face velocities.

Definition at line 55 of file INSFVMomentumResidualObject.h.

Referenced by INSFVElementalKernel::computeJacobian(), INSFVFluxBC::computeJacobian(), INSFVFluxKernel::computeJacobian(), INSFVFluxKernel::computeQpResidual(), INSFVFluxBC::computeQpResidual(), INSFVElementalKernel::computeResidual(), INSFVFluxBC::computeResidual(), INSFVFluxKernel::computeResidual(), INSFVFluxBC::computeResidualAndJacobian(), INSFVElementalKernel::computeResidualAndJacobian(), INSFVFluxKernel::computeResidualAndJacobian(), INSFVSymmetryVelocityBC::computeSegregatedContribution(), INSFVMomentumAdvectionOutflowBC::computeSegregatedContribution(), PINSFVMomentumFrictionCorrection::gatherRCData(), INSFVMomentumTimeDerivative::gatherRCData(), PINSFVMomentumFriction::gatherRCData(), INSFVMomentumMeshAdvection::gatherRCData(), WCNSFV2PMomentumDriftFlux::gatherRCData(), WCNSFVMomentumTimeDerivative::gatherRCData(), INSFVMixingLengthReynoldsStress::gatherRCData(), INSFVSymmetryVelocityBC::gatherRCData(), INSFVWallFunctionBC::gatherRCData(), INSFVMomentumDiffusion::gatherRCData(), PINSFVFunctorBC::gatherRCData(), INSFVMomentumAdvectionOutflowBC::gatherRCData(), gatherRCData(), and INSFVWallFunctionBC::INSFVWallFunctionBC().

◆ _rc_vel_provider

const RhieChowInterpolatorBase& INSFVAdvectionKernel::_rc_vel_provider

protectedinherited

The Rhie-Chow user object that provides us with the velocity.

Definition at line 47 of file INSFVAdvectionKernel.h.

Referenced by INSFVTurbulentAdvection::computeQpResidual(), and INSFVAdvectionKernel::velocity().

◆ _rho

const Moose::Functor<ADReal>& INSFVMomentumAdvection::_rho

protected

Density.

Definition at line 60 of file INSFVMomentumAdvection.h.

Referenced by WCNSFV2PMomentumAdvectionSlip::computeResidualsAndAData(), computeResidualsAndAData(), and initialSetup().

◆ _rho_u

std::unique_ptr<PiecewiseByBlockLambdaFunctor<ADReal> > INSFVMomentumAdvection::_rho_u

protected

Our local momentum functor.

Definition at line 69 of file INSFVMomentumAdvection.h.

Referenced by WCNSFV2PMomentumAdvectionSlip::computeResidualsAndAData(), computeResidualsAndAData(), and initialSetup().

◆ _slip_wall_boundaries

std::set<BoundaryID> INSFVBCInterface::_slip_wall_boundaries

protectedinherited

Boundary IDs with slip walls.

Definition at line 43 of file INSFVBCInterface.h.

Referenced by INSFVBCInterface::initialSetup().

◆ _symmetry_boundaries

std::set<BoundaryID> INSFVBCInterface::_symmetry_boundaries

protectedinherited

Symmetry Boundary IDs.

Definition at line 55 of file INSFVBCInterface.h.

Referenced by INSFVBCInterface::initialSetup().

◆ _unity_functor

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

protected

A unity functor used in the epsilon virtual method.

Definition at line 84 of file INSFVMomentumAdvection.h.

Referenced by epsilon().

◆ _velocity_interp_method

Moose::FV::InterpMethod INSFVAdvectionKernel::_velocity_interp_method

protectedinherited

The interpolation method to use for the velocity.

Definition at line 44 of file INSFVAdvectionKernel.h.

Referenced by INSFVTurbulentAdvection::computeQpResidual(), gatherRCData(), INSFVAdvectionKernel::INSFVAdvectionKernel(), and INSFVAdvectionKernel::velocity().

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

navier_stokes/include/fvkernels/INSFVMomentumAdvection.h
navier_stokes/src/fvkernels/INSFVMomentumAdvection.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ INSFVMomentumAdvection()

Member Function Documentation

◆ computeJacobian()

◆ computeQpResidual()

◆ computeResidual()

◆ computeResidualsAndAData()

◆ epsilon()

◆ gatherRCData() [1/2]

◆ gatherRCData() [2/2]

◆ hasMaterialTimeDerivative()

◆ initialSetup() [1/2]

◆ initialSetup() [2/2]

◆ listOfCommonParams()

◆ skipForBoundary()

◆ uniqueParams()

◆ validParams()

◆ velocity()

Member Data Documentation

◆ _advected_interp_method

◆ _ae

◆ _all_boundaries

◆ _an

◆ _approximate_as

◆ _cs

◆ _elem_residual

◆ _flow_boundaries

◆ _free_surface_boundaries

◆ _fully_developed_flow_boundaries

◆ _index

◆ _neighbor_residual

◆ _no_slip_wall_boundaries

◆ _rc_uo

◆ _rc_vel_provider

◆ _rho

◆ _rho_u

◆ _slip_wall_boundaries

◆ _symmetry_boundaries

◆ _unity_functor

◆ _velocity_interp_method