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 | List of all members
SCMFrictionUpdatedChengTodreas Class Reference

Class that calculates the friction factor based on the updated Cheng & Todreas correlations (Cheng et all 2018). More...

#include <SCMFrictionUpdatedChengTodreas.h>

Inheritance diagram for SCMFrictionUpdatedChengTodreas:
[legend]

Public Types

typedef SubChannel1PhaseProblem::FrictionStruct FrictionStruct
 
typedef DataFileName DataFileParameterType
 

Public Member Functions

 SCMFrictionUpdatedChengTodreas (const InputParameters &parameters)
 
virtual Real computeFrictionFactor (const FrictionStruct &friction_info) const override
 Computes the friction factor for the local conditions. More...
 
virtual void execute () final
 
virtual void initialize () final
 
virtual void finalize () final
 
virtual void threadJoin (const UserObject &) final
 
virtual void subdomainSetup () final
 
bool needThreadedCopy () const override final
 
virtual Real spatialValue (const Point &) const
 
virtual const std::vector< Point > spatialPoints () const
 
void setPrimaryThreadCopy (UserObject *primary)
 
UserObject * primaryThreadCopy ()
 
SubProblem & getSubProblem () const
 
bool shouldDuplicateInitialExecution () 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)
 
std::set< UserObjectName > getDependObjects () const
 
const std::set< std::string > & getRequestedItems () override
 
const std::set< std::string > & getSuppliedItems () override
 
unsigned int systemNumber () const
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
bool isKokkosObject () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
const std::string & name () const
 
std::string typeAndName () const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
MooseObjectName uniqueName () const
 
const InputParameters & parameters () const
 
const hit::Node * getHitNode () const
 
bool hasBase () const
 
const std::string & getBase () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
T getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool haveParameter (const std::string &name) const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &name) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (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
 
std::string messagePrefix (const bool hit_prefix=true) const
 
std::string errorPrefix (const std::string &) const
 
void mooseError (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecatedNoTrace (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
void callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
virtual void initialSetup ()
 
virtual void timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnum & getExecuteOnEnum () const
 
UserObjectName getUserObjectName (const std::string &param_name) const
 
const T & getUserObject (const std::string &param_name, bool is_dependency=true) const
 
const T & getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const
 
const UserObjectBase & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObjectBase & getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
 
const std::vector< MooseVariableScalar *> & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyByName (const std::string &prop_name_in)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOldByName (const std::string &prop_name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOlderByName (const std::string &prop_name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialProperty (const std::string &name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOld (const std::string &name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOlder (const std::string &name)
 
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty (const MaterialPropertyName &name)
 
std::pair< Moose::Kokkos::MaterialProperty< T, dimension >, std::set< SubdomainID > > getKokkosBlockMaterialProperty (const MaterialPropertyName &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty ()
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialPropertyByName (const std::string &prop_name)
 
const MaterialProperty< T > & getZeroMaterialProperty (Ts... args)
 
std::set< SubdomainID > getMaterialPropertyBlocks (const std::string &name)
 
std::vector< SubdomainName > getMaterialPropertyBlockNames (const std::string &name)
 
std::set< BoundaryID > getMaterialPropertyBoundaryIDs (const std::string &name)
 
std::vector< BoundaryName > getMaterialPropertyBoundaryNames (const std::string &name)
 
void checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)
 
std::unordered_map< SubdomainID, std::vector< MaterialBase *> > buildRequiredMaterials (bool allow_stateful=true)
 
void statefulPropertiesAllowed (bool)
 
virtual 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
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasKokkosMaterialProperty (const std::string &name)
 
bool hasKokkosMaterialProperty (const std::string &name)
 
bool hasKokkosMaterialPropertyByName (const std::string &name)
 
bool hasKokkosMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
const Function & getFunction (const std::string &name) const
 
const Function & getFunctionByName (const FunctionName &name) const
 
bool hasFunction (const std::string &param_name) const
 
bool hasFunctionByName (const FunctionName &name) const
 
Moose::Kokkos::Function getKokkosFunction (const std::string &name) const
 
const T & getKokkosFunction (const std::string &name) const
 
Moose::Kokkos::Function getKokkosFunctionByName (const FunctionName &name) const
 
const T & getKokkosFunctionByName (const FunctionName &name) const
 
bool hasKokkosFunction (const std::string &param_name) const
 
bool hasKokkosFunctionByName (const FunctionName &name) const
 
bool isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessor (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessorByName (const PostprocessorName &name) const
 
std::size_t coupledPostprocessors (const std::string &param_name) const
 
const PostprocessorName & getPostprocessorName (const std::string &param_name, const unsigned int index=0) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name) const
 
const VectorPostprocessorName & getVectorPostprocessorName (const std::string &param_name) const
 
T & getSampler (const std::string &name)
 
Sampler & getSampler (const std::string &name)
 
T & getSamplerByName (const SamplerName &name)
 
Sampler & getSamplerByName (const SamplerName &name)
 
virtual void meshChanged ()
 
virtual void meshDisplaced ()
 
PerfGraph & perfGraph ()
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
const Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 

Static Public Member Functions

static InputParameters validParams ()
 
static void callMooseError (MooseApp *const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node *node, const bool show_trace=true)
 
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, NameFunc &&name_func)
 
static void cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)
 

Public Attributes

 usingCombinedWarningSolutionWarnings
 
const ConsoleStream _console
 

Static Public Attributes

static const std::string type_param
 
static const std::string name_param
 
static const std::string unique_name_param
 
static const std::string app_param
 
static const std::string moose_base_param
 
static const std::string kokkos_object_param
 
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

Real computeTriLatticeFrictionFactor (const FrictionStruct &friction_info) const
 
Real computeQuadLatticeFrictionFactor (const FrictionStruct &friction_info) const
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &name) const override
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override
 
virtual void addUserObjectDependencyHelper (const UserObjectBase &uo) const override
 
void addReporterDependencyHelper (const ReporterName &reporter_name) override
 
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) const
 
const ReporterContextBase & getReporterContextBaseByName (const ReporterName &reporter_name) const
 
const ReporterName & getReporterName (const std::string &param_name) const
 
T & declareRestartableData (const std::string &data_name, Args &&... args)
 
ManagedValue< T > declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
const T & getRestartableData (const std::string &data_name) const
 
T & declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
T & declareRecoverableData (const std::string &data_name, Args &&... args)
 
T & declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
 
T & declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
 
std::string restartableName (const std::string &data_name) const
 
const T & getMeshProperty (const std::string &data_name, const std::string &prefix)
 
const T & getMeshProperty (const std::string &data_name)
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name) const
 
bool hasMeshProperty (const std::string &data_name) const
 
std::string meshPropertyName (const std::string &data_name) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_name) const
 
bool isCoupledScalar (const std::string &var_name, unsigned int i=0) const
 
unsigned int coupledScalarComponents (const std::string &var_name) const
 
unsigned int coupledScalar (const std::string &var_name, unsigned int comp=0) const
 
libMesh::Order coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< is_ad > & coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const VariableValue & coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const MooseVariableScalar * getScalarVar (const std::string &var_name, unsigned int comp) const
 
virtual void checkMaterialProperty (const std::string &name, const unsigned int state)
 
virtual void getKokkosMaterialPropertyHook (const std::string &, const unsigned int)
 
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)
 

Static Protected Member Functions

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

Protected Attributes

bool _is_tri_lattice
 Keep track of the lattice type. More...
 
const TriSubChannelMesh *const _tri_sch_mesh
 Pointer to the tri lattice mesh. More...
 
const QuadSubChannelMesh *const _quad_sch_mesh
 Pointer to the quad lattice mesh. More...
 
const bool _has_wire_wrap
 Whether the triangular assembly has wire-wrap geometry. More...
 
const SubChannelMesh & _subchannel_mesh
 Reference to the subchannel mesh. More...
 
const SubChannel1PhaseProblem & _scm_problem
 Reference to the subchannel problem. More...
 
const Moose::CoordinateSystemType & _coord_sys
 
const THREAD_ID _tid
 
SubProblem & _subproblem
 
FEProblemBase & _fe_problem
 
SystemBase & _sys
 
Assembly & _assembly
 
const bool _duplicate_initial_execution
 
std::set< std::string > _depend_uo
 
const bool & _enabled
 
MooseApp & _app
 
Factory & _factory
 
ActionFactory & _action_factory
 
const std::string & _type
 
const std::string & _name
 
const InputParameters & _pars
 
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 bool _is_kokkos_object
 
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
 

Static Protected Attributes

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

Detailed Description

Class that calculates the friction factor based on the updated Cheng & Todreas correlations (Cheng et all 2018).

It is used for both quad and tri lattices.

Definition at line 20 of file SCMFrictionUpdatedChengTodreas.h.

Member Typedef Documentation

◆ FrictionStruct

typedef SubChannel1PhaseProblem::FrictionStruct SCMFrictionClosureBase::FrictionStruct
inherited

Definition at line 25 of file SCMFrictionClosureBase.h.

Constructor & Destructor Documentation

◆ SCMFrictionUpdatedChengTodreas()

SCMFrictionUpdatedChengTodreas::SCMFrictionUpdatedChengTodreas ( const InputParameters &  parameters)

Definition at line 23 of file SCMFrictionUpdatedChengTodreas.C.

24  : SCMFrictionClosureBase(parameters),
25  _is_tri_lattice(dynamic_cast<const TriSubChannelMesh *>(&_subchannel_mesh) != nullptr),
26  _tri_sch_mesh(dynamic_cast<const TriSubChannelMesh *>(&_subchannel_mesh)),
27  _quad_sch_mesh(dynamic_cast<const QuadSubChannelMesh *>(&_subchannel_mesh)),
28  _has_wire_wrap(_is_tri_lattice && _tri_sch_mesh->getWireDiameter() != 0.0 &&
29  _tri_sch_mesh->getWireLeadLength() != 0.0)
30 {
31  if (_is_tri_lattice &&
32  ((_tri_sch_mesh->getWireDiameter() != 0.0) != (_tri_sch_mesh->getWireLeadLength() != 0.0)))
33  mooseError(name(),
34  ": wire-wrapped bundle friction requires both wire diameter and wire lead length. "
35  "Set both to zero for a bare pin bundle.");
36 
37  if (_is_tri_lattice)
38  {
39  const auto pitch = _subchannel_mesh.getPitch();
40  const auto pin_diameter = _subchannel_mesh.getPinDiameter();
41  const auto p_over_d = pitch / pin_diameter;
42  const auto wire_lead_to_diameter = _tri_sch_mesh->getWireLeadLength() / pin_diameter;
43  const unsigned int Nr = _tri_sch_mesh->getNumOfRings();
44  const unsigned int num_pins = 1 + 3 * Nr * (Nr - 1);
45 
46  // The updated Cheng-Todreas detailed triangular friction factor correlation is based on
47  // data spanning 1.0 <= P/D <= 1.42, 4 <= H/D <= 52, 7 <= Npin <= 271,
48  // and 50 <= Re <= 1e6.
49  if (p_over_d < 1.0 || p_over_d > 1.42)
50  flagSolutionWarning("Pitch-over-pin diameter ratio (P/D) outside the updated "
51  "Cheng-Todreas friction correlation data range.");
52  if (_has_wire_wrap && (wire_lead_to_diameter < 4.0 || wire_lead_to_diameter > 52.0))
53  flagSolutionWarning("Wire lead length-over-pin diameter ratio (H/D) outside the updated "
54  "Cheng-Todreas friction correlation data range.");
55  if (num_pins < 7 || num_pins > 271)
56  flagSolutionWarning("Number of pins outside the updated Cheng-Todreas friction correlation "
57  "data range.");
58  }
59 }
TriSubChannelMesh::getWireDiameter
const Real & getWireDiameter() const
Return wire diameter.
Definition: TriSubChannelMesh.h:67
SubChannelMesh::getPinDiameter
virtual const Real & getPinDiameter() const
Return undeformed Pin diameter.
Definition: SubChannelMesh.h:147
SCMFrictionUpdatedChengTodreas::_tri_sch_mesh
const TriSubChannelMesh *const _tri_sch_mesh
Pointer to the tri lattice mesh.
Definition: SCMFrictionUpdatedChengTodreas.h:36
SCMFrictionUpdatedChengTodreas::_has_wire_wrap
const bool _has_wire_wrap
Whether the triangular assembly has wire-wrap geometry.
Definition: SCMFrictionUpdatedChengTodreas.h:40
SubChannelMesh::getPitch
virtual const Real & getPitch() const
Return the undeformed pitch between 2 subchannels.
Definition: SubChannelMesh.h:142
ThreadedGeneralUserObject::parameters
const InputParameters & parameters() const
SCMFrictionUpdatedChengTodreas::_is_tri_lattice
bool _is_tri_lattice
Keep track of the lattice type.
Definition: SCMFrictionUpdatedChengTodreas.h:34
TriSubChannelMesh::getNumOfRings
const unsigned int & getNumOfRings() const
Return the number of fuel-pin rings, counting the center pin as the first ring.
Definition: TriSubChannelMesh.h:54
ThreadedGeneralUserObject::name
const std::string & name() const
RGMB::pitch
static const std::string pitch
Definition: ReactorGeometryMeshBuilderBase.h:41
SCMFrictionUpdatedChengTodreas::_quad_sch_mesh
const QuadSubChannelMesh *const _quad_sch_mesh
Pointer to the quad lattice mesh.
Definition: SCMFrictionUpdatedChengTodreas.h:38
SCMFrictionClosureBase::SCMFrictionClosureBase
SCMFrictionClosureBase(const InputParameters &parameters)
Definition: SCMFrictionClosureBase.C:20
SCMClosureBase::_subchannel_mesh
const SubChannelMesh & _subchannel_mesh
Reference to the subchannel mesh.
Definition: SCMClosureBase.h:35
ThreadedGeneralUserObject::mooseError
void mooseError(Args &&... args) const
TriSubChannelMesh::getWireLeadLength
const Real & getWireLeadLength() const
Return the wire lead length.
Definition: TriSubChannelMesh.h:77

Member Function Documentation

◆ computeFrictionFactor()

Real SCMFrictionUpdatedChengTodreas::computeFrictionFactor ( const FrictionStruct &  friction_info) const
overridevirtual

Computes the friction factor for the local conditions.

Parameters
friction_infogeometrical information about the cell in the channel
Returns
the friction factor

Implements SCMFrictionClosureBase.

Definition at line 62 of file SCMFrictionUpdatedChengTodreas.C.

63 {
64  if (_is_tri_lattice)
65  return computeTriLatticeFrictionFactor(friction_args);
66  else
67  return computeQuadLatticeFrictionFactor(friction_args);
68 }
SCMFrictionUpdatedChengTodreas::_is_tri_lattice
bool _is_tri_lattice
Keep track of the lattice type.
Definition: SCMFrictionUpdatedChengTodreas.h:34
SCMFrictionUpdatedChengTodreas::computeQuadLatticeFrictionFactor
Real computeQuadLatticeFrictionFactor(const FrictionStruct &friction_info) const
Definition: SCMFrictionUpdatedChengTodreas.C:261
SCMFrictionUpdatedChengTodreas::computeTriLatticeFrictionFactor
Real computeTriLatticeFrictionFactor(const FrictionStruct &friction_info) const
Definition: SCMFrictionUpdatedChengTodreas.C:71

◆ computeQuadLatticeFrictionFactor()

Real SCMFrictionUpdatedChengTodreas::computeQuadLatticeFrictionFactor ( const FrictionStruct &  friction_info) const
protected

Todreas-Kazimi NUCLEAR SYSTEMS, second edition, Volume 1, 2011

Definition at line 261 of file SCMFrictionUpdatedChengTodreas.C.

Referenced by computeFrictionFactor().

263 {
264  const auto Re = friction_args.Re;
265  const auto i_ch = friction_args.i_ch;
267  Real aL, b1L, b2L, cL;
268  Real aT, b1T, b2T, cT;
269  const auto pitch = _subchannel_mesh.getPitch();
270  const auto pin_diameter = _subchannel_mesh.getPinDiameter();
271  // This gap is a constant value for the whole assembly. Might want to make it
272  // subchannel specific in the future if we have duct deformation.
273  const auto side_gap = _quad_sch_mesh->getSideGap();
274  const auto w = (pin_diameter / 2.0) + (pitch / 2.0) + side_gap;
275  const auto p_over_d = pitch / pin_diameter;
276  const auto w_over_d = w / pin_diameter;
277  const auto ReL = std::pow(10, (p_over_d - 1)) * 320.0;
278  const auto ReT = std::pow(10, 0.7 * (p_over_d - 1)) * 1.0E+4;
279  const auto psi = std::log(Re / ReL) / std::log(ReT / ReL);
280  const auto subch_type = _subchannel_mesh.getSubchannelType(i_ch);
281 
282  // Find the coefficients of bare Pin bundle friction factor
283  // correlations for turbulent and laminar flow regimes. Todreas & Kazimi, Nuclear Systems Volume
284  // 1
285  if (subch_type == EChannelType::CENTER)
286  {
287  if (p_over_d < 1.1)
288  {
289  aL = 26.37;
290  b1L = 374.2;
291  b2L = -493.9;
292  aT = 0.09423;
293  b1T = 0.5806;
294  b2T = -1.239;
295  }
296  else
297  {
298  aL = 35.55;
299  b1L = 263.7;
300  b2L = -190.2;
301  aT = 0.1339;
302  b1T = 0.09059;
303  b2T = -0.09926;
304  }
305  // laminar flow friction factor for bare Pin bundle - Center subchannel
306  cL = aL + b1L * (p_over_d - 1) + b2L * Utility::pow<2>((p_over_d - 1));
307  // turbulent flow friction factor for bare Pin bundle - Center subchannel
308  cT = aT + b1T * (p_over_d - 1) + b2T * Utility::pow<2>((p_over_d - 1));
309  }
310  else if (subch_type == EChannelType::EDGE)
311  {
312  if (p_over_d < 1.1)
313  {
314  aL = 26.18;
315  b1L = 554.5;
316  b2L = -1480;
317  aT = 0.09377;
318  b1T = 0.8732;
319  b2T = -3.341;
320  }
321  else
322  {
323  aL = 44.40;
324  b1L = 256.7;
325  b2L = -267.6;
326  aT = 0.1430;
327  b1T = 0.04199;
328  b2T = -0.04428;
329  }
330  // laminar flow friction factor for bare Pin bundle - Edge subchannel
331  cL = aL + b1L * (w_over_d - 1) + b2L * Utility::pow<2>((w_over_d - 1));
332  // turbulent flow friction factor for bare Pin bundle - Edge subchannel
333  cT = aT + b1T * (w_over_d - 1) + b2T * Utility::pow<2>((w_over_d - 1));
334  }
335  else
336  {
337  if (p_over_d < 1.1)
338  {
339  aL = 28.62;
340  b1L = 715.9;
341  b2L = -2807;
342  aT = 0.09755;
343  b1T = 1.127;
344  b2T = -6.304;
345  }
346  else
347  {
348  aL = 58.83;
349  b1L = 160.7;
350  b2L = -203.5;
351  aT = 0.1452;
352  b1T = 0.02681;
353  b2T = -0.03411;
354  }
355  // laminar flow friction factor for bare Pin bundle - Corner subchannel
356  cL = aL + b1L * (w_over_d - 1) + b2L * Utility::pow<2>((w_over_d - 1));
357  // turbulent flow friction factor for bare Pin bundle - Corner subchannel
358  cT = aT + b1T * (w_over_d - 1) + b2T * Utility::pow<2>((w_over_d - 1));
359  }
360  // laminar friction factor and turbulent friction factor coefficients
361  const Real bL = -1.0;
362  const Real bT = -0.18;
363  auto fL = cL * std::pow(Re, bL);
364  auto fT = cT * std::pow(Re, bT);
365 
366  if (Re < ReL)
367  {
368  // laminar flow
369  return fL;
370  }
371  else if (Re > ReT)
372  {
373  // turbulent flow
374  return fT;
375  }
376  else
377  {
378  // transient flow: psi definition uses a Bulk ReT/ReL number, same for all channels
379  return fL * std::pow((1 - psi), 1.0 / 3.0) * (1 - std::pow(psi, 7)) +
380  fT * std::pow(psi, 1.0 / 3.0);
381  }
382 }
SubChannelMesh::getPinDiameter
virtual const Real & getPinDiameter() const
Return undeformed Pin diameter.
Definition: SubChannelMesh.h:147
SubChannelMesh::getPitch
virtual const Real & getPitch() const
Return the undeformed pitch between 2 subchannels.
Definition: SubChannelMesh.h:142
SubChannelMesh::getSubchannelType
virtual EChannelType getSubchannelType(unsigned int index) const =0
Return the type of the subchannel for given subchannel index.
QuadSubChannelMesh::getSideGap
const Real & getSideGap() const
Returns the side gap, not to be confused with the gap between pins, this refers to the gap next to th...
Definition: QuadSubChannelMesh.h:89
RGMB::pitch
static const std::string pitch
Definition: ReactorGeometryMeshBuilderBase.h:41
Re
const double Re
Definition: GasLiquidMassTransferTest.C:28
SCMFrictionUpdatedChengTodreas::_quad_sch_mesh
const QuadSubChannelMesh *const _quad_sch_mesh
Pointer to the quad lattice mesh.
Definition: SCMFrictionUpdatedChengTodreas.h:38
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
SCMClosureBase::_subchannel_mesh
const SubChannelMesh & _subchannel_mesh
Reference to the subchannel mesh.
Definition: SCMClosureBase.h:35
std::pow
MooseUnits pow(const MooseUnits &, int)
NS::cL
static const std::string cL
Definition: NS.h:115

◆ computeTriLatticeFrictionFactor()

Real SCMFrictionUpdatedChengTodreas::computeTriLatticeFrictionFactor ( const FrictionStruct &  friction_info) const
protected

Definition at line 71 of file SCMFrictionUpdatedChengTodreas.C.

Referenced by computeFrictionFactor().

73 {
74  const auto Re = friction_args.Re;
75  const auto i_ch = friction_args.i_ch;
76  const auto S = friction_args.S;
77  const auto w_perim = friction_args.w_perim;
78  const auto Dh_i = 4.0 * S / w_perim;
79  Real aL, b1L, b2L, cL;
80  Real aT, b1T, b2T, cT;
81  const Real & pitch = _subchannel_mesh.getPitch();
82  const Real & pin_diameter = _subchannel_mesh.getPinDiameter();
83  const Real & wire_lead_length = _tri_sch_mesh->getWireLeadLength();
84  const Real & wire_diameter = _tri_sch_mesh->getWireDiameter();
85  const auto p_over_d = pitch / pin_diameter;
86  const auto subch_type = _subchannel_mesh.getSubchannelType(i_ch);
87  // This gap is a constant value for the whole assembly. Might want to make it
88  // subchannel specific in the future if we have duct deformation.
89  const auto gap = _tri_sch_mesh->getDuctToPinGap();
90  const auto w_over_d = (pin_diameter + gap) / pin_diameter;
91 
92  if (Re < 50.0 || Re > 1.0e6)
93  flagSolutionWarning("Reynolds number (Re) outside the updated Cheng-Todreas friction "
94  "correlation data range.");
95 
96  const auto ReL = std::pow(10, (p_over_d - 1)) * 320.0;
97  const auto ReT = std::pow(10, 0.7 * (p_over_d - 1)) * 1.0E+4;
98  const auto psi = std::log(Re / ReL) / std::log(ReT / ReL);
99 
100  // Find the coefficients of bare Pin bundle friction factor
101  // correlations for turbulent and laminar flow regimes. Todreas & Kazimi, Nuclear Systems
102  // second edition, Volume 1, Chapter 9.6
103  if (subch_type == EChannelType::CENTER)
104  {
105  if (p_over_d < 1.1)
106  {
107  aL = 26.0;
108  b1L = 888.2;
109  b2L = -3334.0;
110  aT = 0.09378;
111  b1T = 1.398;
112  b2T = -8.664;
113  }
114  else
115  {
116  aL = 62.97;
117  b1L = 216.9;
118  b2L = -190.2;
119  aT = 0.1458;
120  b1T = 0.03632;
121  b2T = -0.03333;
122  }
123  // laminar flow friction factor for bare Pin bundle - Center subchannel
124  cL = aL + b1L * (p_over_d - 1) + b2L * Utility::pow<2>((p_over_d - 1));
125  // turbulent flow friction factor for bare Pin bundle - Center subchannel
126  cT = aT + b1T * (p_over_d - 1) + b2T * Utility::pow<2>((p_over_d - 1));
127  }
128  else if (subch_type == EChannelType::EDGE)
129  {
130  if (w_over_d < 1.1)
131  {
132  aL = 26.18;
133  b1L = 554.5;
134  b2L = -1480.0;
135  aT = 0.09377;
136  b1T = 0.8732;
137  b2T = -3.341;
138  }
139  else
140  {
141  aL = 44.4;
142  b1L = 256.7;
143  b2L = -267.6;
144  aT = 0.1430;
145  b1T = 0.04199;
146  b2T = -0.04428;
147  }
148  // laminar flow friction factor for bare Pin bundle - Edge subchannel
149  cL = aL + b1L * (w_over_d - 1) + b2L * Utility::pow<2>((w_over_d - 1));
150  // turbulent flow friction factor for bare Pin bundle - Edge subchannel
151  cT = aT + b1T * (w_over_d - 1) + b2T * Utility::pow<2>((w_over_d - 1));
152  }
153  else
154  {
155  if (w_over_d < 1.1)
156  {
157  aL = 26.98;
158  b1L = 1636.0;
159  b2L = -10050.0;
160  aT = 0.1004;
161  b1T = 1.625;
162  b2T = -11.85;
163  }
164  else
165  {
166  aL = 87.26;
167  b1L = 38.59;
168  b2L = -55.12;
169  aT = 0.1499;
170  b1T = 0.006706;
171  b2T = -0.009567;
172  }
173  // laminar flow friction factor for bare Pin bundle - Corner subchannel
174  cL = aL + b1L * (w_over_d - 1) + b2L * Utility::pow<2>((w_over_d - 1));
175  // turbulent flow friction factor for bare Pin bundle - Corner subchannel
176  cT = aT + b1T * (w_over_d - 1) + b2T * Utility::pow<2>((w_over_d - 1));
177  }
178 
179  // Find the coefficients of wire-wrapped Pin bundle friction factor
180  // correlations for turbulent and laminar flow regimes. Todreas & Kazimi, Nuclear Systems
181  // Volume 1 Chapter 9-6 also Chen and Todreas (2018).
182  if (_has_wire_wrap)
183  {
184  const auto theta =
185  std::acos(wire_lead_length /
186  std::sqrt(Utility::pow<2>(wire_lead_length) +
187  Utility::pow<2>(libMesh::pi * (pin_diameter + wire_diameter))));
188  const auto wd_t = (19.56 - 98.71 * (wire_diameter / pin_diameter) +
189  303.47 * Utility::pow<2>((wire_diameter / pin_diameter))) *
190  std::pow((wire_lead_length / pin_diameter), -0.541);
191  const auto wd_l = 1.4 * wd_t;
192  const auto ws_t = -11.0 * std::log(wire_lead_length / pin_diameter) + 19.0;
193  const auto ws_l = ws_t;
194  Real ar = 0.0;
195  Real a_p = 0.0;
196 
197  if (subch_type == EChannelType::CENTER)
198  {
199  // wetted perimeter for center subchannel and bare Pin bundle
200  const Real pw_p = libMesh::pi * pin_diameter / 2.0;
201  // wire projected area - center subchannel wire-wrapped bundle
202  ar = libMesh::pi * (pin_diameter + wire_diameter) * wire_diameter / 6.0;
203  // bare Pin bundle center subchannel flow area (normal area + wire area)
204  a_p = S + libMesh::pi * Utility::pow<2>(wire_diameter) / 8.0 / std::cos(theta);
205  // turbulent friction factor equation constant - Center subchannel
206  cT *= (pw_p / w_perim);
207  cT += wd_t * (3.0 * ar / a_p) * (Dh_i / wire_lead_length) *
208  std::pow((Dh_i / wire_diameter), 0.18);
209  // laminar friction factor equation constant - Center subchannel
210  cL *= (pw_p / w_perim);
211  cL += wd_l * (3.0 * ar / a_p) * (Dh_i / wire_lead_length) * (Dh_i / wire_diameter);
212  }
213  else if (subch_type == EChannelType::EDGE)
214  {
215  // wire projected area - edge subchannel wire-wrapped bundle
216  ar = libMesh::pi * (pin_diameter + wire_diameter) * wire_diameter / 4.0;
217  // bare Pin bundle edge subchannel flow area (normal area + wire area)
218  a_p = S + libMesh::pi * Utility::pow<2>(wire_diameter) / 8.0 / std::cos(theta);
219  // turbulent friction factor equation constant - Edge subchannel
220  cT *= std::pow((1 + ws_t * (ar / a_p) * Utility::pow<2>(std::tan(theta))), 1.41);
221  // laminar friction factor equation constant - Edge subchannel
222  cL *= (1 + ws_l * (ar / a_p) * Utility::pow<2>(std::tan(theta)));
223  }
224  else
225  {
226  // wire projected area - corner subchannel wire-wrapped bundle
227  ar = libMesh::pi * (pin_diameter + wire_diameter) * wire_diameter / 6.0;
228  // bare Pin bundle corner subchannel flow area (normal area + wire area)
229  a_p = S + libMesh::pi * Utility::pow<2>(wire_diameter) / 24.0 / std::cos(theta);
230  // turbulent friction factor equation constant - Corner subchannel
231  cT *= std::pow((1 + ws_t * (ar / a_p) * Utility::pow<2>(std::tan(theta))), 1.41);
232  // laminar friction factor equation constant - Corner subchannel
233  cL *= (1 + ws_l * (ar / a_p) * Utility::pow<2>(std::tan(theta)));
234  }
235  }
236  // laminar friction factor and turbulent friction factor coefficients
237  const Real bL = -1.0;
238  const Real bT = -0.18;
239  auto fL = cL * std::pow(Re, bL);
240  auto fT = cT * std::pow(Re, bT);
241 
242  if (Re < ReL)
243  {
244  // laminar flow
245  return fL;
246  }
247  else if (Re > ReT)
248  {
249  // turbulent flow
250  return fT;
251  }
252  else
253  {
254  // transient flow: psi definition uses a Bulk ReT/ReL number, same for all channels
255  return fL * std::pow((1 - psi), 1.0 / 3.0) * (1 - std::pow(psi, 7)) +
256  fT * std::pow(psi, 1.0 / 3.0);
257  }
258 }
TriSubChannelMesh::getWireDiameter
const Real & getWireDiameter() const
Return wire diameter.
Definition: TriSubChannelMesh.h:67
SubChannelMesh::getPinDiameter
virtual const Real & getPinDiameter() const
Return undeformed Pin diameter.
Definition: SubChannelMesh.h:147
SCMFrictionUpdatedChengTodreas::_tri_sch_mesh
const TriSubChannelMesh *const _tri_sch_mesh
Pointer to the tri lattice mesh.
Definition: SCMFrictionUpdatedChengTodreas.h:36
SCMFrictionUpdatedChengTodreas::_has_wire_wrap
const bool _has_wire_wrap
Whether the triangular assembly has wire-wrap geometry.
Definition: SCMFrictionUpdatedChengTodreas.h:40
SubChannelMesh::getPitch
virtual const Real & getPitch() const
Return the undeformed pitch between 2 subchannels.
Definition: SubChannelMesh.h:142
SubChannelMesh::getSubchannelType
virtual EChannelType getSubchannelType(unsigned int index) const =0
Return the type of the subchannel for given subchannel index.
TriSubChannelMesh::getDuctToPinGap
const Real & getDuctToPinGap() const
Return the the gap thickness between the duct and peripheral fuel pins.
Definition: TriSubChannelMesh.h:49
NS::S
static const std::string S
Definition: NS.h:167
RGMB::pitch
static const std::string pitch
Definition: ReactorGeometryMeshBuilderBase.h:41
Re
const double Re
Definition: GasLiquidMassTransferTest.C:28
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
SCMClosureBase::_subchannel_mesh
const SubChannelMesh & _subchannel_mesh
Reference to the subchannel mesh.
Definition: SCMClosureBase.h:35
TriSubChannelMesh::getWireLeadLength
const Real & getWireLeadLength() const
Return the wire lead length.
Definition: TriSubChannelMesh.h:77
std::pow
MooseUnits pow(const MooseUnits &, int)
NS::cL
static const std::string cL
Definition: NS.h:115
libMesh::pi
const Real pi

◆ execute()

virtual void SCMClosureBase::execute ( )
inlinefinalvirtualinherited

Implements ThreadedGeneralUserObject.

Definition at line 26 of file SCMClosureBase.h.

26 {}

◆ finalize()

virtual void SCMClosureBase::finalize ( )
inlinefinalvirtualinherited

Implements ThreadedGeneralUserObject.

Definition at line 28 of file SCMClosureBase.h.

28 {}

◆ initialize()

virtual void SCMClosureBase::initialize ( )
inlinefinalvirtualinherited

Implements ThreadedGeneralUserObject.

Definition at line 27 of file SCMClosureBase.h.

27 {}

◆ subdomainSetup()

virtual void SCMClosureBase::subdomainSetup ( )
inlinefinalvirtualinherited

Reimplemented from ThreadedGeneralUserObject.

Definition at line 31 of file SCMClosureBase.h.

31 {}

◆ threadJoin()

virtual void SCMClosureBase::threadJoin ( const UserObject &  )
inlinefinalvirtualinherited

Reimplemented from ThreadedGeneralUserObject.

Definition at line 30 of file SCMClosureBase.h.

30 {}

◆ validParams()

InputParameters SCMFrictionUpdatedChengTodreas::validParams ( )
static

Definition at line 15 of file SCMFrictionUpdatedChengTodreas.C.

16 {
17  InputParameters params = SCMFrictionClosureBase::validParams();
18  params.addClassDescription("Class that computes the axial friction factor using the updated "
19  "Cheng Todreas correlations.");
20  return params;
21 }
SCMFrictionClosureBase::validParams
static InputParameters validParams()
Definition: SCMFrictionClosureBase.C:14
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _has_wire_wrap

const bool SCMFrictionUpdatedChengTodreas::_has_wire_wrap
protected

Whether the triangular assembly has wire-wrap geometry.

Definition at line 40 of file SCMFrictionUpdatedChengTodreas.h.

Referenced by computeTriLatticeFrictionFactor(), and SCMFrictionUpdatedChengTodreas().

◆ _is_tri_lattice

bool SCMFrictionUpdatedChengTodreas::_is_tri_lattice
protected

Keep track of the lattice type.

Definition at line 34 of file SCMFrictionUpdatedChengTodreas.h.

Referenced by computeFrictionFactor(), and SCMFrictionUpdatedChengTodreas().

◆ _quad_sch_mesh

const QuadSubChannelMesh* const SCMFrictionUpdatedChengTodreas::_quad_sch_mesh
protected

Pointer to the quad lattice mesh.

Definition at line 38 of file SCMFrictionUpdatedChengTodreas.h.

Referenced by computeQuadLatticeFrictionFactor().

◆ _scm_problem

const SubChannel1PhaseProblem& SCMClosureBase::_scm_problem
protectedinherited

Reference to the subchannel problem.

Definition at line 37 of file SCMClosureBase.h.

Referenced by SCMMixingKimAndChung::computeLatticeMixingParameter(), SCMHTCGnielinski::computeNusseltNumber(), SCMHTCBorishanskii::SCMHTCBorishanskii(), SCMHTCGraberRieger::SCMHTCGraberRieger(), SCMHTCKazimiCarelli::SCMHTCKazimiCarelli(), and SCMHTCSchadModified::SCMHTCSchadModified().

◆ _subchannel_mesh

const SubChannelMesh& SCMClosureBase::_subchannel_mesh
protectedinherited

Reference to the subchannel mesh.

Definition at line 35 of file SCMClosureBase.h.

Referenced by SCMMixingChengTodreas::computeMixingParameter(), SCMHTCClosureBase::computeNusseltNumberPreInfo(), computeQuadLatticeFrictionFactor(), SCMMixingChengTodreas::computeSweepFlowMixingParameter(), computeTriLatticeFrictionFactor(), SCMFrictionUpdatedChengTodreas(), SCMMixingChengTodreas::SCMMixingChengTodreas(), and SCMMixingKimAndChung::SCMMixingKimAndChung().

◆ _tri_sch_mesh

const TriSubChannelMesh* const SCMFrictionUpdatedChengTodreas::_tri_sch_mesh
protected

Pointer to the tri lattice mesh.

Definition at line 36 of file SCMFrictionUpdatedChengTodreas.h.

Referenced by computeTriLatticeFrictionFactor(), and SCMFrictionUpdatedChengTodreas().

The documentation for this class was generated from the following files:
Generated on Wed Jun 24 2026 08:35:35 for https://mooseframework.inl.gov by   doxygen 1.8.14