https://mooseframework.inl.gov
Loading...
Searching...
No Matches
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 | Static Private Member Functions | Private Attributes | List of all members
SCMFrictionChenTodreas Class Reference

Class that calculates the friction factor using the Chen-Todreas correlations. More...

#include <SCMFrictionChenTodreas.h>

Inheritance diagram for SCMFrictionChenTodreas:
[legend]

Public Types

typedef SubChannel1PhaseProblem::FrictionStruct FrictionStruct
 
typedef DataFileName DataFileParameterType
 

Public Member Functions

 SCMFrictionChenTodreas (const InputParameters &parameters)
 
virtual Real computeFrictionFactor (const FrictionStruct &friction_info) const override
 Computes the friction factor for the local conditions.
 
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 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, const std::string &tag_param_name, unsigned int comp=0) const
 
const VariableValue & coupledMatrixTagScalarValue (const std::string &var_name, const std::string &tag_param_name, 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
 
Moose::Kokkos::VariableValue kokkosCoupledVectorTagScalarValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledVectorTagScalarValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::Scalar< const Real > kokkosCoupledScalarDotDu (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.
 
const TriSubChannelMesh *const _tri_sch_mesh
 Pointer to the tri lattice mesh.
 
const QuadSubChannelMesh *const _quad_sch_mesh
 Pointer to the quad lattice mesh.
 
const bool _has_wire_wrap
 Whether the triangular assembly has wire-wrap geometry.
 
const MooseEnum & _friction_model
 Chen-Todreas correlation version.
 
const SubChannelMesh & _subchannel_mesh
 Reference to the subchannel mesh.
 
const SubChannel1PhaseProblem & _scm_problem
 Reference to the subchannel problem.
 
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
 

Private Member Functions

const Moose::FunctionBase * getKokkosFunctionByNameHelper (const FunctionName &name) const
 
const UserObjectBase & getUserObjectFromFEProblem (const UserObjectName &object_name, const THREAD_ID tid=0) const
 
const T & castUserObject (const UserObjectBase &uo_base, const std::string &param_name="") const
 
void mooseObjectError (const std::string &param_name, std::stringstream &oss) const
 
const std::string & userObjectType (const UserObjectBase &uo) const
 
const std::string & userObjectName (const UserObjectBase &uo) const
 
const PostprocessorName & getPostprocessorNameInternal (const std::string &param_name, const unsigned int index, const bool allow_default_value=true) const
 
bool isDefaultPostprocessorValueByName (const PostprocessorName &name) const
 
PostprocessorValue getDefaultPostprocessorValueByName (const PostprocessorName &name) const
 
void checkParam (const std::string &param_name, const unsigned int index=std::numeric_limits< unsigned int >::max()) const
 
bool postprocessorsAdded () const
 
const VectorPostprocessorValue & getVectorPostprocessorByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name, bool broadcast, std::size_t t_index) const
 
const VectorPostprocessorContext< VectorPostprocessorValue > & getVectorPostprocessorContextByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool vectorPostprocessorsAdded () const
 
bool reportersAdded () const
 
void possiblyCheckHasReporter (const ReporterName &reporter_name, const std::string &param_name="") const
 
RestartableDataValue & registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const
 
void registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)
 
RestartableData< T > & declareRestartableDataHelper (const std::string &data_name, void *context, Args &&... args) const
 
virtual std::string meshPropertyPrefix (const std::string &data_name) const
 
const RestartableDataValue & getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const
 
void mooseErrorInternal (Args &&... args) const
 
const VariableValue * getDefaultValue (const std::string &var_name) const
 
const ADVariableValue * getADDefaultValue (const std::string &var_name) const
 
void checkVar (const std::string &var_name) const
 
void validateExecutionerType (const std::string &name, const std::string &fn_name) const
 
Moose::Kokkos::Variable kokkosCoupledVectorTagScalarVariable (const std::string &var_name, const std::string &tag_name, unsigned int comp) const
 
Moose::MaterialDataType getMaterialDataType (const std::set< BoundaryID > &boundary_ids) const
 
unsigned int getMaxQps () const
 
void addConsumedPropertyName (const MooseObjectName &obj_name, const std::string &prop_name)
 
const PostprocessorValue & getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const
 
void possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
void possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
void possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
void possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 

Static Private Member Functions

static const hit::Node * getHitNode (const InputParameters &params)
 
static std::string messagePrefix (const InputParameters &params, const bool hit_prefix)
 

Private Attributes

UserObject * _primary_thread_copy
 
std::set< std::string > _supplied_uo
 
const ParallelParamObject & _parent
 
const MooseBase & _si_moose_base
 
const FEProblemBase * _si_problem
 
ExecFlagEnum _empty_execute_enum
 
const MooseObject & _fni_object
 
const InputParameters & _fni_params
 
FEProblemBase & _fni_feproblem
 
const THREAD_ID _fni_tid
 
const MooseObject & _uoi_moose_object
 
const FEProblemBase & _uoi_feproblem
 
const THREAD_ID _uoi_tid
 
const MooseObject & _ppi_moose_object
 
const InputParameters & _ppi_params
 
const FEProblemBase & _ppi_feproblem
 
std::map< PostprocessorName, std::unique_ptr< PostprocessorValue > > _default_values
 
const bool _broadcast_by_default
 
const MooseObject & _vpi_moose_object
 
const FEProblemBase & _vpi_feproblem
 
const THREAD_ID _vpi_tid
 
const InputParameters & _ri_params
 
FEProblemBase & _ri_fe_problem_base
 
const ReporterData & _ri_reporter_data
 
const MooseObject & _ri_moose_object
 
const InputParameters & _dni_params
 
FEProblemBase & _dni_feproblem
 
const MooseObject *const _dni_moose_object_ptr
 
const InputParameters & _si_params
 
FEProblemBase & _si_feproblem
 
THREAD_ID _si_tid
 
const RestartableDataMapName _metaname
 
std::string _restartable_name
 
MooseApp & _meta_data_app
 
const MooseObject *const _meta_data_object
 
const InputParameters & _sc_parameters
 
const std::string & _sc_name
 
const bool _sc_is_implicit
 
std::unordered_map< std::string, std::vector< MooseVariableScalar * > > _coupled_scalar_vars
 
std::unordered_map< std::string, std::unique_ptr< VariableValue > > _default_value
 
std::unordered_map< std::string, std::unique_ptr< ADVariableValue > > _dual_default_value
 
std::vector< MooseVariableScalar * > _coupled_moose_scalar_vars
 
std::unordered_map< std::string, std::vector< MooseVariableFieldBase * > > _sc_coupled_vars
 
std::set< TagID > _sc_coupleable_vector_tags
 
std::set< TagID > _sc_coupleable_matrix_tags
 
const MooseObject & _mi_moose_object
 
const bool _mi_boundary_restricted
 
const std::set< SubdomainID > & _mi_block_ids
 
const std::set< BoundaryID > & _mi_boundary_ids
 
std::vector< std::unique_ptr< OptionalMaterialPropertyProxyBase< MaterialPropertyInterface > > > _optional_property_proxies
 
const std::string _ti_name
 

Detailed Description

Class that calculates the friction factor using the Chen-Todreas correlations.

For triangular wire-wrapped lattices, the user may select either the Upgraded Chen-Todreas or Pacio-Chen-Todreas parameterization. It is used for both quad and tri lattices.

Definition at line 21 of file SCMFrictionChenTodreas.h.

Member Typedef Documentation

◆ FrictionStruct

typedef SubChannel1PhaseProblem::FrictionStruct SCMFrictionClosureBase::FrictionStruct
inherited

Definition at line 25 of file SCMFrictionClosureBase.h.

Constructor & Destructor Documentation

◆ SCMFrictionChenTodreas()

SCMFrictionChenTodreas::SCMFrictionChenTodreas ( const InputParameters &  parameters)

Definition at line 40 of file SCMFrictionChenTodreas.C.

41 : SCMFrictionClosureBase(parameters),
42 _is_tri_lattice(dynamic_cast<const TriSubChannelMesh *>(&_subchannel_mesh) != nullptr),
43 _tri_sch_mesh(dynamic_cast<const TriSubChannelMesh *>(&_subchannel_mesh)),
44 _quad_sch_mesh(dynamic_cast<const QuadSubChannelMesh *>(&_subchannel_mesh)),
45 _has_wire_wrap(_is_tri_lattice && _tri_sch_mesh->getWireDiameter() != 0.0 &&
46 _tri_sch_mesh->getWireLeadLength() != 0.0),
47 _friction_model(getParam<MooseEnum>("friction_model"))
48{
49 if (_is_tri_lattice &&
50 ((_tri_sch_mesh->getWireDiameter() != 0.0) != (_tri_sch_mesh->getWireLeadLength() != 0.0)))
51 mooseError("Wire-wrapped bundle friction requires both wire diameter and wire lead length. "
52 "Set both to zero for a bare pin bundle.");
53
54 if (_is_tri_lattice && !_has_wire_wrap && _friction_model == "Pacio")
55 paramError("friction_model",
56 "The Pacio-Chen-Todreas friction correlation applies only to wire-wrapped "
57 "triangular assemblies.");
58
59 if (_is_tri_lattice)
60 {
61 const auto pitch = _subchannel_mesh.getPitch();
62 const auto pin_diameter = _subchannel_mesh.getPinDiameter();
63 const auto p_over_d = pitch / pin_diameter;
64 const auto wire_lead_to_diameter = _tri_sch_mesh->getWireLeadLength() / pin_diameter;
65 const unsigned int Nr = _tri_sch_mesh->getNumOfRings();
66 const unsigned int num_pins = 1 + 3 * Nr * (Nr - 1);
67
68 // Reported ranges of validity from Table 1 of Pacio et al. (2022):
69 // UCTD: 7 <= Npin <= 217, 1.00 <= P/D <= 1.42, 8 <= H/D <= 52, 50 <= Reb <= 1.0e6
70 // PCTD: 19 <= Npin <= 217, 1.02 <= P/D <= 1.42, 7.5 <= H/D <= 54, 10 <= Reb <= 3.0e5
71 if (_friction_model == "Upgraded")
72 {
73 if (p_over_d < 1.0 || p_over_d > 1.42)
74 flagSolutionWarning("Pitch-over-pin diameter ratio (P/D) outside the Upgraded "
75 "Chen-Todreas friction correlation data range.");
76 if (_has_wire_wrap && (wire_lead_to_diameter < 8.0 || wire_lead_to_diameter > 52.0))
77 flagSolutionWarning("Wire lead length-over-pin diameter ratio (H/D) outside the Upgraded "
78 "Chen-Todreas friction correlation data range.");
79 if (num_pins < 7 || num_pins > 217)
80 flagSolutionWarning("Number of pins outside the Upgraded Chen-Todreas friction correlation "
81 "data range.");
82 }
83 else
84 {
85 if (p_over_d < 1.02 || p_over_d > 1.42)
86 flagSolutionWarning("Pitch-over-pin diameter ratio (P/D) outside the "
87 "Pacio-Chen-Todreas friction correlation data range.");
88 if (_has_wire_wrap && (wire_lead_to_diameter < 7.5 || wire_lead_to_diameter > 54.0))
89 flagSolutionWarning("Wire lead length-over-pin diameter ratio (H/D) outside the "
90 "Pacio-Chen-Todreas friction correlation data range.");
91 if (num_pins < 19 || num_pins > 217)
92 flagSolutionWarning("Number of pins outside the Pacio-Chen-Todreas friction correlation "
93 "data range.");
94 }
95 }
96}
ThreadedGeneralUserObject::parameters
const InputParameters & parameters() const
ThreadedGeneralUserObject::paramError
void paramError(const std::string &param, Args... args) const
ThreadedGeneralUserObject::mooseError
void mooseError(Args &&... args) const
QuadSubChannelMesh
Creates the mesh of subchannels in a quadrilateral lattice.
Definition QuadSubChannelMesh.h:24
SCMClosureBase::_subchannel_mesh
const SubChannelMesh & _subchannel_mesh
Reference to the subchannel mesh.
Definition SCMClosureBase.h:35
SCMFrictionChenTodreas::_tri_sch_mesh
const TriSubChannelMesh *const _tri_sch_mesh
Pointer to the tri lattice mesh.
Definition SCMFrictionChenTodreas.h:37
SCMFrictionChenTodreas::_is_tri_lattice
bool _is_tri_lattice
Keep track of the lattice type.
Definition SCMFrictionChenTodreas.h:35
SCMFrictionChenTodreas::_has_wire_wrap
const bool _has_wire_wrap
Whether the triangular assembly has wire-wrap geometry.
Definition SCMFrictionChenTodreas.h:41
SCMFrictionChenTodreas::_friction_model
const MooseEnum & _friction_model
Chen-Todreas correlation version.
Definition SCMFrictionChenTodreas.h:43
SCMFrictionChenTodreas::_quad_sch_mesh
const QuadSubChannelMesh *const _quad_sch_mesh
Pointer to the quad lattice mesh.
Definition SCMFrictionChenTodreas.h:39
SCMFrictionClosureBase
Base class for friction closures used in SCM.
Definition SCMFrictionClosureBase.h:19
SubChannelMesh::getPitch
virtual const Real & getPitch() const
Return the undeformed pitch between 2 subchannels.
Definition SubChannelMesh.h:142
SubChannelMesh::getPinDiameter
virtual const Real & getPinDiameter() const
Return undeformed Pin diameter.
Definition SubChannelMesh.h:147
TriSubChannelMesh
Mesh class for triangular, edge and corner subchannels for hexagonal lattice fuel assemblies.
Definition TriSubChannelMesh.h:23
TriSubChannelMesh::getWireDiameter
const Real & getWireDiameter() const
Return wire diameter.
Definition TriSubChannelMesh.h:67
TriSubChannelMesh::getWireLeadLength
const Real & getWireLeadLength() const
Return the wire lead length.
Definition TriSubChannelMesh.h:77
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

Member Function Documentation

◆ computeFrictionFactor()

Real SCMFrictionChenTodreas::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 99 of file SCMFrictionChenTodreas.C.

100{
101 if (_is_tri_lattice)
102 return computeTriLatticeFrictionFactor(friction_args);
103 else
104 return computeQuadLatticeFrictionFactor(friction_args);
105}
SCMFrictionChenTodreas::computeTriLatticeFrictionFactor
Real computeTriLatticeFrictionFactor(const FrictionStruct &friction_info) const
Definition SCMFrictionChenTodreas.C:108
SCMFrictionChenTodreas::computeQuadLatticeFrictionFactor
Real computeQuadLatticeFrictionFactor(const FrictionStruct &friction_info) const
Definition SCMFrictionChenTodreas.C:381

◆ computeQuadLatticeFrictionFactor()

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

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

Definition at line 381 of file SCMFrictionChenTodreas.C.

382{
383 const auto Re = friction_args.Re;
384 // Limit the Reynolds number used in the friction-factor correlation to avoid
385 // singular behavior k1T zero flow.
386 const Real Re_eff = std::max(Re, 1.0);
387 const auto i_ch = friction_args.i_ch;
389 Real k1L, k2L, k3L, CfL;
390 Real k1T, k2T, k3T, CfT;
391 const auto pitch = _subchannel_mesh.getPitch();
392 const auto pin_diameter = _subchannel_mesh.getPinDiameter();
393 // This gap is a constant value for the whole assembly. Might want to make it
394 // subchannel specific in the future if we have duct deformation.
395 const auto side_gap = _quad_sch_mesh->getSideGap();
396 const auto w = (pin_diameter / 2.0) + (pitch / 2.0) + side_gap;
397 const auto p_over_d = pitch / pin_diameter;
398 const auto w_over_d = w / pin_diameter;
399 const auto ReL = std::pow(10, (p_over_d - 1)) * 320.0;
400 const auto ReT = std::pow(10, 0.7 * (p_over_d - 1)) * 1.0E+4;
401 const auto Reb = _scm_problem.getBulkReynoldsNumber();
402 const auto psi = std::log(Reb / ReL) / std::log(ReT / ReL);
403 const auto subch_type = _subchannel_mesh.getSubchannelType(i_ch);
404 // interpolation exponent
405 Real lambda;
406 // transition smoothing coefficient
407 Real gamma;
408
409 // Find the coefficients of bare Pin bundle friction factor
410 // correlations for turbulent and laminar flow regimes. Todreas & Kazimi, Nuclear Systems Volume
411 // 1
412 if (subch_type == EChannelType::CENTER)
413 {
414 if (p_over_d < 1.1)
415 {
416 k1L = 26.37;
417 k2L = 374.2;
418 k3L = -493.9;
419 k1T = 0.09423;
420 k2T = 0.5806;
421 k3T = -1.239;
422 }
423 else
424 {
425 k1L = 35.55;
426 k2L = 263.7;
427 k3L = -190.2;
428 k1T = 0.1339;
429 k2T = 0.09059;
430 k3T = -0.09926;
431 }
432 // laminar flow friction factor for bare Pin bundle - Center subchannel
433 CfL = k1L + k2L * (p_over_d - 1) + k3L * Utility::pow<2>((p_over_d - 1));
434 // turbulent flow friction factor for bare Pin bundle - Center subchannel
435 CfT = k1T + k2T * (p_over_d - 1) + k3T * Utility::pow<2>((p_over_d - 1));
436 }
437 else if (subch_type == EChannelType::EDGE)
438 {
439 if (p_over_d < 1.1)
440 {
441 k1L = 26.18;
442 k2L = 554.5;
443 k3L = -1480;
444 k1T = 0.09377;
445 k2T = 0.8732;
446 k3T = -3.341;
447 }
448 else
449 {
450 k1L = 44.40;
451 k2L = 256.7;
452 k3L = -267.6;
453 k1T = 0.1430;
454 k2T = 0.04199;
455 k3T = -0.04428;
456 }
457 // laminar flow friction factor for bare Pin bundle - Edge subchannel
458 CfL = k1L + k2L * (w_over_d - 1) + k3L * Utility::pow<2>((w_over_d - 1));
459 // turbulent flow friction factor for bare Pin bundle - Edge subchannel
460 CfT = k1T + k2T * (w_over_d - 1) + k3T * Utility::pow<2>((w_over_d - 1));
461 }
462 else
463 {
464 if (p_over_d < 1.1)
465 {
466 k1L = 28.62;
467 k2L = 715.9;
468 k3L = -2807;
469 k1T = 0.09755;
470 k2T = 1.127;
471 k3T = -6.304;
472 }
473 else
474 {
475 k1L = 58.83;
476 k2L = 160.7;
477 k3L = -203.5;
478 k1T = 0.1452;
479 k2T = 0.02681;
480 k3T = -0.03411;
481 }
482 // laminar flow friction factor for bare Pin bundle - Corner subchannel
483 CfL = k1L + k2L * (w_over_d - 1) + k3L * Utility::pow<2>((w_over_d - 1));
484 // turbulent flow friction factor for bare Pin bundle - Corner subchannel
485 CfT = k1T + k2T * (w_over_d - 1) + k3T * Utility::pow<2>((w_over_d - 1));
486 }
487 // laminar friction factor and turbulent friction factor coefficients
488 const Real mL = -1.0;
489 const Real mT = -0.18;
490 auto fL = CfL * std::pow(Re_eff, mL);
491 auto fT = CfT * std::pow(Re_eff, mT);
492 gamma = 1.0 / 3.0;
493 lambda = 7.0;
494 if (Reb < ReL)
495 {
496 // laminar flow
497 return fL;
498 }
499 else if (Reb > ReT)
500 {
501 // turbulent flow
502 return fT;
503 }
504 else
505 {
506 // Transition regime is selected by bulk Reynolds number, same for all channels.
507 return fL * std::pow((1 - psi), gamma) * (1 - std::pow(psi, lambda)) +
508 fT * std::pow(psi, gamma);
509 }
510}
Re
const double Re
Definition GasLiquidMassTransferTest.C:28
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
SCMClosureBase::_scm_problem
const SubChannel1PhaseProblem & _scm_problem
Reference to the subchannel problem.
Definition SCMClosureBase.h:37
SubChannelMesh::getSubchannelType
virtual EChannelType getSubchannelType(unsigned int index) const =0
Return the type of the subchannel for given subchannel index.
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

Referenced by computeFrictionFactor().

◆ computeTriLatticeFrictionFactor()

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

Definition at line 108 of file SCMFrictionChenTodreas.C.

109{
110 const auto Re = friction_args.Re;
111 // Limit the Reynolds number used in the friction-factor correlation to avoid
112 // singular behavior at zero flow.
113 const Real Re_eff = std::max(Re, 1.0);
114 const auto i_ch = friction_args.i_ch;
115 const auto S = friction_args.S;
116 const auto w_perim = friction_args.w_perim;
117 const auto Dh_i = 4.0 * S / w_perim;
118 // Bare fuel Pins coefficients, and friction factor
119 Real k1L, k2L, k3L, CfL;
120 Real k1T, k2T, k3T, CfT;
121 // Transient range parameters
122 Real CbL1, CbL2, CbT1, CbT2;
123 // wire sweep coefficient parameters
124 Real a, b;
125 // wire Drag coefficient parameters
126 Real CwT1, CwT2, CwT3, CwT4;
127 // Ratio of laminar over turbulent drag and sweep coefficients
128 Real CwL1, CwL2;
129 // interpolation exponent
130 Real lambda;
131 // transition smoothing coefficient
132 Real gamma;
133 if (_friction_model == "Upgraded")
134 {
135 CbL1 = 320.0;
136 CbL2 = 1.0;
137 CbT1 = 10000.0;
138 CbT2 = 0.7;
139
140 a = -11.0;
141 b = 19.0;
142
143 CwT1 = 19.56;
144 CwT2 = -98.71;
145 CwT3 = 303.47;
146 CwT4 = -0.541;
147
148 CwL1 = 1.4;
149 CwL2 = 1.0;
150
151 lambda = 7.0;
152 gamma = 1.0 / 3.0;
153 }
154 else
155 {
156 CbL1 = 700.0;
157 CbL2 = 0.0;
158 CbT1 = 10000.0;
159 CbT2 = 0.0;
160
161 a = -6.9;
162 b = 12.0;
163
164 CwT1 = 15.2;
165 CwT2 = -48.0;
166 CwT3 = 148.6;
167 CwT4 = -0.547;
168
169 CwL1 = 0.8;
170 CwL2 = 1.2;
171
172 lambda = 6.7;
173 gamma = 0.362;
174 }
175
176 const Real & pitch = _subchannel_mesh.getPitch();
177 const Real & pin_diameter = _subchannel_mesh.getPinDiameter();
178 const Real & wire_lead_length = _tri_sch_mesh->getWireLeadLength();
179 const Real & wire_diameter = _tri_sch_mesh->getWireDiameter();
180 const auto gap = _tri_sch_mesh->getDuctToPinGap();
181 const auto p_over_d = pitch / pin_diameter;
182 const auto w_over_d = (pin_diameter + gap) / pin_diameter;
183 const auto subch_type = _subchannel_mesh.getSubchannelType(i_ch);
184 const auto ReL = std::pow(10, CbL2 * (p_over_d - 1)) * CbL1;
185 const auto ReT = std::pow(10, CbT2 * (p_over_d - 1)) * CbT1;
186 const auto Reb = _scm_problem.getBulkReynoldsNumber();
187 const auto psi = std::log(Reb / ReL) / std::log(ReT / ReL);
188
189 // The bulk Reynolds number is computed from the solution during the solve, so its
190 // applicability range (see constructor) can only be checked here rather than at construction
191 if (_friction_model == "Upgraded")
192 {
193 if (Reb < 50.0 || Reb > 1.0e6)
194 flagSolutionWarning("Bulk Reynolds number (Reb) outside the Upgraded Chen-Todreas friction "
195 "correlation data range.");
196 }
197 else if (Reb < 10.0 || Reb > 3.0e5)
198 flagSolutionWarning("Bulk Reynolds number (Reb) outside the Pacio-Chen-Todreas friction "
199 "correlation data range.");
200
201 // Find the coefficients of bare Pin bundle friction factor
202 // correlations for turbulent and laminar flow regimes. Todreas & Kazimi, Nuclear Systems
203 // second edition, Volume 1, Chapter 9.6
204 if (subch_type == EChannelType::CENTER)
205 {
206 if (p_over_d < 1.1)
207 {
208 k1L = 26.0;
209 k2L = 888.2;
210 k3L = -3334.0;
211 k1T = 0.09378;
212 k2T = 1.398;
213 k3T = -8.664;
214 }
215 else
216 {
217 k1L = 62.97;
218 k2L = 216.9;
219 k3L = -190.2;
220 k1T = 0.1458;
221 k2T = 0.03632;
222 k3T = -0.03333;
223 }
224 // laminar flow friction factor for bare Pin bundle - Center subchannel
225 CfL = k1L + k2L * (p_over_d - 1) + k3L * Utility::pow<2>((p_over_d - 1));
226 // turbulent flow friction factor for bare Pin bundle - Center subchannel
227 CfT = k1T + k2T * (p_over_d - 1) + k3T * Utility::pow<2>((p_over_d - 1));
228 }
229 else if (subch_type == EChannelType::EDGE)
230 {
231 if (w_over_d < 1.1)
232 {
233 k1L = 26.18;
234 k2L = 554.5;
235 k3L = -1480.0;
236 k1T = 0.09377;
237 k2T = 0.8732;
238 k3T = -3.341;
239 }
240 else
241 {
242 k1L = 44.4;
243 k2L = 256.7;
244 k3L = -267.6;
245 k1T = 0.1430;
246 k2T = 0.04199;
247 k3T = -0.04428;
248 }
249 // laminar flow friction factor for bare Pin bundle - Edge subchannel
250 CfL = k1L + k2L * (w_over_d - 1) + k3L * Utility::pow<2>((w_over_d - 1));
251 // turbulent flow friction factor for bare Pin bundle - Edge subchannel
252 CfT = k1T + k2T * (w_over_d - 1) + k3T * Utility::pow<2>((w_over_d - 1));
253 }
254 else
255 {
256 if (w_over_d < 1.1)
257 {
258 k1L = 26.98;
259 k2L = 1636.0;
260 k3L = -10050.0;
261 k1T = 0.1004;
262 k2T = 1.625;
263 k3T = -11.85;
264 }
265 else
266 {
267 k1L = 87.26;
268 k2L = 38.59;
269 k3L = -55.12;
270 k1T = 0.1499;
271 k2T = 0.006706;
272 k3T = -0.009567;
273 }
274 // laminar flow friction factor for bare Pin bundle - Corner subchannel
275 CfL = k1L + k2L * (w_over_d - 1) + k3L * Utility::pow<2>((w_over_d - 1));
276 // turbulent flow friction factor for bare Pin bundle - Corner subchannel
277 CfT = k1T + k2T * (w_over_d - 1) + k3T * Utility::pow<2>((w_over_d - 1));
278 }
279
280 // Find the coefficients of wire-wrapped Pin bundle friction factor
281 // correlations for turbulent and laminar flow regimes. Todreas & Kazimi, Nuclear Systems
282 // Volume 1 Chapter 9-6 also Chen and Todreas (2018).
283 if (_has_wire_wrap)
284 {
285 const auto theta =
286 std::acos(wire_lead_length /
287 std::sqrt(Utility::pow<2>(wire_lead_length) +
288 Utility::pow<2>(libMesh::pi * (pin_diameter + wire_diameter))));
289 // Drag coefficient
290 const auto WdT = (CwT1 + CwT2 * (wire_diameter / pin_diameter) +
291 CwT3 * Utility::pow<2>((wire_diameter / pin_diameter))) *
292 std::pow((wire_lead_length / pin_diameter), CwT4);
293 const auto WdL = CwL1 * WdT;
294 // Sweep coefficient
295 const auto WsT = a * std::log10(wire_lead_length / pin_diameter) + b;
296 const auto WsL = CwL2 * WsT;
297 Real ar = 0.0;
298 Real a_p = 0.0;
299
300 if (subch_type == EChannelType::CENTER)
301 {
302 // wetted perimeter for center subchannel and bare Pin bundle
303 const Real pw_p = libMesh::pi * pin_diameter / 2.0;
304 // wire projected area - center subchannel wire-wrapped bundle
305 ar = libMesh::pi * (pin_diameter + wire_diameter) * wire_diameter / 6.0;
306 // bare Pin bundle center subchannel flow area (normal area + wire area)
307 a_p = S + libMesh::pi * Utility::pow<2>(wire_diameter) / 8.0 / std::cos(theta);
308 // turbulent friction factor equation constant - Center subchannel
309 CfT *= (pw_p / w_perim);
310 CfT += WdT * (3.0 * ar / a_p) * (Dh_i / wire_lead_length) *
311 std::pow((Dh_i / wire_diameter), 0.18);
312 // laminar friction factor equation constant - Center subchannel
313 CfL *= (pw_p / w_perim);
314 CfL += WdL * (3.0 * ar / a_p) * (Dh_i / wire_lead_length) * (Dh_i / wire_diameter);
315 }
316 else if (subch_type == EChannelType::EDGE)
317 {
318 // wire projected area - edge subchannel wire-wrapped bundle
319 ar = libMesh::pi * (pin_diameter + wire_diameter) * wire_diameter / 4.0;
320 // bare Pin bundle edge subchannel flow area (normal area + wire area)
321 a_p = S + libMesh::pi * Utility::pow<2>(wire_diameter) / 8.0 / std::cos(theta);
322 // turbulent friction factor equation constant - Edge subchannel
323 const Real turbulent_wire_correction =
324 1 + WsT * (ar / a_p) * Utility::pow<2>(std::tan(theta));
325 if (!std::isfinite(turbulent_wire_correction) || turbulent_wire_correction < 0.0)
326 mooseError("The exponentiated term in the Chen-Todreas turbulent wire correction must be "
327 "non-negative and finite for an edge subchannel. Computed ",
328 turbulent_wire_correction,
329 ".");
330 CfT *= std::pow(turbulent_wire_correction, 1.41);
331 // laminar friction factor equation constant - Edge subchannel
332 CfL *= (1 + WsL * (ar / a_p) * Utility::pow<2>(std::tan(theta)));
333 }
334 else
335 {
336 // wire projected area - corner subchannel wire-wrapped bundle
337 ar = libMesh::pi * (pin_diameter + wire_diameter) * wire_diameter / 6.0;
338 // bare Pin bundle corner subchannel flow area (normal area + wire area)
339 a_p = S + libMesh::pi * Utility::pow<2>(wire_diameter) / 24.0 / std::cos(theta);
340 // turbulent friction factor equation constant - Corner subchannel
341 const Real turbulent_wire_correction =
342 1 + WsT * (ar / a_p) * Utility::pow<2>(std::tan(theta));
343 if (!std::isfinite(turbulent_wire_correction) || turbulent_wire_correction < 0.0)
344 mooseError("The exponentiated term in the Chen-Todreas turbulent wire correction must be "
345 "non-negative and finite for a corner subchannel. Computed ",
346 turbulent_wire_correction,
347 ".");
348 CfT *= std::pow(turbulent_wire_correction, 1.41);
349 // laminar friction factor equation constant - Corner subchannel
350 CfL *= (1 + WsL * (ar / a_p) * Utility::pow<2>(std::tan(theta)));
351 }
352 }
353 // laminar friction factor and turbulent friction factor coefficients
354 const Real mL = -1.0;
355 const Real mT = -0.18;
356 auto fL = CfL * std::pow(Re_eff, mL);
357 auto fT = CfT * std::pow(Re_eff, mT);
358 if (Reb < ReL)
359 {
360 // laminar flow
361 return fL;
362 }
363 else if (Reb > ReT)
364 {
365 // turbulent flow
366 return fT;
367 }
368 else
369 {
370 // Transition regime is selected by bulk Reynolds number, same for all channels.
371 // fL and fT are evaluated at the local Reynolds number of the subchannel, as Eq. (35) of
372 // Pacio et al. (2022) is written. The example calculation of that paper, Section 6.1.3,
373 // evaluates fL with the laminar and fT with the turbulent flow split of the subchannel type
374 // instead, which gives a different transition flow split.
375 return fL * std::pow((1 - psi), gamma) * (1 - std::pow(psi, lambda)) +
376 fT * std::pow(psi, gamma);
377 }
378}
TriSubChannelMesh::getDuctToPinGap
const Real & getDuctToPinGap() const
Return the the gap thickness between the duct and peripheral fuel pins.
Definition TriSubChannelMesh.h:49
libMesh::pi
const Real pi

Referenced by computeFrictionFactor().

◆ 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 SCMFrictionChenTodreas::validParams ( )
static

Definition at line 23 of file SCMFrictionChenTodreas.C.

24{
25 InputParameters params = SCMFrictionClosureBase::validParams();
26
27 params.addClassDescription(
28 "Class that computes the axial friction factor using the Chen-Todreas correlations.");
29
30 MooseEnum friction_model("Upgraded Pacio", "Upgraded");
31
32 params.addParam<MooseEnum>(
33 "friction_model",
34 friction_model,
35 "Friction-factor parameterization for triangular wire-wrapped Chen-Todreas correlations.");
36
37 return params;
38}
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
SCMFrictionClosureBase::validParams
static InputParameters validParams()
Definition SCMFrictionClosureBase.C:14

Member Data Documentation

◆ _friction_model

const MooseEnum& SCMFrictionChenTodreas::_friction_model
protected

Chen-Todreas correlation version.

Definition at line 43 of file SCMFrictionChenTodreas.h.

Referenced by computeTriLatticeFrictionFactor(), and SCMFrictionChenTodreas().

◆ _has_wire_wrap

const bool SCMFrictionChenTodreas::_has_wire_wrap
protected

Whether the triangular assembly has wire-wrap geometry.

Definition at line 41 of file SCMFrictionChenTodreas.h.

Referenced by computeTriLatticeFrictionFactor(), and SCMFrictionChenTodreas().

◆ _is_tri_lattice

bool SCMFrictionChenTodreas::_is_tri_lattice
protected

Keep track of the lattice type.

Definition at line 35 of file SCMFrictionChenTodreas.h.

Referenced by computeFrictionFactor(), and SCMFrictionChenTodreas().

◆ _quad_sch_mesh

const QuadSubChannelMesh* const SCMFrictionChenTodreas::_quad_sch_mesh
protected

Pointer to the quad lattice mesh.

Definition at line 39 of file SCMFrictionChenTodreas.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 SCMMixingChenTodreas::computeBlockMixingParameters(), SCMMixingChenTodreas::computeBulkMixingParameters(), SCMMixingKimAndChung::computeLatticeMixingParameter(), SCMHTCGnielinski::computeNusseltNumber(), SCMMixingChenTodreas::computePacioMixingParameter(), computeQuadLatticeFrictionFactor(), computeTriLatticeFrictionFactor(), 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 SCMMixingChenTodreas::computeBlockMixingParameters(), SCMMixingChenTodreas::computeBulkMixingParameters(), SCMMixingChenTodreas::computeMixingParameter(), SCMHTCClosureBase::computeNusseltNumberPreInfo(), SCMMixingChenTodreas::computePacioMixingParameter(), computeQuadLatticeFrictionFactor(), SCMMixingChenTodreas::computeSweepFlowMixingParameter(), computeTriLatticeFrictionFactor(), SCMFrictionChenTodreas(), SCMMixingChenTodreas::SCMMixingChenTodreas(), and SCMMixingKimAndChung::SCMMixingKimAndChung().

◆ _tri_sch_mesh

const TriSubChannelMesh* const SCMFrictionChenTodreas::_tri_sch_mesh
protected

Pointer to the tri lattice mesh.

Definition at line 37 of file SCMFrictionChenTodreas.h.

Referenced by computeTriLatticeFrictionFactor(), and SCMFrictionChenTodreas().

The documentation for this class was generated from the following files:
Generated on Thu Oct 22 2026 20:39:48 for https://mooseframework.inl.gov by doxygen 1.9.8