Loading [MathJax]/extensions/tex2jax.js
https://mooseframework.inl.gov
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
RhieChowInterpolatorBase Class Referenceabstract

#include <RhieChowInterpolatorBase.h>

Inheritance diagram for RhieChowInterpolatorBase:
[legend]

Public Types

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

Public Member Functions

 RhieChowInterpolatorBase (const InputParameters &params)
 
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. More...
 
virtual VectorValue< ADReal > getVelocity (const Moose::FV::InterpMethod m, const FaceInfo &fi, const Moose::StateArg &time, const THREAD_ID tid, bool subtract_mesh_velocity) const =0
 Retrieve a face velocity. More...
 
virtual Real getVolumetricFaceFlux (const Moose::FV::InterpMethod m, const FaceInfo &fi, const Moose::StateArg &time, const THREAD_ID tid, bool subtract_mesh_velocity) const override
 Retrieve the volumetric face flux, will not include derivatives. More...
 
Moose::FV::InterpMethod velocityInterpolationMethod () const
 Return the interpolation method used for velocity. More...
 
virtual void ghostADataOnBoundary (const BoundaryID)
 makes sure coefficient data gets communicated on both sides of a given boundary. More...
 
const INSFVPressureVariable & pressure (THREAD_ID tid) const
 
const INSFVVelocityVariable * vel () const
 
virtual bool segregated () const =0
 Bool of the Rhie Chow user object is used in monolithic/segregated approaches. More...
 
bool hasFaceSide (const FaceInfo &fi, const bool fi_elem_side) const override
 
virtual bool supportMeshVelocity () const
 Returns whether the UO can support mesh velocity advection. More...
 
virtual void execute ()=0
 
virtual void initialize ()=0
 
virtual void finalize ()=0
 
SubProblem & getSubProblem () const
 
bool shouldDuplicateInitialExecution () const
 
virtual Real spatialValue (const Point &) const
 
virtual const std::vector< Point > spatialPoints () const
 
void gatherSum (T &value)
 
void gatherMax (T &value)
 
void gatherMin (T &value)
 
void gatherProxyValueMax (T1 &proxy, T2 &value)
 
void gatherProxyValueMin (T1 &proxy, T2 &value)
 
void setPrimaryThreadCopy (UserObject *primary)
 
UserObject * primaryThreadCopy ()
 
std::set< UserObjectName > getDependObjects () const
 
virtual bool needThreadedCopy () const
 
const std::set< std::string > & getRequestedItems () override
 
const std::set< std::string > & getSuppliedItems () override
 
unsigned int systemNumber () const
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
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 customSetup (const ExecFlagType &)
 
const ExecFlagEnum & getExecuteOnEnum () const
 
UserObjectName getUserObjectName (const std::string &param_name) const
 
const T & getUserObject (const std::string &param_name, bool is_dependency=true) const
 
const T & getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const
 
const UserObject & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObject & getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
 
const std::vector< MooseVariableScalar *> & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty (const MaterialPropertyName &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty ()
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialPropertyByName (const std::string &prop_name)
 
const MaterialProperty< T > & getZeroMaterialProperty (Ts... args)
 
std::set< SubdomainID > getMaterialPropertyBlocks (const std::string &name)
 
std::vector< SubdomainName > getMaterialPropertyBlockNames (const std::string &name)
 
std::set< BoundaryID > getMaterialPropertyBoundaryIDs (const std::string &name)
 
std::vector< BoundaryName > getMaterialPropertyBoundaryNames (const std::string &name)
 
void checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)
 
std::unordered_map< SubdomainID, std::vector< MaterialBase *> > buildRequiredMaterials (bool allow_stateful=true)
 
void statefulPropertiesAllowed (bool)
 
bool getMaterialPropertyCalled () const
 
virtual const std::unordered_set< unsigned int > & getMatPropDependencies () const
 
virtual void resolveOptionalProperties ()
 
const GenericMaterialProperty< T, is_ad > & getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)
 
bool isImplicit ()
 
Moose::StateArg determineState () const
 
virtual void threadJoin (const UserObject &) override
 
virtual void threadJoin (const UserObject &) override
 
virtual void subdomainSetup () override
 
virtual void subdomainSetup () override
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
const Function & getFunction (const std::string &name) const
 
const Function & getFunctionByName (const FunctionName &name) const
 
bool hasFunction (const std::string &param_name) const
 
bool hasFunctionByName (const FunctionName &name) const
 
bool isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessor (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessorByName (const PostprocessorName &name) const
 
std::size_t coupledPostprocessors (const std::string &param_name) const
 
const PostprocessorName & getPostprocessorName (const std::string &param_name, const unsigned int index=0) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name) const
 
const VectorPostprocessorName & getVectorPostprocessorName (const std::string &param_name) const
 
T & getSampler (const std::string &name)
 
Sampler & getSampler (const std::string &name)
 
T & getSamplerByName (const SamplerName &name)
 
Sampler & getSamplerByName (const SamplerName &name)
 
virtual void meshChanged ()
 
PerfGraph & perfGraph ()
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
const Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 
const std::vector< SubdomainName > & blocks () const
 
unsigned int numBlocks () const
 
virtual const std::set< SubdomainID > & blockIDs () const
 
unsigned int blocksMaxDimension () const
 
bool hasBlocks (const SubdomainName &name) const
 
bool hasBlocks (const std::vector< SubdomainName > &names) const
 
bool hasBlocks (const std::set< SubdomainName > &names) const
 
bool hasBlocks (SubdomainID id) const
 
bool hasBlocks (const std::vector< SubdomainID > &ids) const
 
bool hasBlocks (const std::set< SubdomainID > &ids) const
 
bool isBlockSubset (const std::set< SubdomainID > &ids) const
 
bool isBlockSubset (const std::vector< SubdomainID > &ids) const
 
bool hasBlockMaterialProperty (const std::string &prop_name)
 
const std::set< SubdomainID > & meshBlockIDs () const
 
virtual bool blockRestricted () const
 
virtual void checkVariable (const MooseVariableFieldBase &variable) const
 
void useVectorTag (const TagName &tag_name, VectorTagsKey)
 
void useVectorTag (TagID tag_id, VectorTagsKey)
 
void useMatrixTag (const TagName &tag_name, MatrixTagsKey)
 
void useMatrixTag (TagID tag_id, MatrixTagsKey)
 
bool isVectorTagged ()
 
bool isMatrixTagged ()
 
bool hasVectorTags () const
 
const std::set< TagID > & getVectorTags (VectorTagsKey) const
 
const std::set< TagID > & getMatrixTags (MatrixTagsKey) const
 

Static Public Member Functions

static InputParameters validParams ()
 
static void sort (typename std::vector< T > &vector)
 
static void sortDFS (typename std::vector< T > &vector)
 
static void cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)
 
static std::string deduceFunctorName (const std::string &name, const InputParameters &params)
 

Public Attributes

const ConsoleStream _console
 

Static Public Attributes

static constexpr PropertyValue::id_type default_property_id
 
static constexpr PropertyValue::id_type zero_property_id
 
static constexpr auto SYSTEM
 
static constexpr auto NAME
 

Protected Member Functions

virtual const Moose::FunctorBase< ADReal > & epsilon (THREAD_ID tid) const
 A virtual method that allows us to only implement getVelocity once for free and porous flows. More...
 
template<typename Container >
void fillContainer (const std::string &var_name, Container &container)
 Fill the passed-in variable container with the thread copies of var_name. More...
 
template<typename VarType >
void checkBlocks (const VarType &var) const
 Check the block consistency between the passed in var and us. More...
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &name) const override
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override
 
virtual void addUserObjectDependencyHelper (const UserObject &uo) const override
 
void addReporterDependencyHelper (const ReporterName &reporter_name) override
 
const ReporterName & getReporterName (const std::string &param_name) const
 
T & declareRestartableData (const std::string &data_name, Args &&... args)
 
ManagedValue< T > declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
const T & getRestartableData (const std::string &data_name) const
 
T & declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
T & declareRecoverableData (const std::string &data_name, Args &&... args)
 
T & declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
 
T & declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
 
std::string restartableName (const std::string &data_name) const
 
const T & getMeshProperty (const std::string &data_name, const std::string &prefix)
 
const T & getMeshProperty (const std::string &data_name)
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name) const
 
bool hasMeshProperty (const std::string &data_name) const
 
std::string meshPropertyName (const std::string &data_name) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_name) const
 
bool isCoupledScalar (const std::string &var_name, unsigned int i=0) const
 
unsigned int coupledScalarComponents (const std::string &var_name) const
 
unsigned int coupledScalar (const std::string &var_name, unsigned int comp=0) const
 
libMesh::Order coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< is_ad > & coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const VariableValue & coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const MooseVariableScalar * getScalarVar (const std::string &var_name, unsigned int comp) const
 
virtual void checkMaterialProperty (const std::string &name, const unsigned int state)
 
void markMatPropRequested (const std::string &)
 
MaterialPropertyName getMaterialPropertyName (const std::string &name) const
 
void checkExecutionStage ()
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 
virtual bool hasBlockMaterialPropertyHelper (const std::string &prop_name)
 
void initializeBlockRestrictable (const MooseObject *moose_object)
 
Moose::CoordinateSystemType getBlockCoordSystem ()
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTagNeighbor (Assembly &assembly, unsigned int ivar)
 
void prepareVectorTagLower (Assembly &assembly, unsigned int ivar)
 
void prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar)
 
void prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar, DenseMatrix< Number > &k) const
 
void prepareMatrixTagNonlocal (Assembly &assembly, unsigned int ivar, unsigned int jvar)
 
void prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type)
 
void prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, DenseMatrix< Number > &k) const
 
void prepareMatrixTagLower (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::ConstraintJacobianType type)
 
void accumulateTaggedLocalResidual ()
 
void assignTaggedLocalResidual ()
 
void accumulateTaggedLocalMatrix ()
 
void accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, const DenseMatrix< Number > &k)
 
void accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, const DenseMatrix< Number > &k)
 
void accumulateTaggedNonlocalMatrix ()
 
void assignTaggedLocalMatrix ()
 
void addResiduals (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResiduals (Assembly &assembly, const DenseVector< T > &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResiduals (Assembly &assembly, const ADResidualsPacket &packet)
 
void addResidualsAndJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResidualsAndJacobian (Assembly &assembly, const ADResidualsPacket &packet)
 
void addJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobian (Assembly &assembly, const ADResidualsPacket &packet)
 
void addJacobian (Assembly &assembly, DenseMatrix< Real > &local_k, const std::vector< dof_id_type > &row_indices, const std::vector< dof_id_type > &column_indices, Real scaling_factor)
 
void addResidualsWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResidualsAndJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobianElement (Assembly &assembly, Real value, dof_id_type row_index, dof_id_type column_index, Real scaling_factor)
 
void setResidual (SystemBase &sys, const T &residual, MooseVariableFE< T > &var)
 
void setResidual (SystemBase &sys, Real residual, dof_id_type dof_index)
 
void setResidual (SystemBase &sys, SetResidualFunctor set_residual_functor)
 
std::string deduceFunctorName (const std::string &name) const
 
const Moose::Functor< T > & getFunctor (const std::string &name)
 
const Moose::Functor< T > & getFunctor (const std::string &name, THREAD_ID tid)
 
const Moose::Functor< T > & getFunctor (const std::string &name, SubProblem &subproblem)
 
const Moose::Functor< T > & getFunctor (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
 
bool isFunctor (const std::string &name) const
 
bool isFunctor (const std::string &name, const SubProblem &subproblem) const
 
Moose::ElemArg makeElemArg (const Elem *elem, bool correct_skewnewss=false) const
 
void checkFunctorSupportsSideIntegration (const std::string &name, bool qp_integration)
 

Static Protected Member Functions

static std::string meshPropertyName (const std::string &data_name, const std::string &prefix)
 

Protected Attributes

MooseMesh & _moose_mesh
 The MooseMesh that this user object operates on. More...
 
const libMesh::MeshBase & _mesh
 The libMesh mesh that this object acts on. More...
 
const unsigned int _dim
 The dimension of the mesh, e.g. 3 for hexes and tets, 2 for quads and tris. More...
 
INSFVPressureVariable *const _p
 The thread 0 copy of the pressure variable. More...
 
INSFVVelocityVariable *const _u
 The thread 0 copy of the x-velocity variable. More...
 
INSFVVelocityVariable *const _v
 The thread 0 copy of the y-velocity variable (null if the problem is 1D) More...
 
INSFVVelocityVariable *const _w
 The thread 0 copy of the z-velocity variable (null if the problem is not 3D) More...
 
std::vector< MooseVariableFVReal * > _ps
 All the thread copies of the pressure variable. More...
 
std::vector< MooseVariableFVReal * > _us
 All the thread copies of the x-velocity variable. More...
 
std::vector< MooseVariableFVReal * > _vs
 All the thread copies of the y-velocity variable. More...
 
std::vector< MooseVariableFVReal * > _ws
 All the thread copies of the z-velocity variable. More...
 
std::vector< unsigned int > _var_numbers
 The velocity variable numbers. More...
 
SystemBase & _sys
 The nonlinear system. More...
 
Moose::FV::InterpMethod _velocity_interp_method
 The interpolation method to use for the velocity. More...
 
const bool _displaced
 Whether this object is operating on the displaced mesh. More...
 
SubProblem & _subproblem
 
FEProblemBase & _fe_problem
 
const THREAD_ID _tid
 
Assembly & _assembly
 
const Moose::CoordinateSystemType & _coord_sys
 
const bool _duplicate_initial_execution
 
std::set< std::string > _depend_uo
 
const bool & _enabled
 
MooseApp & _app
 
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
 
MooseApp & _restartable_app
 
const std::string _restartable_system_name
 
const THREAD_ID _restartable_tid
 
const bool _restartable_read_only
 
FEProblemBase & _mci_feproblem
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
FEProblemBase & _sc_fe_problem
 
const THREAD_ID _sc_tid
 
const Real & _real_zero
 
const VariableValue & _scalar_zero
 
const Point & _point_zero
 
const InputParameters & _mi_params
 
const std::string _mi_name
 
const MooseObjectName _mi_moose_object_name
 
FEProblemBase & _mi_feproblem
 
SubProblem & _mi_subproblem
 
const THREAD_ID _mi_tid
 
const Moose::MaterialDataType _material_data_type
 
MaterialData & _material_data
 
bool _stateful_allowed
 
bool _get_material_property_called
 
std::vector< std::unique_ptr< PropertyValue > > _default_properties
 
std::unordered_set< unsigned int > _material_property_dependencies
 
const MaterialPropertyName _get_suffix
 
const bool _use_interpolated_state
 
const InputParameters & _ti_params
 
FEProblemBase & _ti_feproblem
 
bool _is_implicit
 
Real & _t
 
const Real & _t_old
 
int & _t_step
 
Real & _dt
 
Real & _dt_old
 
bool _is_transient
 
const Parallel::Communicator & _communicator
 
const MaterialData * _blk_material_data
 
SubProblem & _subproblem
 
DenseVector< Number > _local_re
 
DenseMatrix< Number > _local_ke
 
DenseMatrix< Number > _nonlocal_ke
 

Static Protected Attributes

static const std::string _interpolated_old
 
static const std::string _interpolated_older
 

Private Attributes

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

Detailed Description

Definition at line 31 of file RhieChowInterpolatorBase.h.

Constructor & Destructor Documentation

◆ RhieChowInterpolatorBase()

RhieChowInterpolatorBase::RhieChowInterpolatorBase ( const InputParameters &  params)

Definition at line 65 of file RhieChowInterpolatorBase.C.

66  : RhieChowFaceFluxProvider(params),
67  TaggingInterface(this),
68  ADFunctorInterface(this),
69  _moose_mesh(UserObject::_subproblem.mesh()),
70  _mesh(_moose_mesh.getMesh()),
71  _dim(blocksMaxDimension()),
72  _p(dynamic_cast<INSFVPressureVariable *>(
73  &UserObject::_subproblem.getVariable(0, getParam<VariableName>(NS::pressure)))),
74  _u(dynamic_cast<INSFVVelocityVariable *>(
75  &UserObject::_subproblem.getVariable(0, getParam<VariableName>("u")))),
76  _v(isParamValid("v") ? dynamic_cast<INSFVVelocityVariable *>(
77  &UserObject::_subproblem.getVariable(0, getParam<VariableName>("v")))
78  : nullptr),
79  _w(isParamValid("w") ? dynamic_cast<INSFVVelocityVariable *>(
80  &UserObject::_subproblem.getVariable(0, getParam<VariableName>("w")))
81  : nullptr),
82  _ps(libMesh::n_threads(), nullptr),
83  _us(libMesh::n_threads(), nullptr),
84  _vs(libMesh::n_threads(), nullptr),
85  _ws(libMesh::n_threads(), nullptr),
86  _sys(*getCheckedPointerParam<SystemBase *>("_sys")),
87  _displaced(dynamic_cast<DisplacedProblem *>(&(UserObject::_subproblem)))
88 {
89  if (!_p)
90  paramError(NS::pressure, "the pressure must be a INSFVPressureVariable.");
91  checkBlocks(*_p);
92 
93  if (!_u)
94  paramError("u", "the u velocity must be an INSFVVelocityVariable.");
95  checkBlocks(*_u);
96  _var_numbers.push_back(_u->number());
97 
98  if (_dim >= 2)
99  {
100  if (!_v)
101  mooseError("In two or more dimensions, the v velocity must be supplied and it must be an "
102  "INSFVVelocityVariable.");
103  checkBlocks(*_v);
104  _var_numbers.push_back(_v->number());
105  }
106 
107  if (_dim >= 3)
108  {
109  if (!_w)
110  mooseError("In three-dimensions, the w velocity must be supplied and it must be an "
111  "INSFVVelocityVariable.");
112  checkBlocks(*_w);
113  _var_numbers.push_back(_w->number());
114  }
115 
116  fillContainer(NS::pressure, _ps);
117  fillContainer("u", _us);
118 
119  if (_dim >= 2)
120  {
121  fillContainer("v", _vs);
122  if (_v->faceInterpolationMethod() != _u->faceInterpolationMethod())
123  mooseError("x and y velocity component face interpolation methods do not match");
124 
125  if (_dim >= 3)
126  {
127  fillContainer("w", _ws);
128  if (_w->faceInterpolationMethod() != _u->faceInterpolationMethod())
129  mooseError("x and z velocity component face interpolation methods do not match");
130  }
131  }
132 
133  if (&(UserObject::_subproblem) != &(TaggingInterface::_subproblem))
134  mooseError("Different subproblems in RhieChowInterpolatorBase!");
135 
136  const auto & velocity_interp_method = params.get<MooseEnum>("velocity_interp_method");
137  if (velocity_interp_method == "average")
138  _velocity_interp_method = Moose::FV::InterpMethod::Average;
139  else if (velocity_interp_method == "rc")
140  _velocity_interp_method = Moose::FV::InterpMethod::RhieChow;
141 }
BlockRestrictable::blocksMaxDimension
unsigned int blocksMaxDimension() const
RhieChowInterpolatorBase::_p
INSFVPressureVariable *const _p
The thread 0 copy of the pressure variable.
Definition: RhieChowInterpolatorBase.h:116
RhieChowInterpolatorBase::_ps
std::vector< MooseVariableFVReal * > _ps
All the thread copies of the pressure variable.
Definition: RhieChowInterpolatorBase.h:128
TaggingInterface::_subproblem
SubProblem & _subproblem
libMesh::n_threads
unsigned int n_threads()
RhieChowInterpolatorBase::_sys
SystemBase & _sys
The nonlinear system.
Definition: RhieChowInterpolatorBase.h:143
RhieChowInterpolatorBase::_moose_mesh
MooseMesh & _moose_mesh
The MooseMesh that this user object operates on.
Definition: RhieChowInterpolatorBase.h:107
RhieChowInterpolatorBase::_u
INSFVVelocityVariable *const _u
The thread 0 copy of the x-velocity variable.
Definition: RhieChowInterpolatorBase.h:119
MooseVariableFV< Real >::number
unsigned int number() const
InputParameters::get
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
RhieChowInterpolatorBase::_v
INSFVVelocityVariable *const _v
The thread 0 copy of the y-velocity variable (null if the problem is 1D)
Definition: RhieChowInterpolatorBase.h:122
RhieChowFaceFluxProvider::RhieChowFaceFluxProvider
RhieChowFaceFluxProvider(const InputParameters &params)
Definition: RhieChowFaceFluxProvider.C:23
mesh
MeshBase & mesh
RhieChowInterpolatorBase::_displaced
const bool _displaced
Whether this object is operating on the displaced mesh.
Definition: RhieChowInterpolatorBase.h:149
UserObject::_subproblem
SubProblem & _subproblem
GeneralUserObject::isParamValid
bool isParamValid(const std::string &name) const
RhieChowInterpolatorBase::_us
std::vector< MooseVariableFVReal * > _us
All the thread copies of the x-velocity variable.
Definition: RhieChowInterpolatorBase.h:131
TaggingInterface::TaggingInterface
TaggingInterface(const MooseObject *moose_object)
MooseMesh::getMesh
MeshBase & getMesh()
RhieChowInterpolatorBase::_dim
const unsigned int _dim
The dimension of the mesh, e.g. 3 for hexes and tets, 2 for quads and tris.
Definition: RhieChowInterpolatorBase.h:113
GeneralUserObject::paramError
void paramError(const std::string &param, Args... args) const
SubProblem::getVariable
virtual const MooseVariableFieldBase & getVariable(const THREAD_ID tid, const std::string &var_name, Moose::VarKindType expected_var_type=Moose::VarKindType::VAR_ANY, Moose::VarFieldType expected_var_field_type=Moose::VarFieldType::VAR_FIELD_ANY) const=0
RhieChowInterpolatorBase::_velocity_interp_method
Moose::FV::InterpMethod _velocity_interp_method
The interpolation method to use for the velocity.
Definition: RhieChowInterpolatorBase.h:146
RhieChowInterpolatorBase::fillContainer
void fillContainer(const std::string &var_name, Container &container)
Fill the passed-in variable container with the thread copies of var_name.
Definition: RhieChowInterpolatorBase.h:171
RhieChowInterpolatorBase::_mesh
const libMesh::MeshBase & _mesh
The libMesh mesh that this object acts on.
Definition: RhieChowInterpolatorBase.h:110
RhieChowInterpolatorBase::checkBlocks
void checkBlocks(const VarType &var) const
Check the block consistency between the passed in var and us.
Definition: RhieChowInterpolatorBase.h:184
MooseVariableFV< Real >::faceInterpolationMethod
Moose::FV::InterpMethod faceInterpolationMethod() const
RhieChowInterpolatorBase::_w
INSFVVelocityVariable *const _w
The thread 0 copy of the z-velocity variable (null if the problem is not 3D)
Definition: RhieChowInterpolatorBase.h:125
RhieChowInterpolatorBase::_var_numbers
std::vector< unsigned int > _var_numbers
The velocity variable numbers.
Definition: RhieChowInterpolatorBase.h:140
NS::pressure
static const std::string pressure
Definition: NS.h:56
GeneralUserObject::mooseError
void mooseError(Args &&... args) const
ADFunctorInterface::ADFunctorInterface
ADFunctorInterface(const MooseObject *moose_object)
RhieChowInterpolatorBase::_ws
std::vector< MooseVariableFVReal * > _ws
All the thread copies of the z-velocity variable.
Definition: RhieChowInterpolatorBase.h:137
RhieChowInterpolatorBase::_vs
std::vector< MooseVariableFVReal * > _vs
All the thread copies of the y-velocity variable.
Definition: RhieChowInterpolatorBase.h:134

Member Function Documentation

◆ addToA()

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

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

This is only supposed to be called if we are using an implicit pressure-velocity coupling in a monolithic solve.

Parameters
Theelement we are adding 'a' coefficient data for
componentThe velocity component we are adding 'a' coefficient data for
valueThe value of 'a' that we are adding

Implemented in INSFVRhieChowInterpolator, and INSFVRhieChowInterpolatorSegregated.

Referenced by PINSFVMomentumFrictionCorrection::gatherRCData(), INSFVMomentumTimeDerivative::gatherRCData(), PINSFVMomentumFriction::gatherRCData(), INSFVMomentumMeshAdvection::gatherRCData(), WCNSFV2PMomentumDriftFlux::gatherRCData(), WCNSFVMomentumTimeDerivative::gatherRCData(), INSFVMixingLengthReynoldsStress::gatherRCData(), INSFVWallFunctionBC::gatherRCData(), INSFVSymmetryVelocityBC::gatherRCData(), INSFVMomentumDiffusion::gatherRCData(), PINSFVFunctorBC::gatherRCData(), INSFVMomentumAdvectionOutflowBC::gatherRCData(), and INSFVMomentumAdvection::gatherRCData().

◆ checkBlocks()

template<typename VarType >
void RhieChowInterpolatorBase::checkBlocks ( const VarType &  var) const
protected

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

Definition at line 184 of file RhieChowInterpolatorBase.h.

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

185 {
186  const auto & var_blocks = var.blockIDs();
187  const auto & uo_blocks = blockIDs();
188 
189  // Error if this UO has any blocks that the variable does not
190  std::set<SubdomainID> uo_blocks_minus_var_blocks;
191  std::set_difference(uo_blocks.begin(),
192  uo_blocks.end(),
193  var_blocks.begin(),
194  var_blocks.end(),
195  std::inserter(uo_blocks_minus_var_blocks, uo_blocks_minus_var_blocks.end()));
196  if (uo_blocks_minus_var_blocks.size() > 0)
197  mooseError("Block restriction of interpolator user object '",
198  this->name(),
199  "' (",
200  Moose::stringify(blocks()),
201  ") includes blocks not in the block restriction of variable '",
202  var.name(),
203  "' (",
204  Moose::stringify(var.blocks()),
205  ")");
206 
207  // Get the blocks in the variable but not this UO
208  std::set<SubdomainID> var_blocks_minus_uo_blocks;
209  std::set_difference(var_blocks.begin(),
210  var_blocks.end(),
211  uo_blocks.begin(),
212  uo_blocks.end(),
213  std::inserter(var_blocks_minus_uo_blocks, var_blocks_minus_uo_blocks.end()));
214 
215  // For each block in the variable but not this UO, error if there is connection
216  // to any blocks on the UO.
217  for (auto & block_id : var_blocks_minus_uo_blocks)
218  {
219  const auto connected_blocks = _moose_mesh.getBlockConnectedBlocks(block_id);
220  std::set<SubdomainID> connected_blocks_on_uo;
221  std::set_intersection(connected_blocks.begin(),
222  connected_blocks.end(),
223  uo_blocks.begin(),
224  uo_blocks.end(),
225  std::inserter(connected_blocks_on_uo, connected_blocks_on_uo.end()));
226  if (connected_blocks_on_uo.size() > 0)
227  mooseError("Block restriction of interpolator user object '",
228  this->name(),
229  "' (",
230  Moose::stringify(uo_blocks),
231  ") doesn't match the block restriction of variable '",
232  var.name(),
233  "' (",
234  Moose::stringify(var_blocks),
235  ")");
236  }
237 }
RhieChowInterpolatorBase::_moose_mesh
MooseMesh & _moose_mesh
The MooseMesh that this user object operates on.
Definition: RhieChowInterpolatorBase.h:107
MooseMesh::getBlockConnectedBlocks
const std::set< SubdomainID > & getBlockConnectedBlocks(const SubdomainID subdomain_id) const
BlockRestrictable::blockIDs
virtual const std::set< SubdomainID > & blockIDs() const
GeneralUserObject::name
virtual const std::string & name() const
Moose::stringify
std::string stringify(const T &t)
BlockRestrictable::blocks
const std::vector< SubdomainName > & blocks() const
GeneralUserObject::mooseError
void mooseError(Args &&... args) const

◆ epsilon()

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

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

Reimplemented in PINSFVRhieChowInterpolator, and PINSFVRhieChowInterpolatorSegregated.

Definition at line 157 of file RhieChowInterpolatorBase.h.

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

158 {
159  return _unity_functor;
160 }
RhieChowInterpolatorBase::_unity_functor
const Moose::ConstantFunctor< ADReal > _unity_functor
A unity functor used in the epsilon virtual method.
Definition: RhieChowInterpolatorBase.h:153

◆ fillContainer()

template<typename Container >
void RhieChowInterpolatorBase::fillContainer ( const std::string &  var_name,
Container &  container 
)
protected

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

Definition at line 171 of file RhieChowInterpolatorBase.h.

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

172 {
173  typedef typename Container::value_type ContainedType;
174  for (const auto tid : make_range(libMesh::n_threads()))
175  {
176  auto * const var = static_cast<ContainedType>(
177  &UserObject::_subproblem.getVariable(tid, getParam<VariableName>(name)));
178  container[tid] = var;
179  }
180 }
libMesh::n_threads
unsigned int n_threads()
GeneralUserObject::name
virtual const std::string & name() const
UserObject::_subproblem
SubProblem & _subproblem
SubProblem::getVariable
virtual const MooseVariableFieldBase & getVariable(const THREAD_ID tid, const std::string &var_name, Moose::VarKindType expected_var_type=Moose::VarKindType::VAR_ANY, Moose::VarFieldType expected_var_field_type=Moose::VarFieldType::VAR_FIELD_ANY) const=0
make_range
IntRange< T > make_range(T beg, T end)

◆ getVelocity()

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

Retrieve a face velocity.

Parameters
mThe velocity interpolation method. This is either Rhie-Chow or Average. Rhie-Chow is recommended as it avoids checkerboards in the pressure field
fiThe face that we wish to retrieve the velocity for
tidThe thread ID
Returns
The face velocity

Implemented in INSFVRhieChowInterpolator, and INSFVRhieChowInterpolatorSegregated.

Referenced by INSFVTurbulentAdvection::computeQpResidual(), INSFVSymmetryVelocityBC::computeSegregatedContribution(), INSFVMomentumAdvectionOutflowBC::computeSegregatedContribution(), getVolumetricFaceFlux(), and INSFVAdvectionKernel::velocity().

◆ getVolumetricFaceFlux()

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

Retrieve the volumetric face flux, will not include derivatives.

Parameters
mThe velocity interpolation method. This is either Rhie-Chow or Average. Rhie-Chow is recommended as it avoids checkerboards in the pressure field
fiThe face that we wish to retrieve the velocity for
tidThe thread ID
Returns
The face velocity

Implements RhieChowFaceFluxProvider.

Definition at line 144 of file RhieChowInterpolatorBase.C.

149 {
150  return raw_value(this->getVelocity(m, fi, time, tid, subtract_mesh_velocity)) * fi.normal();
151 }
raw_value
auto raw_value(const Eigen::Map< T > &in)
RhieChowInterpolatorBase::getVelocity
virtual VectorValue< ADReal > getVelocity(const Moose::FV::InterpMethod m, const FaceInfo &fi, const Moose::StateArg &time, const THREAD_ID tid, bool subtract_mesh_velocity) const =0
Retrieve a face velocity.
FaceInfo::normal
const Point & normal() const

◆ ghostADataOnBoundary()

virtual void RhieChowInterpolatorBase::ghostADataOnBoundary ( const BoundaryID  )
inlinevirtual

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

This is a virtual function, mostly used for monolithic approaches.

Reimplemented in INSFVRhieChowInterpolator.

Definition at line 76 of file RhieChowInterpolatorBase.h.

Referenced by VolumetricFlowRate::initialSetup().

76 {}

◆ hasFaceSide()

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

Implements FaceArgInterface.

Definition at line 29 of file RhieChowFaceFluxProvider.C.

30 {
31  if (fi_elem_side)
32  return hasBlocks(fi.elem().subdomain_id());
33  else
34  return fi.neighborPtr() && hasBlocks(fi.neighbor().subdomain_id());
35 }
FaceInfo::elem
const Elem & elem() const
FaceInfo::neighborPtr
const Elem * neighborPtr() const
FaceInfo::neighbor
const Elem & neighbor() const
libMesh::Elem::subdomain_id
subdomain_id_type subdomain_id() const
BlockRestrictable::hasBlocks
bool hasBlocks(const SubdomainName &name) const

◆ pressure()

const INSFVPressureVariable & RhieChowInterpolatorBase::pressure ( THREAD_ID  tid) const
inline
Returns
The pressure variable corresponding to the provided thread ID

Definition at line 163 of file RhieChowInterpolatorBase.h.

164 {
165  mooseAssert(tid < _ps.size(), "Attempt to access out-of-bounds in pressure variable container");
166  return *static_cast<INSFVPressureVariable *>(_ps[tid]);
167 }
RhieChowInterpolatorBase::_ps
std::vector< MooseVariableFVReal * > _ps
All the thread copies of the pressure variable.
Definition: RhieChowInterpolatorBase.h:128

◆ segregated()

virtual bool RhieChowInterpolatorBase::segregated ( ) const
pure virtual

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

Implemented in INSFVRhieChowInterpolator, and INSFVRhieChowInterpolatorSegregated.

Referenced by INSFVElementalKernel::computeJacobian(), INSFVFluxBC::computeJacobian(), INSFVFluxKernel::computeJacobian(), INSFVFluxKernel::computeQpResidual(), INSFVFluxBC::computeQpResidual(), INSFVElementalKernel::computeResidual(), INSFVFluxBC::computeResidual(), INSFVFluxKernel::computeResidual(), INSFVFluxBC::computeResidualAndJacobian(), INSFVElementalKernel::computeResidualAndJacobian(), INSFVFluxKernel::computeResidualAndJacobian(), and INSFVWallFunctionBC::INSFVWallFunctionBC().

◆ supportMeshVelocity()

virtual bool RhieChowFaceFluxProvider::supportMeshVelocity ( ) const
inlinevirtualinherited

Returns whether the UO can support mesh velocity advection.

Reimplemented in RhieChowMassFlux.

Definition at line 49 of file RhieChowFaceFluxProvider.h.

Referenced by VolumetricFlowRate::VolumetricFlowRate().

49 { return true; }

◆ validParams()

InputParameters RhieChowInterpolatorBase::validParams ( )
static

Definition at line 38 of file RhieChowInterpolatorBase.C.

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

39 {
40  auto params = RhieChowFaceFluxProvider::validParams();
41  params += TaggingInterface::validParams();
42  params += ADFunctorInterface::validParams();
43 
44  params.addClassDescription(
45  "Computes the Rhie-Chow velocity based on gathered 'a' coefficient data.");
46 
47  // Avoid uninitialized residual objects
48  params.suppressParameter<bool>("force_preic");
49 
50  params.addRequiredParam<VariableName>(NS::pressure, "The pressure variable.");
51  params.addRequiredParam<VariableName>("u", "The x-component of velocity");
52  params.addParam<VariableName>("v", "The y-component of velocity");
53  params.addParam<VariableName>("w", "The z-component of velocity");
54 
55  MooseEnum velocity_interp_method("average rc", "rc");
56  params.addParam<MooseEnum>(
57  "velocity_interp_method",
58  velocity_interp_method,
59  "The interpolation to use for the velocity. Options are "
60  "'average' and 'rc' which stands for Rhie-Chow. The default is Rhie-Chow.");
61 
62  return params;
63 }
ADFunctorInterface::validParams
static InputParameters validParams()
RhieChowFaceFluxProvider::validParams
static InputParameters validParams()
Definition: RhieChowFaceFluxProvider.C:15
NS::pressure
static const std::string pressure
Definition: NS.h:56
TaggingInterface::validParams
static InputParameters validParams()

◆ vel()

const INSFVVelocityVariable* RhieChowInterpolatorBase::vel ( ) const
inline

Definition at line 83 of file RhieChowInterpolatorBase.h.

Referenced by INSFVRhieChowInterpolator::getVelocity().

83 { return _u; }
RhieChowInterpolatorBase::_u
INSFVVelocityVariable *const _u
The thread 0 copy of the x-velocity variable.
Definition: RhieChowInterpolatorBase.h:119

◆ velocityInterpolationMethod()

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

Return the interpolation method used for velocity.

Definition at line 70 of file RhieChowInterpolatorBase.h.

70 { return _velocity_interp_method; }
RhieChowInterpolatorBase::_velocity_interp_method
Moose::FV::InterpMethod _velocity_interp_method
The interpolation method to use for the velocity.
Definition: RhieChowInterpolatorBase.h:146

Member Data Documentation

◆ _dim

const unsigned int RhieChowInterpolatorBase::_dim
protected

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

Definition at line 113 of file RhieChowInterpolatorBase.h.

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

◆ _displaced

const bool RhieChowInterpolatorBase::_displaced
protected

Whether this object is operating on the displaced mesh.

Definition at line 149 of file RhieChowInterpolatorBase.h.

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

◆ _mesh

const libMesh::MeshBase& RhieChowInterpolatorBase::_mesh
protected

The libMesh mesh that this object acts on.

Definition at line 110 of file RhieChowInterpolatorBase.h.

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

◆ _moose_mesh

MooseMesh& RhieChowInterpolatorBase::_moose_mesh
protected

The MooseMesh that this user object operates on.

Definition at line 107 of file RhieChowInterpolatorBase.h.

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

◆ _p

INSFVPressureVariable* const RhieChowInterpolatorBase::_p
protected

The thread 0 copy of the pressure variable.

Definition at line 116 of file RhieChowInterpolatorBase.h.

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

◆ _ps

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

All the thread copies of the pressure variable.

Definition at line 128 of file RhieChowInterpolatorBase.h.

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

◆ _sys

SystemBase& RhieChowInterpolatorBase::_sys
protected

The nonlinear system.

Definition at line 143 of file RhieChowInterpolatorBase.h.

◆ _u

INSFVVelocityVariable* const RhieChowInterpolatorBase::_u
protected

The thread 0 copy of the x-velocity variable.

Definition at line 119 of file RhieChowInterpolatorBase.h.

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

◆ _unity_functor

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

A unity functor used in the epsilon virtual method.

Definition at line 153 of file RhieChowInterpolatorBase.h.

Referenced by epsilon().

◆ _us

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

All the thread copies of the x-velocity variable.

Definition at line 131 of file RhieChowInterpolatorBase.h.

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

◆ _v

INSFVVelocityVariable* const RhieChowInterpolatorBase::_v
protected

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

Definition at line 122 of file RhieChowInterpolatorBase.h.

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

◆ _var_numbers

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

The velocity variable numbers.

Definition at line 140 of file RhieChowInterpolatorBase.h.

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

◆ _velocity_interp_method

Moose::FV::InterpMethod RhieChowInterpolatorBase::_velocity_interp_method
protected

The interpolation method to use for the velocity.

Definition at line 146 of file RhieChowInterpolatorBase.h.

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

◆ _vs

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

All the thread copies of the y-velocity variable.

Definition at line 134 of file RhieChowInterpolatorBase.h.

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

◆ _w

INSFVVelocityVariable* const RhieChowInterpolatorBase::_w
protected

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

Definition at line 125 of file RhieChowInterpolatorBase.h.

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

◆ _ws

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

All the thread copies of the z-velocity variable.

Definition at line 137 of file RhieChowInterpolatorBase.h.

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

The documentation for this class was generated from the following files:
Generated on Sun Jun 29 2025 08:12:06 for https://mooseframework.inl.gov by   doxygen 1.8.14