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

Creates positions (points) following an hexagonal grid. More...

#include <HexagonalGridPositions.h>

Inheritance diagram for HexagonalGridPositions:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 HexagonalGridPositions (const InputParameters &parameters)
 
void initialize () override
 
const std::vector< Point > & getPositions (bool initial) const
 
const std::vector< std::vector< Point > > & getPositionsVector2D () const
 
const std::vector< std::vector< std::vector< Point > > > & getPositionsVector3D () const
 
const std::vector< std::vector< std::vector< std::vector< Point > > > > & getPositionsVector4D () const
 
unsigned int getNumPositions (bool initial=false) const
 
const Point & getPosition (unsigned int index, bool initial) const
 
const Point & getNearestPosition (const Point &target, bool initial) const
 
unsigned int getNearestPositionIndex (const Point &target, bool initial) const
 
Real getMinDistanceBetweenPositions () const
 
bool arePositionsCoplanar () const
 
bool initialized (bool initial) const
 
void threadJoin (const UserObject &) final
 
bool shouldStore () 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 needThreadedCopy () 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 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
 
virtual void store (nlohmann::json &json) const
 
virtual void declareLateValues ()
 
void buildOutputHideVariableList (std::set< std::string > variable_names)
 
const std::set< OutputName > & getOutputs ()
 
virtual void subdomainSetup () override
 
virtual void subdomainSetup () override
 
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 meshDisplaced ()
 
PerfGraph & perfGraph ()
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
const Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 

Static Public Member Functions

static InputParameters validParams ()
 
static void callMooseError (MooseApp *const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node *node, const bool show_trace=true)
 
static void sort (typename std::vector< T > &vector)
 
static void sortDFS (typename std::vector< T > &vector)
 
static void cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header, NameFunc &&name_func)
 
static void cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)
 

Public Attributes

 usingCombinedWarningSolutionWarnings
 
const ConsoleStream _console
 

Static Public Attributes

static const std::string type_param
 
static const std::string name_param
 
static const std::string unique_name_param
 
static const std::string app_param
 
static const std::string moose_base_param
 
static const std::string kokkos_object_param
 
static constexpr PropertyValue::id_type default_property_id
 
static constexpr PropertyValue::id_type zero_property_id
 
static constexpr auto SYSTEM
 
static constexpr auto NAME
 

Protected Member Functions

virtual void execute () override
 
virtual void finalize () override
 
virtual void meshChanged () override
 
virtual void timestepSetup () override
 
virtual void residualSetup () override
 
virtual void jacobianSetup () override
 
void clearPositions ()
 
void unrollMultiDPositions ()
 
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 ()
 
T & declareUnusedValue (Args &&... args)
 
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)
 
T & declareValue (const std::string &param_name, Args &&... args)
 
T & declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)
 
T & declareValue (const std::string &param_name, Args &&... args)
 
T & declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)
 
T & declareValue (const std::string &param_name, Args &&... args)
 
T & declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)
 
T & declareValue (const std::string &param_name, Args &&... args)
 
T & declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)
 

Static Protected Member Functions

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

Protected Attributes

const Point _center
 Center of the lattice.
 
const Real _lattice_flat_to_flat
 Distance from one side to the one facing it of the lattice.
 
const Real _pin_pitch
 Pitch between fuel pins.
 
const MooseEnum _z_axis_index
 Axial component for the Z axis.
 
const unsigned int _nr
 Number of rings in the radial direction.
 
std::vector< std::vector< unsigned int > > _pattern
 2D pattern of the pins to select (if specified)
 
std::set< unsigned int > _include_in_pattern
 List of the pattern locations to include. Include all if empty.
 
std::vector< std::vector< int > > _positions_pattern
 List of positions objects, the positions of which are translated in the parent hexagonal pattern.
 
std::map< std::string, unsigned int > _positions_pattern_indexing
 Indexing of the positions objects in the pattern.
 
std::unique_ptr< HexagonalLatticeUtils > _hex_latt
 Hexagonal lattice utility object.
 
const std::vector< Point > *const _initial_positions
 
std::vector< Point > & _positions
 
std::vector< std::vector< Point > > _positions_2d
 
std::vector< std::vector< std::vector< Point > > > _positions_3d
 
std::vector< std::vector< std::vector< std::vector< Point > > > > _positions_4d
 
std::unique_ptr< KDTree > _initial_positions_kd_tree
 
std::unique_ptr< KDTree > _positions_kd_tree
 
bool _need_broadcast
 
const bool _need_sort
 
bool _initialized
 
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 ReporterValueName & getReporterValueName (const std::string &param_name) const
 
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

const bool _always_store
 
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
 
const MooseObject & _reporter_moose_object
 
const InputParameters & _reporter_params
 
const std::string & _reporter_name
 
FEProblemBase & _reporter_fe_problem
 
ReporterData & _reporter_data
 
std::vector< std::unique_ptr< UnusedWrapperBase > > _unused_values
 
MooseApp & _oi_moose_app
 
OutputWarehouse & _oi_output_warehouse
 
std::set< OutputName > _oi_outputs
 

Detailed Description

Creates positions (points) following an hexagonal grid.

Definition at line 19 of file HexagonalGridPositions.h.

Constructor & Destructor Documentation

◆ HexagonalGridPositions()

HexagonalGridPositions::HexagonalGridPositions ( const InputParameters &  parameters)

Definition at line 64 of file HexagonalGridPositions.C.

65 : Positions(parameters),
66 _center(getParam<Point>("center")),
67 _lattice_flat_to_flat(getParam<Real>("lattice_flat_to_flat")),
68 _pin_pitch(getParam<Real>("pin_pitch")),
69 _z_axis_index(MooseEnum("X Y Z", "Z")),
70 _nr(getParam<unsigned int>("nr")),
71 _pattern(getParam<std::vector<std::vector<unsigned int>>>("pattern")),
72 _include_in_pattern(
73 std::set<unsigned int>(getParam<std::vector<unsigned int>>("include_in_pattern").begin(),
74 getParam<std::vector<unsigned int>>("include_in_pattern").end())),
75 _positions_pattern(getParam<std::vector<std::vector<int>>>("positions_pattern")),
76 _positions_pattern_indexing(
77 getParam<std::map<std::string, unsigned int>>("positions_pattern_indexing"))
78{
79 // Check dimensions
80 if (_nr == 1)
81 {
82 if (MooseUtils::absoluteFuzzyGreaterThan(_pin_pitch, _lattice_flat_to_flat))
83 paramError("lattice_flat_to_flat",
84 "For one ring, the lattice flat to flat must be at least the pin pitch");
85 }
86 else
87 {
88 if (MooseUtils::absoluteFuzzyGreaterThan((3 * _nr - 1) * _pin_pitch / sqrt(3),
89 _lattice_flat_to_flat))
90 paramError("lattice_flat_to_flat",
91 "Lattice flat to flat distance is less than the minimum (3 * nr - 1) * pin_pitch "
92 "/ sqrt(3) given nr rings with a pitch of pin_pitch");
93 }
94
95 // Check pattern and include_in_pattern
96 if ((_include_in_pattern.empty() && _pattern.size()) ||
97 (_include_in_pattern.size() && _pattern.empty()))
98 paramError(
99 "include_in_pattern",
100 "The 'pattern' parameter and the 'include_in_pattern' must be both specified or both not "
101 "specified by the user.");
102 for (const auto include : _include_in_pattern)
103 {
104 bool found = false;
105 for (const auto & row : _pattern)
106 if (std::find(row.begin(), row.end(), include) != row.end())
107 found = true;
108 if (!found)
109 paramError("include_in_pattern",
110 "Pattern item '" + std::to_string(include) +
111 "' to include is not present in the pattern");
112 }
113
114 // Check positions_pattern and positions_pattern_indexing
115 if ((_positions_pattern.empty() && !_positions_pattern_indexing.empty()) ||
116 (!_positions_pattern.empty() && _positions_pattern_indexing.empty()))
117 paramError("positions_pattern_indexing",
118 "The 'positions_pattern' parameter and the 'positions_pattern_indexing' must be "
119 "both specified or both not specified by the user.");
120 for (const auto & [pos_name, index] : _positions_pattern_indexing)
121 {
122 bool found = false;
123 for (const auto & row : _positions_pattern)
124 if (std::find(row.begin(), row.end(), index) != row.end())
125 found = true;
126 if (!found)
127 paramError("include_in_pattern",
128 "Pattern item '" + pos_name + "' with index '" + std::to_string(index) +
129 "' to include is not present in the pattern");
130 }
131
132 // Check incompatible parameters
133 if (((_positions_pattern.size() && _positions_pattern[0].size()) ||
134 _positions_pattern_indexing.size()) &&
135 ((_pattern.size() && _pattern[0].size()) || _include_in_pattern.size()))
136 paramError("positions_pattern",
137 "'pattern'/'include_in_pattern' are not supported in combination with "
138 "'positions_pattern/positions_pattern_indexing'. Only one pattern is supported");
139
140 // Obtain the positions by unrolling the patterns
141 initialize();
142 // Sort if needed (user-specified)
143 finalize();
144}
HexagonalGridPositions::_z_axis_index
const MooseEnum _z_axis_index
Axial component for the Z axis.
Definition HexagonalGridPositions.h:39
HexagonalGridPositions::_positions_pattern_indexing
std::map< std::string, unsigned int > _positions_pattern_indexing
Indexing of the positions objects in the pattern.
Definition HexagonalGridPositions.h:54
HexagonalGridPositions::_positions_pattern
std::vector< std::vector< int > > _positions_pattern
List of positions objects, the positions of which are translated in the parent hexagonal pattern.
Definition HexagonalGridPositions.h:51
HexagonalGridPositions::_nr
const unsigned int _nr
Number of rings in the radial direction.
Definition HexagonalGridPositions.h:42
HexagonalGridPositions::_lattice_flat_to_flat
const Real _lattice_flat_to_flat
Distance from one side to the one facing it of the lattice.
Definition HexagonalGridPositions.h:34
HexagonalGridPositions::_center
const Point _center
Center of the lattice.
Definition HexagonalGridPositions.h:30
HexagonalGridPositions::_include_in_pattern
std::set< unsigned int > _include_in_pattern
List of the pattern locations to include. Include all if empty.
Definition HexagonalGridPositions.h:48
HexagonalGridPositions::_pin_pitch
const Real _pin_pitch
Pitch between fuel pins.
Definition HexagonalGridPositions.h:36
HexagonalGridPositions::_pattern
std::vector< std::vector< unsigned int > > _pattern
2D pattern of the pins to select (if specified)
Definition HexagonalGridPositions.h:45
Positions::parameters
const InputParameters & parameters() const
Positions::paramError
void paramError(const std::string &param, Args... args) const
Positions::getParam
const T & getParam(const std::string &name) const
Positions::finalize
virtual void finalize() override
CompileTimeDerivatives::sqrt
CTSub CT_OPERATOR_BINARY CTMul CTCompareLess CTCompareGreater CTCompareEqual _arg template * sqrt(_arg)) *_arg.template D< dtag >()) CT_SIMPLE_UNARY_FUNCTION(tanh
Moose::Kokkos::Utils::find
KOKKOS_INLINE_FUNCTION const T * find(const T &target, const T *const begin, const T *const end)
libMesh::if
if(subdm)

Member Function Documentation

◆ initialize()

void HexagonalGridPositions::initialize ( )
overridevirtual

Implements Positions.

Definition at line 147 of file HexagonalGridPositions.C.

148{
149 clearPositions();
150
151 // We make very large pins so they cover the entire position
152 _hex_latt = std::make_unique<HexagonalLatticeUtils>(_lattice_flat_to_flat,
153 _pin_pitch,
154 _pin_pitch,
155 0.,
156 1.,
157 _nr,
158 _z_axis_index,
159 getParam<Real>("rotation_around_axis"));
160
161 if (!isParamSetByUser("positions_pattern"))
162 {
163 // Unroll pattern
164 std::vector<int> pattern_unrolled;
165
166 if (_pattern.size())
167 {
168 // Check number of pins in pattern
169 std::size_t pattern_size = 0;
170 for (const auto & row : _pattern)
171 pattern_size += row.size();
172 if (_pattern.size() != cast_int<std::size_t>(2 * _nr - 1))
173 mooseError("Number of rows in pattern (",
174 _pattern.size(),
175 ") should be equal to twice the number of hexagonal rings minus one");
176 if (pattern_size != _hex_latt->totalPins(_nr))
177 mooseError("Pattern size (",
178 pattern_size,
179 ") does not match the number of pins with ",
180 _nr,
181 " rings: ",
182 _hex_latt->totalPins(_nr));
183
184 pattern_unrolled.resize(_hex_latt->totalPins(_nr));
185 unsigned int i = 0;
186 for (const auto r_i : make_range(_nr))
187 for (const auto a_i : make_range(_hex_latt->pins(r_i + 1)))
188 {
189 libmesh_ignore(a_i);
190 unsigned int row_i, within_row_i;
191 _hex_latt->get2DInputPatternIndex(i, row_i, within_row_i);
192 pattern_unrolled[i++] = _pattern[row_i][within_row_i];
193 }
194 }
195 // just needs to be the right size
196 else
197 pattern_unrolled.resize(_hex_latt->totalPins(_nr), 0);
198
199 // Count the number of positions we do not need to include
200 unsigned int n_exclusions = 0;
201 if (_include_in_pattern.size())
202 for (const auto patt : pattern_unrolled)
203 if (_include_in_pattern.count(patt) == 0)
204 n_exclusions++;
205
206 // Size array, remove the '-1' / not included positions
207 const auto n_positions = cast_int<std::size_t>(_hex_latt->totalPins(_nr) - n_exclusions);
208 _positions.resize(n_positions);
209
210 // Fill the positions by retrieving the pin centers at indices included in the pattern (if
211 // specified)
212 unsigned int pos_i = 0;
213 for (const auto patt_i : index_range(pattern_unrolled))
214 if (!_pattern.size() || !_include_in_pattern.size() ||
215 _include_in_pattern.count(pattern_unrolled[patt_i]))
216 _positions[pos_i++] = _hex_latt->pinCenters()[patt_i];
217 }
218 else
219 {
220 // Unroll pattern into positions array
221 const bool initial = _fe_problem.getCurrentExecuteOnFlag() == EXEC_INITIAL;
222
223 // Check number of positions in pattern of nested positions
224 unsigned pattern_size = 0;
225 for (const auto & row : _positions_pattern)
226 pattern_size += row.size();
227 if (_positions_pattern.size() != cast_int<std::size_t>(2 * _nr - 1))
228 mooseError("Number of rows in 'positions_pattern' (",
229 _pattern.size(),
230 ") should be equal to twice the number of hexagonal rings minus one");
231 if (pattern_size != _hex_latt->totalPins(_nr))
232 mooseError("Pattern size ",
233 pattern_size,
234 " does not match the number of pins with ",
235 _nr,
236 " rings: ",
237 _hex_latt->totalPins(_nr));
238
239 // Check that all the positions names are valid
240 unsigned num_pos = 0;
241 for (const auto & [pos_name, index] : _positions_pattern_indexing)
242 if (_fe_problem.hasUserObject(pos_name))
243 num_pos += _fe_problem.getPositionsObject(pos_name).getNumPositions(initial);
244 _positions.reserve(num_pos);
245
246 // Invert map from positions to indices
247 std::map<unsigned int, PositionsName> index_to_pos;
248 for (const auto & [pos_name, index] : _positions_pattern_indexing)
249 index_to_pos[index] = pos_name;
250
251 // Unroll pattern : the positions vector is 1D and should be
252 std::vector<PositionsName> pattern_unrolled;
253 pattern_unrolled.resize(_hex_latt->totalPins(_nr));
254 unsigned int i = 0;
255 for (const auto r_i : make_range(_nr))
256 for (const auto a_i : make_range(_hex_latt->pins(r_i + 1)))
257 {
258 libmesh_ignore(a_i);
259 unsigned int row_i, within_row_i;
260 _hex_latt->get2DInputPatternIndex(i, row_i, within_row_i);
261 const auto pos_index = _positions_pattern[row_i][within_row_i];
262 if (auto it = index_to_pos.find(cast_int<unsigned int>(pos_index));
263 it != index_to_pos.end())
264 pattern_unrolled[i++] = it->second;
265 else if (pos_index != -1)
266 paramError("positions_pattern",
267 "Index '" + std::to_string(pos_index) +
268 "' in pattern is not found in 'positions_pattern_indexing'");
269 else
270 pattern_unrolled[i++] = "-1";
271 }
272
273 // Now place the positions in the _positions array with the offset from the parent lattice index
274 for (const auto patt_i : index_range(pattern_unrolled))
275 {
276 const auto & pos_name = pattern_unrolled[patt_i];
277 if (pos_name != "-1")
278 for (const auto & pos : _fe_problem.getPositionsObject(pos_name).getPositions(initial))
279 _positions.push_back(_hex_latt->pinCenters()[patt_i] + pos);
280 }
281 }
282
283 _initialized = true;
284}
EXEC_INITIAL
const ExecFlagType EXEC_INITIAL
count
unsigned int count
for
for(PetscInt i=0;i< nvars;++i)
FEProblemBase::getCurrentExecuteOnFlag
const ExecFlagType & getCurrentExecuteOnFlag() const
HexagonalGridPositions::_hex_latt
std::unique_ptr< HexagonalLatticeUtils > _hex_latt
Hexagonal lattice utility object.
Definition HexagonalGridPositions.h:57
Positions::isParamSetByUser
bool isParamSetByUser(const std::string &name) const
Positions::mooseError
void mooseError(Args &&... args) const
Positions::getNumPositions
unsigned int getNumPositions(bool initial=false) const
Positions::clearPositions
void clearPositions()
Positions::_positions
std::vector< Point > & _positions
Positions::getPositions
const std::vector< Point > & getPositions(bool initial) const
Positions::_initialized
bool _initialized
Positions::_fe_problem
FEProblemBase & _fe_problem
Positions::hasUserObject
bool hasUserObject(const std::string &param_name) const
libMesh::index_range
auto index_range(const T &sizable)
libMesh::libmesh_ignore
void libmesh_ignore(const Args &...)
libMesh::make_range
IntRange< T > make_range(T beg, T end)

Referenced by HexagonalGridPositions().

◆ validParams()

InputParameters HexagonalGridPositions::validParams ( )
static

Definition at line 16 of file HexagonalGridPositions.C.

17{
18 InputParameters params = Positions::validParams();
19 params.addClassDescription(
20 "Create positions along a hexagonal grid. Numbering of positions increases first "
21 "counterclockwise, then expanding outwards from the inner ring. "
22 "Inner-numbering is within a radial ring.");
23
24 params.addRequiredParam<Point>("center", "Center of the hexagonal grid");
25 params.addRequiredRangeCheckedParam<Real>(
26 "lattice_flat_to_flat",
27 "lattice_flat_to_flat>0",
28 "Distance between two (inner) opposite sides of a lattice. Also known as bundle pitch or "
29 "inner flat-to-flat distance");
30 params.addRequiredRangeCheckedParam<Real>("pin_pitch", "pin_pitch>0", "Distance between pins");
31 params.addRequiredRangeCheckedParam<unsigned int>("nr", "nr>0", "Number of hexagonal rings");
32 params.addParam<Real>("rotation_around_axis",
33 0.,
34 "Rotation angle to apply to the underlying hexagonal lattice (in degrees)");
35
36 params.addRangeCheckedParam<std::vector<std::vector<unsigned int>>>(
37 "pattern",
38 {},
39 "pattern>=0",
40 "A double-indexed hexagonal-shaped array starting with the upper-left corner. '-1's are not "
41 "selected as positions.");
42 params.addParam<std::vector<unsigned int>>(
43 "include_in_pattern", {}, "A vector of the numbers in the pattern to include");
44 params.addParam<std::vector<std::vector<int>>>(
45 "positions_pattern",
46 {},
47 "A double-indexed hexagonal-shaped array with the index of other Positions objects starting "
48 "with the upper-left corner. These positions objects will be distributed within the "
49 "hexagonal grid. The indexing is given in 'positions_pattern_indexing'. Use '-1' to discard "
50 "a position in the lattice.");
51 params.addParam<std::map<std::string, unsigned int>>(
52 "positions_pattern_indexing",
53 {},
54 "A map from the name of positions objects to their index in the 'positions_pattern'");
55
56 // Use user-provided ordering
57 params.set<bool>("auto_sort") = false;
58 // All functors defined on all processes for now
59 params.set<bool>("auto_broadcast") = false;
60
61 return params;
62}
InputParameters::addRequiredRangeCheckedParam
void addRequiredRangeCheckedParam(const std::string &name, const std::string &parsed_function, const std::string &doc_string)
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
InputParameters::addRangeCheckedParam
void addRangeCheckedParam(const std::string &name, const T &value, const std::string &parsed_function, const std::string &doc_string)
Positions::validParams
static InputParameters validParams()
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

Member Data Documentation

◆ _center

const Point HexagonalGridPositions::_center
protected

Center of the lattice.

Definition at line 30 of file HexagonalGridPositions.h.

◆ _hex_latt

std::unique_ptr<HexagonalLatticeUtils> HexagonalGridPositions::_hex_latt
protected

Hexagonal lattice utility object.

Definition at line 57 of file HexagonalGridPositions.h.

Referenced by initialize().

◆ _include_in_pattern

std::set<unsigned int> HexagonalGridPositions::_include_in_pattern
protected

List of the pattern locations to include. Include all if empty.

Definition at line 48 of file HexagonalGridPositions.h.

Referenced by HexagonalGridPositions(), and initialize().

◆ _lattice_flat_to_flat

const Real HexagonalGridPositions::_lattice_flat_to_flat
protected

Distance from one side to the one facing it of the lattice.

Definition at line 34 of file HexagonalGridPositions.h.

Referenced by HexagonalGridPositions(), and initialize().

◆ _nr

const unsigned int HexagonalGridPositions::_nr
protected

Number of rings in the radial direction.

Definition at line 42 of file HexagonalGridPositions.h.

Referenced by HexagonalGridPositions(), and initialize().

◆ _pattern

std::vector<std::vector<unsigned int> > HexagonalGridPositions::_pattern
protected

2D pattern of the pins to select (if specified)

Definition at line 45 of file HexagonalGridPositions.h.

Referenced by HexagonalGridPositions(), and initialize().

◆ _pin_pitch

const Real HexagonalGridPositions::_pin_pitch
protected

Pitch between fuel pins.

Definition at line 36 of file HexagonalGridPositions.h.

Referenced by HexagonalGridPositions(), and initialize().

◆ _positions_pattern

std::vector<std::vector<int> > HexagonalGridPositions::_positions_pattern
protected

List of positions objects, the positions of which are translated in the parent hexagonal pattern.

Definition at line 51 of file HexagonalGridPositions.h.

Referenced by HexagonalGridPositions(), and initialize().

◆ _positions_pattern_indexing

std::map<std::string, unsigned int> HexagonalGridPositions::_positions_pattern_indexing
protected

Indexing of the positions objects in the pattern.

Definition at line 54 of file HexagonalGridPositions.h.

Referenced by HexagonalGridPositions(), and initialize().

◆ _z_axis_index

const MooseEnum HexagonalGridPositions::_z_axis_index
protected

Axial component for the Z axis.

Definition at line 39 of file HexagonalGridPositions.h.

Referenced by initialize().

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