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

#include <HexagonalGridPositions.h>

Inheritance diagram for HexagonalGridPositions:

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

SubProblem &	getSubProblem () const

bool	shouldDuplicateInitialExecution () const

virtual Real	spatialValue (const Point &) const

virtual const std::vector< Point >	spatialPoints () 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)

void	setPrimaryThreadCopy (UserObject *primary)

UserObject *	primaryThreadCopy ()

std::set< UserObjectName >	getDependObjects () const

virtual bool	needThreadedCopy () 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

MooseApp &	getMooseApp () const

const std::string &	type () const

virtual const std::string &	name () const

std::string	typeAndName () const

std::string	errorPrefix (const std::string &error_type) const

void	callMooseError (std::string msg, const bool with_prefix) const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

const InputParameters &	parameters () const

MooseObjectName	uniqueName () 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 &nm) const

void	paramError (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

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	mooseError (Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseInfo (Args &&... args) 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 UserObject &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const

const UserObject &	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)

std::pair< const MaterialProperty< T > *, std::set< SubdomainID > >	getBlockMaterialProperty (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)

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	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

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	sort (typename std::vector< T > &vector)

static void	sortDFS (typename std::vector< T > &vector)

static void	cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)

Public Attributes
const ConsoleStream	_console

Static Public Attributes
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 UserObject &uo) const override

void	addReporterDependencyHelper (const ReporterName &reporter_name) override

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)

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. More...

const Real	_lattice_flat_to_flat
	Distance from one side to the one facing it of the lattice. More...

const Real	_pin_pitch
	Pitch between fuel pins. More...

const MooseEnum	_z_axis_index
	Axial component for the Z axis. More...

const unsigned int	_nr
	Number of rings in the radial direction. More...

std::vector< std::vector< unsigned int > >	_pattern
	2D pattern of the pins to select (if specified) More...

std::set< unsigned int >	_include_in_pattern
	List of the pattern locations to include. Include all if empty. More...

std::vector< std::vector< int > >	_positions_pattern
	List of positions objects, the positions of which are translated in the parent hexagonal pattern. More...

std::map< std::string, unsigned int >	_positions_pattern_indexing
	Indexing of the positions objects in the pattern. More...

std::unique_ptr< HexagonalLatticeUtils >	_hex_latt
	Hexagonal lattice utility object. More...

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

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

const THREAD_ID	_tid

Assembly &	_assembly

const Moose::CoordinateSystemType &	_coord_sys

const bool	_duplicate_initial_execution

std::set< std::string >	_depend_uo

const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

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 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

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 60 of file HexagonalGridPositions.C.

   : Positions(parameters),
     _center(getParam<Point>("center")),
     _lattice_flat_to_flat(getParam<Real>("lattice_flat_to_flat")),
     _pin_pitch(getParam<Real>("pin_pitch")),
     _z_axis_index(MooseEnum("X Y Z", "Z")),
     _nr(getParam<unsigned int>("nr")),
     _pattern(getParam<std::vector<std::vector<unsigned int>>>("pattern")),
     _include_in_pattern(
         std::set<unsigned int>(getParam<std::vector<unsigned int>>("include_in_pattern").begin(),
                                getParam<std::vector<unsigned int>>("include_in_pattern").end())),
     _positions_pattern(getParam<std::vector<std::vector<int>>>("positions_pattern")),
     _positions_pattern_indexing(
         getParam<std::map<std::string, unsigned int>>("positions_pattern_indexing"))
 {
   // Check dimensions
   if (_nr == 1)
   {
     if (MooseUtils::absoluteFuzzyGreaterThan(_pin_pitch, _lattice_flat_to_flat))
       paramError("lattice_flat_to_flat",
                  "For one ring, the lattice flat to flat must be at least the pin pitch");
   }
   else
   {
     if (MooseUtils::absoluteFuzzyGreaterThan((3 * _nr - 1) * _pin_pitch / sqrt(3),
                                              _lattice_flat_to_flat))
       paramError("lattice_flat_to_flat",
                  "Lattice flat to flat distance is less than the minimum (3 * nr - 1) * pin_pitch "
                  "/ sqrt(3) given nr rings with a pitch of pin_pitch");
   }
 
   // Check pattern and include_in_pattern
   if ((_include_in_pattern.empty() && _pattern.size()) ||
       (_include_in_pattern.size() && _pattern.empty()))
     paramError(
         "include_in_pattern",
         "The 'pattern' parameter and the 'include_in_pattern' must be both specified or both not "
         "specified by the user.");
   for (const auto include : _include_in_pattern)
   {
     bool found = false;
     for (const auto & row : _pattern)
       if (std::find(row.begin(), row.end(), include) != row.end())
         found = true;
     if (!found)
       paramError("include_in_pattern",
                  "Pattern item '" + std::to_string(include) +
                      "' to include is not present in the pattern");
   }
 
   // Check positions_pattern and positions_pattern_indexing
   if ((_positions_pattern.empty() && !_positions_pattern_indexing.empty()) ||
       (!_positions_pattern.empty() && _positions_pattern_indexing.empty()))
     paramError("positions_pattern_indexing",
                "The 'positions_pattern' parameter and the 'positions_pattern_indexing' must be "
                "both specified or both not specified by the user.");
   for (const auto & [pos_name, index] : _positions_pattern_indexing)
   {
     bool found = false;
     for (const auto & row : _positions_pattern)
       if (std::find(row.begin(), row.end(), index) != row.end())
         found = true;
     if (!found)
       paramError("include_in_pattern",
                  "Pattern item '" + pos_name + "' with index '" + std::to_string(index) +
                      "' to include is not present in the pattern");
   }
 
   // Check incompatible parameters
   if (((_positions_pattern.size() && _positions_pattern[0].size()) ||
        _positions_pattern_indexing.size()) &&
       ((_pattern.size() && _pattern[0].size()) || _include_in_pattern.size()))
     paramError("positions_pattern",
                "'pattern'/'include_in_pattern' are not supported in combination with "
                "'positions_pattern/positions_pattern_indexing'. Only one pattern is supported");
 
   // Obtain the positions by unrolling the patterns
   initialize();
   // Sort if needed (user-specified)
   finalize();
 }

Member Function Documentation

◆ initialize()

void HexagonalGridPositions::initialize ( )

overridevirtual

Implements Positions.

Definition at line 143 of file HexagonalGridPositions.C.

Referenced by HexagonalGridPositions().

 {
   clearPositions();
 
   // We make very large pins so they cover the entire position
   _hex_latt = std::make_unique<HexagonalLatticeUtils>(
       _lattice_flat_to_flat, _pin_pitch, _pin_pitch, 0., 1., _nr, _z_axis_index);
 
   if (!isParamSetByUser("positions_pattern"))
   {
     // Unroll pattern
     std::vector<int> pattern_unrolled;
 
     if (_pattern.size())
     {
       // Check number of pins in pattern
       std::size_t pattern_size = 0;
       for (const auto & row : _pattern)
         pattern_size += row.size();
       if (_pattern.size() != cast_int<std::size_t>(2 * _nr - 1))
         mooseError("Number of rows in pattern (",
                    _pattern.size(),
                    ") should be equal to twice the number of hexagonal rings minus one");
       if (pattern_size != _hex_latt->totalPins(_nr))
         mooseError("Pattern size (",
                    pattern_size,
                    ") does not match the number of pins with ",
                    _nr,
                    " rings: ",
                    _hex_latt->totalPins(_nr));
 
       pattern_unrolled.resize(_hex_latt->totalPins(_nr));
       unsigned int i = 0;
       for (const auto r_i : make_range(_nr))
         for (const auto a_i : make_range(_hex_latt->pins(r_i + 1)))
         {
           libmesh_ignore(a_i);
           unsigned int row_i, within_row_i;
           _hex_latt->get2DInputPatternIndex(i, row_i, within_row_i);
           pattern_unrolled[i++] = _pattern[row_i][within_row_i];
         }
     }
     // just needs to be the right size
     else
       pattern_unrolled.resize(_hex_latt->totalPins(_nr), 0);
 
     // Count the number of positions we do not need to include
     unsigned int n_exclusions = 0;
     if (_include_in_pattern.size())
       for (const auto patt : pattern_unrolled)
         if (_include_in_pattern.count(patt) == 0)
           n_exclusions++;
 
     // Size array, remove the '-1' / not included positions
     const auto n_positions = cast_int<std::size_t>(_hex_latt->totalPins(_nr) - n_exclusions);
     _positions.resize(n_positions);
 
     // Fill the positions by retrieving the pin centers at indices included in the pattern (if
     // specified)
     unsigned int pos_i = 0;
     for (const auto patt_i : index_range(pattern_unrolled))
       if (!_pattern.size() || !_include_in_pattern.size() ||
           _include_in_pattern.count(pattern_unrolled[patt_i]))
         _positions[pos_i++] = _hex_latt->pinCenters()[patt_i];
   }
   else
   {
     // Unroll pattern into positions array
     const bool initial = _fe_problem.getCurrentExecuteOnFlag() == EXEC_INITIAL;
 
     // Check number of positions in pattern of nested positions
     unsigned pattern_size = 0;
     for (const auto & row : _positions_pattern)
       pattern_size += row.size();
     if (_positions_pattern.size() != cast_int<std::size_t>(2 * _nr - 1))
       mooseError("Number of rows in 'positions_pattern' (",
                  _pattern.size(),
                  ") should be equal to twice the number of hexagonal rings minus one");
     if (pattern_size != _hex_latt->totalPins(_nr))
       mooseError("Pattern size ",
                  pattern_size,
                  " does not match the number of pins with ",
                  _nr,
                  " rings: ",
                  _hex_latt->totalPins(_nr));
 
     // Check that all the positions names are valid
     unsigned num_pos = 0;
     for (const auto & [pos_name, index] : _positions_pattern_indexing)
       if (_fe_problem.hasUserObject(pos_name))
         num_pos += _fe_problem.getPositionsObject(pos_name).getNumPositions(initial);
     _positions.reserve(num_pos);
 
     // Invert map from positions to indices
     std::map<unsigned int, PositionsName> index_to_pos;
     for (const auto & [pos_name, index] : _positions_pattern_indexing)
       index_to_pos[index] = pos_name;
 
     // Unroll pattern : the positions vector is 1D and should be
     std::vector<PositionsName> pattern_unrolled;
     pattern_unrolled.resize(_hex_latt->totalPins(_nr));
     unsigned int i = 0;
     for (const auto r_i : make_range(_nr))
       for (const auto a_i : make_range(_hex_latt->pins(r_i + 1)))
       {
         libmesh_ignore(a_i);
         unsigned int row_i, within_row_i;
         _hex_latt->get2DInputPatternIndex(i, row_i, within_row_i);
         const auto pos_index = _positions_pattern[row_i][within_row_i];
         if (auto it = index_to_pos.find(cast_int<unsigned int>(pos_index));
             it != index_to_pos.end())
           pattern_unrolled[i++] = it->second;
         else if (pos_index != -1)
           paramError("positions_pattern",
                      "Index '" + std::to_string(pos_index) +
                          "' in pattern is not found in 'positions_pattern_indexing'");
         else
           pattern_unrolled[i++] = "-1";
       }
 
     // Now place the positions in the _positions array with the offset from the parent lattice index
     for (const auto patt_i : index_range(pattern_unrolled))
     {
       const auto & pos_name = pattern_unrolled[patt_i];
       if (pos_name != "-1")
         for (const auto & pos : _fe_problem.getPositionsObject(pos_name).getPositions(initial))
           _positions.push_back(_hex_latt->pinCenters()[patt_i] + pos);
     }
   }
 
   _initialized = true;
 }

◆ validParams()

InputParameters HexagonalGridPositions::validParams ( )

static

Definition at line 16 of file HexagonalGridPositions.C.

 {
   InputParameters params = Positions::validParams();
   params.addClassDescription(
       "Create positions along a hexagonal grid. Numbering of positions increases first "
       "counterclockwise, then expanding outwards from the inner ring. "
       "Inner-numbering is within a radial ring.");
 
   params.addRequiredParam<Point>("center", "Center of the hexagonal grid");
   params.addRequiredRangeCheckedParam<Real>(
       "lattice_flat_to_flat",
       "lattice_flat_to_flat>0",
       "Distance between two (inner) opposite sides of a lattice. Also known as bundle pitch or "
       "inner flat-to-flat distance");
   params.addRequiredRangeCheckedParam<Real>("pin_pitch", "pin_pitch>0", "Distance between pins");
   params.addRequiredRangeCheckedParam<unsigned int>("nr", "nr>0", "Number of hexagonal rings");
   params.addRangeCheckedParam<std::vector<std::vector<unsigned int>>>(
       "pattern",
       {},
       "pattern>=0",
       "A double-indexed hexagonal-shaped array starting with the upper-left corner. '-1's are not "
       "selected as positions.");
   params.addParam<std::vector<unsigned int>>(
       "include_in_pattern", {}, "A vector of the numbers in the pattern to include");
   params.addParam<std::vector<std::vector<int>>>(
       "positions_pattern",
       {},
       "A double-indexed hexagonal-shaped array with the index of other Positions objects starting "
       "with the upper-left corner. These positions objects will be distributed within the "
       "hexagonal grid. The indexing is given in 'positions_pattern_indexing'. Use '-1' to discard "
       "a position in the lattice.");
   params.addParam<std::map<std::string, unsigned int>>(
       "positions_pattern_indexing",
       {},
       "A map from the name of positions objects to their index in the 'positions_pattern'");
 
   // Use user-provided ordering
   params.set<bool>("auto_sort") = false;
   // All functors defined on all processes for now
   params.set<bool>("auto_broadcast") = false;
 
   return params;
 }

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:

reactor/include/positions/HexagonalGridPositions.h
reactor/src/positions/HexagonalGridPositions.C

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

Detailed Description

Constructor & Destructor Documentation

◆ HexagonalGridPositions()

Member Function Documentation

◆ initialize()

◆ validParams()

Member Data Documentation

◆ _center

◆ _hex_latt

◆ _include_in_pattern

◆ _lattice_flat_to_flat

◆ _nr

◆ _pattern

◆ _pin_pitch

◆ _positions_pattern

◆ _positions_pattern_indexing

◆ _z_axis_index