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

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

#include <SCMFrictionUpgradedChengTodreas.h>

Inheritance diagram for SCMFrictionUpgradedChengTodreas:
[legend]

Public Types

typedef SubChannel1PhaseProblem::FrictionStruct FrictionStruct
 
typedef DataFileName DataFileParameterType
 

Public Member Functions

 SCMFrictionUpgradedChengTodreas (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 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 based on the upgraded Cheng & Todreas correlations (Cheng et all 2018).

It is used for both quad and tri lattices.

Definition at line 20 of file SCMFrictionUpgradedChengTodreas.h.

Member Typedef Documentation

◆ FrictionStruct

typedef SubChannel1PhaseProblem::FrictionStruct SCMFrictionClosureBase::FrictionStruct
inherited

Definition at line 25 of file SCMFrictionClosureBase.h.

Constructor & Destructor Documentation

◆ SCMFrictionUpgradedChengTodreas()

SCMFrictionUpgradedChengTodreas::SCMFrictionUpgradedChengTodreas ( const InputParameters &  parameters)

Definition at line 23 of file SCMFrictionUpgradedChengTodreas.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("Wire-wrapped bundle friction requires both wire diameter and wire lead length. "
34 "Set both to zero for a bare pin bundle.");
35
36 if (_is_tri_lattice)
37 {
38 const auto pitch = _subchannel_mesh.getPitch();
39 const auto pin_diameter = _subchannel_mesh.getPinDiameter();
40 const auto p_over_d = pitch / pin_diameter;
41 const auto wire_lead_to_diameter = _tri_sch_mesh->getWireLeadLength() / pin_diameter;
42 const unsigned int Nr = _tri_sch_mesh->getNumOfRings();
43 const unsigned int num_pins = 1 + 3 * Nr * (Nr - 1);
44 const auto Reb = _scm_problem.getBulkReynoldsNumber();
45
46 // The upgraded 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 <= 217,
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 upgraded "
51 "Cheng-Todreas friction correlation data range.");
52 if (_has_wire_wrap && (wire_lead_to_diameter < 8.0 || wire_lead_to_diameter > 52.0))
53 flagSolutionWarning("Wire lead length-over-pin diameter ratio (H/D) outside the upgraded "
54 "Cheng-Todreas friction correlation data range.");
55 if (num_pins < 7 || num_pins > 271)
56 flagSolutionWarning("Number of pins outside the upgraded Cheng-Todreas friction correlation "
57 "data range.");
58 if (Reb < 50.0 || Reb > 1.0e6)
59 flagSolutionWarning("Bulk Reynolds number (Reb) outside the upgraded Cheng-Todreas friction "
60 "correlation data range.");
61 }
62}
ThreadedGeneralUserObject::parameters
const InputParameters & parameters() const
ThreadedGeneralUserObject::mooseError
void mooseError(Args &&... args) const
QuadSubChannelMesh
Creates the mesh of subchannels in a quadrilateral lattice.
Definition QuadSubChannelMesh.h:24
SCMClosureBase::_scm_problem
const SubChannel1PhaseProblem & _scm_problem
Reference to the subchannel problem.
Definition SCMClosureBase.h:37
SCMClosureBase::_subchannel_mesh
const SubChannelMesh & _subchannel_mesh
Reference to the subchannel mesh.
Definition SCMClosureBase.h:35
SCMFrictionClosureBase
Base class for friction closures used in SCM.
Definition SCMFrictionClosureBase.h:19
SCMFrictionUpgradedChengTodreas::_is_tri_lattice
bool _is_tri_lattice
Keep track of the lattice type.
Definition SCMFrictionUpgradedChengTodreas.h:34
SCMFrictionUpgradedChengTodreas::_has_wire_wrap
const bool _has_wire_wrap
Whether the triangular assembly has wire-wrap geometry.
Definition SCMFrictionUpgradedChengTodreas.h:40
SCMFrictionUpgradedChengTodreas::_tri_sch_mesh
const TriSubChannelMesh *const _tri_sch_mesh
Pointer to the tri lattice mesh.
Definition SCMFrictionUpgradedChengTodreas.h:36
SCMFrictionUpgradedChengTodreas::_quad_sch_mesh
const QuadSubChannelMesh *const _quad_sch_mesh
Pointer to the quad lattice mesh.
Definition SCMFrictionUpgradedChengTodreas.h:38
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 SCMFrictionUpgradedChengTodreas::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 65 of file SCMFrictionUpgradedChengTodreas.C.

66{
67 if (_is_tri_lattice)
68 return computeTriLatticeFrictionFactor(friction_args);
69 else
70 return computeQuadLatticeFrictionFactor(friction_args);
71}
SCMFrictionUpgradedChengTodreas::computeTriLatticeFrictionFactor
Real computeTriLatticeFrictionFactor(const FrictionStruct &friction_info) const
Definition SCMFrictionUpgradedChengTodreas.C:74
SCMFrictionUpgradedChengTodreas::computeQuadLatticeFrictionFactor
Real computeQuadLatticeFrictionFactor(const FrictionStruct &friction_info) const
Definition SCMFrictionUpgradedChengTodreas.C:301

◆ computeQuadLatticeFrictionFactor()

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

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

Definition at line 301 of file SCMFrictionUpgradedChengTodreas.C.

303{
304 const auto Re = friction_args.Re;
305 // Limit the Reynolds number used in the friction-factor correlation to avoid
306 // singular behavior k1T zero flow.
307 const Real Re_eff = std::max(Re, 1.0);
308 const auto i_ch = friction_args.i_ch;
310 Real k1L, k2L, k3L, CfL;
311 Real k1T, k2T, k3T, CfT;
312 const auto pitch = _subchannel_mesh.getPitch();
313 const auto pin_diameter = _subchannel_mesh.getPinDiameter();
314 // This gap is a constant value for the whole assembly. Might want to make it
315 // subchannel specific in the future if we have duct deformation.
316 const auto side_gap = _quad_sch_mesh->getSideGap();
317 const auto w = (pin_diameter / 2.0) + (pitch / 2.0) + side_gap;
318 const auto p_over_d = pitch / pin_diameter;
319 const auto w_over_d = w / pin_diameter;
320 const auto ReL = std::pow(10, (p_over_d - 1)) * 320.0;
321 const auto ReT = std::pow(10, 0.7 * (p_over_d - 1)) * 1.0E+4;
322 const auto Reb = _scm_problem.getBulkReynoldsNumber();
323 const auto psi = std::log(Reb / ReL) / std::log(ReT / ReL);
324 const auto subch_type = _subchannel_mesh.getSubchannelType(i_ch);
325 // interpolation exponent
326 Real lambda;
327 // transition smoothing coefficient
328 Real gamma;
329
330 // Find the coefficients of bare Pin bundle friction factor
331 // correlations for turbulent and laminar flow regimes. Todreas & Kazimi, Nuclear Systems Volume
332 // 1
333 if (subch_type == EChannelType::CENTER)
334 {
335 if (p_over_d < 1.1)
336 {
337 k1L = 26.37;
338 k2L = 374.2;
339 k3L = -493.9;
340 k1T = 0.09423;
341 k2T = 0.5806;
342 k3T = -1.239;
343 }
344 else
345 {
346 k1L = 35.55;
347 k2L = 263.7;
348 k3L = -190.2;
349 k1T = 0.1339;
350 k2T = 0.09059;
351 k3T = -0.09926;
352 }
353 // laminar flow friction factor for bare Pin bundle - Center subchannel
354 CfL = k1L + k2L * (p_over_d - 1) + k3L * Utility::pow<2>((p_over_d - 1));
355 // turbulent flow friction factor for bare Pin bundle - Center subchannel
356 CfT = k1T + k2T * (p_over_d - 1) + k3T * Utility::pow<2>((p_over_d - 1));
357 }
358 else if (subch_type == EChannelType::EDGE)
359 {
360 if (p_over_d < 1.1)
361 {
362 k1L = 26.18;
363 k2L = 554.5;
364 k3L = -1480;
365 k1T = 0.09377;
366 k2T = 0.8732;
367 k3T = -3.341;
368 }
369 else
370 {
371 k1L = 44.40;
372 k2L = 256.7;
373 k3L = -267.6;
374 k1T = 0.1430;
375 k2T = 0.04199;
376 k3T = -0.04428;
377 }
378 // laminar flow friction factor for bare Pin bundle - Edge subchannel
379 CfL = k1L + k2L * (w_over_d - 1) + k3L * Utility::pow<2>((w_over_d - 1));
380 // turbulent flow friction factor for bare Pin bundle - Edge subchannel
381 CfT = k1T + k2T * (w_over_d - 1) + k3T * Utility::pow<2>((w_over_d - 1));
382 }
383 else
384 {
385 if (p_over_d < 1.1)
386 {
387 k1L = 28.62;
388 k2L = 715.9;
389 k3L = -2807;
390 k1T = 0.09755;
391 k2T = 1.127;
392 k3T = -6.304;
393 }
394 else
395 {
396 k1L = 58.83;
397 k2L = 160.7;
398 k3L = -203.5;
399 k1T = 0.1452;
400 k2T = 0.02681;
401 k3T = -0.03411;
402 }
403 // laminar flow friction factor for bare Pin bundle - Corner subchannel
404 CfL = k1L + k2L * (w_over_d - 1) + k3L * Utility::pow<2>((w_over_d - 1));
405 // turbulent flow friction factor for bare Pin bundle - Corner subchannel
406 CfT = k1T + k2T * (w_over_d - 1) + k3T * Utility::pow<2>((w_over_d - 1));
407 }
408 // laminar friction factor and turbulent friction factor coefficients
409 const Real mL = -1.0;
410 const Real mT = -0.18;
411 auto fL = CfL * std::pow(Re_eff, mL);
412 auto fT = CfT * std::pow(Re_eff, mT);
413 gamma = 1.0 / 3.0;
414 lambda = 7.0;
415 if (Reb < ReL)
416 {
417 // laminar flow
418 return fL;
419 }
420 else if (Reb > ReT)
421 {
422 // turbulent flow
423 return fT;
424 }
425 else
426 {
427 // Transition regime is selected by bulk Reynolds number, same for all channels.
428 return fL * std::pow((1 - psi), gamma) * (1 - std::pow(psi, lambda)) +
429 fT * std::pow(psi, gamma);
430 }
431}
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
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 SCMFrictionUpgradedChengTodreas::computeTriLatticeFrictionFactor ( const FrictionStruct &  friction_info) const
protected

Definition at line 74 of file SCMFrictionUpgradedChengTodreas.C.

76{
77 const auto Re = friction_args.Re;
78 // Limit the Reynolds number used in the friction-factor correlation to avoid
79 // singular behavior at zero flow.
80 const Real Re_eff = std::max(Re, 1.0);
81 const auto i_ch = friction_args.i_ch;
82 const auto S = friction_args.S;
83 const auto w_perim = friction_args.w_perim;
84 const auto Dh_i = 4.0 * S / w_perim;
85 // Bare fuel Pins coefficients, and friction factor
86 Real k1L, k2L, k3L, CfL;
87 Real k1T, k2T, k3T, CfT;
88 // Transient range parameters
89 Real CbL1, CbL2, CbT1, CbT2;
90 // Ratio of laminar over turbulent drag and sweep coefficients
91 Real CwL1, CwL2;
92 // interpolation exponent
93 Real lambda;
94 // transition smoothing coefficient
95 Real gamma;
96 const Real & pitch = _subchannel_mesh.getPitch();
97 const Real & pin_diameter = _subchannel_mesh.getPinDiameter();
98 const Real & wire_lead_length = _tri_sch_mesh->getWireLeadLength();
99 const Real & wire_diameter = _tri_sch_mesh->getWireDiameter();
100 const auto gap = _tri_sch_mesh->getDuctToPinGap();
101 const auto p_over_d = pitch / pin_diameter;
102 const auto w_over_d = (pin_diameter + gap) / pin_diameter;
103 const auto subch_type = _subchannel_mesh.getSubchannelType(i_ch);
104 CbL1 = 320;
105 CbL2 = 1.0;
106 CbT1 = 10000;
107 CbT2 = 0.7;
108 const auto ReL = std::pow(10, CbL2 * (p_over_d - 1)) * CbL1;
109 const auto ReT = std::pow(10, CbT2 * (p_over_d - 1)) * CbT1;
110 const auto Reb = _scm_problem.getBulkReynoldsNumber();
111 const auto psi = std::log(Reb / ReL) / std::log(ReT / ReL);
112
113 // Find the coefficients of bare Pin bundle friction factor
114 // correlations for turbulent and laminar flow regimes. Todreas & Kazimi, Nuclear Systems
115 // second edition, Volume 1, Chapter 9.6
116 if (subch_type == EChannelType::CENTER)
117 {
118 if (p_over_d < 1.1)
119 {
120 k1L = 26.0;
121 k2L = 888.2;
122 k3L = -3334.0;
123 k1T = 0.09378;
124 k2T = 1.398;
125 k3T = -8.664;
126 }
127 else
128 {
129 k1L = 62.97;
130 k2L = 216.9;
131 k3L = -190.2;
132 k1T = 0.1458;
133 k2T = 0.03632;
134 k3T = -0.03333;
135 }
136 // laminar flow friction factor for bare Pin bundle - Center subchannel
137 CfL = k1L + k2L * (p_over_d - 1) + k3L * Utility::pow<2>((p_over_d - 1));
138 // turbulent flow friction factor for bare Pin bundle - Center subchannel
139 CfT = k1T + k2T * (p_over_d - 1) + k3T * Utility::pow<2>((p_over_d - 1));
140 }
141 else if (subch_type == EChannelType::EDGE)
142 {
143 if (w_over_d < 1.1)
144 {
145 k1L = 26.18;
146 k2L = 554.5;
147 k3L = -1480.0;
148 k1T = 0.09377;
149 k2T = 0.8732;
150 k3T = -3.341;
151 }
152 else
153 {
154 k1L = 44.4;
155 k2L = 256.7;
156 k3L = -267.6;
157 k1T = 0.1430;
158 k2T = 0.04199;
159 k3T = -0.04428;
160 }
161 // laminar flow friction factor for bare Pin bundle - Edge subchannel
162 CfL = k1L + k2L * (w_over_d - 1) + k3L * Utility::pow<2>((w_over_d - 1));
163 // turbulent flow friction factor for bare Pin bundle - Edge subchannel
164 CfT = k1T + k2T * (w_over_d - 1) + k3T * Utility::pow<2>((w_over_d - 1));
165 }
166 else
167 {
168 if (w_over_d < 1.1)
169 {
170 k1L = 26.98;
171 k2L = 1636.0;
172 k3L = -10050.0;
173 k1T = 0.1004;
174 k2T = 1.625;
175 k3T = -11.85;
176 }
177 else
178 {
179 k1L = 87.26;
180 k2L = 38.59;
181 k3L = -55.12;
182 k1T = 0.1499;
183 k2T = 0.006706;
184 k3T = -0.009567;
185 }
186 // laminar flow friction factor for bare Pin bundle - Corner subchannel
187 CfL = k1L + k2L * (w_over_d - 1) + k3L * Utility::pow<2>((w_over_d - 1));
188 // turbulent flow friction factor for bare Pin bundle - Corner subchannel
189 CfT = k1T + k2T * (w_over_d - 1) + k3T * Utility::pow<2>((w_over_d - 1));
190 }
191
192 // Find the coefficients of wire-wrapped Pin bundle friction factor
193 // correlations for turbulent and laminar flow regimes. Todreas & Kazimi, Nuclear Systems
194 // Volume 1 Chapter 9-6 also Chen and Todreas (2018).
195 if (_has_wire_wrap)
196 {
197 const auto theta =
198 std::acos(wire_lead_length /
199 std::sqrt(Utility::pow<2>(wire_lead_length) +
200 Utility::pow<2>(libMesh::pi * (pin_diameter + wire_diameter))));
201 // wire Drag coefficient parameters
202 const Real CwT1 = 19.56;
203 const Real CwT2 = -98.71;
204 const Real CwT3 = 303.47;
205 const Real CwT4 = -0.541;
206 CwL1 = 1.4;
207 CwL2 = 1.0;
208 // Drag coefficient
209 const auto WdT = (CwT1 + CwT2 * (wire_diameter / pin_diameter) +
210 CwT3 * Utility::pow<2>((wire_diameter / pin_diameter))) *
211 std::pow((wire_lead_length / pin_diameter), CwT4);
212 const auto WdL = CwL1 * WdT;
213 // wire sweep coefficient parameters
214 const Real a = -11;
215 const Real b = 19;
216 // Sweep coefficient
217 const auto WsT = a * std::log10(wire_lead_length / pin_diameter) + b;
218 const auto WsL = CwL2 * WsT;
219 Real ar = 0.0;
220 Real a_p = 0.0;
221
222 if (subch_type == EChannelType::CENTER)
223 {
224 // wetted perimeter for center subchannel and bare Pin bundle
225 const Real pw_p = libMesh::pi * pin_diameter / 2.0;
226 // wire projected area - center subchannel wire-wrapped bundle
227 ar = libMesh::pi * (pin_diameter + wire_diameter) * wire_diameter / 6.0;
228 // bare Pin bundle center subchannel flow area (normal area + wire area)
229 a_p = S + libMesh::pi * Utility::pow<2>(wire_diameter) / 8.0 / std::cos(theta);
230 // turbulent friction factor equation constant - Center subchannel
231 CfT *= (pw_p / w_perim);
232 CfT += WdT * (3.0 * ar / a_p) * (Dh_i / wire_lead_length) *
233 std::pow((Dh_i / wire_diameter), 0.18);
234 // laminar friction factor equation constant - Center subchannel
235 CfL *= (pw_p / w_perim);
236 CfL += WdL * (3.0 * ar / a_p) * (Dh_i / wire_lead_length) * (Dh_i / wire_diameter);
237 }
238 else if (subch_type == EChannelType::EDGE)
239 {
240 // wire projected area - edge subchannel wire-wrapped bundle
241 ar = libMesh::pi * (pin_diameter + wire_diameter) * wire_diameter / 4.0;
242 // bare Pin bundle edge subchannel flow area (normal area + wire area)
243 a_p = S + libMesh::pi * Utility::pow<2>(wire_diameter) / 8.0 / std::cos(theta);
244 // turbulent friction factor equation constant - Edge subchannel
245 const Real turbulent_wire_correction =
246 1 + WsT * (ar / a_p) * Utility::pow<2>(std::tan(theta));
247 if (!std::isfinite(turbulent_wire_correction) || turbulent_wire_correction < 0.0)
248 mooseError("The exponentiated term in the Cheng-Todreas turbulent wire correction must be "
249 "non-negative and finite for an edge subchannel. Computed ",
250 turbulent_wire_correction,
251 ".");
252 CfT *= std::pow(turbulent_wire_correction, 1.41);
253 // laminar friction factor equation constant - Edge subchannel
254 CfL *= (1 + WsL * (ar / a_p) * Utility::pow<2>(std::tan(theta)));
255 }
256 else
257 {
258 // wire projected area - corner subchannel wire-wrapped bundle
259 ar = libMesh::pi * (pin_diameter + wire_diameter) * wire_diameter / 6.0;
260 // bare Pin bundle corner subchannel flow area (normal area + wire area)
261 a_p = S + libMesh::pi * Utility::pow<2>(wire_diameter) / 24.0 / std::cos(theta);
262 // turbulent friction factor equation constant - Corner subchannel
263 const Real turbulent_wire_correction =
264 1 + WsT * (ar / a_p) * Utility::pow<2>(std::tan(theta));
265 if (!std::isfinite(turbulent_wire_correction) || turbulent_wire_correction < 0.0)
266 mooseError("The exponentiated term in the Cheng-Todreas turbulent wire correction must be "
267 "non-negative and finite for a corner subchannel. Computed ",
268 turbulent_wire_correction,
269 ".");
270 CfT *= std::pow(turbulent_wire_correction, 1.41);
271 // laminar friction factor equation constant - Corner subchannel
272 CfL *= (1 + WsL * (ar / a_p) * Utility::pow<2>(std::tan(theta)));
273 }
274 }
275 // laminar friction factor and turbulent friction factor coefficients
276 const Real mL = -1.0;
277 const Real mT = -0.18;
278 auto fL = CfL * std::pow(Re_eff, mL);
279 auto fT = CfT * std::pow(Re_eff, mT);
280 gamma = 1.0 / 3.0;
281 lambda = 7.0;
282 if (Reb < ReL)
283 {
284 // laminar flow
285 return fL;
286 }
287 else if (Reb > ReT)
288 {
289 // turbulent flow
290 return fT;
291 }
292 else
293 {
294 // Transition regime is selected by bulk Reynolds number, same for all channels.
295 return fL * std::pow((1 - psi), gamma) * (1 - std::pow(psi, lambda)) +
296 fT * std::pow(psi, gamma);
297 }
298}
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 SCMFrictionUpgradedChengTodreas::validParams ( )
static

Definition at line 15 of file SCMFrictionUpgradedChengTodreas.C.

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

Member Data Documentation

◆ _has_wire_wrap

const bool SCMFrictionUpgradedChengTodreas::_has_wire_wrap
protected

Whether the triangular assembly has wire-wrap geometry.

Definition at line 40 of file SCMFrictionUpgradedChengTodreas.h.

Referenced by computeTriLatticeFrictionFactor(), and SCMFrictionUpgradedChengTodreas().

◆ _is_tri_lattice

bool SCMFrictionUpgradedChengTodreas::_is_tri_lattice
protected

Keep track of the lattice type.

Definition at line 34 of file SCMFrictionUpgradedChengTodreas.h.

Referenced by computeFrictionFactor(), and SCMFrictionUpgradedChengTodreas().

◆ _quad_sch_mesh

const QuadSubChannelMesh* const SCMFrictionUpgradedChengTodreas::_quad_sch_mesh
protected

Pointer to the quad lattice mesh.

Definition at line 38 of file SCMFrictionUpgradedChengTodreas.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(), SCMMixingChengTodreas::computeMixingParameter(), SCMHTCGnielinski::computeNusseltNumber(), computeQuadLatticeFrictionFactor(), SCMMixingChengTodreas::computeSweepFlowMixingParameter(), computeTriLatticeFrictionFactor(), SCMFrictionUpgradedChengTodreas(), 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(), SCMFrictionUpgradedChengTodreas(), SCMMixingChengTodreas::SCMMixingChengTodreas(), and SCMMixingKimAndChung::SCMMixingKimAndChung().

◆ _tri_sch_mesh

const TriSubChannelMesh* const SCMFrictionUpgradedChengTodreas::_tri_sch_mesh
protected

Pointer to the tri lattice mesh.

Definition at line 36 of file SCMFrictionUpgradedChengTodreas.h.

Referenced by computeTriLatticeFrictionFactor(), and SCMFrictionUpgradedChengTodreas().

The documentation for this class was generated from the following files:
Generated on Mon Sep 28 2026 20:40:45 for https://mooseframework.inl.gov by doxygen 1.9.8