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

Class that calculates turbulent mixing and sweep-flow coefficients based on the Cheng & Todreas correlations (Cheng & Todreas 1986). More...

#include <SCMMixingChengTodreas.h>

Inheritance diagram for SCMMixingChengTodreas:
[legend]

Public Types

typedef SubChannel1PhaseProblem::FrictionStruct FrictionStruct
 
typedef DataFileName DataFileParameterType
 

Public Member Functions

 SCMMixingChengTodreas (const InputParameters &parameters)
 
Real computeMixingParameter (const unsigned int i_gap, const unsigned int iz) const override
 Computes the turbulent mixing coefficient for the local conditions around gap(i_gap) and axial level(iz)
 
Real computeSweepFlowMixingParameter (const unsigned int i_gap, const unsigned int iz) const override
 Computes the wire-wrap sweep-flow coefficient for peripheral gaps.
 
virtual Real getCT () const
 Return the Turbulent modeling parameter.
 
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

bool _is_tri_lattice
 Keep track of the lattice type.
 
const TriSubChannelMesh *const _tri_sch_mesh
 Pointer to the tri lattice mesh.
 
SolutionHandle _S_soln
 
SolutionHandle _mdot_soln
 
SolutionHandle _w_perim_soln
 
SolutionHandle _mu_soln
 
const Real _CT
 Turbulent modeling parameter used in axial momentum equation.
 
 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

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

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 turbulent mixing and sweep-flow coefficients based on the Cheng & Todreas correlations (Cheng & Todreas 1986).

It is used only for wire-wrapped triangular lattices.

Definition at line 20 of file SCMMixingChengTodreas.h.

Member Typedef Documentation

◆ FrictionStruct

typedef SubChannel1PhaseProblem::FrictionStruct SCMMixingClosureBase::FrictionStruct
inherited

Definition at line 25 of file SCMMixingClosureBase.h.

Constructor & Destructor Documentation

◆ SCMMixingChengTodreas()

SCMMixingChengTodreas::SCMMixingChengTodreas ( const InputParameters &  parameters)

Definition at line 23 of file SCMMixingChengTodreas.C.

24 : SCMMixingClosureBase(parameters),
25 _is_tri_lattice(dynamic_cast<const TriSubChannelMesh *>(&_subchannel_mesh) != nullptr),
26 _tri_sch_mesh(dynamic_cast<const TriSubChannelMesh *>(&_subchannel_mesh)),
27 _S_soln(_subproblem.getVariable(0, "S")),
28 _mdot_soln(_subproblem.getVariable(0, "mdot")),
29 _w_perim_soln(_subproblem.getVariable(0, "w_perim")),
30 _mu_soln(_subproblem.getVariable(0, "mu"))
31{
32 if (!_is_tri_lattice)
33 mooseError("This correlation applies only for triangular assemblies");
34
35 if (_tri_sch_mesh->getWireLeadLength() == 0 || _tri_sch_mesh->getWireDiameter() == 0)
36 mooseError("This correlation applies only for wire-wrapped assemblies");
37
38 const Real pitch = _subchannel_mesh.getPitch();
39 const Real pin_diameter = _subchannel_mesh.getPinDiameter();
40 const Real pitch_to_diameter = pitch / pin_diameter;
41 const Real 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
45 // Cheng and Todreas (1986) fitted the wire-wrapped mixing parameters over the ranges
46 // 1.067 <= P/D <= 1.35, 4 <= H/D <= 52, and 7 <= Npin <= 217.
47 if (pitch_to_diameter < 1.067 || pitch_to_diameter > 1.35)
48 flagSolutionWarning("Pitch-over-pin diameter ratio (P/D) outside the Cheng-Todreas "
49 "wire-wrapped mixing correlation data range.");
50 if (wire_lead_to_diameter < 4.0 || wire_lead_to_diameter > 52.0)
51 flagSolutionWarning("Wire lead length-over-pin diameter ratio (H/D) outside the "
52 "Cheng-Todreas wire-wrapped mixing correlation data range.");
53 if (num_pins < 7 || num_pins > 217)
54 flagSolutionWarning("Number of pins outside the Cheng-Todreas wire-wrapped mixing "
55 "correlation data range.");
56}
ThreadedGeneralUserObject::parameters
const InputParameters & parameters() const
ThreadedGeneralUserObject::mooseError
void mooseError(Args &&... args) const
SCMClosureBase::_subchannel_mesh
const SubChannelMesh & _subchannel_mesh
Reference to the subchannel mesh.
Definition SCMClosureBase.h:35
SCMMixingChengTodreas::_tri_sch_mesh
const TriSubChannelMesh *const _tri_sch_mesh
Pointer to the tri lattice mesh.
Definition SCMMixingChengTodreas.h:35
SCMMixingChengTodreas::_is_tri_lattice
bool _is_tri_lattice
Keep track of the lattice type.
Definition SCMMixingChengTodreas.h:33
SCMMixingClosureBase
Base class for turbulent mixing closures used in SCM.
Definition SCMMixingClosureBase.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
SubProblem::getVariable
virtual const MooseVariableFieldBase & getVariable(const THREAD_ID tid, const std::string &var_name, Moose::VarKindType expected_var_type=Moose::VarKindType::VAR_ANY, Moose::VarFieldType expected_var_field_type=Moose::VarFieldType::VAR_FIELD_ANY) const=0
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
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

Member Function Documentation

◆ computeMixingParameter()

Real SCMMixingChengTodreas::computeMixingParameter ( const unsigned int  i_gap,
const unsigned int  iz 
) const
overridevirtual

Computes the turbulent mixing coefficient for the local conditions around gap(i_gap) and axial level(iz)

Parameters
i_gapindex of the gap
Returns
the mixing coefficient (beta)

Implements SCMMixingClosureBase.

Definition at line 59 of file SCMMixingChengTodreas.C.

60{
61 Real beta = 0.0;
62
63 const Real pitch = _subchannel_mesh.getPitch();
64 const Real pin_diameter = _subchannel_mesh.getPinDiameter();
65
66 const Real wire_lead_length = _tri_sch_mesh->getWireLeadLength();
67 const Real wire_diameter = _tri_sch_mesh->getWireDiameter();
68 const unsigned int Nr = _tri_sch_mesh->getNumOfRings();
69
70 const auto chans = _subchannel_mesh.getGapChannels(i_gap);
71 const unsigned int i_ch = chans.first;
72 const unsigned int j_ch = chans.second;
73
74 const auto subch_type_i = _subchannel_mesh.getSubchannelType(i_ch);
75 const auto subch_type_j = _subchannel_mesh.getSubchannelType(j_ch);
76
77 const Node * const node_in_i = _subchannel_mesh.getChannelNode(i_ch, iz - 1);
78 const Node * const node_out_i = _subchannel_mesh.getChannelNode(i_ch, iz);
79 const Node * const node_in_j = _subchannel_mesh.getChannelNode(j_ch, iz - 1);
80 const Node * const node_out_j = _subchannel_mesh.getChannelNode(j_ch, iz);
81
82 const Real Si_in = _S_soln(node_in_i);
83 const Real Sj_in = _S_soln(node_in_j);
84 const Real Si_out = _S_soln(node_out_i);
85 const Real Sj_out = _S_soln(node_out_j);
86
87 const Real S_total = Si_in + Sj_in + Si_out + Sj_out;
88 const Real Si = 0.5 * (Si_in + Si_out);
89 const Real Sj = 0.5 * (Sj_in + Sj_out);
90
91 const Real w_perim_i = 0.5 * (_w_perim_soln(node_in_i) + _w_perim_soln(node_out_i));
92 const Real w_perim_j = 0.5 * (_w_perim_soln(node_in_j) + _w_perim_soln(node_out_j));
93
94 const Real avg_mu =
95 (1.0 / S_total) * (_mu_soln(node_out_i) * Si_out + _mu_soln(node_in_i) * Si_in +
96 _mu_soln(node_out_j) * Sj_out + _mu_soln(node_in_j) * Sj_in);
97
98 const Real avg_hD = 4.0 * (Si + Sj) / (w_perim_i + w_perim_j);
99
100 const Real avg_massflux =
101 0.5 * ((_mdot_soln(node_in_i) + _mdot_soln(node_in_j)) / (Si_in + Sj_in) +
102 (_mdot_soln(node_out_i) + _mdot_soln(node_out_j)) / (Si_out + Sj_out));
103
104 const Real Re = avg_massflux * avg_hD / avg_mu;
105 if (Re < 400.0 || Re > 1.0e6)
106 flagSolutionWarning("Reynolds number (Re) outside the Cheng-Todreas wire-wrapped mixing "
107 "correlation data range.");
108
109 // Calculation of flow regime
110 const Real ReL = 320.0 * std::pow(10.0, pitch / pin_diameter - 1.0);
111 const Real ReT = 10000.0 * std::pow(10.0, 0.7 * (pitch / pin_diameter - 1.0));
112 const Real bulk_Re = _scm_problem.getBulkReynoldsNumber();
113
114 // This beta is used by the global turbulent crossflow relation:
115 // w'_ij = beta * S_ij * G_bar. Peripheral sweep flow is handled separately by
116 // computeSweepFlowMixingParameter().
117 if (subch_type_i == EChannelType::CENTER || subch_type_j == EChannelType::CENTER)
118 {
119 // Calculation of geometric parameters
120 // wire angle
121 const Real theta =
122 std::acos(wire_lead_length /
123 std::sqrt(Utility::pow<2>(wire_lead_length) +
124 Utility::pow<2>(libMesh::pi * (pin_diameter + wire_diameter))));
125
126 // projected area of wire on subchannel
127 const Real Ar1 = libMesh::pi * (pin_diameter + wire_diameter) * wire_diameter / 6.0;
128
129 // bare subchannel flow area
130 const Real A1prime = (std::sqrt(3.0) / 4.0) * Utility::pow<2>(pitch) -
131 libMesh::pi * Utility::pow<2>(pin_diameter) / 8.0;
132
133 // empirical constant for mixing parameter
134 Real Cm = 0.0;
135 Real CmL_constant = 0.0;
136 Real CmT_constant = 0.0;
137
138 if (Nr == 1)
139 {
140 CmT_constant = 0.1;
141 CmL_constant = 0.055;
142 }
143 else
144 {
145 CmT_constant = 0.14;
146 CmL_constant = 0.077;
147 }
148
149 const Real CmT = CmT_constant * std::pow((pitch - pin_diameter) / pin_diameter, -0.5);
150 const Real CmL = CmL_constant * std::pow((pitch - pin_diameter) / pin_diameter, -0.5);
151
152 if (bulk_Re < ReL)
153 {
154 Cm = CmL;
155 }
156 else if (bulk_Re > ReT)
157 {
158 Cm = CmT;
159 }
160 else
161 {
162 // Simplified intermittency factor; see SCMMixingChengTodreas.md.
163 // Cheng and Todreas (1986) use a more detailed expression for psi.
164 const Real psi = std::log(bulk_Re / ReL) / std::log(ReT / ReL);
165 const Real gamma = 2.0 / 3.0;
166 Cm = CmL + (CmT - CmL) * std::pow(psi, gamma);
167 }
168
169 // mixing parameter
170 beta = Cm * std::sqrt(Ar1 / A1prime) * std::tan(theta);
171 }
172 return beta;
173}
Re
const double Re
Definition GasLiquidMassTransferTest.C:28
SCMClosureBase::_scm_problem
const SubChannel1PhaseProblem & _scm_problem
Reference to the subchannel problem.
Definition SCMClosureBase.h:37
SubChannelMesh::getGapChannels
virtual const std::pair< unsigned int, unsigned int > & getGapChannels(unsigned int i_gap) const =0
Return a pair of subchannel indices for a given gap index.
SubChannelMesh::getSubchannelType
virtual EChannelType getSubchannelType(unsigned int index) const =0
Return the type of the subchannel for given subchannel index.
SubChannelMesh::getChannelNode
virtual Node * getChannelNode(unsigned int i_chan, unsigned int iz) const =0
Get the subchannel mesh node for a given channel index and elevation index.
libMesh::pi
const Real pi

◆ computeSweepFlowMixingParameter()

Real SCMMixingChengTodreas::computeSweepFlowMixingParameter ( const unsigned int  i_gap,
const unsigned int  iz 
) const
overridevirtual

Computes the wire-wrap sweep-flow coefficient for peripheral gaps.

Returns
the sweep-flow coefficient; defaults to zero for closures without sweep flow.

Reimplemented from SCMMixingClosureBase.

Definition at line 176 of file SCMMixingChengTodreas.C.

178{
179 Real beta = 0.0;
180
181 const Real pitch = _subchannel_mesh.getPitch();
182 const Real pin_diameter = _subchannel_mesh.getPinDiameter();
183
184 const Real wire_lead_length = _tri_sch_mesh->getWireLeadLength();
185 const Real wire_diameter = _tri_sch_mesh->getWireDiameter();
186 const unsigned int Nr = _tri_sch_mesh->getNumOfRings();
187
188 const auto chans = _subchannel_mesh.getGapChannels(i_gap);
189 const unsigned int i_ch = chans.first;
190 const unsigned int j_ch = chans.second;
191
192 const auto subch_type_i = _subchannel_mesh.getSubchannelType(i_ch);
193 const auto subch_type_j = _subchannel_mesh.getSubchannelType(j_ch);
194
195 const Node * const node_in_i = _subchannel_mesh.getChannelNode(i_ch, iz - 1);
196 const Node * const node_out_i = _subchannel_mesh.getChannelNode(i_ch, iz);
197 const Node * const node_in_j = _subchannel_mesh.getChannelNode(j_ch, iz - 1);
198 const Node * const node_out_j = _subchannel_mesh.getChannelNode(j_ch, iz);
199
200 const Real Si_in = _S_soln(node_in_i);
201 const Real Sj_in = _S_soln(node_in_j);
202 const Real Si_out = _S_soln(node_out_i);
203 const Real Sj_out = _S_soln(node_out_j);
204
205 const Real S_total = Si_in + Sj_in + Si_out + Sj_out;
206 const Real Si = 0.5 * (Si_in + Si_out);
207 const Real Sj = 0.5 * (Sj_in + Sj_out);
208
209 const Real w_perim_i = 0.5 * (_w_perim_soln(node_in_i) + _w_perim_soln(node_out_i));
210 const Real w_perim_j = 0.5 * (_w_perim_soln(node_in_j) + _w_perim_soln(node_out_j));
211
212 const Real avg_mu =
213 (1.0 / S_total) * (_mu_soln(node_out_i) * Si_out + _mu_soln(node_in_i) * Si_in +
214 _mu_soln(node_out_j) * Sj_out + _mu_soln(node_in_j) * Sj_in);
215
216 const Real avg_hD = 4.0 * (Si + Sj) / (w_perim_i + w_perim_j);
217
218 const Real avg_massflux =
219 0.5 * ((_mdot_soln(node_in_i) + _mdot_soln(node_in_j)) / (Si_in + Sj_in) +
220 (_mdot_soln(node_out_i) + _mdot_soln(node_out_j)) / (Si_out + Sj_out));
221
222 const Real Re = avg_massflux * avg_hD / avg_mu;
223 if (Re < 400.0 || Re > 1.0e6)
224 flagSolutionWarning("Reynolds number (Re) outside the Cheng-Todreas wire-wrapped mixing "
225 "correlation data range.");
226
227 // Calculation of flow regime
228 const Real ReL = 320.0 * std::pow(10.0, pitch / pin_diameter - 1.0);
229 const Real ReT = 10000.0 * std::pow(10.0, 0.7 * (pitch / pin_diameter - 1.0));
230 const Real bulk_Re = _scm_problem.getBulkReynoldsNumber();
231
232 if ((subch_type_i == EChannelType::CORNER || subch_type_i == EChannelType::EDGE) &&
233 (subch_type_j == EChannelType::CORNER || subch_type_j == EChannelType::EDGE))
234 {
235 const Real theta =
236 std::acos(wire_lead_length /
237 std::sqrt(Utility::pow<2>(wire_lead_length) +
238 Utility::pow<2>(libMesh::pi * (pin_diameter + wire_diameter))));
239
240 // Calculation of geometric parameters
241 // distance from pin surface to duct
242 const Real dpgap = _tri_sch_mesh->getDuctToPinGap();
243
244 // Edge pitch parameter defined as pin diameter plus distance to duct wall
245 const Real w = pin_diameter + dpgap;
246
247 const Real Ar2 = libMesh::pi * (pin_diameter + wire_diameter) * wire_diameter / 4.0;
248
249 const Real A2prime =
250 pitch * (w - pin_diameter / 2.0) - libMesh::pi * Utility::pow<2>(pin_diameter) / 8.0;
251
252 // empirical constant for mixing parameter
253 Real Cs = 0.0;
254 Real CsL_constant = 0.0;
255 Real CsT_constant = 0.0;
256
257 if (Nr == 1)
258 {
259 CsT_constant = 0.6;
260 CsL_constant = 0.33;
261 }
262 else
263 {
264 CsT_constant = 0.75;
265 CsL_constant = 0.413;
266 }
267
268 const Real CsL = CsL_constant * std::pow(wire_lead_length / pin_diameter, 0.3);
269 const Real CsT = CsT_constant * std::pow(wire_lead_length / pin_diameter, 0.3);
270
271 if (bulk_Re < ReL)
272 {
273 Cs = CsL;
274 }
275 else if (bulk_Re > ReT)
276 {
277 Cs = CsT;
278 }
279 else
280 {
281 // Simplified intermittency factor; see SCMMixingChengTodreas.md.
282 // Cheng and Todreas (1986) use a more detailed expression for psi.
283 const Real psi = std::log(bulk_Re / ReL) / std::log(ReT / ReL);
284 const Real gamma = 2.0 / 3.0;
285 Cs = CsL + (CsT - CsL) * std::pow(psi, gamma);
286 }
287
288 // Sweep-flow coefficient used only by the peripheral enthalpy calculation.
289 beta = Cs * std::sqrt(Ar2 / A2prime) * std::tan(theta);
290 }
291
292 return beta;
293}
TriSubChannelMesh::getDuctToPinGap
const Real & getDuctToPinGap() const
Return the the gap thickness between the duct and peripheral fuel pins.
Definition TriSubChannelMesh.h:49

◆ 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{}

◆ getCT()

virtual Real SCMMixingClosureBase::getCT ( ) const
inlinevirtualinherited

Return the Turbulent modeling parameter.

Definition at line 43 of file SCMMixingClosureBase.h.

43{ return _CT; }
SCMMixingClosureBase::_CT
const Real _CT
Turbulent modeling parameter used in axial momentum equation.
Definition SCMMixingClosureBase.h:38

Referenced by SubChannel1PhaseProblem::initialSetup().

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

Definition at line 15 of file SCMMixingChengTodreas.C.

16{
17 InputParameters params = SCMMixingClosureBase::validParams();
18 params.addClassDescription("Class that models the turbulent mixing coefficient for wire-wrapped "
19 "triangular assemblies using the Cheng Todreas correlations.");
20 return params;
21}
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
SCMMixingClosureBase::validParams
static InputParameters validParams()
Definition SCMMixingClosureBase.C:14

Member Data Documentation

◆ _CT

const Real SCMMixingClosureBase::_CT
inherited

Turbulent modeling parameter used in axial momentum equation.

Definition at line 38 of file SCMMixingClosureBase.h.

Referenced by SCMMixingClosureBase::getCT().

◆ _is_tri_lattice

bool SCMMixingChengTodreas::_is_tri_lattice

Keep track of the lattice type.

Definition at line 33 of file SCMMixingChengTodreas.h.

Referenced by SCMMixingChengTodreas().

◆ _mdot_soln

SolutionHandle SCMMixingChengTodreas::_mdot_soln

Definition at line 38 of file SCMMixingChengTodreas.h.

Referenced by computeMixingParameter(), and computeSweepFlowMixingParameter().

◆ _mu_soln

SolutionHandle SCMMixingChengTodreas::_mu_soln

Definition at line 40 of file SCMMixingChengTodreas.h.

Referenced by computeMixingParameter(), and computeSweepFlowMixingParameter().

◆ _S_soln

SolutionHandle SCMMixingChengTodreas::_S_soln

Definition at line 37 of file SCMMixingChengTodreas.h.

Referenced by computeMixingParameter(), and computeSweepFlowMixingParameter().

◆ _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(), computeMixingParameter(), SCMHTCGnielinski::computeNusseltNumber(), SCMFrictionUpgradedChengTodreas::computeQuadLatticeFrictionFactor(), computeSweepFlowMixingParameter(), SCMFrictionUpgradedChengTodreas::computeTriLatticeFrictionFactor(), SCMFrictionUpgradedChengTodreas::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 computeMixingParameter(), SCMHTCClosureBase::computeNusseltNumberPreInfo(), SCMFrictionUpgradedChengTodreas::computeQuadLatticeFrictionFactor(), computeSweepFlowMixingParameter(), SCMFrictionUpgradedChengTodreas::computeTriLatticeFrictionFactor(), SCMFrictionUpgradedChengTodreas::SCMFrictionUpgradedChengTodreas(), SCMMixingChengTodreas(), and SCMMixingKimAndChung::SCMMixingKimAndChung().

◆ _tri_sch_mesh

const TriSubChannelMesh* const SCMMixingChengTodreas::_tri_sch_mesh

Pointer to the tri lattice mesh.

Definition at line 35 of file SCMMixingChengTodreas.h.

Referenced by computeMixingParameter(), computeSweepFlowMixingParameter(), and SCMMixingChengTodreas().

◆ _w_perim_soln

SolutionHandle SCMMixingChengTodreas::_w_perim_soln

Definition at line 39 of file SCMMixingChengTodreas.h.

Referenced by computeMixingParameter(), and computeSweepFlowMixingParameter().

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