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
PINSFVMomentumFriction Class Reference

Imposes a friction force on the momentum equation in porous media in Rhie-Chow contexts. More...

#include <PINSFVMomentumFriction.h>

Inheritance diagram for PINSFVMomentumFriction:
[legend]

Public Types

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

Public Member Functions

 PINSFVMomentumFriction (const InputParameters &params)
 
void gatherRCData (const Elem &) override
 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 &) 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 FaceInfo &) 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 computeResidual () override
 
void computeJacobian () override
 
void computeOffDiagJacobian () override final
 
virtual void computeOffDiagJacobian ()
 
void computeOffDiagJacobian (unsigned int) override
 
virtual void computeOffDiagJacobian ()
 
void computeOffDiagJacobian (unsigned int) override
 
void computeOffDiagJacobian (unsigned int) override
 
void computeResidualAndJacobian () override
 
const MooseVariableFV< Real > & variable () const override
 
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
 
MooseVariableBase * mooseVariableBase () const
 
MooseVariableField< Real > & mooseVariableField ()
 
MooseVariableFE< Real > * mooseVariable () const
 
MooseVariableFV< Real > * mooseVariableFV () const
 
MooseLinearVariableFV< Real > * mooseLinearVariableFV () const
 
virtual const VariableValue & coupledValueByName (const std::string &var_name)
 
virtual const ArrayVariableValue & coupledArrayValueByName (const std::string &var_name)
 
const std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> > & getCoupledVars () const
 
const std::vector< MooseVariableFieldBase *> & getCoupledMooseVars () const
 
const std::vector< MooseVariable *> & getCoupledStandardMooseVars () const
 
const std::vector< VectorMooseVariable *> & getCoupledVectorMooseVars () const
 
const std::vector< ArrayMooseVariable *> & getCoupledArrayMooseVars () const
 
void addFEVariableCoupleableVectorTag (TagID tag)
 
void addFEVariableCoupleableMatrixTag (TagID tag)
 
std::set< TagID > & getFEVariableCoupleableVectorTags ()
 
const std::set< TagID > & getFEVariableCoupleableVectorTags () const
 
std::set< TagID > & getFEVariableCoupleableMatrixTags ()
 
const std::set< TagID > & getFEVariableCoupleableMatrixTags () const
 
auto & getWritableCoupledVariables () const
 
bool hasWritableCoupledVariables () const
 
const ADVariableValue * getADDefaultValue (const std::string &var_name) const
 
const ADVectorVariableValue * getADDefaultVectorValue (const std::string &var_name) const
 
const ADVariableGradient & getADDefaultGradient () const
 
const ADVectorVariableGradient & getADDefaultVectorGradient () const
 
const ADVariableSecond & getADDefaultSecond () const
 
const ADVectorVariableCurl & getADDefaultCurl () const
 
const std::vector< MooseVariableScalar *> & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
const std::set< MooseVariableFieldBase *> & getMooseVariableDependencies () const
 
std::set< MooseVariableFieldBase *> checkAllVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_omit={})
 
std::set< MooseVariableFieldBase *> checkVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
void addMooseVariableDependency (MooseVariableFieldBase *var)
 
void addMooseVariableDependency (const std::vector< MooseVariableFieldBase * > &vars)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty (const MaterialPropertyName &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty ()
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialPropertyByName (const std::string &prop_name)
 
const MaterialProperty< T > & getZeroMaterialProperty (Ts... args)
 
std::set< SubdomainID > getMaterialPropertyBlocks (const std::string &name)
 
std::vector< SubdomainName > getMaterialPropertyBlockNames (const std::string &name)
 
std::set< BoundaryID > getMaterialPropertyBoundaryIDs (const std::string &name)
 
std::vector< BoundaryName > getMaterialPropertyBoundaryNames (const std::string &name)
 
void checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)
 
std::unordered_map< SubdomainID, std::vector< MaterialBase *> > buildRequiredMaterials (bool allow_stateful=true)
 
void statefulPropertiesAllowed (bool)
 
bool getMaterialPropertyCalled () const
 
virtual const std::unordered_set< unsigned int > & getMatPropDependencies () const
 
virtual void resolveOptionalProperties ()
 
const GenericMaterialProperty< T, is_ad > & getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)
 
bool 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 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 computeSegregatedContribution () override
 Compute the contribution which goes into the residual of the segregated system. More...
 
ADReal computeFrictionWCoefficient (const Moose::ElemArg &elem_arg, const Moose::StateArg &state)
 Computes the friction coefficient which gets multiplied by the velocity. More...
 
ADReal computeQpResidual () override final
 
void addResidualAndJacobian (const ADReal &residual, dof_id_type dof)
 Process into either the system residual or Jacobian. More...
 
std::string deduceFunctorName (const std::string &name) 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 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
 
virtual void checkMaterialProperty (const std::string &name, const unsigned int state)
 
void markMatPropRequested (const std::string &)
 
MaterialPropertyName getMaterialPropertyName (const std::string &name) const
 
void checkExecutionStage ()
 
const 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 bool _is_porous_medium
 
const bool _standard_friction_formulation
 
const Moose::Functor< ADReal > *const _mu
 Dynamic viscosity. More...
 
const Moose::Functor< ADReal > & _rho
 Density as a functor. More...
 
const Moose::Functor< ADReal > *const _speed
 Speed (norm of the interstitial velocity) as a functor. More...
 
const unsigned int _dim
 The dimension of the domain. More...
 
const Moose::Functor< ADReal > * _u_var
 x-velocity More...
 
const Moose::Functor< ADReal > * _v_var
 y-velocity More...
 
const Moose::Functor< ADReal > * _w_var
 z-velocity More...
 
const Moose::Functor< ADReal > & _epsilon
 Adding porosity functor. More...
 
MooseVariableFV< Real > & _var
 
const ADVariableValue & _u
 
const Moose::Functor< ADReal > & _u_functor
 
const unsigned int _qp
 
const Elem *const & _current_elem
 
const MooseArray< Point > & _q_point
 
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
 
bool _nodal
 
MooseVariableFE< Real > * _variable
 
MooseVariableFV< Real > * _fv_variable
 
MooseLinearVariableFV< Real > * _linear_fv_variable
 
MooseVariableField< Real > * _field_variable
 
Assembly * _mvi_assembly
 
const InputParameters & _c_parameters
 
const std::string & _c_name
 
const std::string & _c_type
 
FEProblemBase & _c_fe_problem
 
const SystemBase *const _c_sys
 
std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> > _coupled_vars
 
std::vector< MooseVariableFieldBase *> _coupled_moose_vars
 
std::vector< MooseVariable *> _coupled_standard_moose_vars
 
std::vector< VectorMooseVariable *> _coupled_vector_moose_vars
 
std::vector< ArrayMooseVariable *> _coupled_array_moose_vars
 
std::vector< MooseVariableFV< Real > *> _coupled_standard_fv_moose_vars
 
std::vector< MooseLinearVariableFV< Real > *> _coupled_standard_linear_fv_moose_vars
 
const std::unordered_map< std::string, std::string > & _new_to_deprecated_coupled_vars
 
bool _c_nodal
 
bool _c_is_implicit
 
const bool _c_allow_element_to_nodal_coupling
 
THREAD_ID _c_tid
 
std::unordered_map< std::string, std::vector< std::unique_ptr< VariableValue > > > _default_value
 
std::unordered_map< std::string, std::unique_ptr< MooseArray< ADReal > > > _ad_default_value
 
std::unordered_map< std::string, std::unique_ptr< VectorVariableValue > > _default_vector_value
 
std::unordered_map< std::string, std::unique_ptr< ArrayVariableValue > > _default_array_value
 
std::unordered_map< std::string, std::unique_ptr< MooseArray< ADRealVectorValue > > > _ad_default_vector_value
 
VariableValue _default_value_zero
 
VariableGradient _default_gradient
 
MooseArray< ADRealVectorValue > _ad_default_gradient
 
MooseArray< ADRealTensorValue > _ad_default_vector_gradient
 
VariableSecond _default_second
 
MooseArray< ADRealTensorValue > _ad_default_second
 
MooseArray< ADRealVectorValue > _ad_default_curl
 
const VariableValue & _zero
 
const VariablePhiValue & _phi_zero
 
const MooseArray< ADReal > & _ad_zero
 
const VariableGradient & _grad_zero
 
const MooseArray< ADRealVectorValue > & _ad_grad_zero
 
const VariablePhiGradient & _grad_phi_zero
 
const VariableSecond & _second_zero
 
const MooseArray< ADRealTensorValue > & _ad_second_zero
 
const VariablePhiSecond & _second_phi_zero
 
const VectorVariableValue & _vector_zero
 
const VectorVariableCurl & _vector_curl_zero
 
VectorVariableValue _default_vector_value_zero
 
VectorVariableGradient _default_vector_gradient
 
VectorVariableCurl _default_vector_curl
 
VectorVariableDivergence _default_div
 
ArrayVariableValue _default_array_value_zero
 
ArrayVariableGradient _default_array_gradient
 
bool _coupleable_neighbor
 
FEProblemBase & _sc_fe_problem
 
const THREAD_ID _sc_tid
 
const Real & _real_zero
 
const VariableValue & _scalar_zero
 
const Point & _point_zero
 
const InputParameters & _mi_params
 
const std::string _mi_name
 
const MooseObjectName _mi_moose_object_name
 
FEProblemBase & _mi_feproblem
 
SubProblem & _mi_subproblem
 
const THREAD_ID _mi_tid
 
const Moose::MaterialDataType _material_data_type
 
MaterialData & _material_data
 
bool _stateful_allowed
 
bool _get_material_property_called
 
std::vector< std::unique_ptr< PropertyValue > > _default_properties
 
std::unordered_set< unsigned int > _material_property_dependencies
 
const MaterialPropertyName _get_suffix
 
const bool _use_interpolated_state
 
const 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

Imposes a friction force on the momentum equation in porous media in Rhie-Chow contexts.

Definition at line 17 of file PINSFVMomentumFriction.h.

Constructor & Destructor Documentation

◆ PINSFVMomentumFriction()

PINSFVMomentumFriction::PINSFVMomentumFriction ( const InputParameters &  params)

Definition at line 47 of file PINSFVMomentumFriction.C.

48  : INSFVElementalKernel(params),
49  _D(isParamValid("Darcy_name") ? &getFunctor<ADRealVectorValue>("Darcy_name") : nullptr),
50  _F(isParamValid("Forchheimer_name") ? &getFunctor<ADRealVectorValue>("Forchheimer_name")
51  : nullptr),
52  _use_Darcy_friction_model(isParamValid("Darcy_name")),
53  _use_Forchheimer_friction_model(isParamValid("Forchheimer_name")),
54  _is_porous_medium(getParam<bool>("is_porous_medium")),
55  _standard_friction_formulation(getParam<bool>("standard_friction_formulation")),
56  _mu(isParamValid(NS::mu) ? &getFunctor<ADReal>(NS::mu) : nullptr),
57  _rho(getFunctor<ADReal>(NS::density)),
58  _speed(isParamValid(NS::speed) ? &getFunctor<ADReal>(NS::speed) : nullptr),
59  _dim(_subproblem.mesh().dimension()),
60  _u_var(params.isParamValid("u") ? &(getFunctor<ADReal>("u")) : nullptr),
61  _v_var(params.isParamValid("v") ? &(getFunctor<ADReal>("v")) : nullptr),
62  _w_var(params.isParamValid("w") ? &(getFunctor<ADReal>("w")) : nullptr),
63  _epsilon(getFunctor<ADReal>(NS::porosity))
64 {
65  if (!_use_Darcy_friction_model && !_use_Forchheimer_friction_model)
66  mooseError("At least one friction model needs to be specified.");
67 
68  if (_standard_friction_formulation && _use_Darcy_friction_model && !_mu)
69  mooseError("If using the standard Darcy friction model, then the '",
70  NS::mu,
71  "' parameter must be provided");
72  if (_use_Forchheimer_friction_model && !_speed)
73  {
74  if (_dim >= 1)
75  {
76  if (!_u_var)
77  mooseError("The velocity variable 'u' should be defined if no speed functor material is "
78  "defined for this kernel when using the Forchheimer fromulation.");
79  }
80  if (_dim >= 2)
81  {
82  if (!_v_var)
83  mooseError(
84  "The velocity variable 'v' should be defined if no speed functor material is "
85  "defined for this kernel and dimensions >= 2 when using the Forchheimer fromulation.");
86  }
87  if (_dim >= 3)
88  {
89  if (!_w_var)
90  mooseError(
91  "The velocity variable 'w' should be defined if no speed functor material is "
92  "defined for this kernel and dimensions >= 3 when using the Forchheimer fromulation.");
93  }
94  }
95 }
PINSFVMomentumFriction::_w_var
const Moose::Functor< ADReal > * _w_var
z-velocity
Definition: PINSFVMomentumFriction.h:57
SubProblem::mesh
virtual MooseMesh & mesh()=0
NS::speed
static const std::string speed
Definition: NS.h:143
PINSFVMomentumFriction::_speed
const Moose::Functor< ADReal > *const _speed
Speed (norm of the interstitial velocity) as a functor.
Definition: PINSFVMomentumFriction.h:48
PINSFVMomentumFriction::_mu
const Moose::Functor< ADReal > *const _mu
Dynamic viscosity.
Definition: PINSFVMomentumFriction.h:44
NS::density
static const std::string density
Definition: NS.h:33
FVElementalKernel::isParamValid
bool isParamValid(const std::string &name) const
NS::porosity
static const std::string porosity
Definition: NS.h:104
PINSFVMomentumFriction::_dim
const unsigned int _dim
The dimension of the domain.
Definition: PINSFVMomentumFriction.h:51
MooseMesh::dimension
virtual unsigned int dimension() const
PINSFVMomentumFriction::_rho
const Moose::Functor< ADReal > & _rho
Density as a functor.
Definition: PINSFVMomentumFriction.h:46
NS::mu
static const std::string mu
Definition: NS.h:123
FVElementalKernel::_subproblem
SubProblem & _subproblem
PINSFVMomentumFriction::_epsilon
const Moose::Functor< ADReal > & _epsilon
Adding porosity functor.
Definition: PINSFVMomentumFriction.h:59
INSFVElementalKernel::INSFVElementalKernel
INSFVElementalKernel(const InputParameters &params)
Definition: INSFVElementalKernel.C:20
PINSFVMomentumFriction::_D
const Moose::Functor< ADRealVectorValue > *const _D
Darcy coefficient.
Definition: PINSFVMomentumFriction.h:34
PINSFVMomentumFriction::_u_var
const Moose::Functor< ADReal > * _u_var
x-velocity
Definition: PINSFVMomentumFriction.h:53
PINSFVMomentumFriction::_use_Darcy_friction_model
const bool _use_Darcy_friction_model
Booleans to select the right models.
Definition: PINSFVMomentumFriction.h:38
PINSFVMomentumFriction::_v_var
const Moose::Functor< ADReal > * _v_var
y-velocity
Definition: PINSFVMomentumFriction.h:55
FVElementalKernel::mooseError
void mooseError(Args &&... args) const
PINSFVMomentumFriction::_F
const Moose::Functor< ADRealVectorValue > *const _F
Forchheimer coefficient.
Definition: PINSFVMomentumFriction.h:36
InputParameters::isParamValid
bool isParamValid(const std::string &name) const

Member Function Documentation

◆ addResidualAndJacobian()

void INSFVElementalKernel::addResidualAndJacobian ( const ADReal &  residual,
dof_id_type  dof 
)
protectedinherited

Process into either the system residual or Jacobian.

Definition at line 60 of file INSFVElementalKernel.C.

Referenced by gatherRCData().

61 {
62  addResidualsAndJacobian(_assembly,
63  std::array<ADReal, 1>{{residual}},
64  std::array<dof_id_type, 1>{{dof_index}},
65  _var.scalingFactor());
66 }
FVElementalKernel::addResidualsAndJacobian
void addResidualsAndJacobian(Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
FVElementalKernel::_assembly
Assembly & _assembly
MooseVariableFV< Real >::scalingFactor
void scalingFactor(const std::vector< Real > &factor)
FVElementalKernel::_var
MooseVariableFV< Real > & _var

◆ computeFrictionWCoefficient()

ADReal PINSFVMomentumFriction::computeFrictionWCoefficient ( const Moose::ElemArg &  elem_arg,
const Moose::StateArg &  state 
)
protected

Computes the friction coefficient which gets multiplied by the velocity.

Speed treatment

Fluid properies

Definition at line 119 of file PINSFVMomentumFriction.C.

Referenced by computeSegregatedContribution(), and gatherRCData().

121 {
122  // Forward declaration of the coeffcients to be used and returned by the model
123  ADReal coefficient = 0.0;
124  ADReal speed = 0.0;
125  ADReal rho = 0.0;
126  ADReal mu = 0.0;
128  if (_use_Forchheimer_friction_model && _speed)
129  speed = (*_speed)(elem_arg, state);
130  else if (_use_Forchheimer_friction_model && !_speed)
131  {
132  ADRealVectorValue superficial_velocity;
133  if (_dim >= 1)
134  {
135  superficial_velocity(0) = (*_u_var)(elem_arg, state);
136  if (_dim >= 2)
137  {
138  superficial_velocity(1) = (*_v_var)(elem_arg, state);
139  if (_dim >= 3)
140  superficial_velocity(2) = (*_w_var)(elem_arg, state);
141  }
142  }
143  speed = NS::computeSpeed(superficial_velocity);
144  if (_is_porous_medium)
145  {
146  speed *= (1 / _epsilon(elem_arg, state));
147  }
148  }
149 
151  if (_use_Darcy_friction_model && _standard_friction_formulation)
152  {
153  mu = (*_mu)(elem_arg, state);
154  }
155 
156  if (_use_Forchheimer_friction_model && _standard_friction_formulation)
157  {
158  rho = _rho(elem_arg, state);
159  }
160 
164  if (_standard_friction_formulation)
165  {
166  if (_use_Darcy_friction_model)
167  coefficient += mu * (*_D)(elem_arg, state)(_index);
168  if (_use_Forchheimer_friction_model)
169  coefficient += rho / 2 * (*_F)(elem_arg, state)(_index)*speed;
170  }
171  else
172  {
173  if (_use_Darcy_friction_model)
174  coefficient += (*_D)(elem_arg, state)(_index);
175  if (_use_Forchheimer_friction_model)
176  coefficient += (*_F)(elem_arg, state)(_index)*speed;
177  }
178 
179  return coefficient;
180 }
NS::superficial_velocity
static const std::string superficial_velocity
Definition: NS.h:53
NS::speed
static const std::string speed
Definition: NS.h:143
PINSFVMomentumFriction::_speed
const Moose::Functor< ADReal > *const _speed
Speed (norm of the interstitial velocity) as a functor.
Definition: PINSFVMomentumFriction.h:48
INSFVMomentumResidualObject::_index
const unsigned int _index
index x|y|z
Definition: INSFVMomentumResidualObject.h:58
ADReal
DualNumber< Real, DNDerivativeType, true > ADReal
PINSFVMomentumFriction::_dim
const unsigned int _dim
The dimension of the domain.
Definition: PINSFVMomentumFriction.h:51
PINSFVMomentumFriction::_rho
const Moose::Functor< ADReal > & _rho
Density as a functor.
Definition: PINSFVMomentumFriction.h:46
NS::mu
static const std::string mu
Definition: NS.h:123
PINSFVMomentumFriction::_epsilon
const Moose::Functor< ADReal > & _epsilon
Adding porosity functor.
Definition: PINSFVMomentumFriction.h:59
PINSFVMomentumFriction::_use_Darcy_friction_model
const bool _use_Darcy_friction_model
Booleans to select the right models.
Definition: PINSFVMomentumFriction.h:38
NS::computeSpeed
ADReal computeSpeed(const ADRealVectorValue &velocity)
Compute the speed (velocity norm) given the supplied velocity.
Definition: NavierStokesMethods.C:148

◆ computeJacobian()

void INSFVElementalKernel::computeJacobian ( )
overridevirtualinherited

Reimplemented from FVElementalKernel.

Definition at line 38 of file INSFVElementalKernel.C.

39 {
40  if (_rc_uo.segregated())
41  {
42  const auto r = computeSegregatedContribution() * _assembly.elemVolume();
43  mooseAssert(_var.dofIndices().size() == 1, "We're currently built to use CONSTANT MONOMIALS");
44  addJacobian(_assembly, std::array<ADReal, 1>{{r}}, _var.dofIndices(), _var.scalingFactor());
45  }
46 }
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
FVElementalKernel::addJacobian
void addJacobian(Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
RhieChowInterpolatorBase::segregated
virtual bool segregated() const =0
Bool of the Rhie Chow user object is used in monolithic/segregated approaches.
FVElementalKernel::_assembly
Assembly & _assembly
INSFVElementalKernel::computeSegregatedContribution
virtual ADReal computeSegregatedContribution()
Compute the contribution which goes into the residual of the segregated system.
Definition: INSFVElementalKernel.h:44
Assembly::elemVolume
const Real & elemVolume() const
MooseVariableFV< Real >::scalingFactor
void scalingFactor(const std::vector< Real > &factor)
MooseVariableFV< Real >::dofIndices
virtual const std::vector< dof_id_type > & dofIndices() const final
FVElementalKernel::_var
MooseVariableFV< Real > & _var

◆ computeOffDiagJacobian() [1/5]

virtual void FVElementalKernel::computeOffDiagJacobian
inherited

◆ computeOffDiagJacobian() [2/5]

void FVElementalKernel::computeOffDiagJacobian
inherited

◆ computeOffDiagJacobian() [3/5]

virtual void FVElementalKernel::computeOffDiagJacobian
inherited

◆ computeOffDiagJacobian() [4/5]

void FVElementalKernel::computeOffDiagJacobian
inherited

◆ computeOffDiagJacobian() [5/5]

void INSFVElementalKernel::computeOffDiagJacobian ( )
inlinefinaloverridevirtualinherited

Reimplemented from FVElementalKernel.

Definition at line 32 of file INSFVElementalKernel.h.

32 {}

◆ computeQpResidual()

ADReal INSFVElementalKernel::computeQpResidual ( )
inlinefinaloverrideprotectedvirtualinherited

Implements FVElementalKernel.

Definition at line 36 of file INSFVElementalKernel.h.

37  {
38  mooseError("INSFVElementalKernels must implement gatherRCData and not computeQpResidual");
39  }
FVElementalKernel::mooseError
void mooseError(Args &&... args) const

◆ computeResidual()

void INSFVElementalKernel::computeResidual ( )
overridevirtualinherited

Reimplemented from FVElementalKernel.

Definition at line 26 of file INSFVElementalKernel.C.

27 {
28  if (_rc_uo.segregated())
29  {
30  prepareVectorTag(_assembly, _var.number());
31  _local_re(0) +=
32  MetaPhysicL::raw_value(computeSegregatedContribution() * _assembly.elemVolume());
33  accumulateTaggedLocalResidual();
34  }
35 }
FVElementalKernel::accumulateTaggedLocalResidual
void accumulateTaggedLocalResidual()
MooseVariableFV< Real >::number
unsigned int number() const
MetaPhysicL::raw_value
auto raw_value(const Eigen::Map< T > &in)
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.
FVElementalKernel::_assembly
Assembly & _assembly
INSFVElementalKernel::computeSegregatedContribution
virtual ADReal computeSegregatedContribution()
Compute the contribution which goes into the residual of the segregated system.
Definition: INSFVElementalKernel.h:44
FVElementalKernel::_local_re
DenseVector< Number > _local_re
Assembly::elemVolume
const Real & elemVolume() const
FVElementalKernel::prepareVectorTag
void prepareVectorTag(Assembly &assembly, unsigned int ivar)
FVElementalKernel::_var
MooseVariableFV< Real > & _var

◆ computeResidualAndJacobian()

void INSFVElementalKernel::computeResidualAndJacobian ( )
overridevirtualinherited

Reimplemented from FVElementalKernel.

Definition at line 49 of file INSFVElementalKernel.C.

50 {
51  if (_rc_uo.segregated())
52  {
53  const auto r = computeSegregatedContribution() * _assembly.elemVolume();
54  addResidualsAndJacobian(
55  _assembly, std::array<ADReal, 1>{{r}}, _var.dofIndices(), _var.scalingFactor());
56  }
57 }
FVElementalKernel::addResidualsAndJacobian
void addResidualsAndJacobian(Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
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.
FVElementalKernel::_assembly
Assembly & _assembly
INSFVElementalKernel::computeSegregatedContribution
virtual ADReal computeSegregatedContribution()
Compute the contribution which goes into the residual of the segregated system.
Definition: INSFVElementalKernel.h:44
Assembly::elemVolume
const Real & elemVolume() const
MooseVariableFV< Real >::scalingFactor
void scalingFactor(const std::vector< Real > &factor)
MooseVariableFV< Real >::dofIndices
virtual const std::vector< dof_id_type > & dofIndices() const final
FVElementalKernel::_var
MooseVariableFV< Real > & _var

◆ computeSegregatedContribution()

ADReal PINSFVMomentumFriction::computeSegregatedContribution ( )
overrideprotectedvirtual

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 from INSFVElementalKernel.

Definition at line 183 of file PINSFVMomentumFriction.C.

184 {
185  const auto & elem_arg = makeElemArg(_current_elem);
186  const auto state = determineState();
187  return raw_value(computeFrictionWCoefficient(elem_arg, state)) * _u_functor(elem_arg, state);
188 }
PINSFVMomentumFriction::computeFrictionWCoefficient
ADReal computeFrictionWCoefficient(const Moose::ElemArg &elem_arg, const Moose::StateArg &state)
Computes the friction coefficient which gets multiplied by the velocity.
Definition: PINSFVMomentumFriction.C:119
FVElementalKernel::determineState
Moose::StateArg determineState() const
raw_value
auto raw_value(const Eigen::Map< T > &in)
FVElementalKernel::makeElemArg
Moose::ElemArg makeElemArg(const Elem *elem, bool correct_skewnewss=false) const
FVElementalKernel::_current_elem
const Elem *const & _current_elem
FVElementalKernel::_u_functor
const Moose::Functor< ADReal > & _u_functor

◆ gatherRCData() [1/5]

void INSFVElementalKernel::gatherRCData
inlinefinaloverride

Definition at line 25 of file INSFVElementalKernel.h.

25 {}

◆ gatherRCData() [2/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() [3/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() [4/5]

void PINSFVMomentumFriction::gatherRCData ( const Elem &  elem)
overridevirtual

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 191 of file PINSFVMomentumFriction.C.

192 {
193  const auto elem_arg = makeElemArg(&elem);
194  const auto state = determineState();
195  const auto coefficient =
196  computeFrictionWCoefficient(elem_arg, state) * _assembly.elementVolume(&elem);
197  _rc_uo.addToA(&elem, _index, coefficient);
198  const auto dof_number = elem.dof_number(_sys.number(), _var.number(), 0);
199  addResidualAndJacobian(coefficient * _u_functor(elem_arg, state), dof_number);
200 }
PINSFVMomentumFriction::computeFrictionWCoefficient
ADReal computeFrictionWCoefficient(const Moose::ElemArg &elem_arg, const Moose::StateArg &state)
Computes the friction coefficient which gets multiplied by the velocity.
Definition: PINSFVMomentumFriction.C:119
INSFVElementalKernel::addResidualAndJacobian
void addResidualAndJacobian(const ADReal &residual, dof_id_type dof)
Process into either the system residual or Jacobian.
Definition: INSFVElementalKernel.C:60
MooseVariableFV< Real >::number
unsigned int number() const
FVElementalKernel::determineState
Moose::StateArg determineState() const
INSFVMomentumResidualObject::_index
const unsigned int _index
index x|y|z
Definition: INSFVMomentumResidualObject.h:58
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
FVElementalKernel::_sys
SystemBase & _sys
FVElementalKernel::makeElemArg
Moose::ElemArg makeElemArg(const Elem *elem, bool correct_skewnewss=false) const
Assembly::elementVolume
Real elementVolume(const Elem *elem) const
SystemBase::number
unsigned int number() const
FVElementalKernel::_assembly
Assembly & _assembly
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.
FVElementalKernel::_u_functor
const Moose::Functor< ADReal > & _u_functor
FVElementalKernel::_var
MooseVariableFV< Real > & _var

◆ gatherRCData() [5/5]

void INSFVElementalKernel::gatherRCData ( const FaceInfo &  fi)
inlinefinaloverridevirtualinherited

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 25 of file INSFVElementalKernel.h.

25 {}

◆ validParams()

InputParameters PINSFVMomentumFriction::validParams ( )
static

Definition at line 19 of file PINSFVMomentumFriction.C.

20 {
21  InputParameters params = INSFVElementalKernel::validParams();
22  params.addClassDescription(
23  "Computes a friction force term on fluid in porous media in the "
24  "Navier Stokes i-th momentum equation in Rhie-Chow (incompressible) contexts.");
25  params.addParam<MooseFunctorName>("Darcy_name", "Name of the Darcy coefficients property.");
26  params.addParam<MooseFunctorName>("Forchheimer_name",
27  "Name of the Forchheimer coefficients property.");
28  params.addParam<bool>("is_porous_medium", true, "Boolean to choose the type of medium.");
29  params.addParam<bool>(
30  "standard_friction_formulation", true, "Boolean to choose the type of friction formulation.");
31  params.addParam<MooseFunctorName>(NS::mu, "The dynamic viscosity");
32  params.addParam<MooseFunctorName>(NS::speed, "The magnitude of the interstitial velocity.");
33  params.addParam<MooseFunctorName>("u",
34  "The velocity in the x direction. Superficial in the case of "
35  "porous treatment, interstitial otherwise");
36  params.addParam<MooseFunctorName>("v",
37  "The velocity in the y direction. Superficial in the case of "
38  "porous treatment, interstitial otherwise");
39  params.addParam<MooseFunctorName>("w",
40  "The velocity in the z direction. Superficial in the case of "
41  "porous treatment, interstitial otherwise");
42  params.addParam<MooseFunctorName>(NS::porosity, 1.0, "The porosity");
43  params.addRequiredParam<MooseFunctorName>(NS::density, "The density.");
44  return params;
45 }
NS::speed
static const std::string speed
Definition: NS.h:143
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
NS::density
static const std::string density
Definition: NS.h:33
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
NS::porosity
static const std::string porosity
Definition: NS.h:104
NS::mu
static const std::string mu
Definition: NS.h:123
INSFVElementalKernel::validParams
static InputParameters validParams()
Definition: INSFVElementalKernel.C:13
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _D

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

Darcy coefficient.

Definition at line 34 of file PINSFVMomentumFriction.h.

◆ _dim

const unsigned int PINSFVMomentumFriction::_dim
protected

The dimension of the domain.

Definition at line 51 of file PINSFVMomentumFriction.h.

Referenced by computeFrictionWCoefficient(), and PINSFVMomentumFriction().

◆ _epsilon

const Moose::Functor<ADReal>& PINSFVMomentumFriction::_epsilon
protected

Adding porosity functor.

Definition at line 59 of file PINSFVMomentumFriction.h.

Referenced by computeFrictionWCoefficient().

◆ _F

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

Forchheimer coefficient.

Definition at line 36 of file PINSFVMomentumFriction.h.

◆ _index

const unsigned int INSFVMomentumResidualObject::_index
protectedinherited

index x|y|z

Definition at line 58 of file INSFVMomentumResidualObject.h.

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

◆ _is_porous_medium

const bool PINSFVMomentumFriction::_is_porous_medium
protected

Definition at line 40 of file PINSFVMomentumFriction.h.

Referenced by computeFrictionWCoefficient().

◆ _mu

const Moose::Functor<ADReal>* const PINSFVMomentumFriction::_mu
protected

Dynamic viscosity.

Definition at line 44 of file PINSFVMomentumFriction.h.

Referenced by PINSFVMomentumFriction().

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

◆ _rho

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

Density as a functor.

Definition at line 46 of file PINSFVMomentumFriction.h.

Referenced by computeFrictionWCoefficient().

◆ _speed

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

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

Definition at line 48 of file PINSFVMomentumFriction.h.

Referenced by computeFrictionWCoefficient(), and PINSFVMomentumFriction().

◆ _standard_friction_formulation

const bool PINSFVMomentumFriction::_standard_friction_formulation
protected

Definition at line 41 of file PINSFVMomentumFriction.h.

Referenced by computeFrictionWCoefficient(), and PINSFVMomentumFriction().

◆ _u_var

const Moose::Functor<ADReal>* PINSFVMomentumFriction::_u_var
protected

x-velocity

Definition at line 53 of file PINSFVMomentumFriction.h.

Referenced by PINSFVMomentumFriction().

◆ _use_Darcy_friction_model

const bool PINSFVMomentumFriction::_use_Darcy_friction_model
protected

Booleans to select the right models.

Definition at line 38 of file PINSFVMomentumFriction.h.

Referenced by computeFrictionWCoefficient(), and PINSFVMomentumFriction().

◆ _use_Forchheimer_friction_model

const bool PINSFVMomentumFriction::_use_Forchheimer_friction_model
protected

Definition at line 39 of file PINSFVMomentumFriction.h.

Referenced by computeFrictionWCoefficient(), and PINSFVMomentumFriction().

◆ _v_var

const Moose::Functor<ADReal>* PINSFVMomentumFriction::_v_var
protected

y-velocity

Definition at line 55 of file PINSFVMomentumFriction.h.

Referenced by PINSFVMomentumFriction().

◆ _w_var

const Moose::Functor<ADReal>* PINSFVMomentumFriction::_w_var
protected

z-velocity

Definition at line 57 of file PINSFVMomentumFriction.h.

Referenced by PINSFVMomentumFriction().

The documentation for this class was generated from the following files:
Generated on Fri Jul 18 2025 13:49:47 for https://mooseframework.inl.gov by   doxygen 1.8.14