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

#include <PINSFVMomentumFrictionCorrection.h>

Inheritance diagram for PINSFVMomentumFrictionCorrection:
[legend]

Public Types

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

Public Member Functions

 PINSFVMomentumFrictionCorrection (const InputParameters &params)
 
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 gatherRCData (const Elem &) override final
 
virtual void gatherRCData (const Elem &elem)=0
 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...
 
virtual void gatherRCData (const FaceInfo &fi)=0
 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 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 computeResidual (const FaceInfo &fi) override final
 
void computeResidual () override
 
void computeResidual (const FaceInfo &fi) override
 
void computeResidual () override
 
void computeJacobian (const FaceInfo &fi) override final
 
void computeJacobian () override
 
void computeJacobian (const FaceInfo &fi) override
 
void computeJacobian () override
 
void computeResidualAndJacobian (const FaceInfo &fi) override final
 
void computeResidualAndJacobian () override
 
void computeResidualAndJacobian (const FaceInfo &fi) override
 
void computeResidualAndJacobian () 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 initialSetup ()
 
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 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

ADReal computeQpResidual () override final
 
void addResidual (const Real residual)
 Process into the system residual. More...
 
void addResidualAndJacobian (const ADReal &residual)
 Process into either the system residual or Jacobian. More...
 
virtual ADReal computeSegregatedContribution ()
 Compute the contribution which goes into the residual of the segregated system. More...
 
std::string deduceFunctorName (const std::string &name) const
 
virtual ADReal gradUDotNormal (const Moose::StateArg &time, const bool correct_skewness) const
 
virtual bool skipForBoundary (const FaceInfo &fi) 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< ADRealVectorValue > *const _D
 Darcy coefficient. More...
 
const Moose::Functor< ADRealVectorValue > *const _F
 Forchheimer coefficient. More...
 
const bool _use_Darcy_friction_model
 Booleans to select the right models. More...
 
const bool _use_Forchheimer_friction_model
 
const Moose::Functor< ADReal > & _rho
 Density as a functor. More...
 
const Moose::Functor< ADReal > & _mu
 Dynamic viscosity as a functor. More...
 
const Moose::Functor< ADReal > *const _speed
 Speed (norm of the interstitial velocity) as a functor. More...
 
Real _consistent_scaling
 Parameter for scaling the consistent pressure interpolation. 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
 
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

Definition at line 14 of file PINSFVMomentumFrictionCorrection.h.

Constructor & Destructor Documentation

◆ PINSFVMomentumFrictionCorrection()

PINSFVMomentumFrictionCorrection::PINSFVMomentumFrictionCorrection ( const InputParameters &  params)

Definition at line 40 of file PINSFVMomentumFrictionCorrection.C.

41  : INSFVFluxKernel(params),
42  _D(isParamValid("Darcy_name") ? &getFunctor<ADRealVectorValue>("Darcy_name") : nullptr),
43  _F(isParamValid("Forchheimer_name") ? &getFunctor<ADRealVectorValue>("Forchheimer_name")
44  : nullptr),
45  _use_Darcy_friction_model(isParamValid("Darcy_name")),
46  _use_Forchheimer_friction_model(isParamValid("Forchheimer_name")),
47  _rho(getFunctor<ADReal>(NS::density)),
48  _mu(getFunctor<ADReal>(NS::mu)),
49  _speed(isParamValid(NS::speed) ? &getFunctor<ADReal>(NS::speed) : nullptr),
50  _consistent_scaling(getParam<Real>("consistent_scaling"))
51 {
52  if (!_use_Darcy_friction_model && !_use_Forchheimer_friction_model)
53  mooseError("At least one friction model needs to be specified.");
54 
55  if (_use_Forchheimer_friction_model && !_speed)
56  mooseError("If using a Forchheimer friction model, then the '",
57  NS::speed,
58  "' parameter must be provided");
59 }
PINSFVMomentumFrictionCorrection::_F
const Moose::Functor< ADRealVectorValue > *const _F
Forchheimer coefficient.
Definition: PINSFVMomentumFrictionCorrection.h:26
NS::speed
static const std::string speed
Definition: NS.h:143
PINSFVMomentumFrictionCorrection::_D
const Moose::Functor< ADRealVectorValue > *const _D
Darcy coefficient.
Definition: PINSFVMomentumFrictionCorrection.h:24
PINSFVMomentumFrictionCorrection::_mu
const Moose::Functor< ADReal > & _mu
Dynamic viscosity as a functor.
Definition: PINSFVMomentumFrictionCorrection.h:35
NS::density
static const std::string density
Definition: NS.h:33
PINSFVMomentumFrictionCorrection::_rho
const Moose::Functor< ADReal > & _rho
Density as a functor.
Definition: PINSFVMomentumFrictionCorrection.h:33
INSFVFluxKernel::INSFVFluxKernel
INSFVFluxKernel(const InputParameters &params)
Definition: INSFVFluxKernel.C:24
FVFluxKernel::isParamValid
bool isParamValid(const std::string &name) const
NS::mu
static const std::string mu
Definition: NS.h:123
FVFluxKernel::mooseError
void mooseError(Args &&... args) const
PINSFVMomentumFrictionCorrection::_use_Darcy_friction_model
const bool _use_Darcy_friction_model
Booleans to select the right models.
Definition: PINSFVMomentumFrictionCorrection.h:29
PINSFVMomentumFrictionCorrection::_consistent_scaling
Real _consistent_scaling
Parameter for scaling the consistent pressure interpolation.
Definition: PINSFVMomentumFrictionCorrection.h:40
PINSFVMomentumFrictionCorrection::_speed
const Moose::Functor< ADReal > *const _speed
Speed (norm of the interstitial velocity) as a functor.
Definition: PINSFVMomentumFrictionCorrection.h:37

Member Function Documentation

◆ addResidual()

void INSFVFluxKernel::addResidual ( const Real  residual)
protectedinherited

Process into the system residual.

◆ addResidualAndJacobian()

void INSFVFluxKernel::addResidualAndJacobian ( const ADReal &  residual)
protectedinherited

Process into either the system residual or Jacobian.

Definition at line 58 of file INSFVFluxKernel.C.

Referenced by gatherRCData(), WCNSFV2PMomentumDriftFlux::gatherRCData(), INSFVMixingLengthReynoldsStress::gatherRCData(), and INSFVMomentumDiffusion::gatherRCData().

59 {
60  auto process_residual = [this](const ADReal & residual, const Elem & elem)
61  {
62  const auto dof_index = elem.dof_number(_sys.number(), _var.number(), 0);
63  addResidualsAndJacobian(_assembly,
64  std::array<ADReal, 1>{{residual}},
65  std::array<dof_id_type, 1>{{dof_index}},
66  _var.scalingFactor());
67  };
68 
69  if (_face_type == FaceInfo::VarFaceNeighbors::ELEM ||
70  _face_type == FaceInfo::VarFaceNeighbors::BOTH)
71  process_residual(residual, _face_info->elem());
72  if (_face_type == FaceInfo::VarFaceNeighbors::NEIGHBOR ||
73  _face_type == FaceInfo::VarFaceNeighbors::BOTH)
74  process_residual(-residual, _face_info->neighbor());
75 }
FVFluxKernel::addResidualsAndJacobian
void addResidualsAndJacobian(Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
MooseVariableFV< Real >::number
unsigned int number() const
FaceInfo::elem
const Elem & elem() const
FVFluxKernel::_face_info
const FaceInfo * _face_info
ADReal
DualNumber< Real, DNDerivativeType, true > ADReal
FVFluxKernel::_sys
SystemBase & _sys
FaceInfo::neighbor
const Elem & neighbor() const
SystemBase::number
unsigned int number() const
FVFluxKernel::_face_type
FaceInfo::VarFaceNeighbors _face_type
FVFluxKernel::_assembly
Assembly & _assembly
FVFluxKernel::_var
MooseVariableFV< Real > & _var
MooseVariableFV< Real >::scalingFactor
void scalingFactor(const std::vector< Real > &factor)

◆ computeJacobian() [1/3]

void FVFluxKernel::computeJacobian
inherited

◆ computeJacobian() [2/3]

void FVFluxKernel::computeJacobian
inherited

◆ computeJacobian() [3/3]

void INSFVFluxKernel::computeJacobian ( const FaceInfo &  fi)
finaloverridevirtualinherited

Reimplemented from FVFluxKernel.

Definition at line 37 of file INSFVFluxKernel.C.

38 {
39  if (_rc_uo.segregated())
40  FVFluxKernel::computeJacobian(fi);
41 }
INSFVMomentumResidualObject::_rc_uo
RhieChowInterpolatorBase & _rc_uo
The Rhie Chow user object that is responsible for generating face velocities for advection terms...
Definition: INSFVMomentumResidualObject.h:55
FVFluxKernel::computeJacobian
void computeJacobian() override
RhieChowInterpolatorBase::segregated
virtual bool segregated() const =0
Bool of the Rhie Chow user object is used in monolithic/segregated approaches.

◆ computeQpResidual()

ADReal INSFVFluxKernel::computeQpResidual ( )
finaloverrideprotectedvirtualinherited

Implements FVFluxKernel.

Definition at line 51 of file INSFVFluxKernel.C.

52 {
53  mooseAssert(_rc_uo.segregated(), "We should not get here if we are not segregated!");
54  return computeSegregatedContribution();
55 }
INSFVFluxKernel::computeSegregatedContribution
virtual ADReal computeSegregatedContribution()
Compute the contribution which goes into the residual of the segregated system.
Definition: INSFVFluxKernel.h:53
INSFVMomentumResidualObject::_rc_uo
RhieChowInterpolatorBase & _rc_uo
The Rhie Chow user object that is responsible for generating face velocities for advection terms...
Definition: INSFVMomentumResidualObject.h:55
RhieChowInterpolatorBase::segregated
virtual bool segregated() const =0
Bool of the Rhie Chow user object is used in monolithic/segregated approaches.

◆ computeResidual() [1/3]

void FVFluxKernel::computeResidual
inherited

◆ computeResidual() [2/3]

void FVFluxKernel::computeResidual
inherited

◆ computeResidual() [3/3]

void INSFVFluxKernel::computeResidual ( const FaceInfo &  fi)
finaloverridevirtualinherited

Reimplemented from FVFluxKernel.

Definition at line 30 of file INSFVFluxKernel.C.

31 {
32  if (_rc_uo.segregated())
33  FVFluxKernel::computeResidual(fi);
34 }
INSFVMomentumResidualObject::_rc_uo
RhieChowInterpolatorBase & _rc_uo
The Rhie Chow user object that is responsible for generating face velocities for advection terms...
Definition: INSFVMomentumResidualObject.h:55
RhieChowInterpolatorBase::segregated
virtual bool segregated() const =0
Bool of the Rhie Chow user object is used in monolithic/segregated approaches.
FVFluxKernel::computeResidual
void computeResidual() override

◆ computeResidualAndJacobian() [1/3]

void FVFluxKernel::computeResidualAndJacobian
inherited

◆ computeResidualAndJacobian() [2/3]

void FVFluxKernel::computeResidualAndJacobian
inherited

◆ computeResidualAndJacobian() [3/3]

void INSFVFluxKernel::computeResidualAndJacobian ( const FaceInfo &  fi)
finaloverridevirtualinherited

Reimplemented from FVFluxKernel.

Definition at line 44 of file INSFVFluxKernel.C.

45 {
46  if (_rc_uo.segregated())
47  FVFluxKernel::computeResidualAndJacobian(fi);
48 }
FVFluxKernel::computeResidualAndJacobian
void computeResidualAndJacobian() override
INSFVMomentumResidualObject::_rc_uo
RhieChowInterpolatorBase & _rc_uo
The Rhie Chow user object that is responsible for generating face velocities for advection terms...
Definition: INSFVMomentumResidualObject.h:55
RhieChowInterpolatorBase::segregated
virtual bool segregated() const =0
Bool of the Rhie Chow user object is used in monolithic/segregated approaches.

◆ computeSegregatedContribution()

virtual ADReal INSFVFluxKernel::computeSegregatedContribution ( )
inlineprotectedvirtualinherited

Compute the contribution which goes into the residual of the segregated system.

This needs to accomodate the different linearization approaches needed to get the suitable system matrix contributions when the Jacobian assembly routine is called.

Reimplemented in INSFVMixingLengthReynoldsStress, INSFVMomentumDiffusion, and WCNSFV2PMomentumDriftFlux.

Definition at line 53 of file INSFVFluxKernel.h.

Referenced by INSFVFluxKernel::computeQpResidual().

54  {
55  mooseError("computeSegregatedContribution not implemented for ",
56  this->type(),
57  ". This function needs to be implemented to be able to use this object with a "
58  "segregated solver!");
59  }
FVFluxKernel::type
const std::string & type() const
FVFluxKernel::mooseError
void mooseError(Args &&... args) const

◆ gatherRCData() [1/5]

virtual void INSFVMomentumResidualObject::gatherRCData

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.

◆ gatherRCData() [2/5]

virtual void INSFVMomentumResidualObject::gatherRCData

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.

◆ gatherRCData() [3/5]

void INSFVFluxKernel::gatherRCData
inlinefinaloverride

Definition at line 26 of file INSFVFluxKernel.h.

26 {}

◆ gatherRCData() [4/5]

void PINSFVMomentumFrictionCorrection::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 62 of file PINSFVMomentumFrictionCorrection.C.

63 {
64  if (skipForBoundary(fi))
65  return;
66 
67  _face_info = &fi;
68  _normal = fi.normal();
69  _face_type = fi.faceType(std::make_pair(_var.number(), _var.sys().number()));
70 
71  using namespace Moose::FV;
72 
73  const auto elem_face = elemArg();
74  const auto neighbor_face = neighborArg();
75  const auto state = determineState();
76 
77  Point _face_centroid = _face_info->faceCentroid();
78  Point _elem_centroid = _face_info->elemCentroid();
79 
80  ADReal friction_term_elem = 0;
81  ADReal friction_term_neighbor = 0;
82 
83  ADReal diff_face;
84 
85  // If we are on an internal face for the variable, we interpolate the friction terms
86  // to the face using the cell values
87  if (_var.isInternalFace(*_face_info))
88  {
89  if (_use_Darcy_friction_model)
90  {
91  friction_term_elem += (*_D)(elem_face, state)(_index)*_mu(elem_face, state);
92  friction_term_neighbor += (*_D)(neighbor_face, state)(_index)*_mu(neighbor_face, state);
93  }
94  if (_use_Forchheimer_friction_model)
95  {
96  friction_term_elem +=
97  (*_F)(elem_face, state)(_index)*_rho(elem_face, state) / 2 * (*_speed)(elem_face, state);
98  friction_term_neighbor += (*_F)(neighbor_face, state)(_index)*_rho(neighbor_face, state) / 2 *
99  (*_speed)(neighbor_face, state);
100  }
101 
102  Point _neighbor_centroid = _face_info->neighborCentroid();
103 
104  Real geometric_factor = _consistent_scaling * (_neighbor_centroid - _face_centroid).norm() *
105  (_elem_centroid - _face_centroid).norm();
106 
107  // Compute the diffusion driven by the velocity gradient
108  // Interpolate viscosity divided by porosity on the face
109  interpolate(Moose::FV::InterpMethod::Average,
110  diff_face,
111  friction_term_elem * geometric_factor,
112  friction_term_neighbor * geometric_factor,
113  *_face_info,
114  true);
115  }
116  // If not, we use the extrapolated values of the functors on the face
117  else
118  {
119  const auto face =
120  makeFace(*_face_info, Moose::FV::limiterType(Moose::FV::InterpMethod::Average), true);
121  if (_use_Darcy_friction_model)
122  friction_term_elem += (*_D)(face, state)(_index)*_mu(face, state);
123  if (_use_Forchheimer_friction_model)
124  friction_term_elem +=
125  (*_F)(face, state)(_index)*_rho(face, state) / 2 * (*_speed)(face, state);
126 
127  Real geometric_factor =
128  _consistent_scaling * std::pow((_elem_centroid - _face_centroid).norm(), 2);
129 
130  diff_face = friction_term_elem * geometric_factor;
131  }
132 
133  // Compute face superficial velocity gradient
134  auto dudn = _var.gradient(makeCDFace(*_face_info), state) * _face_info->normal();
135 
136  if (_face_type == FaceInfo::VarFaceNeighbors::ELEM ||
137  _face_type == FaceInfo::VarFaceNeighbors::BOTH)
138  {
139  const auto dof_number = _face_info->elem().dof_number(_sys.number(), _var.number(), 0);
140  // A gradient is a linear combination of degrees of freedom so it's safe to straight-up index
141  // into the derivatives vector at the dof we care about
142  ADReal ae = dudn.derivatives()[dof_number];
143  ae *= -diff_face;
144  _rc_uo.addToA(&fi.elem(), _index, ae * (fi.faceArea() * fi.faceCoord()));
145  }
146  if (_face_type == FaceInfo::VarFaceNeighbors::NEIGHBOR ||
147  _face_type == FaceInfo::VarFaceNeighbors::BOTH)
148  {
149  const auto dof_number = _face_info->neighbor().dof_number(_sys.number(), _var.number(), 0);
150  ADReal an = dudn.derivatives()[dof_number];
151  an *= diff_face;
152  _rc_uo.addToA(fi.neighborPtr(), _index, an * (fi.faceArea() * fi.faceCoord()));
153  }
154 
155  const auto strong_resid = -diff_face * dudn;
156 
157  addResidualAndJacobian(strong_resid * (fi.faceArea() * fi.faceCoord()));
158 }
FVFluxKernel::elemArg
Moose::ElemArg elemArg(bool correct_skewness=false) const
MooseVariableFV< Real >::number
unsigned int number() const
PINSFVMomentumFrictionCorrection::_mu
const Moose::Functor< ADReal > & _mu
Dynamic viscosity as a functor.
Definition: PINSFVMomentumFrictionCorrection.h:35
FaceInfo::elem
const Elem & elem() const
FVFluxKernel::_face_info
const FaceInfo * _face_info
FVFluxKernel::determineState
Moose::StateArg determineState() const
FaceInfo::faceCentroid
const Point & faceCentroid() const
INSFVMomentumResidualObject::_index
const unsigned int _index
index x|y|z
Definition: INSFVMomentumResidualObject.h:58
FaceInfo::faceCoord
Real & faceCoord()
PINSFVMomentumFrictionCorrection::_rho
const Moose::Functor< ADReal > & _rho
Density as a functor.
Definition: PINSFVMomentumFrictionCorrection.h:33
FaceInfo::neighborCentroid
const Point & neighborCentroid() const
FVFluxKernel::_normal
RealVectorValue _normal
FaceInfo::faceArea
Real faceArea() const
INSFVMomentumResidualObject::_rc_uo
RhieChowInterpolatorBase & _rc_uo
The Rhie Chow user object that is responsible for generating face velocities for advection terms...
Definition: INSFVMomentumResidualObject.h:55
FVFluxKernel::_sys
SystemBase & _sys
FVFluxKernel::skipForBoundary
virtual bool skipForBoundary(const FaceInfo &fi) const
MooseVariableFV< Real >::isInternalFace
bool isInternalFace(const FaceInfo &) const
Moose::FV::limiterType
LimiterType limiterType(InterpMethod interp_method)
FaceInfo::neighborPtr
const Elem * neighborPtr() const
FaceInfo::elemCentroid
const Point & elemCentroid() const
FaceInfo::neighbor
const Elem & neighbor() const
FaceInfo::normal
const Point & normal() const
SystemBase::number
unsigned int number() const
norm
auto norm(const T &a) -> decltype(std::abs(a))
FVFluxKernel::_face_type
FaceInfo::VarFaceNeighbors _face_type
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
INSFVFluxKernel::addResidualAndJacobian
void addResidualAndJacobian(const ADReal &residual)
Process into either the system residual or Jacobian.
Definition: INSFVFluxKernel.C:58
RhieChowInterpolatorBase::addToA
virtual void addToA(const libMesh::Elem *elem, unsigned int component, const ADReal &value)=0
API for momentum residual objects that have on-diagonals for velocity call.
FVFluxKernel::neighborArg
Moose::ElemArg neighborArg(bool correct_skewness=false) const
MooseVariableFV< Real >::gradient
GradientType gradient(const ElemArg &elem, const StateArg &state) const
PINSFVMomentumFrictionCorrection::_use_Darcy_friction_model
const bool _use_Darcy_friction_model
Booleans to select the right models.
Definition: PINSFVMomentumFrictionCorrection.h:29
PINSFVMomentumFrictionCorrection::_consistent_scaling
Real _consistent_scaling
Parameter for scaling the consistent pressure interpolation.
Definition: PINSFVMomentumFrictionCorrection.h:40
FVFluxKernel::_var
MooseVariableFV< Real > & _var
FVFluxKernel::makeCDFace
Moose::FaceArg makeCDFace(const FaceInfo &fi, const bool correct_skewness=false) const
interpolate
void interpolate(InterpMethod m, T &result, const T2 &value1, const T3 &value2, const FaceInfo &fi, const bool one_is_elem)
std::pow
MooseUnits pow(const MooseUnits &, int)
FVFluxKernel::makeFace
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
FaceInfo::faceType
VarFaceNeighbors faceType(const std::pair< unsigned int, unsigned int > &var_sys) const

◆ gatherRCData() [5/5]

void INSFVFluxKernel::gatherRCData ( const Elem &  elem)
inlinefinaloverridevirtualinherited

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 26 of file INSFVFluxKernel.h.

26 {}

◆ validParams()

InputParameters PINSFVMomentumFrictionCorrection::validParams ( )
static

Definition at line 18 of file PINSFVMomentumFrictionCorrection.C.

19 {
20  auto params = INSFVFluxKernel::validParams();
21  params.addClassDescription(
22  "Computes a correction term to avoid oscillations from average pressure interpolation in "
23  "regions of high changes in friction coefficients.");
24  params.addParam<MooseFunctorName>("Darcy_name", "Name of the Darcy coefficients property.");
25  params.addParam<MooseFunctorName>("Forchheimer_name",
26  "Name of the Forchheimer coefficients property.");
27  params.addRequiredParam<MooseFunctorName>(NS::density, "The density.");
28  params.addParam<MooseFunctorName>(
29  NS::speed,
30  "The norm of the interstitial velocity. This is required for Forchheimer calculations");
31  params.addParam<MooseFunctorName>(NS::mu, NS::mu, "The dynamic viscosity");
32  params.addRangeCheckedParam<Real>("consistent_scaling",
33  1,
34  "consistent_scaling >= 0",
35  "Smoothing scaling parameter to control "
36  "collocated mesh oscillations");
37  return params;
38 }
NS::speed
static const std::string speed
Definition: NS.h:143
NS::density
static const std::string density
Definition: NS.h:33
NS::mu
static const std::string mu
Definition: NS.h:123
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
INSFVFluxKernel::validParams
static InputParameters validParams()
Definition: INSFVFluxKernel.C:17

Member Data Documentation

◆ _consistent_scaling

Real PINSFVMomentumFrictionCorrection::_consistent_scaling
protected

Parameter for scaling the consistent pressure interpolation.

Definition at line 40 of file PINSFVMomentumFrictionCorrection.h.

Referenced by gatherRCData().

◆ _D

const Moose::Functor<ADRealVectorValue>* const PINSFVMomentumFrictionCorrection::_D
protected

Darcy coefficient.

Definition at line 24 of file PINSFVMomentumFrictionCorrection.h.

◆ _F

const Moose::Functor<ADRealVectorValue>* const PINSFVMomentumFrictionCorrection::_F
protected

Forchheimer coefficient.

Definition at line 26 of file PINSFVMomentumFrictionCorrection.h.

◆ _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(), INSFVMomentumAdvection::computeResidualsAndAData(), INSFVSymmetryVelocityBC::computeSegregatedContribution(), INSFVWallFunctionBC::computeStrongResidual(), WCNSFV2PMomentumDriftFlux::computeStrongResidual(), INSFVMomentumDiffusion::computeStrongResidual(), INSFVMixingLengthReynoldsStress::computeStrongResidual(), gatherRCData(), INSFVMomentumTimeDerivative::gatherRCData(), PINSFVMomentumFriction::gatherRCData(), INSFVMomentumMeshAdvection::gatherRCData(), WCNSFVMomentumTimeDerivative::gatherRCData(), WCNSFV2PMomentumDriftFlux::gatherRCData(), INSFVWallFunctionBC::gatherRCData(), INSFVSymmetryVelocityBC::gatherRCData(), INSFVVaporRecoilPressureMomentumFluxBC::gatherRCData(), INSFVMixingLengthReynoldsStress::gatherRCData(), INSFVMomentumDiffusion::gatherRCData(), INSFVMomentumAdvectionOutflowBC::gatherRCData(), and INSFVMomentumAdvection::gatherRCData().

◆ _mu

const Moose::Functor<ADReal>& PINSFVMomentumFrictionCorrection::_mu
protected

Dynamic viscosity as a functor.

Definition at line 35 of file PINSFVMomentumFrictionCorrection.h.

Referenced by gatherRCData().

◆ _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(), gatherRCData(), INSFVMomentumTimeDerivative::gatherRCData(), PINSFVMomentumFriction::gatherRCData(), INSFVMomentumMeshAdvection::gatherRCData(), WCNSFV2PMomentumDriftFlux::gatherRCData(), WCNSFVMomentumTimeDerivative::gatherRCData(), INSFVMixingLengthReynoldsStress::gatherRCData(), INSFVSymmetryVelocityBC::gatherRCData(), INSFVWallFunctionBC::gatherRCData(), INSFVMomentumDiffusion::gatherRCData(), PINSFVFunctorBC::gatherRCData(), INSFVMomentumAdvectionOutflowBC::gatherRCData(), INSFVMomentumAdvection::gatherRCData(), and INSFVWallFunctionBC::INSFVWallFunctionBC().

◆ _rho

const Moose::Functor<ADReal>& PINSFVMomentumFrictionCorrection::_rho
protected

Density as a functor.

Definition at line 33 of file PINSFVMomentumFrictionCorrection.h.

Referenced by gatherRCData().

◆ _speed

const Moose::Functor<ADReal>* const PINSFVMomentumFrictionCorrection::_speed
protected

Speed (norm of the interstitial velocity) as a functor.

Definition at line 37 of file PINSFVMomentumFrictionCorrection.h.

Referenced by PINSFVMomentumFrictionCorrection().

◆ _use_Darcy_friction_model

const bool PINSFVMomentumFrictionCorrection::_use_Darcy_friction_model
protected

Booleans to select the right models.

Definition at line 29 of file PINSFVMomentumFrictionCorrection.h.

Referenced by gatherRCData(), and PINSFVMomentumFrictionCorrection().

◆ _use_Forchheimer_friction_model

const bool PINSFVMomentumFrictionCorrection::_use_Forchheimer_friction_model
protected

Definition at line 30 of file PINSFVMomentumFrictionCorrection.h.

Referenced by gatherRCData(), and PINSFVMomentumFrictionCorrection().

The documentation for this class was generated from the following files:
Generated on Thu Jul 17 2025 01:50:13 for https://mooseframework.inl.gov by   doxygen 1.8.14