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

Class that calculates the turbulent mixing coefficient based on the Kim and Chung (2001) correllation (eq 25). More...

#include <SCMMixingKimAndChung.h>

Inheritance diagram for SCMMixingKimAndChung:
[legend]

Public Types

typedef SubChannel1PhaseProblem::FrictionStruct FrictionStruct
 
typedef DataFileName DataFileParameterType
 

Public Member Functions

 SCMMixingKimAndChung (const InputParameters &parameters)
 
virtual 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)
 
virtual Real computeSweepFlowMixingParameter (const unsigned int i_gap, const unsigned int iz) const
 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

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

Real computeTriLatticeMixingParameter (const unsigned int i_gap, const unsigned int iz) const
 
Real computeQuadLatticeMixingParameter (const unsigned int i_gap, const unsigned int iz) const
 
Real computeLatticeMixingParameter (const unsigned int i_gap, const unsigned int iz, const Real delta, const Real sf) const
 Common implementation for both tri and quad lattices.
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &name) const override
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override
 
virtual void addUserObjectDependencyHelper (const UserObjectBase &uo) const override
 
void addReporterDependencyHelper (const ReporterName &reporter_name) override
 
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) const
 
const ReporterContextBase & getReporterContextBaseByName (const ReporterName &reporter_name) const
 
const ReporterName & getReporterName (const std::string &param_name) const
 
T & declareRestartableData (const std::string &data_name, Args &&... args)
 
ManagedValue< T > declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
const T & getRestartableData (const std::string &data_name) const
 
T & declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
T & declareRecoverableData (const std::string &data_name, Args &&... args)
 
T & declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
 
T & declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
 
std::string restartableName (const std::string &data_name) const
 
const T & getMeshProperty (const std::string &data_name, const std::string &prefix)
 
const T & getMeshProperty (const std::string &data_name)
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name) const
 
bool hasMeshProperty (const std::string &data_name) const
 
std::string meshPropertyName (const std::string &data_name) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_name) const
 
bool isCoupledScalar (const std::string &var_name, unsigned int i=0) const
 
unsigned int coupledScalarComponents (const std::string &var_name) const
 
unsigned int coupledScalar (const std::string &var_name, unsigned int comp=0) const
 
libMesh::Order coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< is_ad > & coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const VariableValue & coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const MooseVariableScalar * getScalarVar (const std::string &var_name, unsigned int comp) const
 
virtual void checkMaterialProperty (const std::string &name, const unsigned int state)
 
virtual void getKokkosMaterialPropertyHook (const std::string &, const unsigned int)
 
void markMatPropRequested (const std::string &)
 
MaterialPropertyName getMaterialPropertyName (const std::string &name) const
 
void checkExecutionStage ()
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 

Static Protected Member Functions

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

Protected Attributes

bool _is_tri_lattice
 Keep track of the lattice type.
 
const SubChannelMesh & _sch_mesh
 Pointer to the base subchannel mesh.
 
SolutionHandle _S_soln
 
SolutionHandle _mdot_soln
 
SolutionHandle _w_perim_soln
 
SolutionHandle _mu_soln
 
SolutionHandle _P_soln
 
SolutionHandle _T_soln
 
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::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 turbulent mixing coefficient based on the Kim and Chung (2001) correllation (eq 25).

It is used for both quad and tri lattices with bare fuel pins.

Definition at line 20 of file SCMMixingKimAndChung.h.

Member Typedef Documentation

◆ FrictionStruct

typedef SubChannel1PhaseProblem::FrictionStruct SCMMixingClosureBase::FrictionStruct
inherited

Definition at line 25 of file SCMMixingClosureBase.h.

Constructor & Destructor Documentation

◆ SCMMixingKimAndChung()

SCMMixingKimAndChung::SCMMixingKimAndChung ( const InputParameters &  parameters)

Definition at line 27 of file SCMMixingKimAndChung.C.

28 : SCMMixingClosureBase(parameters),
29 _is_tri_lattice(dynamic_cast<const TriSubChannelMesh *>(&_subchannel_mesh) != nullptr),
30 _sch_mesh(_subchannel_mesh),
31 _S_soln(_subproblem.getVariable(0, "S")),
32 _mdot_soln(_subproblem.getVariable(0, "mdot")),
33 _w_perim_soln(_subproblem.getVariable(0, "w_perim")),
34 _mu_soln(_subproblem.getVariable(0, "mu")),
35 _P_soln(_subproblem.getVariable(0, "P")),
36 _T_soln(_subproblem.getVariable(0, "T"))
37{
38 if (_is_tri_lattice)
39 {
40 const auto & tri_mesh = static_cast<const TriSubChannelMesh &>(_subchannel_mesh);
41 if (tri_mesh.getWireDiameter() != 0.0 || tri_mesh.getWireLeadLength() != 0.0)
42 mooseError("SCMMixingKimAndChung applies only to bare-pin assemblies and cannot be used "
43 "with wire-wrapped triangular bundles.");
44 }
45}
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
SCMMixingClosureBase
Base class for turbulent mixing closures used in SCM.
Definition SCMMixingClosureBase.h:19
SCMMixingKimAndChung::_is_tri_lattice
bool _is_tri_lattice
Keep track of the lattice type.
Definition SCMMixingKimAndChung.h:41
SCMMixingKimAndChung::_sch_mesh
const SubChannelMesh & _sch_mesh
Pointer to the base subchannel mesh.
Definition SCMMixingKimAndChung.h:43
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

Member Function Documentation

◆ computeLatticeMixingParameter()

Real SCMMixingKimAndChung::computeLatticeMixingParameter ( const unsigned int  i_gap,
const unsigned int  iz,
const Real  delta,
const Real  sf 
) const
protected

Common implementation for both tri and quad lattices.

The only lattice-dependent quantities are delta and sf (shape factor).

Definition at line 61 of file SCMMixingKimAndChung.C.

65{
66 const Real P_out = _scm_problem.getOutletPressure();
67 const auto fp = _scm_problem.getSinglePhaseFluidProperties();
68 const Real pin_diameter = _sch_mesh.getPinDiameter();
69
70 const auto chans = _sch_mesh.getGapChannels(i_gap);
71 const unsigned int i_ch = chans.first;
72 const unsigned int j_ch = chans.second;
73
74 const Node * const node_in_i = _sch_mesh.getChannelNode(i_ch, iz - 1);
75 const Node * const node_out_i = _sch_mesh.getChannelNode(i_ch, iz);
76 const Node * const node_in_j = _sch_mesh.getChannelNode(j_ch, iz - 1);
77 const Node * const node_out_j = _sch_mesh.getChannelNode(j_ch, iz);
78
79 const Real Si_in = _S_soln(node_in_i);
80 const Real Sj_in = _S_soln(node_in_j);
81 const Real Si_out = _S_soln(node_out_i);
82 const Real Sj_out = _S_soln(node_out_j);
83
84 const Real Si = 0.5 * (Si_in + Si_out);
85 const Real Sj = 0.5 * (Sj_in + Sj_out);
86 const Real S_total = Si_in + Sj_in + Si_out + Sj_out;
87
88 // crossflow area between channels i,j (dz*gap_width)
89 const Real gap = _sch_mesh.getGapWidth(iz, i_gap);
90
91 const Real massflux_i = 0.5 * (_mdot_soln(node_in_i) + _mdot_soln(node_out_i)) / Si;
92 const Real massflux_j = 0.5 * (_mdot_soln(node_in_j) + _mdot_soln(node_out_j)) / Sj;
93
94 // average massflux definition
95 const Real avg_massflux =
96 0.5 * ((_mdot_soln(node_in_i) + _mdot_soln(node_in_j)) / (Si_in + Sj_in) +
97 (_mdot_soln(node_out_i) + _mdot_soln(node_out_j)) / (Si_out + Sj_out));
98
99 const Real w_perim_i = 0.5 * (_w_perim_soln(node_in_i) + _w_perim_soln(node_out_i));
100 const Real w_perim_j = 0.5 * (_w_perim_soln(node_in_j) + _w_perim_soln(node_out_j));
101
102 const Real mu_i = 0.5 * (_mu_soln(node_in_i) + _mu_soln(node_out_i));
103 const Real mu_j = 0.5 * (_mu_soln(node_in_j) + _mu_soln(node_out_j));
104 const Real avg_mu = 0.5 * (mu_i + mu_j);
105
106 const Real avg_hD = 4.0 * (Si + Sj) / (w_perim_i + w_perim_j);
107 const Real hD_i = 4.0 * Si / w_perim_i;
108 const Real hD_j = 4.0 * Sj / w_perim_j;
109
110 const Real Re_i = massflux_i * hD_i / mu_i;
111 const Real Re_j = massflux_j * hD_j / mu_j;
112 const Real Re = avg_massflux * avg_hD / avg_mu;
113
114 constexpr Real gamma = 20.0; // empirical constant
115 constexpr Real a = 0.18;
116 constexpr Real b = 0.2;
117
118 const auto friction_args_i = FrictionStruct(i_ch, Re_i, Si, w_perim_i);
119 const auto friction_args_j = FrictionStruct(j_ch, Re_j, Sj, w_perim_j);
120
121 const Real fi = _scm_problem.getFrictionClosure()->computeFrictionFactor(friction_args_i);
122 const Real fj = _scm_problem.getFrictionClosure()->computeFrictionFactor(friction_args_j);
123 const Real f = 0.5 * (fi + fj);
124
125 // average heat conduction
126 const Real avg_k =
127 (1.0 / S_total) * (fp->k_from_p_T(_P_soln(node_out_i) + P_out, _T_soln(node_out_i)) * Si_out +
128 fp->k_from_p_T(_P_soln(node_in_i) + P_out, _T_soln(node_in_i)) * Si_in +
129 fp->k_from_p_T(_P_soln(node_out_j) + P_out, _T_soln(node_out_j)) * Sj_out +
130 fp->k_from_p_T(_P_soln(node_in_j) + P_out, _T_soln(node_in_j)) * Sj_in);
131
132 // average specific heat capacity
133 const Real avg_cp = (1.0 / S_total) *
134 (fp->cp_from_p_T(_P_soln(node_out_i) + P_out, _T_soln(node_out_i)) * Si_out +
135 fp->cp_from_p_T(_P_soln(node_in_i) + P_out, _T_soln(node_in_i)) * Si_in +
136 fp->cp_from_p_T(_P_soln(node_out_j) + P_out, _T_soln(node_out_j)) * Sj_out +
137 fp->cp_from_p_T(_P_soln(node_in_j) + P_out, _T_soln(node_in_j)) * Sj_in);
138
139 const Real Pr = avg_mu * avg_cp / avg_k; // Prandtl number
140 const Real Pr_t = Pr * (Re / gamma) * std::sqrt(f / 8.0); // Turbulent Prandtl number
141
142 // This form is intended for liquid-metal applications; warn when the local average Prandtl
143 // number is outside the usual low-Pr liquid-metal regime.
144 if (Pr >= 0.1)
145 flagSolutionWarning("Prandtl number (Pr) outside the low-Prandtl-number liquid-metal range "
146 "expected by the Kim-Chung turbulent mixing closure.");
147
148 const Real L_x = sf * delta; // axial length scale (gap is the lateral length scale)
149 const Real lamda = gap / L_x; // aspect ratio
150 const Real a_x = 1.0 - 2.0 * lamda * lamda / libMesh::pi; // velocity coefficient
151
152 const Real z_FP_over_D =
153 (2.0 * L_x / pin_diameter) *
154 (1.0 + (-0.5 * std::log(lamda) + 0.5 * std::log(4.0) - 0.25) * lamda * lamda);
155
156 const Real Str =
157 1.0 / (0.822 * (gap / pin_diameter) + 0.144); // Strouhal number (Wu & Trupp 1994)
158
159 const Real freq_factor = 2.0 / Utility::pow<2>(gamma) * std::sqrt(a / 8.0) * (avg_hD / gap);
160
161 const Real rod_mixing = (1.0 / Pr_t) * lamda;
162 const Real axial_mixing = a_x * z_FP_over_D * Str;
163
164 // Mixing Stanton number following Kim and Chung (2001), Eq. 25, as used by
165 // Jeong et al. (2005), Eq. 19:
166 //
167 // St_g = 2/gamma^2 * sqrt(a/8) * (D_h/g)
168 // * [lambda/Pr_t + a_x * (z_FP/D) * Str] * Re^(-b/2).
169 //
170 // The subchannel problem converts St_g to the turbulent interchange flow through
171 // w'_ij = beta * S_ij * G_bar (St_g = beta). This correlation doesn't include the
172 // molecular diffusion term which represents the conductive heat transfer,
173 // which is separately modeled in the subchannel energy equation.
174 return freq_factor * (rod_mixing + axial_mixing) * std::pow(Re, -b / 2.0);
175}
f
Real f(Real x)
Test function for Brents method.
Definition BrentsMethodTest.C:21
Re
const double Re
Definition GasLiquidMassTransferTest.C:28
SCMClosureBase::_scm_problem
const SubChannel1PhaseProblem & _scm_problem
Reference to the subchannel problem.
Definition SCMClosureBase.h:37
SCMFrictionClosureBase::computeFrictionFactor
virtual Real computeFrictionFactor(const FrictionStruct &friction_info) const =0
Computes the friction factor for the local conditions.
SCMMixingClosureBase::FrictionStruct
SubChannel1PhaseProblem::FrictionStruct FrictionStruct
Definition SCMMixingClosureBase.h:25
SubChannel1PhaseProblem::getOutletPressure
const PostprocessorValue & getOutletPressure() const
Get outlet pressure.
Definition SubChannel1PhaseProblem.h:95
SubChannel1PhaseProblem::getFrictionClosure
const SCMFrictionClosureBase * getFrictionClosure() const
Definition SubChannel1PhaseProblem.h:46
SubChannel1PhaseProblem::getSinglePhaseFluidProperties
const SinglePhaseFluidProperties * getSinglePhaseFluidProperties() const
Get fluid properties object.
Definition SubChannel1PhaseProblem.h:101
SubChannelMesh::getGapWidth
virtual Real getGapWidth(unsigned int axial_index, unsigned int gap_index) const =0
Return gap width for a given gap index.
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::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.
SubChannelMesh::getPinDiameter
virtual const Real & getPinDiameter() const
Return undeformed Pin diameter.
Definition SubChannelMesh.h:147
NS::delta
int delta(unsigned int i, unsigned int j)
Delta function, which returns zero if $i\ne j$ and unity if $i=j$.
Definition NavierStokesMethods.C:18
libMesh::pi
const Real pi
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

Referenced by computeQuadLatticeMixingParameter(), and computeTriLatticeMixingParameter().

◆ computeMixingParameter()

Real SCMMixingKimAndChung::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 48 of file SCMMixingKimAndChung.C.

49{
50 if (_is_tri_lattice)
51 return computeTriLatticeMixingParameter(i_gap, iz);
52 else
53 return computeQuadLatticeMixingParameter(i_gap, iz);
54}
SCMMixingKimAndChung::computeTriLatticeMixingParameter
Real computeTriLatticeMixingParameter(const unsigned int i_gap, const unsigned int iz) const
Definition SCMMixingKimAndChung.C:178
SCMMixingKimAndChung::computeQuadLatticeMixingParameter
Real computeQuadLatticeMixingParameter(const unsigned int i_gap, const unsigned int iz) const
Definition SCMMixingKimAndChung.C:189

◆ computeQuadLatticeMixingParameter()

Real SCMMixingKimAndChung::computeQuadLatticeMixingParameter ( const unsigned int  i_gap,
const unsigned int  iz 
) const
protected

Definition at line 189 of file SCMMixingKimAndChung.C.

191{
192 // main differences for quad lattice: delta and sf
193 const Real pitch = _sch_mesh.getPitch();
194 const Real delta = pitch; // centroid to centroid distance
195 constexpr Real sf = 1.0; // shape factor
196 return computeLatticeMixingParameter(i_gap, iz, delta, sf);
197}
SCMMixingKimAndChung::computeLatticeMixingParameter
Real computeLatticeMixingParameter(const unsigned int i_gap, const unsigned int iz, const Real delta, const Real sf) const
Common implementation for both tri and quad lattices.
Definition SCMMixingKimAndChung.C:61
SubChannelMesh::getPitch
virtual const Real & getPitch() const
Return the undeformed pitch between 2 subchannels.
Definition SubChannelMesh.h:142

Referenced by computeMixingParameter().

◆ computeSweepFlowMixingParameter()

Real SCMMixingClosureBase::computeSweepFlowMixingParameter ( const unsigned int  i_gap,
const unsigned int  iz 
) const
virtualinherited

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

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

Reimplemented in SCMMixingChengTodreas.

Definition at line 27 of file SCMMixingClosureBase.C.

29{
30 return 0.0;
31}

Referenced by SubChannel1PhaseProblem::computeSweepFlowMixingParameter().

◆ computeTriLatticeMixingParameter()

Real SCMMixingKimAndChung::computeTriLatticeMixingParameter ( const unsigned int  i_gap,
const unsigned int  iz 
) const
protected

Definition at line 178 of file SCMMixingKimAndChung.C.

180{
181 // main differences for tri lattice: delta and sf
182 const Real pitch = _sch_mesh.getPitch();
183 const Real delta = pitch / std::sqrt(3.0); // centroid to centroid distance
184 constexpr Real sf = 2.0 / 3.0; // shape factor
185 return computeLatticeMixingParameter(i_gap, iz, delta, sf);
186}

Referenced by computeMixingParameter().

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

Definition at line 19 of file SCMMixingKimAndChung.C.

20{
21 InputParameters params = SCMMixingClosureBase::validParams();
22 params.addClassDescription(
23 "Class that models the turbulent mixing coefficient using the Kim and Chung correlations.");
24 return params;
25}
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 SCMMixingKimAndChung::_is_tri_lattice
protected

Keep track of the lattice type.

Definition at line 41 of file SCMMixingKimAndChung.h.

Referenced by computeMixingParameter(), and SCMMixingKimAndChung().

◆ _mdot_soln

SolutionHandle SCMMixingKimAndChung::_mdot_soln
protected

Definition at line 46 of file SCMMixingKimAndChung.h.

Referenced by computeLatticeMixingParameter().

◆ _mu_soln

SolutionHandle SCMMixingKimAndChung::_mu_soln
protected

Definition at line 48 of file SCMMixingKimAndChung.h.

Referenced by computeLatticeMixingParameter().

◆ _P_soln

SolutionHandle SCMMixingKimAndChung::_P_soln
protected

Definition at line 49 of file SCMMixingKimAndChung.h.

Referenced by computeLatticeMixingParameter().

◆ _S_soln

SolutionHandle SCMMixingKimAndChung::_S_soln
protected

Definition at line 45 of file SCMMixingKimAndChung.h.

Referenced by computeLatticeMixingParameter().

◆ _sch_mesh

const SubChannelMesh& SCMMixingKimAndChung::_sch_mesh
protected

Pointer to the base subchannel mesh.

Definition at line 43 of file SCMMixingKimAndChung.h.

Referenced by computeLatticeMixingParameter(), computeQuadLatticeMixingParameter(), and computeTriLatticeMixingParameter().

◆ _scm_problem

const SubChannel1PhaseProblem& SCMClosureBase::_scm_problem
protectedinherited

Reference to the subchannel problem.

Definition at line 37 of file SCMClosureBase.h.

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

◆ _subchannel_mesh

const SubChannelMesh& SCMClosureBase::_subchannel_mesh
protectedinherited

Reference to the subchannel mesh.

Definition at line 35 of file SCMClosureBase.h.

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

◆ _T_soln

SolutionHandle SCMMixingKimAndChung::_T_soln
protected

Definition at line 50 of file SCMMixingKimAndChung.h.

Referenced by computeLatticeMixingParameter().

◆ _w_perim_soln

SolutionHandle SCMMixingKimAndChung::_w_perim_soln
protected

Definition at line 47 of file SCMMixingKimAndChung.h.

Referenced by computeLatticeMixingParameter().

The documentation for this class was generated from the following files:
Generated on Fri Aug 21 2026 13:43:48 for https://mooseframework.inl.gov by doxygen 1.9.8