https://mooseframework.inl.gov
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 Member Functions | List of all members
PINSFVRhieChowInterpolator Class Reference

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

#include <PINSFVRhieChowInterpolator.h>

Inheritance diagram for PINSFVRhieChowInterpolator:
[legend]

Public Types

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

Public Member Functions

 PINSFVRhieChowInterpolator (const InputParameters &params)
 
virtual void meshChanged () override
 
virtual void initialize () override
 
virtual void execute () override
 
virtual void finalize () override
 
virtual void addToA (const libMesh::Elem *elem, unsigned int component, const ADReal &value) override
 API that momentum residual objects that have on-diagonals for velocity call. More...
 
virtual VectorValue< ADRealgetVelocity (const Moose::FV::InterpMethod m, const FaceInfo &fi, const Moose::StateArg &time, const THREAD_ID tid, bool subtract_mesh_velocity) const override
 Retrieve a face velocity. More...
 
virtual void initialSetup () override
 
virtual bool segregated () const override
 Bool of the Rhie Chow user object is used in monolithic/segregated approaches. More...
 
virtual void ghostADataOnBoundary (const BoundaryID boundary_id) override
 makes sure coefficient data gets communicated on both sides of a given boundary More...
 
void pullAllNonlocal ()
 Whether to pull all 'a' coefficient data from the owning process for all nonlocal elements we have access to (e.g. More...
 
bool velocitySkewCorrection (THREAD_ID tid) const
 Whether central differencing face interpolations of velocity should include a skewness correction Also used for the face interpolation of the D coefficient and the face interpolation of volumetric forces for for the volume correction method and the face interpolation of porosity. More...
 
bool pressureSkewCorrection (THREAD_ID tid) const
 Whether central differencing face interpolations of pressure should include a skewness correction. More...
 
virtual Real getVolumetricFaceFlux (const Moose::FV::InterpMethod m, const FaceInfo &fi, const Moose::StateArg &time, const THREAD_ID tid, bool subtract_mesh_velocity) const override
 Retrieve the volumetric face flux, will not include derivatives. More...
 
Moose::FV::InterpMethod velocityInterpolationMethod () const
 Return the interpolation method used for velocity. More...
 
const INSFVPressureVariablepressure (THREAD_ID tid) const
 
const INSFVVelocityVariablevel () const
 
bool hasFaceSide (const FaceInfo &fi, const bool fi_elem_side) const override
 
virtual bool supportMeshVelocity () const
 Returns whether the UO can support mesh velocity advection. More...
 
SubProblemgetSubProblem () 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)
 
UserObjectprimaryThreadCopy ()
 
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< MooseObjectgetSharedPtr ()
 
std::shared_ptr< const MooseObjectgetSharedPtr () const
 
MooseAppgetMooseApp () 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 InputParametersparameters () 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
 
getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &nm) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
virtual void timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnumgetExecuteOnEnum () 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 UserObjectgetUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObjectgetUserObjectBaseByName (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< SubdomainIDgetMaterialPropertyBlocks (const std::string &name)
 
std::vector< SubdomainName > getMaterialPropertyBlockNames (const std::string &name)
 
std::set< BoundaryIDgetMaterialPropertyBoundaryIDs (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)
 
MaterialBasegetMaterial (const std::string &name)
 
MaterialBasegetMaterial (const std::string &name)
 
MaterialBasegetMaterialByName (const std::string &name, bool no_warn=false)
 
MaterialBasegetMaterialByName (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 FunctiongetFunction (const std::string &name) const
 
const FunctiongetFunctionByName (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 VectorPostprocessorValuegetVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValueOldByName (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)
 
SamplergetSampler (const std::string &name)
 
T & getSamplerByName (const SamplerName &name)
 
SamplergetSamplerByName (const SamplerName &name)
 
virtual void meshDisplaced ()
 
PerfGraphperfGraph ()
 
const PostprocessorValuegetPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValuegetPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValuegetPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOlderByName (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 DistributiongetDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const DistributiongetDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const DistributiongetDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const DistributiongetDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 
const std::vector< SubdomainName > & blocks () const
 
unsigned int numBlocks () const
 
virtual const std::set< SubdomainID > & blockIDs () const
 
unsigned int blocksMaxDimension () const
 
bool hasBlocks (const SubdomainName &name) const
 
bool hasBlocks (const std::vector< SubdomainName > &names) const
 
bool hasBlocks (const std::set< SubdomainName > &names) const
 
bool hasBlocks (SubdomainID id) const
 
bool hasBlocks (const std::vector< SubdomainID > &ids) const
 
bool hasBlocks (const std::set< SubdomainID > &ids) const
 
bool isBlockSubset (const std::set< SubdomainID > &ids) const
 
bool isBlockSubset (const std::vector< SubdomainID > &ids) const
 
bool hasBlockMaterialProperty (const std::string &prop_name)
 
const std::set< SubdomainID > & meshBlockIDs () const
 
virtual bool blockRestricted () const
 
virtual void checkVariable (const MooseVariableFieldBase &variable) const
 
void useVectorTag (const TagName &tag_name, VectorTagsKey)
 
void useVectorTag (TagID tag_id, VectorTagsKey)
 
void useMatrixTag (const TagName &tag_name, MatrixTagsKey)
 
void useMatrixTag (TagID tag_id, MatrixTagsKey)
 
bool isVectorTagged ()
 
bool isMatrixTagged ()
 
bool hasVectorTags () const
 
const std::set< TagID > & getVectorTags (VectorTagsKey) const
 
const std::set< TagID > & getMatrixTags (MatrixTagsKey) const
 

Static Public Member Functions

static InputParameters validParams ()
 
static InputParameters uniqueParams ()
 Parameters of this object that should be added to the NSFV action that are unique to this object. More...
 
static std::vector< std::string > listOfCommonParams ()
 
static void 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

const Moose::FunctorBase< ADReal > & epsilon (THREAD_ID tid) const override
 A virtual method that allows us to only implement getVelocity once for free and porous flows. More...
 
bool isFaceGeometricallyRelevant (const FaceInfo &fi) const
 
void insfvSetup ()
 perform the setup of this object More...
 
template<typename Container >
void fillContainer (const std::string &var_name, Container &container)
 Fill the passed-in variable container with the thread copies of var_name. More...
 
template<typename VarType >
void checkBlocks (const VarType &var) const
 Check the block consistency between the passed in var and us. More...
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &name) const override
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override
 
virtual void addUserObjectDependencyHelper (const UserObject &uo) const override
 
void addReporterDependencyHelper (const ReporterName &reporter_name) override
 
const ReporterNamegetReporterName (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 VariableValuecoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadCoupledScalarValue (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 VariableValuecoupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValuecoupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValuecoupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const MooseVariableScalargetScalarVar (const std::string &var_name, unsigned int comp) const
 
virtual void checkMaterialProperty (const std::string &name, const unsigned int state)
 
void markMatPropRequested (const std::string &)
 
MaterialPropertyName getMaterialPropertyName (const std::string &name) const
 
void checkExecutionStage ()
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 
virtual bool hasBlockMaterialPropertyHelper (const std::string &prop_name)
 
void initializeBlockRestrictable (const MooseObject *moose_object)
 
Moose::CoordinateSystemType getBlockCoordSystem ()
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTagNeighbor (Assembly &assembly, unsigned int ivar)
 
void prepareVectorTagLower (Assembly &assembly, unsigned int ivar)
 
void prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar)
 
void prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar, DenseMatrix< Number > &k) const
 
void prepareMatrixTagNonlocal (Assembly &assembly, unsigned int ivar, unsigned int jvar)
 
void prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type)
 
void prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, DenseMatrix< Number > &k) const
 
void prepareMatrixTagLower (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::ConstraintJacobianType type)
 
void accumulateTaggedLocalResidual ()
 
void assignTaggedLocalResidual ()
 
void accumulateTaggedLocalMatrix ()
 
void accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, const DenseMatrix< Number > &k)
 
void accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, const DenseMatrix< Number > &k)
 
void accumulateTaggedNonlocalMatrix ()
 
void assignTaggedLocalMatrix ()
 
void addResiduals (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResiduals (Assembly &assembly, const DenseVector< T > &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResiduals (Assembly &assembly, const ADResidualsPacket &packet)
 
void addResidualsAndJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResidualsAndJacobian (Assembly &assembly, const ADResidualsPacket &packet)
 
void addJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobian (Assembly &assembly, const ADResidualsPacket &packet)
 
void addJacobian (Assembly &assembly, DenseMatrix< Real > &local_k, const std::vector< dof_id_type > &row_indices, const std::vector< dof_id_type > &column_indices, Real scaling_factor)
 
void addResidualsWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResidualsAndJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobianElement (Assembly &assembly, Real value, dof_id_type row_index, dof_id_type column_index, Real scaling_factor)
 
void setResidual (SystemBase &sys, const T &residual, MooseVariableFE< T > &var)
 
void setResidual (SystemBase &sys, Real residual, dof_id_type dof_index)
 
void setResidual (SystemBase &sys, SetResidualFunctor set_residual_functor)
 
std::string deduceFunctorName (const std::string &name) const
 
const Moose::Functor< T > & getFunctor (const std::string &name)
 
const Moose::Functor< T > & getFunctor (const std::string &name, THREAD_ID tid)
 
const Moose::Functor< T > & getFunctor (const std::string &name, SubProblem &subproblem)
 
const Moose::Functor< T > & getFunctor (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
 
bool isFunctor (const std::string &name) const
 
bool isFunctor (const std::string &name, const SubProblem &subproblem) const
 
Moose::ElemArg makeElemArg (const Elem *elem, bool correct_skewnewss=false) const
 
void checkFunctorSupportsSideIntegration (const std::string &name, bool qp_integration)
 

Static Protected Member Functions

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

Protected Attributes

const Moose::Functor< ADReal > & _eps
 The thread 0 copy of the porosity functor held by the subproblem. More...
 
CellCenteredMapFunctor< ADReal, std::unordered_map< dof_id_type, ADReal > > _smoothed_eps
 The smoothed porosity functor/field. More...
 
std::vector< const Moose::Functor< ADReal > * > _epss
 All the thread copies of the problem's porosity functor. More...
 
std::vector< const Moose::Functor< ADReal > * > _smoothed_epss
 All the thread copies of the problem's smoothed porosity functor. More...
 
const unsigned short _smoothing_layers
 The number of interpolations and reconstructions that should be performed on the porosity functor/field. More...
 
std::vector< const FaceInfo * > _geometric_fi
 All the face information that are "geometrically" accessible on this process. More...
 
std::vector< std::unique_ptr< PiecewiseByBlockLambdaFunctor< ADRealVectorValue > > > _vel
 A functor for computing the (non-RC corrected) velocity. More...
 
std::vector< MooseVariableField< Real > * > _disp_xs
 All the thread copies of the x-displacement variable. More...
 
std::vector< MooseVariableField< Real > * > _disp_ys
 All the thread copies of the y-displacement variable. More...
 
std::vector< MooseVariableField< Real > * > _disp_zs
 All the thread copies of the z-displacement variable. More...
 
std::vector< std::unique_ptr< Moose::VectorCompositeFunctor< ADReal > > > _disps
 A functor for computing the displacement. More...
 
std::unique_ptr< ConstElemRange_elem_range
 All the active and elements local to this process that exist on this object's subdomains. More...
 
CellCenteredMapFunctor< ADRealVectorValue, std::unordered_map< dof_id_type, ADRealVectorValue > > _a
 A map from element IDs to 'a' coefficient data. More...
 
const unsigned int _momentum_sys_number
 The number of the nonlinear system in which the monolithic momentum and continuity equations are located. More...
 
MooseMesh_moose_mesh
 The MooseMesh that this user object operates on. More...
 
const libMesh::MeshBase_mesh
 The libMesh mesh that this object acts on. More...
 
const unsigned int _dim
 The dimension of the mesh, e.g. 3 for hexes and tets, 2 for quads and tris. More...
 
INSFVPressureVariable *const _p
 The thread 0 copy of the pressure variable. More...
 
INSFVVelocityVariable *const _u
 The thread 0 copy of the x-velocity variable. More...
 
INSFVVelocityVariable *const _v
 The thread 0 copy of the y-velocity variable (null if the problem is 1D) More...
 
INSFVVelocityVariable *const _w
 The thread 0 copy of the z-velocity variable (null if the problem is not 3D) More...
 
std::vector< MooseVariableFVReal * > _ps
 All the thread copies of the pressure variable. More...
 
std::vector< MooseVariableFVReal * > _us
 All the thread copies of the x-velocity variable. More...
 
std::vector< MooseVariableFVReal * > _vs
 All the thread copies of the y-velocity variable. More...
 
std::vector< MooseVariableFVReal * > _ws
 All the thread copies of the z-velocity variable. More...
 
std::vector< unsigned int_var_numbers
 The velocity variable numbers. More...
 
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
 
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
 
FEProblemBase_mdi_feproblem
 
MooseApp_pg_moose_app
 
const std::string _prefix
 
FEProblemBase_sc_fe_problem
 
const THREAD_ID _sc_tid
 
const Real_real_zero
 
const VariableValue_scalar_zero
 
const Point & _point_zero
 
const InputParameters_mi_params
 
const std::string _mi_name
 
const MooseObjectName _mi_moose_object_name
 
FEProblemBase_mi_feproblem
 
SubProblem_mi_subproblem
 
const THREAD_ID _mi_tid
 
const Moose::MaterialDataType _material_data_type
 
MaterialData_material_data
 
bool _stateful_allowed
 
bool _get_material_property_called
 
std::vector< std::unique_ptr< PropertyValue > > _default_properties
 
std::unordered_set< unsigned int_material_property_dependencies
 
const MaterialPropertyName _get_suffix
 
const bool _use_interpolated_state
 
const InputParameters_ti_params
 
FEProblemBase_ti_feproblem
 
bool _is_implicit
 
Real_t
 
const Real_t_old
 
int_t_step
 
Real_dt
 
Real_dt_old
 
bool _is_transient
 
const Parallel::Communicator & _communicator
 
const MaterialData_blk_material_data
 
DenseVector< Number_local_re
 
DenseMatrix< Number_local_ke
 
DenseMatrix< Number_nonlocal_ke
 
'a' component functors

These vector component functors are not used anywhere within this class but they can be used for outputting, to auxiliary variables, the on-diagonal 'a' coefficients for use in visualization or transfer to other applications

Moose::VectorComponentFunctor< ADReal_ax
 
Moose::VectorComponentFunctor< ADReal_ay
 The y-component of 'a'. More...
 
Moose::VectorComponentFunctor< ADReal_az
 The z-component of 'a'. More...
 

Static Protected Attributes

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

Private Member Functions

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

Detailed Description

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

Definition at line 22 of file PINSFVRhieChowInterpolator.h.

Constructor & Destructor Documentation

◆ PINSFVRhieChowInterpolator()

PINSFVRhieChowInterpolator::PINSFVRhieChowInterpolator ( const InputParameters params)

Definition at line 43 of file PINSFVRhieChowInterpolator.C.

44  : INSFVRhieChowInterpolator(params),
45  _eps(getFunctor<ADReal>(NS::porosity)),
46  _smoothed_eps(_moose_mesh, NS::smoothed_porosity, /*extrapolated_boundary*/ true),
47  _epss(libMesh::n_threads(), nullptr),
49  _smoothing_layers(getParam<unsigned short>("smoothing_layers"))
50 {
51  if (_smoothing_layers && _eps.wrapsType<MooseVariableBase>())
52  paramError(
54  "If we are reconstructing porosity, then the input porosity to this user object cannot "
55  "be a Moose variable. There are issues with reconstructing Moose variables: 1) initial "
56  "conditions are run after user objects initial setup 2) reconstructing from a variable "
57  "requires ghosting the solution vectors 3) it's difficult to restrict the face "
58  "informations we evaluate interpolations and reconstructions on such that we never query "
59  "an algebraically remote element due to things like two-term extrapolated boundary faces "
60  "which trigger gradient evaluations which trigger neighbor element evaluation");
61 
62  const auto porosity_name = deduceFunctorName(NS::porosity);
63 
64  for (const auto tid : make_range(libMesh::n_threads()))
65  {
66  _epss[tid] = &UserObject::_subproblem.getFunctor<ADReal>(porosity_name, tid, name(), true);
67 
68  if (_smoothing_layers > 0)
69  {
70  if (!UserObject::_subproblem.hasFunctor(NS::smoothed_porosity, tid))
71  // Smoothed porosity is only an envelope at this point, it will be set during pinsfvSetup()
73 
74  _smoothed_epss[tid] =
76  }
77  }
78 }
unsigned int n_threads()
const Moose::Functor< T > & getFunctor(const std::string &name, const THREAD_ID tid, const std::string &requestor_name, bool requestor_is_ad)
MooseMesh & _moose_mesh
The MooseMesh that this user object operates on.
static const std::string smoothed_porosity
Definition: NS.h:105
std::vector< const Moose::Functor< ADReal > * > _epss
All the thread copies of the problem&#39;s porosity functor.
DualNumber< Real, DNDerivativeType, true > ADReal
virtual const std::string & name() const
SubProblem & _subproblem
static const std::string porosity
Definition: NS.h:104
std::vector< const Moose::Functor< ADReal > * > _smoothed_epss
All the thread copies of the problem&#39;s smoothed porosity functor.
void paramError(const std::string &param, Args... args) const
CellCenteredMapFunctor< ADReal, std::unordered_map< dof_id_type, ADReal > > _smoothed_eps
The smoothed porosity functor/field.
IntRange< T > make_range(T beg, T end)
const unsigned short _smoothing_layers
The number of interpolations and reconstructions that should be performed on the porosity functor/fie...
const Moose::Functor< ADReal > & _eps
The thread 0 copy of the porosity functor held by the subproblem.
INSFVRhieChowInterpolator(const InputParameters &params)
static std::string deduceFunctorName(const std::string &name, const InputParameters &params)

Member Function Documentation

◆ addToA()

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

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

Parameters
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

Implements RhieChowInterpolatorBase.

Definition at line 221 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator::ghostADataOnBoundary().

224 {
225  Threads::spin_mutex::scoped_lock lock(_a_mutex);
226 
227  if (elem->processor_id() != this->processor_id())
228  _elements_to_push_pull.insert(elem);
229 
230  _a[elem->id()](component) += value;
231 }
CellCenteredMapFunctor< ADRealVectorValue, std::unordered_map< dof_id_type, ADRealVectorValue > > _a
A map from element IDs to &#39;a&#39; coefficient data.
static const std::string component
Definition: NS.h:153
dof_id_type id() const
std::unordered_set< const Elem * > _elements_to_push_pull
Non-local elements that we should push and pull data for across processes.
Threads::spin_mutex _a_mutex
Mutex that prevents multiple threads from saving into the &#39;a&#39; coefficients at the same time...
processor_id_type processor_id() const
processor_id_type processor_id() const

◆ checkBlocks()

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

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

Definition at line 184 of file RhieChowInterpolatorBase.h.

Referenced by INSFVRhieChowInterpolator::INSFVRhieChowInterpolator(), and RhieChowInterpolatorBase::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  "' (",
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 }
MooseMesh & _moose_mesh
The MooseMesh that this user object operates on.
const std::set< SubdomainID > & getBlockConnectedBlocks(const SubdomainID subdomain_id) const
virtual const std::set< SubdomainID > & blockIDs() const
virtual const std::string & name() const
std::string stringify(const T &t)
const std::vector< SubdomainName > & blocks() const
void mooseError(Args &&... args) const

◆ epsilon()

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

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

Reimplemented from RhieChowInterpolatorBase.

Definition at line 77 of file PINSFVRhieChowInterpolator.h.

78 {
79  if (!_smoothing_layers)
80  return *_epss[tid];
81  else
82  return *_smoothed_epss[tid];
83 }
std::vector< const Moose::Functor< ADReal > * > _epss
All the thread copies of the problem&#39;s porosity functor.
std::vector< const Moose::Functor< ADReal > * > _smoothed_epss
All the thread copies of the problem&#39;s smoothed porosity functor.
const unsigned short _smoothing_layers
The number of interpolations and reconstructions that should be performed on the porosity functor/fie...

◆ execute()

void PINSFVRhieChowInterpolator::execute ( )
overridevirtual

Reimplemented from INSFVRhieChowInterpolator.

Definition at line 189 of file PINSFVRhieChowInterpolator.C.

190 {
191  // Cannot compute Rhie Chow coefficients on initial
192  if (_current_execute_flag != EXEC_INITIAL)
194 }
const ExecFlagType & _current_execute_flag

◆ fillContainer()

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

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

Definition at line 171 of file RhieChowInterpolatorBase.h.

Referenced by INSFVRhieChowInterpolator::INSFVRhieChowInterpolator(), and RhieChowInterpolatorBase::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 }
unsigned int n_threads()
virtual const std::string & name() const
SubProblem & _subproblem
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
IntRange< T > make_range(T beg, T end)

◆ finalize()

void PINSFVRhieChowInterpolator::finalize ( )
overridevirtual

Reimplemented from INSFVRhieChowInterpolator.

Definition at line 197 of file PINSFVRhieChowInterpolator.C.

198 {
199  // Cannot compute Rhie Chow coefficients on initial
200  if (_current_execute_flag != EXEC_INITIAL)
202 }
const ExecFlagType & _current_execute_flag
virtual void finalize() override

◆ getVelocity()

VectorValue< ADReal > INSFVRhieChowInterpolator::getVelocity ( const Moose::FV::InterpMethod  m,
const FaceInfo fi,
const Moose::StateArg time,
const THREAD_ID  tid,
bool  subtract_mesh_velocity 
) const
overridevirtualinherited

Retrieve a face velocity.

Parameters
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
timeThe time at which to evaluate the velocity
tidThe thread ID
subtract_mesh_velocityWhether to subtract the mesh velocity if running on a displaced mesh
Returns
The face velocity

Implements RhieChowInterpolatorBase.

Definition at line 522 of file INSFVRhieChowInterpolator.C.

Referenced by GetAllTheRCVelocities::execute().

527 {
528  const Elem * const elem = &fi.elem();
529  const Elem * const neighbor = fi.neighborPtr();
530  auto & vel = *_vel[tid];
531  auto & p = *_ps[tid];
532  auto * const u = _us[tid];
533  MooseVariableFVReal * const v = _v ? _vs[tid] : nullptr;
534  MooseVariableFVReal * const w = _w ? _ws[tid] : nullptr;
535  // Check if skewness-correction is necessary
536  const bool correct_skewness = velocitySkewCorrection(tid);
537  auto incorporate_mesh_velocity =
538  [this, tid, subtract_mesh_velocity, &time](const auto & space, auto & velocity)
539  {
540  if (_disps.size() && subtract_mesh_velocity)
541  velocity -= _disps[tid]->dot(space, time);
542  };
543 
544  if (Moose::FV::onBoundary(*this, fi))
545  {
546  const Elem * const boundary_elem = hasBlocks(elem->subdomain_id()) ? elem : neighbor;
547  const Moose::FaceArg boundary_face{&fi,
549  true,
550  correct_skewness,
551  boundary_elem,
552  nullptr};
553  auto velocity = vel(boundary_face, time);
554  incorporate_mesh_velocity(boundary_face, velocity);
555 
556  // If not solving for velocity, clear derivatives
559  else
560  return velocity;
561  }
562 
564 
565  Moose::FaceArg face{
566  &fi, Moose::FV::LimiterType::CentralDifference, true, correct_skewness, nullptr, nullptr};
567  // Create the average face velocity (not corrected using RhieChow yet)
568  velocity(0) = (*u)(face, time);
569  if (v)
570  velocity(1) = (*v)(face, time);
571  if (w)
572  velocity(2) = (*w)(face, time);
573 
574  incorporate_mesh_velocity(face, velocity);
575 
576  // If not solving for velocity, clear derivatives
579 
580  // Return if Rhie-Chow was not requested or if we have a porosity jump
582  std::get<0>(NS::isPorosityJumpFace(epsilon(tid), fi, time)))
583  return velocity;
584 
585  // Rhie-Chow coefficients are not available on initial
587  {
588  mooseDoOnce(mooseWarning("Cannot compute Rhie Chow coefficients on initial. Returning linearly "
589  "interpolated velocities"););
590  return velocity;
591  }
592  if (!_fe_problem.shouldSolve())
593  {
594  mooseDoOnce(mooseWarning("Cannot compute Rhie Chow coefficients if not solving. Returning "
595  "linearly interpolated velocities"););
596  return velocity;
597  }
598 
599  mooseAssert(((m == Moose::FV::InterpMethod::RhieChow) &&
602  "The 'a' coefficients have not been generated or provided for "
603  "Rhie Chow velocity interpolation.");
604 
605  mooseAssert(neighbor && this->hasBlocks(neighbor->subdomain_id()),
606  "We should be on an internal face...");
607 
608  // Get pressure gradient. This is the uncorrected gradient plus a correction from cell
609  // centroid values on either side of the face
610  const auto correct_skewness_p = pressureSkewCorrection(tid);
611  const auto & grad_p = p.adGradSln(fi, time, correct_skewness_p);
612 
613  // Get uncorrected pressure gradient. This will use the element centroid gradient if we are
614  // along a boundary face
615  const auto & unc_grad_p = p.uncorrectedAdGradSln(fi, time, correct_skewness_p);
616 
617  // Volumetric Correction Method #1: pressure-based correction
618  // Function that allows us to mark the face for which the Rhie-Chow interpolation is
619  // inconsistent Normally, we should apply a reconstructed volume correction to the Rhie-Chow
620  // coefficients However, since the fluxes at the face are given by the volume force we will
621  // simply mark the face add the reverse pressure interpolation for these faces In brief, this
622  // function is just marking the faces where the Rhie-Chow interpolation is inconsistent
623  auto vf_indicator_pressure_based =
624  [this, &elem, &neighbor, &time, &fi, &correct_skewness](const Point & unit_basis_vector)
625  {
626  // Holders for the interpolated corrected and uncorrected volume force
627  Real interp_vf;
628  Real uncorrected_interp_vf;
629 
630  // Compute the corrected interpolated face value
631  Moose::FaceArg face{
632  &fi, Moose::FV::LimiterType::CentralDifference, true, correct_skewness, nullptr, nullptr};
633 
634  interp_vf = 0.0;
635  for (const auto i : make_range(_volumetric_force.size()))
636  interp_vf += (*this->_volumetric_force[i])(face, time);
637 
638  // Compute the uncorrected interpolated face value
639  // For it to be consistent with the pressure gradient interpolation `uncorrectedAdGradSln`
640  // the uncorrected volume force computation should follow the same Green-Gauss process
641 
642  Real elem_value = 0.0;
643  Real neigh_value = 0.0;
644 
645  // Uncorrected interpolation - Step 1: loop over the faces of the element to compute
646  // face-average cell value
647  Real coord_multiplier;
648  const auto coord_type = _fe_problem.getCoordSystem(elem->subdomain_id());
649  const unsigned int rz_radial_coord =
651 
652  for (const auto side : make_range(elem->n_sides()))
653  {
654  const Elem * const loc_neighbor = elem->neighbor_ptr(side);
655  const bool elem_has_fi = Moose::FV::elemHasFaceInfo(*elem, loc_neighbor);
656  const FaceInfo * const fi_loc =
657  _moose_mesh.faceInfo(elem_has_fi ? elem : loc_neighbor,
658  elem_has_fi ? side : loc_neighbor->which_neighbor_am_i(elem));
659 
660  Moose::FaceArg loc_face{
661  fi_loc, Moose::FV::LimiterType::CentralDifference, true, correct_skewness, elem, nullptr};
662 
664  elem->vertex_average(), coord_multiplier, coord_type, rz_radial_coord);
665 
666  Real face_volume_contribution = fi_loc->faceArea() *
667  (neighbor->vertex_average() - elem->vertex_average()).norm() *
668  coord_multiplier;
669 
670  for (const auto i : make_range(_volumetric_force.size()))
671  {
672  // Add which side (can be both, then we use a nullptr) of the face info the force is defined
673  // on
674  loc_face.face_side =
675  this->_volumetric_force[i]->hasFaceSide(*fi_loc, true)
676  ? (this->_volumetric_force[i]->hasFaceSide(*fi_loc, false) ? nullptr
677  : fi_loc->elemPtr())
678  : fi_loc->neighborPtr();
679  elem_value += (*this->_volumetric_force[i])(loc_face, time) * face_volume_contribution *
680  (fi_loc->normal() * unit_basis_vector);
681  }
682  }
683  elem_value = elem_value / elem->volume();
684 
685  // Uncorrected interpolation - Step 2: loop over the face of the neighbor to compute
686  // face-average cell value
687  for (const auto side : make_range(neighbor->n_sides()))
688  {
689  const Elem * const loc_elem = neighbor->neighbor_ptr(side);
690  const bool elem_has_fi = Moose::FV::elemHasFaceInfo(*neighbor, loc_elem);
691  const FaceInfo * const fi_loc =
692  _moose_mesh.faceInfo(elem_has_fi ? neighbor : loc_elem,
693  elem_has_fi ? side : loc_elem->which_neighbor_am_i(neighbor));
694 
695  Moose::FaceArg loc_face{
696  fi_loc, Moose::FV::LimiterType::CentralDifference, true, correct_skewness, elem, nullptr};
697 
699  neighbor->vertex_average(), coord_multiplier, coord_type, rz_radial_coord);
700 
701  Real face_volume_contribution = fi_loc->faceArea() *
702  (elem->vertex_average() - neighbor->vertex_average()).norm() *
703  coord_multiplier;
704 
705  for (const auto i : make_range(_volumetric_force.size()))
706  {
707  loc_face.face_side =
708  this->_volumetric_force[i]->hasFaceSide(*fi_loc, true)
709  ? (this->_volumetric_force[i]->hasFaceSide(*fi_loc, false) ? nullptr
710  : fi_loc->elemPtr())
711  : fi_loc->neighborPtr();
712  neigh_value += (*this->_volumetric_force[i])(loc_face, time) * face_volume_contribution *
713  (fi_loc->normal() * unit_basis_vector);
714  }
715  }
716  neigh_value = neigh_value / neighbor->volume();
717 
718  // Uncorrected interpolation - Step 3: interpolate element and neighbor reconstructed values
719  // to the face
721  fi.faceCentroid(), coord_multiplier, coord_type, rz_radial_coord);
722  interpolate(
723  Moose::FV::InterpMethod::Average, uncorrected_interp_vf, elem_value, neigh_value, fi, true);
724 
725  // Return the flag indicator on which face the volume force correction is inconsistent
726  return MooseUtils::relativeFuzzyEqual(interp_vf, uncorrected_interp_vf, 1e-10) ? 0.0 : 1.0;
727  };
728 
729  // Volumetric Correction Method #2: volume-based correction
730  // In thery, pressure and velocity cannot be decoupled when a body force is present
731  // Hence, we can de-activate the RC cofficient in faces that have a normal volume force
732  // In the method we mark the faces with a non-zero volume force with recpect to the baseline
733  auto vf_indicator_force_based = [this, &time, &fi, &correct_skewness](Point & face_normal)
734  {
735  Real value = 0.0;
736  Moose::FaceArg loc_face{
737  &fi, Moose::FV::LimiterType::CentralDifference, true, correct_skewness, nullptr, nullptr};
738 
739  for (const auto i : make_range(_volumetric_force.size()))
740  value += (*_volumetric_force[i])(loc_face, time) * (face_normal * fi.normal());
741  if ((std::abs(value) - _baseline_volume_force) > 0)
742  return 1.0;
743  else
744  return 0.0;
745  };
746 
747  const Point & elem_centroid = fi.elemCentroid();
748  const Point & neighbor_centroid = fi.neighborCentroid();
749  Real elem_volume = fi.elemVolume();
750  Real neighbor_volume = fi.neighborVolume();
751 
752  // Now we need to perform the computations of D
753  const auto elem_a = (*_a_read[tid])(makeElemArg(elem), time);
754 
755  mooseAssert(UserObject::_subproblem.getCoordSystem(elem->subdomain_id()) ==
756  UserObject::_subproblem.getCoordSystem(neighbor->subdomain_id()),
757  "Coordinate systems must be the same between the two elements");
758 
759  Real coord;
760  coordTransformFactor(UserObject::_subproblem, elem->subdomain_id(), elem_centroid, coord);
761 
762  elem_volume *= coord;
763 
764  VectorValue<ADReal> elem_D = 0;
765  for (const auto i : make_range(_dim))
766  {
767  mooseAssert(elem_a(i).value() != 0, "We should not be dividing by zero");
768  elem_D(i) = elem_volume / elem_a(i);
769  }
770 
771  VectorValue<ADReal> face_D;
772 
773  const auto neighbor_a = (*_a_read[tid])(makeElemArg(neighbor), time);
774 
775  coordTransformFactor(UserObject::_subproblem, neighbor->subdomain_id(), neighbor_centroid, coord);
776  neighbor_volume *= coord;
777 
778  VectorValue<ADReal> neighbor_D = 0;
779  for (const auto i : make_range(_dim))
780  {
781  mooseAssert(neighbor_a(i).value() != 0, "We should not be dividing by zero");
782  neighbor_D(i) = neighbor_volume / neighbor_a(i);
783  }
784 
785  // We require this to ensure that the correct interpolation weights are used.
786  // This will change once the traditional weights are replaced by the weights
787  // that are used by the skewness-correction.
788  Moose::FV::InterpMethod coeff_interp_method = correct_skewness
791  Moose::FV::interpolate(coeff_interp_method, face_D, elem_D, neighbor_D, fi, true);
792 
793  // evaluate face porosity, see (18) in Hanimann 2021 or (11) in Nordlund 2016
794  const auto face_eps = epsilon(tid)(face, time);
795 
796  // Perform the pressure correction. We don't use skewness-correction on the pressure since
797  // it only influences the averaged cell gradients which cancel out in the correction
798  // below.
799  for (const auto i : make_range(_dim))
800  {
801  // "Standard" pressure-based RC interpolation
802  velocity(i) -= face_D(i) * face_eps * (grad_p(i) - unc_grad_p(i));
803 
804  if (_bool_correct_vf)
805  {
806  // To solve the volume force incorrect interpolation, we add back the pressure gradient to the
807  // RC-inconsistent faces regarding the marking method
808  Point unit_basis_vector;
809  unit_basis_vector(i) = 1.0;
810 
811  // Get the value of the correction face indicator
812  Real correction_indicator;
813  if (_volume_force_correction_method == "force-consistent")
814  correction_indicator = vf_indicator_force_based(unit_basis_vector);
815  else
816  correction_indicator = vf_indicator_pressure_based(unit_basis_vector);
817 
818  // Correct back the velocity
819  velocity(i) += face_D(i) * face_eps * (grad_p(i) - unc_grad_p(i)) * correction_indicator;
820  }
821  }
822 
823  // If not solving for velocity, clear derivatives
826  else
827  return velocity;
828 }
unsigned int getAxisymmetricRadialCoord() const
bool shouldSolve() const
bool elemHasFaceInfo(const Elem &elem, const Elem *const neighbor)
std::vector< MooseVariableFVReal * > _ps
All the thread copies of the pressure variable.
std::vector< const Moose::Functor< Real > * > _volumetric_force
Values of the functors storing the volumetric forces.
const unsigned int invalid_uint
MooseMesh & _moose_mesh
The MooseMesh that this user object operates on.
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...
void coordTransformFactor(const P &point, C &factor, const Moose::CoordinateSystemType coord_type, const unsigned int rz_radial_coord=libMesh::invalid_uint)
INSFVVelocityVariable *const _v
The thread 0 copy of the y-velocity variable (null if the problem is 1D)
const ExecFlagType & getCurrentExecuteOnFlag() const
const Elem & elem() const
std::tuple< bool, ADReal, ADReal > isPorosityJumpFace(const Moose::Functor< ADReal > &porosity, const FaceInfo &fi, const Moose::StateArg &time)
Checks to see whether the porosity value jumps from one side to the other of the provided face...
Definition: NSFVUtils.C:58
void coordTransformFactor(const SubProblem &s, SubdomainID sub_id, const P &point, C &factor, SubdomainID neighbor_sub_id=libMesh::Elem::invalid_subdomain_id)
auto raw_value(const Eigen::Map< T > &in)
Real faceArea() const
void mooseWarning(Args &&... args) const
SubProblem & _subproblem
std::vector< MooseVariableFVReal * > _us
All the thread copies of the x-velocity variable.
Moose::ElemArg makeElemArg(const Elem *elem, bool correct_skewnewss=false) const
bool pressureSkewCorrection(THREAD_ID tid) const
Whether central differencing face interpolations of pressure should include a skewness correction...
const std::vector< const FaceInfo *> & faceInfo() const
const Elem * neighborPtr() const
Real value(unsigned n, unsigned alpha, unsigned beta, Real x)
virtual unsigned int currentNlSysNum() const override
const unsigned int _dim
The dimension of the mesh, e.g. 3 for hexes and tets, 2 for quads and tris.
const Point & normal() const
auto norm(const T &a) -> decltype(std::abs(a))
Moose::FV::InterpMethod _velocity_interp_method
The interpolation method to use for the velocity.
const Elem * elemPtr() const
const MooseEnum _volume_force_correction_method
– Method used for computing the properties average
bool onBoundary(const SubdomainRestrictable &obj, const FaceInfo &fi)
virtual unsigned int n_sides() const=0
const Elem * neighbor_ptr(unsigned int i) const
const INSFVVelocityVariable * vel() const
std::vector< const Moose::FunctorBase< VectorValue< ADReal > > * > _a_read
A vector sized according to the number of threads that holds the &#39;a&#39; data we will read from when comp...
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
static const std::string v
Definition: NS.h:84
subdomain_id_type subdomain_id() const
INSFVVelocityVariable *const _w
The thread 0 copy of the z-velocity variable (null if the problem is not 3D)
Real _baseline_volume_force
Minimum absolute RC force over the domain.
FEProblemBase & _fe_problem
bool relativeFuzzyEqual(const T &var1, const T2 &var2, const T3 &tol=libMesh::TOLERANCE *libMesh::TOLERANCE)
virtual Real volume() const
IntRange< T > make_range(T beg, T end)
std::vector< std::unique_ptr< Moose::VectorCompositeFunctor< ADReal > > > _disps
A functor for computing the displacement.
const bool & _bool_correct_vf
Correct Rhie-Chow coefficients for volumetric force flag.
std::vector< MooseVariableFVReal * > _ws
All the thread copies of the z-velocity variable.
Moose::CoordinateSystemType getCoordSystem(SubdomainID sid) const
static const std::string velocity
Definition: NS.h:45
bool _a_data_provided
Whether &#39;a&#39; data has been provided by the user.
bool velocitySkewCorrection(THREAD_ID tid) const
Whether central differencing face interpolations of velocity should include a skewness correction Als...
bool hasBlocks(const SubdomainName &name) const
void interpolate(InterpMethod m, T &result, const T2 &value1, const T3 &value2, const FaceInfo &fi, const bool one_is_elem)
std::vector< MooseVariableFVReal * > _vs
All the thread copies of the y-velocity variable.
Point vertex_average() const
std::vector< std::unique_ptr< PiecewiseByBlockLambdaFunctor< ADRealVectorValue > > > _vel
A functor for computing the (non-RC corrected) velocity.
const unsigned int _momentum_sys_number
The number of the nonlinear system in which the monolithic momentum and continuity equations are loca...
const ExecFlagType EXEC_INITIAL

◆ getVolumetricFaceFlux()

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

Retrieve the volumetric face flux, will not include derivatives.

Parameters
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 }
auto raw_value(const Eigen::Map< T > &in)
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.
const Point & normal() const

◆ ghostADataOnBoundary()

void INSFVRhieChowInterpolator::ghostADataOnBoundary ( const BoundaryID  boundary_id)
overridevirtualinherited

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

Reimplemented from RhieChowInterpolatorBase.

Definition at line 494 of file INSFVRhieChowInterpolator.C.

495 {
496  if (!needAComputation() || this->n_processors() == 1)
497  return;
498 
499  // Ghost a for the elements on the boundary
500  for (auto elem_id : _moose_mesh.getBoundaryActiveSemiLocalElemIds(boundary_id))
501  {
502  const auto & elem = _moose_mesh.elemPtr(elem_id);
503  // no need to ghost if locally owned or far from local process
504  if (elem->processor_id() != this->processor_id() && elem->is_semilocal(this->processor_id()))
505  // Adding to the a coefficient will make sure the final result gets communicated
506  addToA(elem, 0, 0);
507  }
508 
509  // Ghost a for the neighbors of the elements on the boundary
510  for (auto neighbor_id : _moose_mesh.getBoundaryActiveNeighborElemIds(boundary_id))
511  {
512  const auto & neighbor = _moose_mesh.queryElemPtr(neighbor_id);
513  // no need to ghost if locally owned or far from local process
514  if (neighbor->processor_id() != this->processor_id() &&
515  neighbor->is_semilocal(this->processor_id()))
516  // Adding to the a coefficient will make sure the final result gets communicated
517  addToA(neighbor, 0, 0);
518  }
519 }
bool needAComputation() const
Whether we need &#39;a&#39; coefficient computation.
std::unordered_set< dof_id_type > getBoundaryActiveSemiLocalElemIds(BoundaryID bid) const
virtual Elem * elemPtr(const dof_id_type i)
MooseMesh & _moose_mesh
The MooseMesh that this user object operates on.
virtual Elem * queryElemPtr(const dof_id_type i)
processor_id_type n_processors() const
std::unordered_set< dof_id_type > getBoundaryActiveNeighborElemIds(BoundaryID bid) const
virtual void addToA(const libMesh::Elem *elem, unsigned int component, const ADReal &value) override
API that momentum residual objects that have on-diagonals for velocity call.
processor_id_type processor_id() const

◆ 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 }
const Elem & elem() const
const Elem * neighborPtr() const
const Elem & neighbor() const
subdomain_id_type subdomain_id() const
bool hasBlocks(const SubdomainName &name) const

◆ initialize()

void PINSFVRhieChowInterpolator::initialize ( )
overridevirtual

Reimplemented from INSFVRhieChowInterpolator.

Definition at line 179 of file PINSFVRhieChowInterpolator.C.

180 {
181  if (_current_execute_flag == EXEC_INITIAL)
182  pinsfvSetup();
183  else
184  // Cannot compute Rhie Chow coefficients on initial
186 }
virtual void initialize() override
const ExecFlagType & _current_execute_flag
void pinsfvSetup()
called during the first initialize() and upon meshChanged(), this method performs the interpolations ...

◆ initialSetup()

void INSFVRhieChowInterpolator::initialSetup ( )
overridevirtualinherited

Reimplemented from GeneralUserObject.

Definition at line 265 of file INSFVRhieChowInterpolator.C.

266 {
267  insfvSetup();
268 
270  return;
271  for (const auto var_num : _var_numbers)
272  {
273  std::vector<MooseObject *> var_objects;
275  .query()
276  .template condition<AttribVar>(static_cast<int>(var_num))
277  .template condition<AttribResidualObject>(true)
278  .template condition<AttribSysNum>(_u->sys().number())
279  .queryInto(var_objects);
280  for (auto * const var_object : var_objects)
281  {
282  // Allow FVElementalKernel that are not INSFVMomentumResidualObject for now, refs #20695
283  if (!dynamic_cast<INSFVMomentumResidualObject *>(var_object) &&
284  !dynamic_cast<FVElementalKernel *>(var_object))
285  mooseError("Object ",
286  var_object->name(),
287  " is not a INSFVMomentumResidualObject. Make sure that all the objects applied "
288  "to the momentum equation are INSFV or derived objects.");
289  else if (!dynamic_cast<INSFVMomentumResidualObject *>(var_object) &&
290  dynamic_cast<FVElementalKernel *>(var_object))
291  mooseWarning(
292  "Elemental kernel ",
293  var_object->name(),
294  " is not a INSFVMomentumResidualObject. Make sure that all the objects applied "
295  "to the momentum equation are INSFV or derived objects.");
296  }
297 
298  if (var_objects.size() == 0 && !_a_data_provided)
299  mooseError("No INSFVKernels detected for the velocity variables. If you are trying to use "
300  "auxiliary variables for advection, please specify the a_u/v/w coefficients. If "
301  "not, please specify INSFVKernels for the momentum equations.");
302  }
303 
304  // Get baseline force if force-correction method is used for volumetric correction
305  if (_bool_correct_vf && _volume_force_correction_method == "force-consistent")
306  {
307  _baseline_volume_force = 1e10;
308  for (const auto & loc_elem : *_elem_range)
309  {
310  Real elem_value = 0.0;
311  for (const auto i : make_range(_volumetric_force.size()))
312  elem_value += (*_volumetric_force[i])(makeElemArg(loc_elem), determineState());
313 
314  if (std::abs(elem_value) < _baseline_volume_force)
315  _baseline_volume_force = std::abs(elem_value);
316  if (_baseline_volume_force == 0)
317  break;
318  }
320  }
321 }
std::vector< const Moose::Functor< Real > * > _volumetric_force
Values of the functors storing the volumetric forces.
INSFVVelocityVariable *const _u
The thread 0 copy of the x-velocity variable.
Moose::StateArg determineState() const
const Parallel::Communicator & _communicator
void mooseWarning(Args &&... args) const
Moose::ElemArg makeElemArg(const Elem *elem, bool correct_skewnewss=false) const
void min(const T &r, T &o, Request &req) const
TheWarehouse & theWarehouse() const
void insfvSetup()
perform the setup of this object
unsigned int number() const
Moose::FV::InterpMethod _velocity_interp_method
The interpolation method to use for the velocity.
const MooseEnum _volume_force_correction_method
– Method used for computing the properties average
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
Real _baseline_volume_force
Minimum absolute RC force over the domain.
FEProblemBase & _fe_problem
std::vector< unsigned int > _var_numbers
The velocity variable numbers.
Query query()
std::unique_ptr< ConstElemRange > _elem_range
All the active and elements local to this process that exist on this object&#39;s subdomains.
IntRange< T > make_range(T beg, T end)
const bool & _bool_correct_vf
Correct Rhie-Chow coefficients for volumetric force flag.
void mooseError(Args &&... args) const
bool _a_data_provided
Whether &#39;a&#39; data has been provided by the user.

◆ insfvSetup()

void INSFVRhieChowInterpolator::insfvSetup ( )
protectedinherited

perform the setup of this object

Definition at line 324 of file INSFVRhieChowInterpolator.C.

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

325 {
326  _elem_range =
327  std::make_unique<ConstElemRange>(_mesh.active_local_subdomain_set_elements_begin(blockIDs()),
328  _mesh.active_local_subdomain_set_elements_end(blockIDs()));
329 }
virtual const std::set< SubdomainID > & blockIDs() const
const libMesh::MeshBase & _mesh
The libMesh mesh that this object acts on.
std::unique_ptr< ConstElemRange > _elem_range
All the active and elements local to this process that exist on this object&#39;s subdomains.

◆ isFaceGeometricallyRelevant()

bool PINSFVRhieChowInterpolator::isFaceGeometricallyRelevant ( const FaceInfo fi) const
protected
Returns
whether this face is geometrically relevant to us

Definition at line 129 of file PINSFVRhieChowInterpolator.C.

Referenced by pinsfvSetup().

130 {
131  if (&fi.elem() == libMesh::remote_elem)
132  return false;
133 
134  bool on_us = blockIDs().count(fi.elem().subdomain_id());
135 
136  if (fi.neighborPtr())
137  {
138  if (&fi.neighbor() == libMesh::remote_elem)
139  return false;
140 
141  on_us = on_us || blockIDs().count(fi.neighbor().subdomain_id());
142  }
143 
144  if (!on_us)
145  // Neither the element nor neighbor has a subdomain id on which we are active, so this face is
146  // not relevant
147  return false;
148 
149  //
150  // Ok, we've established that either the element or neighbor is active on our subdomains and
151  // neither of them are remote elements, so this face is still in the running to be considered
152  // relevant. There is one more caveat to be considered. In the case that we are a boundary face,
153  // we will generally need a two term expansion to compute our value, which will require a
154  // cell-gradient evaluation. If that is the case, then all of our surrounding neighbors cannot be
155  // remote. If we are not a boundary face, then at this point we're safe
156  //
157 
158  if (!Moose::FV::onBoundary(blockIDs(), fi))
159  return true;
160 
161  const auto & boundary_elem = (fi.neighborPtr() && blockIDs().count(fi.neighbor().subdomain_id()))
162  ? fi.neighbor()
163  : fi.elem();
164 
165  for (auto * const neighbor : boundary_elem.neighbor_ptr_range())
166  {
167  if (!neighbor)
168  continue;
169 
170  if ((neighbor == libMesh::remote_elem))
171  return false;
172  }
173 
174  // We made it through all the tests!
175  return true;
176 }
const Elem & elem() const
virtual const std::set< SubdomainID > & blockIDs() const
const Elem * neighborPtr() const
const Elem & neighbor() const
bool onBoundary(const SubdomainRestrictable &obj, const FaceInfo &fi)
const RemoteElem * remote_elem

◆ listOfCommonParams()

std::vector< std::string > INSFVRhieChowInterpolator::listOfCommonParams ( )
staticinherited
Returns
A list of the parameters that are common between this object and the NSFV action

Definition at line 65 of file INSFVRhieChowInterpolator.C.

Referenced by WCNSFVFlowPhysics::addRhieChowUserObjects().

66 {
67  return {"pull_all_nonlocal_a",
68  "correct_volumetric_force",
69  "volume_force_correction_method",
70  "volumetric_force_functors"};
71 }

◆ meshChanged()

void PINSFVRhieChowInterpolator::meshChanged ( )
overridevirtual

Reimplemented from INSFVRhieChowInterpolator.

Definition at line 81 of file PINSFVRhieChowInterpolator.C.

82 {
84  pinsfvSetup();
85 }
virtual void meshChanged() override
void pinsfvSetup()
called during the first initialize() and upon meshChanged(), this method performs the interpolations ...

◆ pinsfvSetup()

void PINSFVRhieChowInterpolator::pinsfvSetup ( )
private

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

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

Definition at line 88 of file PINSFVRhieChowInterpolator.C.

Referenced by initialize(), and meshChanged().

89 {
90  if (!_smoothing_layers)
91  return;
92 
93  if (dynamic_cast<BernoulliPressureVariable *>(_p))
94  paramError(
96  "If 'smoothing_layers' is non-zero, e.g. if the porosity is smooth(ed), "
97  "then the pressure drop should be computed automatically. The "
98  "'BernoulliPressureVariable' class enforces a pressure drop according to the Bernoulli "
99  "equation on any face which has different pressure values on either side. This is "
100  "undesirable when the porosity is varying smoothing and there may be pressure drops "
101  "corresponding to viscous effects. Please just use the 'INSFVPressureVariable' "
102  "class for pressure when the porosity is smooth.");
103 
104  const auto & all_fi = _moose_mesh.allFaceInfo();
105  _geometric_fi.reserve(all_fi.size());
106 
107  for (const auto & fi : all_fi)
109  _geometric_fi.push_back(&fi);
110 
111  _geometric_fi.shrink_to_fit();
112 
113  const auto saved_do_derivatives = ADReal::do_derivatives;
114  ADReal::do_derivatives = true;
117  ADReal::do_derivatives = saved_do_derivatives;
118 
119  // Assign the new functor to all
120  for (const auto tid : make_range((unsigned int)(1), libMesh::n_threads()))
121  {
122  auto & other_smoothed_epss = const_cast<Moose::Functor<ADReal> &>(
124  other_smoothed_epss.assign(_smoothed_eps);
125  }
126 }
INSFVPressureVariable *const _p
The thread 0 copy of the pressure variable.
unsigned int n_threads()
const Moose::Functor< T > & getFunctor(const std::string &name, const THREAD_ID tid, const std::string &requestor_name, bool requestor_is_ad)
MooseMesh & _moose_mesh
The MooseMesh that this user object operates on.
bool isFaceGeometricallyRelevant(const FaceInfo &fi) const
static const std::string smoothed_porosity
Definition: NS.h:105
Moose::StateArg determineState() const
std::vector< const FaceInfo * > _geometric_fi
All the face information that are "geometrically" accessible on this process.
DualNumber< Real, DNDerivativeType, true > ADReal
virtual const std::string & name() const
SubProblem & _subproblem
const std::vector< FaceInfo > & allFaceInfo() const
void interpolateReconstruct(CellCenteredMapFunctor< T, Map > &output_functor, const Moose::FunctorBase< T > &input_functor, const unsigned int num_int_recs, const bool weight_with_sf, const std::vector< const FaceInfo *> &faces, const Moose::StateArg &time)
Takes an input functor that can be evaluated at faces, typically by linearly interpolating between ad...
void paramError(const std::string &param, Args... args) const
CellCenteredMapFunctor< ADReal, std::unordered_map< dof_id_type, ADReal > > _smoothed_eps
The smoothed porosity functor/field.
static const std::string pressure
Definition: NS.h:56
IntRange< T > make_range(T beg, T end)
const unsigned short _smoothing_layers
The number of interpolations and reconstructions that should be performed on the porosity functor/fie...
const Moose::Functor< ADReal > & _eps
The thread 0 copy of the porosity functor held by the subproblem.

◆ pressure()

const INSFVPressureVariable & RhieChowInterpolatorBase::pressure ( THREAD_ID  tid) const
inlineinherited
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 }
std::vector< MooseVariableFVReal * > _ps
All the thread copies of the pressure variable.

◆ pressureSkewCorrection()

bool INSFVRhieChowInterpolator::pressureSkewCorrection ( THREAD_ID  tid) const
inlineinherited

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

Definition at line 248 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator::getVelocity().

249 {
250  const auto * const p = _ps[tid];
251  return (p->faceInterpolationMethod() == Moose::FV::InterpMethod::SkewCorrectedAverage);
252 }
std::vector< MooseVariableFVReal * > _ps
All the thread copies of the pressure variable.

◆ pullAllNonlocal()

void INSFVRhieChowInterpolator::pullAllNonlocal ( )
inlineinherited

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

all of our nonlocal elements we have pointers to)

Definition at line 99 of file INSFVRhieChowInterpolator.h.

Referenced by GetAllTheRCVelocities::GetAllTheRCVelocities().

99 { _pull_all_nonlocal = true; }
bool _pull_all_nonlocal
Whether we want to pull all nonlocal &#39;a&#39; coefficient data.

◆ segregated()

virtual bool INSFVRhieChowInterpolator::segregated ( ) const
inlineoverridevirtualinherited

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

Implements RhieChowInterpolatorBase.

Definition at line 88 of file INSFVRhieChowInterpolator.h.

88 { return false; };

◆ supportMeshVelocity()

virtual bool RhieChowFaceFluxProvider::supportMeshVelocity ( ) const
inlinevirtualinherited

Returns whether the UO can support mesh velocity advection.

Reimplemented in RhieChowMassFlux.

Definition at line 49 of file RhieChowFaceFluxProvider.h.

Referenced by VolumetricFlowRate::VolumetricFlowRate().

49 { return true; }

◆ uniqueParams()

InputParameters INSFVRhieChowInterpolator::uniqueParams ( )
staticinherited

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

Definition at line 40 of file INSFVRhieChowInterpolator.C.

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

41 {
42  auto params = emptyInputParameters();
43  params.addParam<bool>(
44  "pull_all_nonlocal_a",
45  false,
46  "Whether to pull all nonlocal 'a' coefficient data to our process. Note that 'nonlocal' "
47  "means elements that we have access to (this may not be all the elements in the mesh if the "
48  "mesh is distributed) but that we do not own.");
49  params.addParamNamesToGroup("pull_all_nonlocal_a", "Parallel Execution Tuning");
50 
51  params.addParam<bool>(
52  "correct_volumetric_force", false, "Flag to activate volume force corrections.");
53  MooseEnum volume_force_correction_method("force-consistent pressure-consistent",
54  "force-consistent");
55  params.addParam<MooseEnum>(
56  "volume_force_correction_method",
57  volume_force_correction_method,
58  "The method used for correcting the Rhie-Chow coefficients for a volume force.");
59  params.addParam<std::vector<MooseFunctorName>>(
60  "volumetric_force_functors", "The names of the functors with the volumetric force sources.");
61  return params;
62 }
InputParameters emptyInputParameters()

◆ validParams()

InputParameters PINSFVRhieChowInterpolator::validParams ( )
static

Definition at line 19 of file PINSFVRhieChowInterpolator.C.

20 {
22  params.addClassDescription("Performs interpolations and reconstructions of porosity and computes "
23  "the Rhie-Chow face velocities.");
24  ExecFlagEnum & exec_enum = params.set<ExecFlagEnum>("execute_on", /*quiet=*/true);
25  exec_enum.setAdditionalValue(EXEC_INITIAL);
26  params.addRequiredParam<MooseFunctorName>(NS::porosity, "The porosity");
27  params.addParam<unsigned short>(
28  "smoothing_layers",
29  0,
30  "The number of interpolation-reconstruction operations to perform on the porosity");
31  params.addRelationshipManager("ElementSideNeighborLayers",
33  [](const InputParameters & obj_params, InputParameters & rm_params)
34  {
35  rm_params.set<unsigned short>("layers") =
36  obj_params.get<unsigned short>("smoothing_layers");
37  rm_params.set<bool>("use_displaced_mesh") =
38  obj_params.get<bool>("use_displaced_mesh");
39  });
40  return params;
41 }
void setAdditionalValue(const std::string &names)
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
T & set(const std::string &name, bool quiet_mode=false)
static const std::string porosity
Definition: NS.h:104
static InputParameters validParams()

◆ vel()

const INSFVVelocityVariable* RhieChowInterpolatorBase::vel ( ) const
inlineinherited

Definition at line 83 of file RhieChowInterpolatorBase.h.

Referenced by INSFVRhieChowInterpolator::getVelocity().

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

◆ velocityInterpolationMethod()

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

Return the interpolation method used for velocity.

Definition at line 70 of file RhieChowInterpolatorBase.h.

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

◆ velocitySkewCorrection()

bool INSFVRhieChowInterpolator::velocitySkewCorrection ( THREAD_ID  tid) const
inlineinherited

Whether central differencing face interpolations of velocity should include a skewness correction Also used for the face interpolation of the D coefficient and the face interpolation of volumetric forces for for the volume correction method and the face interpolation of porosity.

Definition at line 241 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator::getVelocity().

242 {
243  const auto * const u = _us[tid];
244  return (u->faceInterpolationMethod() == Moose::FV::InterpMethod::SkewCorrectedAverage);
245 }
std::vector< MooseVariableFVReal * > _us
All the thread copies of the x-velocity variable.

Member Data Documentation

◆ _a

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

◆ _ax

Moose::VectorComponentFunctor<ADReal> INSFVRhieChowInterpolator::_ax
protectedinherited

The x-component of 'a'

Definition at line 151 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator::fillARead().

◆ _ay

Moose::VectorComponentFunctor<ADReal> INSFVRhieChowInterpolator::_ay
protectedinherited

The y-component of 'a'.

Definition at line 154 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator::fillARead().

◆ _az

Moose::VectorComponentFunctor<ADReal> INSFVRhieChowInterpolator::_az
protectedinherited

The z-component of 'a'.

Definition at line 157 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator::fillARead().

◆ _dim

const unsigned int RhieChowInterpolatorBase::_dim
protectedinherited

◆ _disp_xs

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

All the thread copies of the x-displacement variable.

Definition at line 126 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator::INSFVRhieChowInterpolator().

◆ _disp_ys

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

All the thread copies of the y-displacement variable.

Definition at line 129 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator::INSFVRhieChowInterpolator().

◆ _disp_zs

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

All the thread copies of the z-displacement variable.

Definition at line 132 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator::INSFVRhieChowInterpolator().

◆ _displaced

const bool RhieChowInterpolatorBase::_displaced
protectedinherited

Whether this object is operating on the displaced mesh.

Definition at line 149 of file RhieChowInterpolatorBase.h.

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

◆ _disps

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

A functor for computing the displacement.

Definition at line 135 of file INSFVRhieChowInterpolator.h.

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

◆ _elem_range

std::unique_ptr<ConstElemRange> INSFVRhieChowInterpolator::_elem_range
protectedinherited

All the active and elements local to this process that exist on this object's subdomains.

Definition at line 138 of file INSFVRhieChowInterpolator.h.

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

◆ _eps

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

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

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

Definition at line 44 of file PINSFVRhieChowInterpolator.h.

Referenced by PINSFVRhieChowInterpolator(), and pinsfvSetup().

◆ _epss

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

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

Definition at line 50 of file PINSFVRhieChowInterpolator.h.

Referenced by epsilon(), and PINSFVRhieChowInterpolator().

◆ _geometric_fi

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

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

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

Definition at line 65 of file PINSFVRhieChowInterpolator.h.

Referenced by pinsfvSetup().

◆ _mesh

const libMesh::MeshBase& RhieChowInterpolatorBase::_mesh
protectedinherited

◆ _momentum_sys_number

const unsigned int INSFVRhieChowInterpolator::_momentum_sys_number
protectedinherited

The number of the nonlinear system in which the monolithic momentum and continuity equations are located.

Definition at line 161 of file INSFVRhieChowInterpolator.h.

Referenced by INSFVRhieChowInterpolator::execute(), INSFVRhieChowInterpolator::finalize(), INSFVRhieChowInterpolator::getVelocity(), and INSFVRhieChowInterpolator::initialize().

◆ _moose_mesh

MooseMesh& RhieChowInterpolatorBase::_moose_mesh
protectedinherited

◆ _p

INSFVPressureVariable* const RhieChowInterpolatorBase::_p
protectedinherited

◆ _ps

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

◆ _smoothed_eps

CellCenteredMapFunctor<ADReal, std::unordered_map<dof_id_type, ADReal> > PINSFVRhieChowInterpolator::_smoothed_eps
protected

The smoothed porosity functor/field.

Definition at line 47 of file PINSFVRhieChowInterpolator.h.

Referenced by PINSFVRhieChowInterpolator(), and pinsfvSetup().

◆ _smoothed_epss

std::vector<const Moose::Functor<ADReal> *> PINSFVRhieChowInterpolator::_smoothed_epss
protected

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

Definition at line 53 of file PINSFVRhieChowInterpolator.h.

Referenced by epsilon(), and PINSFVRhieChowInterpolator().

◆ _smoothing_layers

const unsigned short PINSFVRhieChowInterpolator::_smoothing_layers
protected

The number of interpolations and reconstructions that should be performed on the porosity functor/field.

One smoothing layer corresponds to one interpolation and one reconstruction

Definition at line 57 of file PINSFVRhieChowInterpolator.h.

Referenced by epsilon(), PINSFVRhieChowInterpolator(), and pinsfvSetup().

◆ _sys

SystemBase& RhieChowInterpolatorBase::_sys
protectedinherited

The nonlinear system.

Definition at line 143 of file RhieChowInterpolatorBase.h.

◆ _u

INSFVVelocityVariable* const RhieChowInterpolatorBase::_u
protectedinherited

◆ _us

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

◆ _v

INSFVVelocityVariable* const RhieChowInterpolatorBase::_v
protectedinherited

◆ _var_numbers

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

◆ _vel

std::vector<std::unique_ptr<PiecewiseByBlockLambdaFunctor<ADRealVectorValue> > > INSFVRhieChowInterpolator::_vel
protectedinherited

A functor for computing the (non-RC corrected) velocity.

Definition at line 123 of file INSFVRhieChowInterpolator.h.

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

◆ _velocity_interp_method

Moose::FV::InterpMethod RhieChowInterpolatorBase::_velocity_interp_method
protectedinherited

◆ _vs

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

◆ _w

INSFVVelocityVariable* const RhieChowInterpolatorBase::_w
protectedinherited

◆ _ws

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

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