Mesh generator for defining a reactor control drum that can be used in a Cartesian or hexagonal lattice with the option to be 2-D or 3-D. More...

#include <ControlDrumMeshGenerator.h>

Inheritance diagram for ControlDrumMeshGenerator:

[legend]

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	ControlDrumMeshGenerator (const InputParameters &parameters)

std::unique_ptr< MeshBase >	generate () override

void	generateData () override

std::unique_ptr< CSG::CSGBase >	generateInternalCSG ()

std::unique_ptr< MeshBase >	generateInternal ()

const std::set< MeshGeneratorName > &	getRequestedMeshGenerators () const

const std::set< MeshGeneratorName > &	getRequestedMeshGeneratorsForSub () const

void	addParentMeshGenerator (const MeshGenerator &mg, const AddParentChildKey)

void	addChildMeshGenerator (const MeshGenerator &mg, const AddParentChildKey)

const std::set< const MeshGenerator *, Comparator > &	getParentMeshGenerators () const

const std::set< const MeshGenerator *, Comparator > &	getChildMeshGenerators () const

const std::set< const MeshGenerator *, Comparator > &	getSubMeshGenerators () const

bool	isParentMeshGenerator (const MeshGeneratorName &name, const bool direct=true) const

bool	isChildMeshGenerator (const MeshGeneratorName &name, const bool direct=true) const

bool	isNullMeshName (const MeshGeneratorName &name) const

bool	hasSaveMesh () const

bool	hasOutput () const

const std::string &	getSavedMeshName () const

bool	hasGenerateData () const

bool	hasGenerateCSG () const

bool	isDataOnly () 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	haveParameter (const std::string &name) 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

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	addDepletionIDParams (InputParameters &parameters)

static bool	hasGenerateData (const InputParameters &params)

static bool	hasGenerateCSG (const InputParameters &params)

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	setHasGenerateData (InputParameters &params)

static void	setHasGenerateCSG (InputParameters &params)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	data_only_param

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

static constexpr auto	NAME

Protected Types
enum	DepletionIDGenerationLevel { DepletionIDGenerationLevel::Pin, DepletionIDGenerationLevel::Assembly, DepletionIDGenerationLevel::Drum, DepletionIDGenerationLevel::Core }
	specify the depletion id is generated at which reactor generation level More...

Protected Member Functions
void	generateMetadata ()
	Define metadata associated with ControlDrumMeshGenerator. More...

unsigned int	getDrumIdxFromRadialIdx (const unsigned int radial_idx, const Real elem_x, const Real elem_y)
	Get drum index from radial index of mesh element, drum index is used to retrieve region ID and block names for each element. More...

unsigned int	getElemIntegerFromMesh (MeshBase &input_mesh, std::string extra_int_name, bool should_exist=false)
	Initializes extra element integer from id name for a given mesh and throws an error if it should exist but cannot be found within the mesh. More...

void	initializeReactorMeshParams (const std::string reactor_param_name)
	Initializes and checks validity of ReactorMeshParams mesh generator object. More...

void	printReactorMetadata (const std::string geometry_type, const std::string mg_name, const bool first_function_call=true)
	Print metadata associated with ReactorGeometryMeshBuilder object. More...

void	printCoreMetadata (const std::string mg_name, const bool first_function_call)
	Print core-level metadata associated with ReactorGeometryMeshBuilder object. More...

void	printAssemblyMetadata (const std::string mg_name, const bool first_function_call)
	Print assembly-level metadata associated with ReactorGeometryMeshBuilder object. More...

void	printPinMetadata (const std::string mg_name)
	Print pin-level metadata associated with ReactorGeometryMeshBuilder object. More...

void	printGlobalReactorMetadata ()
	Print global ReactorMeshParams metadata associated with ReactorGeometryMeshBuilder object. More...

template<typename T >
void	printMetadataToConsole (const std::string metadata_name, const std::string mg_name)
	Print metadata with provided name that can be found with given mesh generator name. More...

template<typename T >
void	print2dMetadataToConsole (const std::string metadata_name, const std::string mg_name)
	Print metadata with data type std::vector<std::vector<T>> and provided name that can be found with given mesh generator name. More...

void	freeReactorParamsMesh ()
	Releases the mesh obtained in _reactor_params_mesh. More...

void	freeReactorParamsCSG ()
	Releases the CSG base object obtained in _reactor_params_csg. More...

template<typename T >
bool	hasReactorParam (const std::string param_name)
	Checks whether parameter is defined in ReactorMeshParams metadata. More...

template<typename T >
const T &	getReactorParam (const std::string &param_name)
	Returns reference of parameter in ReactorMeshParams object. More...

void	updateElementBlockNameId (MeshBase &input_mesh, Elem *elem, std::map< std::string, SubdomainID > &name_id_map, std::string elem_block_name, SubdomainID &next_free_id)
	Updates the block names and ids of the element in an input mesh according to a map of block name to block ids. More...

MeshGeneratorName	callExtrusionMeshSubgenerators (const MeshGeneratorName input_mesh_name)
	Calls mesh subgenerators related to extrusion, renaming of top / bottom boundaries, and defining plane IDs. More...

void	addDepletionId (MeshBase &input_mesh, const MooseEnum &option, const DepletionIDGenerationLevel generation_level, const bool extrude)
	add depletion IDs More...

std::vector< std::reference_wrapper< const CSG::CSGSurface > >	getOuterRadialSurfacesForUnitCell (unsigned int radial_index, Real halfpitch, CSG::CSGBase &csg_obj)
	Get CSGSurfaces corresponding to hexagonal or square region with given halfpitch and centered around (0, 0, 0) More...

std::vector< std::reference_wrapper< const CSG::CSGSurface > >	getAxialPlaneSurfaces (CSG::CSGBase &csg_obj)
	Get CSGSurfaces corresponding to axial planes of the extruded RGMB mesh. More...

const CSG::CSGLattice &	createRGMBLattice (const Real pitch, const std::vector< std::vector< std::reference_wrapper< const CSG::CSGUniverse >>> pattern, CSG::CSGBase &csg_obj)
	Create CSG lattice for assembly and core lattices. More...

virtual std::unique_ptr< CSG::CSGBase >	generateCSG ()

T &	copyMeshProperty (const std::string &target_data_name, const std::string &source_data_name, const std::string &source_mesh)

T &	copyMeshProperty (const std::string &source_data_name, const std::string &source_mesh)

std::unique_ptr< MeshBase > &	getMesh (const std::string &param_name, const bool allow_invalid=false)

std::vector< std::unique_ptr< MeshBase > *>	getMeshes (const std::string &param_name)

std::unique_ptr< MeshBase > &	getMeshByName (const MeshGeneratorName &mesh_generator_name)

std::vector< std::unique_ptr< MeshBase > *>	getMeshesByName (const std::vector< MeshGeneratorName > &mesh_generator_names)

std::unique_ptr< CSG::CSGBase > &	getCSGBase (const std::string &param_name)

std::unique_ptr< CSG::CSGBase > &	getCSGBaseByName (const MeshGeneratorName &mesh_generator_name)

std::vector< std::unique_ptr< CSG::CSGBase > *>	getCSGBases (const std::string &param_name)

std::vector< std::unique_ptr< CSG::CSGBase > *>	getCSGBasesByName (const std::vector< MeshGeneratorName > &mesh_generator_names)

void	declareMeshForSub (const std::string &param_name)

void	declareMeshesForSub (const std::string &param_name)

void	declareMeshForSubByName (const MeshGeneratorName &mesh_generator_name)

void	declareMeshesForSubByName (const std::vector< MeshGeneratorName > &mesh_generator_names)

std::unique_ptr< MeshBase >	buildMeshBaseObject (unsigned int dim=libMesh::invalid_uint)

std::unique_ptr< ReplicatedMesh >	buildReplicatedMesh (unsigned int dim=libMesh::invalid_uint)

std::unique_ptr< DistributedMesh >	buildDistributedMesh (unsigned int dim=libMesh::invalid_uint)

void	addMeshSubgenerator (const std::string &type, const std::string &name, Ts... extra_input_parameters)

void	addMeshSubgenerator (const std::string &type, const std::string &name, InputParameters params)

void	declareNullMeshName (const MeshGeneratorName &name)

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) 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

T &	declareMeshProperty (const std::string &data_name, Args &&... args)

T &	declareMeshProperty (const std::string &data_name, const T &data_value)

T &	declareMeshProperty (const std::string &data_name, Args &&... args)

T &	declareMeshProperty (const std::string &data_name, const T &data_value)

T &	setMeshProperty (const std::string &data_name, Args &&... args)

T &	setMeshProperty (const std::string &data_name, const T &data_value)

T &	setMeshProperty (const std::string &data_name, Args &&... args)

T &	setMeshProperty (const std::string &data_name, const T &data_value)

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
std::string	_geom_type
	The type of geometry that is being described (Square or Hex, declared in the ReactorMeshParams object) More...

unsigned int	_mesh_dimensions
	The number of dimensions the mesh is ultimately going to have (2 or 3, declared in the ReactorMeshParams object) More...

const subdomain_id_type	_assembly_type
	The id number for the type of the assembly. More...

const Real	_drum_inner_radius
	The inner radius of drum region. More...

const Real	_drum_outer_radius
	The outer radius of drum region. More...

const bool	_extrude
	Whether this mesh should be extruded to 3-D, making it the final structure in the reactor mesh. More...

std::vector< std::vector< subdomain_id_type > >	_region_ids
	2-D vector (axial outer indexing, radial inner indexing) used to set "region_id" extra-element integer of the control drum mesh elements More...

bool	_has_block_names
	Whether block names have been provided by user. More...

std::vector< std::vector< std::string > >	_block_names
	2-D vector (axial outer indexing, radial inner indexing) used to set block names of pin mesh elements More...

Real	_pad_start_angle
	Starting angle of drum pad region. More...

Real	_pad_end_angle
	Ending angle of drum pad region. More...

bool	_has_pad_region
	Whether pad start and end angles are provided by user. More...

std::unique_ptr< MeshBase > *	_build_mesh
	The final mesh that is generated by the subgenerators; This mesh is generated by the subgenerators with only element and boundary IDs changed. More...

MeshGeneratorName	_reactor_params
	The ReactorMeshParams object that is storing the reactor global information for this reactor geometry mesh. More...

MooseMesh *const	_mesh

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

const Parallel::Communicator &	_communicator

Detailed Description

Mesh generator for defining a reactor control drum that can be used in a Cartesian or hexagonal lattice with the option to be 2-D or 3-D.

Definition at line 18 of file ControlDrumMeshGenerator.h.

Member Enumeration Documentation

◆ DepletionIDGenerationLevel

enum ReactorGeometryMeshBuilderBase::DepletionIDGenerationLevel

strongprotectedinherited

specify the depletion id is generated at which reactor generation level

Enumerator
Pin
Assembly
Drum
Core

Definition at line 263 of file ReactorGeometryMeshBuilderBase.h.

   {
     Pin,
     Assembly,
     Drum,
     Core
   };

Constructor & Destructor Documentation

◆ ControlDrumMeshGenerator()

ControlDrumMeshGenerator::ControlDrumMeshGenerator ( const InputParameters & parameters )

Definition at line 92 of file ControlDrumMeshGenerator.C.

   : ReactorGeometryMeshBuilderBase(parameters),
     _assembly_type(getParam<subdomain_id_type>("assembly_type")),
     _drum_inner_radius(getParam<Real>("drum_inner_radius")),
     _drum_outer_radius(getParam<Real>("drum_outer_radius")),
     _extrude(getParam<bool>("extrude")),
     _region_ids(getParam<std::vector<std::vector<subdomain_id_type>>>("region_ids"))
 {
   // Initialize ReactorMeshParams object
   initializeReactorMeshParams(getParam<MeshGeneratorName>("reactor_params"));
 
   // Flexible stitching needs to be invoked in order to create control drum mesh
   if (!getReactorParam<bool>(RGMB::flexible_assembly_stitching))
     mooseError("'flexible_assembly_stitching' needs to be set to true in ReactorMeshParams in "
                "order to use ControlDrumMeshGenerator");
 
   _geom_type = getReactorParam<std::string>(RGMB::mesh_geometry);
   _mesh_dimensions = getReactorParam<unsigned int>(RGMB::mesh_dimensions);
 
   const auto drum_inner_intervals = getParam<unsigned int>("drum_inner_intervals");
   const auto drum_intervals = getParam<unsigned int>("drum_intervals");
   const auto num_sectors = getParam<unsigned int>("num_azimuthal_sectors");
   const auto assembly_pitch = getReactorParam<Real>(RGMB::assembly_pitch);
 
   // Check drum pad parameters
   if (isParamSetByUser("pad_start_angle"))
   {
     _pad_start_angle = getParam<Real>("pad_start_angle");
     if (!isParamSetByUser("pad_end_angle"))
       paramError("pad_start_angle",
                  "If 'pad_start_angle' is set, 'pad_end_angle' needs to also be set.");
     _pad_end_angle = getParam<Real>("pad_end_angle");
 
     if ((_pad_end_angle - _pad_start_angle >= 360) || (_pad_end_angle - _pad_start_angle <= 0))
       paramError("pad_start_angle",
                  "The difference between 'pad_end_angle' and 'pad_start_angle' must be between 0 "
                  "and 360 exclusive.");
     _has_pad_region = true;
   }
   else
   {
     if (isParamSetByUser("pad_end_angle"))
       paramError("pad_end_angle",
                  "If 'pad_end_angle' is set, 'pad_start_angle' needs to also be set.");
     _has_pad_region = false;
   }
 
   // Error checking for azimuthal node tolerance
   const auto azimuthal_node_tolerance = getParam<Real>("azimuthal_node_tolerance");
   if (!_has_pad_region && isParamSetByUser("azimuthal_node_tolerance"))
     paramError("azimuthal_node_tolerance",
                "This parameter is relevant only when pad start and end angles are defined");
   if (_has_pad_region && MooseUtils::absoluteFuzzyGreaterEqual(2. * azimuthal_node_tolerance,
                                                                360. / (Real)num_sectors))
     paramError("azimuthal_node_tolerance",
                "Azimuthal node tolerance should be smaller than half the azimuthal interval size "
                "as defined by 'num_azimuthal_sectors'");
   if (_has_pad_region && MooseUtils::absoluteFuzzyGreaterEqual(2. * azimuthal_node_tolerance,
                                                                _pad_end_angle - _pad_start_angle))
     paramError("azimuthal_node_tolerance",
                "Azimuthal node tolerance should be smaller than half the difference of the pad "
                "angle range");
 
   // Check region IDs have correct size
   const unsigned int n_radial_regions = _has_pad_region ? 4 : 3;
   unsigned int n_axial_levels =
       (_mesh_dimensions == 3)
           ? getReactorParam<std::vector<unsigned int>>(RGMB::axial_mesh_intervals).size()
           : 1;
   if (_region_ids.size() != n_axial_levels)
     mooseError("The size of region IDs must be equal to the number of axial levels as defined in "
                "the ReactorMeshParams object");
   if (_region_ids[0].size() != n_radial_regions)
   {
     std::string err_msg =
         "'region_ids' parameter does not have the correct number of elements per axial zone. ";
     err_msg += _has_pad_region
                    ? "For control drums with a pad region, 4 radial IDs need to be provided per "
                      "axial zone (drum inner, drum pad, drum ex-pad, and drum outer)"
                    : "For control drums with no pad region, 3 radial IDs need to be provided per "
                      "axial zone (drum inner, drum, and drum outer)";
     paramError("region_ids", err_msg);
   }
 
   // Check block names have the correct size
   if (isParamValid("block_names"))
   {
     if (getReactorParam<bool>(RGMB::region_id_as_block_name))
       paramError("block_names",
                  "If ReactorMeshParams/region_id_as_block_name is set, block_names should not be "
                  "specified in ControlDrumMeshGenerator");
     _has_block_names = true;
     _block_names = getParam<std::vector<std::vector<std::string>>>("block_names");
     if (_region_ids.size() != _block_names.size())
       mooseError("The size of block_names must match the size of region_ids");
     for (const auto i : index_range(_region_ids))
       if (_region_ids[i].size() != _block_names[i].size())
         mooseError("The size of block_names must match the size of region_ids");
   }
   else
     _has_block_names = false;
 
   // Check extrusion parameters
   if (_extrude && _mesh_dimensions != 3)
     paramError("extrude",
                "In order to extrude this mesh, ReactorMeshParams/dim needs to be set to 3\n");
   if (_extrude && (!hasReactorParam<boundary_id_type>(RGMB::top_boundary_id) ||
                    !hasReactorParam<boundary_id_type>(RGMB::bottom_boundary_id)))
     mooseError("Both top_boundary_id and bottom_boundary_id must be provided in ReactorMeshParams "
                "if using extruded geometry");
 
   // Define azimuthal angles explicitly based on num_azimuthal_sectors and manually add pad start
   // angle and end angle if they are not contained within these angle intervals
   std::vector<Real> azimuthal_angles;
   const auto custom_start_angle = _has_pad_region ? _pad_start_angle : 0.;
   const auto custom_end_angle =
       _has_pad_region ? ((_pad_end_angle > 360) ? _pad_end_angle - 360. : _pad_end_angle) : 0.;
   for (unsigned int i = 0; i < num_sectors; ++i)
   {
     Real current_azim_angle = (Real)i * 360. / (Real)num_sectors;
     Real next_azim_angle = (Real)(i + 1) * 360. / (Real)num_sectors;
     if (!_has_pad_region)
       azimuthal_angles.push_back(current_azim_angle);
     else
     {
       // When pad regions are involved, check if the current azimuthal node angle coincides with
       // pad start/end angle to within tolerance. If it does, then shift the azimuthal node location
       // to match the pad angle location. If it does not and the pad angle falls within the
       // azimuthal sector, then create an additional node for the pad location
       if (MooseUtils::absoluteFuzzyLessEqual(std::abs(current_azim_angle - custom_start_angle),
                                              azimuthal_node_tolerance))
       {
         azimuthal_angles.push_back(custom_start_angle);
       }
       else if (MooseUtils::absoluteFuzzyLessEqual(std::abs(current_azim_angle - custom_end_angle),
                                                   azimuthal_node_tolerance))
       {
         azimuthal_angles.push_back(custom_end_angle);
       }
       else if (MooseUtils::absoluteFuzzyGreaterThan(custom_start_angle - current_azim_angle,
                                                     azimuthal_node_tolerance) &&
                MooseUtils::absoluteFuzzyGreaterThan(next_azim_angle - custom_start_angle,
                                                     azimuthal_node_tolerance))
       {
         mooseWarning("pad_start_angle not contained within drum azimuthal discretization so "
                      "additional azimuthal nodes are created to align mesh with this angle");
         azimuthal_angles.push_back(current_azim_angle);
         azimuthal_angles.push_back(custom_start_angle);
       }
       else if (MooseUtils::absoluteFuzzyGreaterThan(custom_end_angle - current_azim_angle,
                                                     azimuthal_node_tolerance) &&
                MooseUtils::absoluteFuzzyGreaterThan(next_azim_angle - custom_end_angle,
                                                     azimuthal_node_tolerance))
       {
         mooseWarning("pad_end_angle not contained within drum azimuthal discretization so "
                      "additional azimuthal nodes are created to align mesh with this angle");
         azimuthal_angles.push_back(current_azim_angle);
         azimuthal_angles.push_back(custom_end_angle);
       }
       else
         azimuthal_angles.push_back(current_azim_angle);
     }
   }
 
   // Check drum radius parameters
   if (_drum_inner_radius >= _drum_outer_radius)
     paramError("drum_outer_radius", "Drum outer radius must be larger than the inner radius");
   // Check if volume preserved radius of outer radius exceeds assembly halfpitch. In data driven
   // mode, radius is assumed not to need volume preservation
   auto radius_corrfac =
       getReactorParam<bool>(RGMB::bypass_meshgen)
           ? 1.0
           : PolygonalMeshGenerationUtils::radiusCorrectionFactor(azimuthal_angles);
   if (_drum_outer_radius * radius_corrfac >= assembly_pitch / 2.)
     paramError("drum_outer_radius",
                "Volume-corrected outer radius of drum region must be smaller than half the "
                "assembly pitch as "
                "defined by 'ReactorMeshParams/assembly_pitch'");
 
   // No subgenerators will be called if option to bypass mesh generators is enabled
   if (!getReactorParam<bool>(RGMB::bypass_meshgen))
   {
     const std::string block_name_prefix =
         RGMB::DRUM_BLOCK_NAME_PREFIX + std::to_string(_assembly_type);
 
     {
       // Invoke AdvancedConcentricCircleGenerator to define drum mesh without background region
       auto params = _app.getFactory().getValidParams("AdvancedConcentricCircleGenerator");
 
       params.set<std::vector<Real>>("customized_azimuthal_angles") = azimuthal_angles;
       params.set<std::vector<double>>("ring_radii") = {_drum_inner_radius, _drum_outer_radius};
       params.set<std::vector<unsigned int>>("ring_intervals") = {drum_inner_intervals,
                                                                  drum_intervals};
       if (drum_inner_intervals > 1)
       {
         params.set<std::vector<subdomain_id_type>>("ring_block_ids") = {
             RGMB::CONTROL_DRUM_BLOCK_ID_INNER_TRI,
             RGMB::CONTROL_DRUM_BLOCK_ID_INNER,
             RGMB::CONTROL_DRUM_BLOCK_ID_PAD};
         params.set<std::vector<SubdomainName>>("ring_block_names") = {
             block_name_prefix + "_R0_TRI", block_name_prefix + "_R0", block_name_prefix + "_R1"};
       }
       else
       {
         params.set<std::vector<subdomain_id_type>>("ring_block_ids") = {
             RGMB::CONTROL_DRUM_BLOCK_ID_INNER, RGMB::CONTROL_DRUM_BLOCK_ID_PAD};
         params.set<std::vector<SubdomainName>>("ring_block_names") = {block_name_prefix + "_R0",
                                                                       block_name_prefix + "_R1"};
       }
       params.set<bool>("create_outward_interface_boundaries") = false;
 
       addMeshSubgenerator("AdvancedConcentricCircleGenerator", name() + "_accg", params);
     }
     {
       // Invoke FlexiblePatternGenerator to triangulate drum background region
       auto params = _app.getFactory().getValidParams("FlexiblePatternGenerator");
 
       params.set<std::vector<MeshGeneratorName>>("inputs") = {name() + "_accg"};
       params.set<std::vector<libMesh::Point>>("extra_positions") = {libMesh::Point(0, 0, 0)};
       params.set<std::vector<unsigned int>>("extra_positions_mg_indices") = {0};
       params.set<bool>("use_auto_area_func") = true;
       // `verify_holes` is set to false to prevent false positive instances of points outside of
       // defined holes, which can create test failures on certain dev environments
       params.set<bool>("verify_holes") = false;
       params.set<MooseEnum>("boundary_type") = (_geom_type == "Hex") ? "HEXAGON" : "CARTESIAN";
       params.set<unsigned int>("boundary_sectors") =
           getReactorParam<unsigned int>(RGMB::num_sectors_flexible_stitching);
       params.set<Real>("boundary_size") = assembly_pitch;
       params.set<boundary_id_type>("external_boundary_id") =
           RGMB::ASSEMBLY_BOUNDARY_ID_START + _assembly_type;
       params.set<BoundaryName>("external_boundary_name") =
           RGMB::ASSEMBLY_BOUNDARY_NAME_PREFIX + std::to_string(_assembly_type);
       params.set<SubdomainName>("background_subdomain_name") = block_name_prefix + "_R2_TRI";
       params.set<subdomain_id_type>("background_subdomain_id") = RGMB::CONTROL_DRUM_BLOCK_ID_OUTER;
 
       addMeshSubgenerator("FlexiblePatternGenerator", name() + "_fpg", params);
 
       // Pass mesh meta-data defined in subgenerator constructor to this MeshGenerator
       copyMeshProperty<bool>("is_control_drum_meta", name() + "_fpg");
       copyMeshProperty<Real>("pattern_pitch_meta", name() + "_fpg");
     }
     std::string build_mesh_name = name() + "_delbds";
     {
       // Invoke BoundaryDeletionGenerator to delete extra sidesets created by
       // AdvancedConcentricCircleGenerator
       auto params = _app.getFactory().getValidParams("BoundaryDeletionGenerator");
 
       params.set<MeshGeneratorName>("input") = name() + "_fpg";
       params.set<std::vector<BoundaryName>>("boundary_names") = {"0", "2"};
 
       addMeshSubgenerator("BoundaryDeletionGenerator", build_mesh_name, params);
     }
     if (_extrude && _mesh_dimensions == 3)
       build_mesh_name = callExtrusionMeshSubgenerators(build_mesh_name);
 
     // Store final mesh subgenerator
     _build_mesh = &getMeshByName(build_mesh_name);
   }
 
   generateMetadata();
 }

Member Function Documentation

◆ addDepletionId()

void ReactorGeometryMeshBuilderBase::addDepletionId	(	MeshBase &	input_mesh,
		const MooseEnum &	option,
		const DepletionIDGenerationLevel	generation_level,
		const bool	extrude
	)

protectedinherited

add depletion IDs

Parameters

input_mesh	input mesh
option	option for specifying level of details
generation_level	depletion id is generated at which reactor generator level
extrude	whether input mesh is extruded, if false, assume that input mesh is defined in 2D and do not use 'plane_id` in depletion id generation

Definition at line 130 of file ReactorGeometryMeshBuilderBase.C.

Referenced by AssemblyMeshGenerator::generate(), generate(), and CoreMeshGenerator::generate().

 {
   // prepare set of extra elem ids for depletion ID generation
   std::vector<ExtraElementIDName> id_names = {};
   if (extrude)
     id_names.push_back("plane_id");
   if (generation_level == DepletionIDGenerationLevel::Core)
   {
     if (option == "pin")
       id_names.insert(id_names.end(), {"assembly_id", "pin_id"});
     else if (option == "pin_type")
       id_names.insert(id_names.end(), {"assembly_id", "pin_type_id"});
     else if (option == "assembly")
       id_names.push_back("assembly_id");
     else if (option == "assembly_type")
       id_names.push_back("assembly_type_id");
   }
   else if (generation_level == DepletionIDGenerationLevel::Assembly)
   {
     if (option == "pin")
       id_names.push_back("pin_id");
     else if (option == "pin_type")
       id_names.push_back("pin_type_id");
     else
       paramError("depletion_id_type",
                  "'assembly_id' or 'assembly_type_id' is not allowed in depletion ID generation at "
                  "assembly level");
   }
   else if (generation_level == DepletionIDGenerationLevel::Drum)
   {
     if (option == "pin_type")
       id_names.push_back("pin_type_id");
     else
       paramError("depletion_id_type",
                  "Only 'pin_type' is allowed in depletion ID generation at "
                  "drum level");
   }
   else if (generation_level == DepletionIDGenerationLevel::Pin)
     mooseError("Depletion ID generation is not supported at pin level yet in RGMB");
   id_names.push_back("region_id");
   // no block restriction
   std::set<SubdomainID> block_ids = {};
   // create depletion IDs
   // depletion IDs will be assigned in the following order:
   // regions (materials) within pin -> pins in assembly -> assemblies in core -> axial planes
   std::unordered_map<dof_id_type, dof_id_type> depl_ids =
       MooseMeshUtils::getExtraIDUniqueCombinationMap(input_mesh, block_ids, id_names);
   // assign depletion ids to elements
   const auto depl_id_index = input_mesh.add_elem_integer("depletion_id");
   for (Elem * const elem : input_mesh.active_element_ptr_range())
     elem->set_extra_integer(depl_id_index, depl_ids.at(elem->id()));
 }

◆ addDepletionIDParams()

void ReactorGeometryMeshBuilderBase::addDepletionIDParams ( InputParameters & parameters )

staticinherited

Definition at line 35 of file ReactorGeometryMeshBuilderBase.C.

Referenced by AssemblyMeshGenerator::validParams(), validParams(), and CoreMeshGenerator::validParams().

 {
   params.addParam<bool>(
       "generate_depletion_id", false, "Determine wheter the depletion ID is assigned.");
   MooseEnum depletion_id_option("assembly assembly_type pin pin_type");
   params.addParam<MooseEnum>("depletion_id_type",
                              depletion_id_option,
                              "Determine level of details in depletion ID assignment.");
   params.addParamNamesToGroup("generate_depletion_id depletion_id_type", "Depletion ID assignment");
 }

◆ callExtrusionMeshSubgenerators()

MeshGeneratorName ReactorGeometryMeshBuilderBase::callExtrusionMeshSubgenerators ( const MeshGeneratorName input_mesh_name )

protectedinherited

Calls mesh subgenerators related to extrusion, renaming of top / bottom boundaries, and defining plane IDs.

Parameters

input_mesh_name name of input 2D mesh generator to extrude

Returns: name of final output 3D mesh generator

Definition at line 187 of file ReactorGeometryMeshBuilderBase.C.

Referenced by AssemblyMeshGenerator::AssemblyMeshGenerator(), ControlDrumMeshGenerator(), CoreMeshGenerator::CoreMeshGenerator(), and PinMeshGenerator::PinMeshGenerator().

 {
   std::vector<Real> axial_boundaries = getReactorParam<std::vector<Real>>(RGMB::axial_mesh_sizes);
   const auto top_boundary = getReactorParam<boundary_id_type>(RGMB::top_boundary_id);
   const auto bottom_boundary = getReactorParam<boundary_id_type>(RGMB::bottom_boundary_id);
 
   {
     auto params = _app.getFactory().getValidParams("AdvancedExtruderGenerator");
 
     params.set<MeshGeneratorName>("input") = input_mesh_name;
     params.set<Point>("direction") = Point(0, 0, 1);
     params.set<std::vector<unsigned int>>("num_layers") =
         getReactorParam<std::vector<unsigned int>>(RGMB::axial_mesh_intervals);
     params.set<std::vector<Real>>("heights") = axial_boundaries;
     params.set<BoundaryName>("bottom_boundary") = std::to_string(bottom_boundary);
     params.set<BoundaryName>("top_boundary") = std::to_string(top_boundary);
     addMeshSubgenerator("AdvancedExtruderGenerator", name() + "_extruded", params);
   }
 
   {
     auto params = _app.getFactory().getValidParams("RenameBoundaryGenerator");
 
     params.set<MeshGeneratorName>("input") = name() + "_extruded";
     params.set<std::vector<BoundaryName>>("old_boundary") = {
         std::to_string(top_boundary),
         std::to_string(bottom_boundary)}; // hard coded boundary IDs in patterned mesh generator
     params.set<std::vector<BoundaryName>>("new_boundary") = {"top", "bottom"};
     addMeshSubgenerator("RenameBoundaryGenerator", name() + "_change_plane_name", params);
   }
 
   const MeshGeneratorName output_mesh_name = name() + "_extrudedIDs";
   {
     auto params = _app.getFactory().getValidParams("PlaneIDMeshGenerator");
 
     params.set<MeshGeneratorName>("input") = name() + "_change_plane_name";
 
     std::vector<Real> plane_heights{0};
     for (Real z : axial_boundaries)
       plane_heights.push_back(z + plane_heights.back());
 
     params.set<std::vector<Real>>("plane_coordinates") = plane_heights;
 
     std::string plane_id_name = "plane_id";
     params.set<std::string>("id_name") = "plane_id";
 
     addMeshSubgenerator("PlaneIDMeshGenerator", output_mesh_name, params);
   }
 
   return output_mesh_name;
 }

◆ createRGMBLattice()

const CSG::CSGLattice & ReactorGeometryMeshBuilderBase::createRGMBLattice	(	const Real	pitch,
		const std::vector< std::vector< std::reference_wrapper< const CSG::CSGUniverse >>>	pattern,
		CSG::CSGBase &	csg_obj
	)

protectedinherited

Create CSG lattice for assembly and core lattices.

This method does not set the outer universe of the lattice

Parameters

pitch	lattice pitch
pattern	pattern of universes in the lattice
csg_obj	reference to CSGBase object

Definition at line 311 of file ReactorGeometryMeshBuilderBase.C.

Referenced by AssemblyMeshGenerator::generateCSG(), and CoreMeshGenerator::generateCSG().

 {
   // Create lattice based on whether it is hexagonal or Cartesian
   std::string lat_name = name() + "_lattice";
   std::unique_ptr<CSG::CSGLattice> lat_ptr;
   const auto mesh_geometry = getReactorParam<std::string>(RGMB::mesh_geometry);
   if (mesh_geometry == "Square")
     lat_ptr = std::make_unique<CSG::CSGCartesianLattice>(lat_name, pitch, pattern);
   else // _geom_type == "Hex"
     lat_ptr = std::make_unique<CSG::CSGHexagonalLattice>(lat_name, pitch, pattern);
 
   auto & assembly_lattice = csg_obj.addLattice(std::move(lat_ptr));
   return assembly_lattice;
 }

◆ freeReactorParamsCSG()

void ReactorGeometryMeshBuilderBase::freeReactorParamsCSG ( )

protectedinherited

Releases the CSG base object obtained in _reactor_params_csg.

This must be called in any object that derives from this one, because the MeshGenerator system requires that all meshes that are requested from the system are moved out of the MeshGenerator system and into the MeshGenerator that requests them. In our case, we move it into this MeshGenerator and then release (delete) it.

Definition at line 81 of file ReactorGeometryMeshBuilderBase.C.

Referenced by AssemblyMeshGenerator::generateCSG(), PinMeshGenerator::generateCSG(), and CoreMeshGenerator::generateCSG().

 {
   _reactor_params_csg->reset();
 }

◆ freeReactorParamsMesh()

void ReactorGeometryMeshBuilderBase::freeReactorParamsMesh ( )

protectedinherited

Releases the mesh obtained in _reactor_params_mesh.

This must be called in any object that derives from this one, because the MeshGenerator system requires that all meshes that are requested from the system are moved out of the MeshGenerator system and into the MeshGenerator that requests them. In our case, we move it into this MeshGenerator and then release (delete) it.

Definition at line 75 of file ReactorGeometryMeshBuilderBase.C.

Referenced by AssemblyMeshGenerator::generate(), PinMeshGenerator::generate(), generate(), and CoreMeshGenerator::generate().

 {
   _reactor_params_mesh->reset();
 }

◆ generate()

std::unique_ptr< MeshBase > ControlDrumMeshGenerator::generate ( )

overridevirtual

Implements MeshGenerator.

Definition at line 374 of file ControlDrumMeshGenerator.C.

 {
   // Must be called to free the ReactorMeshParams mesh
   freeReactorParamsMesh();
 
   // If bypass_mesh is true, return a null mesh. In this mode, an output mesh is not
   // generated and only metadata is defined on the generator, so logic related to
   // generation of output mesh will not be called
   if (getReactorParam<bool>(RGMB::bypass_meshgen))
   {
     auto null_mesh = nullptr;
     return null_mesh;
   }
 
   // This generate() method will be called once the subgenerators that we depend on are
   // called. This is where we reassign subdomain ids/name in case they were merged when
   // stitching pins into an assembly. This is also where we set region_id and
   // assembly_type_id element integers.
 
   // Define all extra element names and integers
   std::string plane_id_name = "plane_id";
   std::string region_id_name = "region_id";
   std::string pin_type_id_name = "pin_type_id";
   std::string assembly_type_id_name = "assembly_type_id";
   const std::string default_block_name =
       RGMB::DRUM_BLOCK_NAME_PREFIX + std::to_string(_assembly_type);
 
   auto pin_type_id_int = getElemIntegerFromMesh(*(*_build_mesh), pin_type_id_name);
   auto region_id_int = getElemIntegerFromMesh(*(*_build_mesh), region_id_name);
   auto assembly_type_id_int = getElemIntegerFromMesh(*(*_build_mesh), assembly_type_id_name);
 
   unsigned int plane_id_int = 0;
   if (_extrude)
     plane_id_int = getElemIntegerFromMesh(*(*_build_mesh), plane_id_name, true);
 
   // Get next free block ID in mesh in case subdomain ids need to be remapped
   auto next_block_id = MooseMeshUtils::getNextFreeSubdomainID(*(*(_build_mesh)));
   std::map<std::string, SubdomainID> rgmb_name_id_map;
 
   // Loop through all mesh elements and set region ids and reassign block IDs/names
   // if they were merged during pin stitching
   for (auto & elem : (*_build_mesh)->active_element_ptr_range())
   {
     elem->set_extra_integer(assembly_type_id_int, _assembly_type);
     const dof_id_type z_id = _extrude ? elem->get_extra_integer(plane_id_int) : 0;
 
     // Assembly peripheral element (background / duct), set subdomains according
     // to user preferences and set pin type id to RGMB::MAX_PIN_TYPE_ID - peripheral index
     // Region id is inferred from z_id and peripheral_idx
     const auto base_block_id = elem->subdomain_id();
     const auto base_block_name = (*_build_mesh)->subdomain_name(base_block_id);
 
     // Check if block name has correct prefix
     std::string prefix = RGMB::DRUM_BLOCK_NAME_PREFIX + std::to_string(_assembly_type) + "_R";
     if (!(base_block_name.find(prefix, 0) == 0))
       continue;
 
     // Radial index is integer value of substring after prefix
     const unsigned int radial_idx = std::stoi(base_block_name.substr(prefix.length()));
 
     // Drum index distinguishes between elements in pad and ex-pad regions that have the same radial
     // index
     const unsigned int drum_idx =
         getDrumIdxFromRadialIdx(radial_idx, elem->true_centroid()(0), elem->true_centroid()(1));
     subdomain_id_type pin_type = RGMB::MAX_PIN_TYPE_ID - drum_idx;
     elem->set_extra_integer(pin_type_id_int, pin_type);
 
     const auto elem_rid = _region_ids[z_id][drum_idx];
     elem->set_extra_integer(region_id_int, elem_rid);
 
     // Set element block name and block id
     auto elem_block_name = default_block_name;
     if (getReactorParam<bool>(RGMB::region_id_as_block_name))
       elem_block_name += "_REG" + std::to_string(elem_rid);
     else if (_has_block_names)
       elem_block_name += "_" + _block_names[z_id][drum_idx];
     if (elem->type() == TRI3 || elem->type() == PRISM6)
       elem_block_name += RGMB::TRI_BLOCK_NAME_SUFFIX;
     updateElementBlockNameId(
         *(*_build_mesh), elem, rgmb_name_id_map, elem_block_name, next_block_id);
   }
 
   if (getParam<bool>("generate_depletion_id"))
   {
     const MooseEnum option = getParam<MooseEnum>("depletion_id_type");
     addDepletionId(*(*_build_mesh), option, DepletionIDGenerationLevel::Drum, _extrude);
   }
 
   // Mark mesh as not prepared, as block ID's were re-assigned in this method
   (*_build_mesh)->unset_is_prepared();
 
   return std::move(*_build_mesh);
 }

◆ generateData()

void ReactorGeometryMeshBuilderBase::generateData ( )

inlineoverridevirtualinherited

Reimplemented from MeshGenerator.

Definition at line 119 of file ReactorGeometryMeshBuilderBase.h.

119 {};

◆ generateMetadata()

void ControlDrumMeshGenerator::generateMetadata ( )

protected

Define metadata associated with ControlDrumMeshGenerator.

Definition at line 355 of file ControlDrumMeshGenerator.C.

Referenced by ControlDrumMeshGenerator().

 {
   // Declare metadata for use in downstream mesh generators
   declareMeshProperty(RGMB::assembly_type, _assembly_type);
   declareMeshProperty(RGMB::pitch, getReactorParam<Real>(RGMB::assembly_pitch));
   declareMeshProperty(RGMB::extruded, _extrude && _mesh_dimensions == 3);
   declareMeshProperty(RGMB::is_control_drum, true);
   declareMeshProperty(RGMB::drum_region_ids, _region_ids);
   declareMeshProperty(RGMB::drum_block_names, _block_names);
   std::vector<Real> drum_pad_angles =
       _has_pad_region ? std::vector<Real>({_pad_start_angle, _pad_end_angle}) : std::vector<Real>();
   declareMeshProperty(RGMB::drum_pad_angles, drum_pad_angles);
   std::vector<Real> drum_radii = std::vector<Real>({_drum_inner_radius, _drum_outer_radius});
   declareMeshProperty(RGMB::drum_radii, drum_radii);
   declareMeshProperty(RGMB::is_homogenized, false);
   declareMeshProperty(RGMB::is_single_pin, false);
 }

◆ getAxialPlaneSurfaces()

std::vector< std::reference_wrapper< const CSG::CSGSurface > > ReactorGeometryMeshBuilderBase::getAxialPlaneSurfaces ( CSG::CSGBase & csg_obj )

protectedinherited

Get CSGSurfaces corresponding to axial planes of the extruded RGMB mesh.

Parameters

csg_obj Reference to CSGBase object for adding defined surfaces to

Returns: vector of surfaces that correspond to axial planes of extruded RGMB mesh

Definition at line 279 of file ReactorGeometryMeshBuilderBase.C.

Referenced by AssemblyMeshGenerator::generateCSG(), PinMeshGenerator::generateCSG(), and CoreMeshGenerator::generateCSG().

 {
   std::vector<std::reference_wrapper<const CSG::CSGSurface>> surfaces_by_axial_region;
   const auto axial_boundaries = getReactorParam<std::vector<Real>>(RGMB::axial_mesh_sizes);
   Real axial_level = 0.;
 
   // Check if axial planes have been defined in CSGBase based on a surface name we expect
   // to find
   auto axial_surf_name = RGMB::CSG_AXIAL_PLANE_PREFIX + "0";
   const auto has_axial_surfaces = csg_obj.hasSurface(axial_surf_name);
 
   for (const auto i : make_range(axial_boundaries.size() + 1))
   {
     axial_surf_name = RGMB::CSG_AXIAL_PLANE_PREFIX + std::to_string(i);
     if (has_axial_surfaces)
       // Surface should exist in CSGBase, retrieve from object
       surfaces_by_axial_region.push_back(csg_obj.getSurfaceByName(axial_surf_name));
     else
     {
       // Surface has not been defined, create it and add to CSGBase
       axial_level += (i != 0) ? axial_boundaries[i - 1] : 0.;
       std::unique_ptr<CSG::CSGSurface> plane_surf_ptr =
           std::make_unique<CSG::CSGPlane>(axial_surf_name, 0, 0, 1, axial_level);
       const auto & plane_surf = csg_obj.addSurface(std::move(plane_surf_ptr));
       surfaces_by_axial_region.push_back(plane_surf);
     }
   }
 
   return surfaces_by_axial_region;
 }

◆ getDrumIdxFromRadialIdx()

unsigned int ControlDrumMeshGenerator::getDrumIdxFromRadialIdx	(	const unsigned int	radial_idx,
		const Real	elem_x,
		const Real	elem_y
	)

protected

Get drum index from radial index of mesh element, drum index is used to retrieve region ID and block names for each element.

Definition at line 469 of file ControlDrumMeshGenerator.C.

Referenced by generate().

 {
   // By default, drum index will match radial index unless a pad region is defined
   unsigned int drum_idx = radial_idx;
   if (_has_pad_region)
   {
     if (radial_idx == 1)
     {
       // This is an element in the drum region, use drum angle to determine whether it belongs to
       // pad or ex-pad region Note: drum angle of 0 degrees starts in positive y-direction and
       // increments in clockwise direction, which is consistent
       //       with how AdvancedConcentricCircleMeshGenerator defines azimuthal angles
       Real drum_angle = std::atan2(elem_x, elem_y) * 180. / M_PI;
       if (drum_angle < 0)
         drum_angle += 360;
 
       // If _pad_end_angle does not exceed 360 degrees, check if drum angle lies within
       // _pad_start_angle and _pad_end_angle. Drum index needs to be incremented if element in
       // ex-pad region
       if (_pad_end_angle <= 360)
       {
         if ((drum_angle < _pad_start_angle) || (drum_angle > _pad_end_angle))
           ++drum_idx;
       }
       else
       {
         // If _pad_end_angle exceeds 360 degrees, check two intervals - _pad_start_angle to 360, and
         // 0 to _pad_end_angle - 360 Drum index needs to be incremented if element in ex-pad region
         if ((drum_angle < _pad_start_angle) && (drum_angle > _pad_end_angle - 360.))
           ++drum_idx;
       }
     }
     else if (radial_idx == 2)
     {
       // Element is in outer drum region, drum index needs to be incremented to account for presence
       // of ex-pad region
       ++drum_idx;
     }
   }
   return drum_idx;
 }

◆ getElemIntegerFromMesh()

unsigned int ReactorGeometryMeshBuilderBase::getElemIntegerFromMesh	(	MeshBase &	input_mesh,
		std::string	extra_int_name,
		bool	should_exist = `false`
	)

protectedinherited

Initializes extra element integer from id name for a given mesh and throws an error if it should exist but cannot be found within the mesh.

Parameters

input_mesh	input mesh
extra_int_name	extra element id name
should_exist	whether extra element integer should already exist in mesh

Returns: extra element integer

Definition at line 87 of file ReactorGeometryMeshBuilderBase.C.

Referenced by AssemblyMeshGenerator::generate(), PinMeshGenerator::generate(), generate(), and CoreMeshGenerator::generate().

 {
   if (input_mesh.has_elem_integer(extra_int_name))
     return input_mesh.get_elem_integer_index(extra_int_name);
   else
   {
     if (should_exist)
       mooseError("Expected extruded mesh to have " + extra_int_name + " extra integers");
     else
       return input_mesh.add_elem_integer(extra_int_name);
   }
 }

◆ getOuterRadialSurfacesForUnitCell()

std::vector< std::reference_wrapper< const CSG::CSGSurface > > ReactorGeometryMeshBuilderBase::getOuterRadialSurfacesForUnitCell	(	unsigned int	radial_index,
		Real	halfpitch,
		CSG::CSGBase &	csg_obj
	)

protectedinherited

Get CSGSurfaces corresponding to hexagonal or square region with given halfpitch and centered around (0, 0, 0)

Parameters

radial_index	Radial index of hex / square region, for surface naming
halfpitch	Halfpitch of square or hexagon
csg_obj	Reference to CSGBase object for adding defined surfaces to

Returns: vector of surfaces that correspond to hexagonal or square region

Definition at line 240 of file ReactorGeometryMeshBuilderBase.C.

Referenced by AssemblyMeshGenerator::generateCSG(), and PinMeshGenerator::generateCSG().

 {
   std::vector<std::reference_wrapper<const CSG::CSGSurface>> duct_surfaces;
   const auto mesh_geometry = getReactorParam<std::string>(RGMB::mesh_geometry);
   const auto n_azim_surfaces = mesh_geometry == "Square" ? 4 : 6;
 
   // Convert halfpitch to radius (distance from vertex to center)
   const Real angle_offset_degrees = mesh_geometry == "Square" ? 45. : 30.;
   const Real angle_offset_radians = angle_offset_degrees * (M_PI / 180.);
   const auto radius = halfpitch / std::cos(angle_offset_radians);
 
   Real angle_increment_radians = 360. / n_azim_surfaces * (M_PI / 180.);
 
   for (const auto i : make_range(n_azim_surfaces))
   {
     const auto surf_name =
         name() + "_radial_duct_" + std::to_string(radial_index) + "_surf_" + std::to_string(i);
 
     // Define 3 points on the surface
     const auto current_angle = i * angle_increment_radians + angle_offset_radians;
     const auto next_angle = (i + 1) * angle_increment_radians + angle_offset_radians;
     libMesh::Point p0(radius * std::cos(current_angle), radius * std::sin(current_angle), 0.);
     libMesh::Point p1(radius * std::cos(next_angle), radius * std::sin(next_angle), 0.);
     libMesh::Point p2 = (p0 + p1) / 2.;
     // Place third point above the two others to form a vertical plane
     p2(2) = angle_offset_degrees;
 
     std::unique_ptr<CSG::CSGSurface> duct_surf_ptr =
         std::make_unique<CSG::CSGPlane>(surf_name, p0, p1, p2);
     const auto & duct_surf = csg_obj.addSurface(std::move(duct_surf_ptr));
     duct_surfaces.push_back(duct_surf);
   }
 
   return duct_surfaces;
 }

◆ getReactorParam()

template<typename T >

const T & ReactorGeometryMeshBuilderBase::getReactorParam ( const std::string & param_name )

protectedinherited

Returns reference of parameter in ReactorMeshParams object.

Template Parameters

T	datatype of metadata value associated with metadata name

Parameters

param_name name of ReactorMeshParams parameter

Returns: reference to parameter defined in ReactorMeshParams metadata

Definition at line 330 of file ReactorGeometryMeshBuilderBase.h.

Referenced by AssemblyMeshGenerator::AssemblyMeshGenerator(), ReactorGeometryMeshBuilderBase::callExtrusionMeshSubgenerators(), ControlDrumMeshGenerator(), PinMeshGenerator::generateMetadata(), and PinMeshGenerator::PinMeshGenerator().

 {
   return getMeshProperty<T>(param_name, _reactor_params);
 }

◆ hasReactorParam()

template<typename T >

bool ReactorGeometryMeshBuilderBase::hasReactorParam ( const std::string param_name )

protectedinherited

Checks whether parameter is defined in ReactorMeshParams metadata.

Template Parameters

T	datatype of metadata value associated with metadata name

Parameters

param_name name of ReactorMeshParams parameter

Returns: whether parameter is defined in ReactorMeshParams metadata

Definition at line 323 of file ReactorGeometryMeshBuilderBase.h.

 {
   return hasMeshProperty<T>(param_name, _reactor_params);
 }

◆ initializeReactorMeshParams()

void ReactorGeometryMeshBuilderBase::initializeReactorMeshParams ( const std::string reactor_param_name )

protectedinherited

Initializes and checks validity of ReactorMeshParams mesh generator object.

Parameters

reactor_param_name name of ReactorMeshParams mesh generator

Definition at line 52 of file ReactorGeometryMeshBuilderBase.C.

Referenced by AssemblyMeshGenerator::AssemblyMeshGenerator(), ControlDrumMeshGenerator(), CoreMeshGenerator::CoreMeshGenerator(), and PinMeshGenerator::PinMeshGenerator().

 {
   _reactor_params = reactor_param_name;
 
   // Ensure that the user has supplied a valid ReactorMeshParams object
   _reactor_params_mesh = &getMeshByName(reactor_param_name);
   if (*_reactor_params_mesh)
     mooseError("The reactor_params mesh is not of the correct type");
 
   if (!hasMeshProperty<unsigned int>("mesh_dimensions", _reactor_params) ||
       !hasMeshProperty<std::string>("mesh_geometry", _reactor_params))
     mooseError("The reactor_params input must be a ReactorMeshParams type MeshGenerator\n Please "
                "check that a valid definition and name of ReactorMeshParams has been provided.");
 
   // Set reactor_params_name metadata for use by future mesh generators
   declareMeshProperty("reactor_params_name", std::string(_reactor_params));
 
   // Store CSGBase object if we are in CSG only mode
   if (_app.getMeshGeneratorSystem().getCSGOnly())
     _reactor_params_csg = &getCSGBaseByName(_reactor_params);
 }

◆ print2dMetadataToConsole()

template<typename T >

void ReactorGeometryMeshBuilderBase::print2dMetadataToConsole	(	const std::string	metadata_name,
		const std::string	mg_name
	)

protectedinherited

Print metadata with data type std::vector<std::vector<T>> and provided name that can be found with given mesh generator name.

Template Parameters

T	datatype of elements in 2-D vector to output

Parameters

metadata_name	Name of metadata to output
mg_name	Name of mesh generator that stores metadata

◆ printAssemblyMetadata()

void ReactorGeometryMeshBuilderBase::printAssemblyMetadata	(	const std::string	mg_name,
		const bool	first_function_call
	)

protectedinherited

Print assembly-level metadata associated with ReactorGeometryMeshBuilder object.

Parameters

mg_name	name of mesh generator associated with assembly
whether	this is the original function call, which will trigger additional output messages

◆ printCoreMetadata()

void ReactorGeometryMeshBuilderBase::printCoreMetadata	(	const std::string	mg_name,
		const bool	first_function_call
	)

protectedinherited

Print core-level metadata associated with ReactorGeometryMeshBuilder object.

Parameters

mg_name	name of mesh generator associated with core
first_function_call	whether this is the original function call, which will trigger additional output messages

◆ printGlobalReactorMetadata()

void ReactorGeometryMeshBuilderBase::printGlobalReactorMetadata ( )

protectedinherited

Print global ReactorMeshParams metadata associated with ReactorGeometryMeshBuilder object.

◆ printMetadataToConsole()

template<typename T >

void ReactorGeometryMeshBuilderBase::printMetadataToConsole	(	const std::string	metadata_name,
		const std::string	mg_name
	)

protectedinherited

Print metadata with provided name that can be found with given mesh generator name.

Template Parameters

T	datatype of metadata value to output

Parameters

metadata_name	Name of metadata to output
mg_name	Name of mesh generator that stores metadata

◆ printPinMetadata()

void ReactorGeometryMeshBuilderBase::printPinMetadata ( const std::string mg_name )

protectedinherited

Print pin-level metadata associated with ReactorGeometryMeshBuilder object.

Parameters

mg_name name of mesh generator associated with assembly

◆ printReactorMetadata()

void ReactorGeometryMeshBuilderBase::printReactorMetadata	(	const std::string	geometry_type,
		const std::string	mg_name,
		const bool	first_function_call = `true`
	)

protectedinherited

Print metadata associated with ReactorGeometryMeshBuilder object.

Parameters

geometry_type	type of geometry (pin / assembly / core) under consideration
mg_name	name of mesh generator associated with this object
first_function_call	whether this is the original function call, which will trigger additional output messages

◆ updateElementBlockNameId()

void ReactorGeometryMeshBuilderBase::updateElementBlockNameId	(	MeshBase &	input_mesh,
		Elem *	elem,
		std::map< std::string, SubdomainID > &	name_id_map,
		std::string	elem_block_name,
		SubdomainID &	next_free_id
	)

protectedinherited

Updates the block names and ids of the element in an input mesh according to a map of block name to block ids.

Updates the map if the block name is not in the map

Parameters

input_name	input mesh
elem	iterator to mesh element
name_id_map	map of name-id pairs used in mesh
elem_block_name	block name to set for element
next_free_id	next free block id to use if block name does not exist in map

Definition at line 103 of file ReactorGeometryMeshBuilderBase.C.

Referenced by AssemblyMeshGenerator::generate(), PinMeshGenerator::generate(), generate(), and CoreMeshGenerator::generate().

 {
   SubdomainID elem_block_id;
   if (name_id_map.find(elem_block_name) == name_id_map.end())
   {
     // Block name does not exist in mesh yet, assign new block id and name
     elem_block_id = next_free_id++;
     elem->subdomain_id() = elem_block_id;
     input_mesh.subdomain_name(elem_block_id) = elem_block_name;
     name_id_map[elem_block_name] = elem_block_id;
   }
   else
   {
     // Block name exists in mesh, reuse block id
     elem_block_id = name_id_map[elem_block_name];
     elem->subdomain_id() = elem_block_id;
   }
 
   input_mesh.unset_has_cached_elem_data();
 }

◆ validParams()

InputParameters ControlDrumMeshGenerator::validParams ( )

static

Definition at line 23 of file ControlDrumMeshGenerator.C.

 {
   auto params = ReactorGeometryMeshBuilderBase::validParams();
 
   params.addRequiredParam<MeshGeneratorName>(
       "reactor_params",
       "The ReactorMeshParams MeshGenerator that is the basis for this component mesh.");
   params.addRequiredParam<subdomain_id_type>(
       "assembly_type",
       "The assembly type integer ID to use for this control drum definition. "
       "This parameter should be uniquely defined for each ControlDrumMeshGenerator "
       "and AssemblyMeshGenerator structure in the RGMB workflow.");
   params.addParam<bool>("extrude",
                         false,
                         "Determines if this is the final step in the geometry construction"
                         " and extrudes the 2D geometry to 3D. If this is true then this mesh "
                         "cannot be used in further mesh building in the Reactor workflow");
   params.addRequiredRangeCheckedParam<Real>(
       "drum_inner_radius", "drum_inner_radius>0", "Inner radius of drum region");
   params.addRequiredRangeCheckedParam<Real>(
       "drum_outer_radius", "drum_outer_radius>0", "Outer radius of drum region");
   params.addRangeCheckedParam<unsigned int>(
       "drum_inner_intervals",
       1,
       "drum_inner_intervals>0",
       "Number of radial mesh intervals in region up to inner drum radius");
   params.addRangeCheckedParam<unsigned int>(
       "drum_intervals", 1, "drum_intervals>0", "Number of radial mesh intervals in drum region");
   params.addRangeCheckedParam<Real>("pad_start_angle",
                                     "pad_start_angle>=0 & pad_start_angle < 360",
                                     "Starting angle of drum pad region");
   params.addRangeCheckedParam<Real>(
       "pad_end_angle", "pad_end_angle>0 & pad_end_angle < 720", "Ending angle of drum pad region");
   params.addRequiredRangeCheckedParam<unsigned int>(
       "num_azimuthal_sectors",
       "num_azimuthal_sectors>2",
       "Number of azimuthal sectors to sub-divide the drum region into");
   params.addRequiredParam<std::vector<std::vector<subdomain_id_type>>>(
       "region_ids",
       "IDs for each radial and axial zone for assignment of region_id extra element "
       "id. "
       "Inner indexing is radial zones (drum inner/drum/drum outer), outer indexing is axial");
   params.addParam<std::vector<std::vector<std::string>>>(
       "block_names",
       "Block names for each radial and axial zone. "
       "Inner indexing is radial zones (drum inner/drum/drum outer), outer indexing is axial");
   params.addParam<Real>("azimuthal_node_tolerance",
                         0.1,
                         "(in degrees) The absolute tolerance for which to shift an azimuthal node "
                         "to match the pad start/end angles");
 
   params.addParamNamesToGroup("region_ids assembly_type", "ID assigment");
   params.addParamNamesToGroup("drum_inner_radius drum_outer_radius drum_inner_intervals "
                               "drum_intervals num_azimuthal_sectors",
                               "Drum specifications");
   params.addParamNamesToGroup("pad_start_angle pad_end_angle azimuthal_node_tolerance",
                               "Control pad specifications");
 
   params.addClassDescription(
       "This ControlDrumMeshGenerator object is designed to generate "
       "drum-like structures, with IDs, from a reactor geometry. "
       "These structures can be used directly within CoreMeshGenerator to stitch"
       "control drums into a core lattice alongside AssemblyMeshGenerator structures");
   // depletion id generation params are added
   addDepletionIDParams(params);
 
   return params;
 }

Member Data Documentation

◆ _assembly_type

const subdomain_id_type ControlDrumMeshGenerator::_assembly_type

protected

The id number for the type of the assembly.

Definition at line 42 of file ControlDrumMeshGenerator.h.

Referenced by ControlDrumMeshGenerator(), generate(), and generateMetadata().

◆ _block_names

std::vector<std::vector<std::string> > ControlDrumMeshGenerator::_block_names

protected

2-D vector (axial outer indexing, radial inner indexing) used to set block names of pin mesh elements

Definition at line 60 of file ControlDrumMeshGenerator.h.

Referenced by ControlDrumMeshGenerator(), generate(), and generateMetadata().

◆ _build_mesh

std::unique_ptr<MeshBase>* ControlDrumMeshGenerator::_build_mesh

protected

The final mesh that is generated by the subgenerators; This mesh is generated by the subgenerators with only element and boundary IDs changed.

Definition at line 73 of file ControlDrumMeshGenerator.h.

Referenced by ControlDrumMeshGenerator(), and generate().

◆ _drum_inner_radius

const Real ControlDrumMeshGenerator::_drum_inner_radius

protected

The inner radius of drum region.

Definition at line 45 of file ControlDrumMeshGenerator.h.

Referenced by ControlDrumMeshGenerator(), and generateMetadata().

◆ _drum_outer_radius

const Real ControlDrumMeshGenerator::_drum_outer_radius

protected

The outer radius of drum region.

Definition at line 48 of file ControlDrumMeshGenerator.h.

Referenced by ControlDrumMeshGenerator(), and generateMetadata().

◆ _extrude

const bool ControlDrumMeshGenerator::_extrude

protected

Whether this mesh should be extruded to 3-D, making it the final structure in the reactor mesh.

Definition at line 51 of file ControlDrumMeshGenerator.h.

Referenced by ControlDrumMeshGenerator(), generate(), and generateMetadata().

◆ _geom_type

std::string ControlDrumMeshGenerator::_geom_type

protected

The type of geometry that is being described (Square or Hex, declared in the ReactorMeshParams object)

Definition at line 36 of file ControlDrumMeshGenerator.h.

Referenced by ControlDrumMeshGenerator().

◆ _has_block_names

bool ControlDrumMeshGenerator::_has_block_names

protected

Whether block names have been provided by user.

Definition at line 57 of file ControlDrumMeshGenerator.h.

Referenced by ControlDrumMeshGenerator(), and generate().

◆ _has_pad_region

bool ControlDrumMeshGenerator::_has_pad_region

protected

Whether pad start and end angles are provided by user.

Definition at line 69 of file ControlDrumMeshGenerator.h.

Referenced by ControlDrumMeshGenerator(), generateMetadata(), and getDrumIdxFromRadialIdx().

◆ _mesh_dimensions

unsigned int ControlDrumMeshGenerator::_mesh_dimensions

protected

The number of dimensions the mesh is ultimately going to have (2 or 3, declared in the ReactorMeshParams object)

Definition at line 39 of file ControlDrumMeshGenerator.h.

Referenced by ControlDrumMeshGenerator(), and generateMetadata().

◆ _pad_end_angle

Real ControlDrumMeshGenerator::_pad_end_angle

protected

Ending angle of drum pad region.

Definition at line 66 of file ControlDrumMeshGenerator.h.

Referenced by ControlDrumMeshGenerator(), generateMetadata(), and getDrumIdxFromRadialIdx().

◆ _pad_start_angle

Real ControlDrumMeshGenerator::_pad_start_angle

protected

Starting angle of drum pad region.

Definition at line 63 of file ControlDrumMeshGenerator.h.

Referenced by ControlDrumMeshGenerator(), generateMetadata(), and getDrumIdxFromRadialIdx().

◆ _reactor_params

MeshGeneratorName ReactorGeometryMeshBuilderBase::_reactor_params

protectedinherited

The ReactorMeshParams object that is storing the reactor global information for this reactor geometry mesh.

Definition at line 261 of file ReactorGeometryMeshBuilderBase.h.

Referenced by ReactorGeometryMeshBuilderBase::getReactorParam(), ReactorGeometryMeshBuilderBase::hasReactorParam(), and ReactorGeometryMeshBuilderBase::initializeReactorMeshParams().

◆ _region_ids

std::vector<std::vector<subdomain_id_type> > ControlDrumMeshGenerator::_region_ids

protected

2-D vector (axial outer indexing, radial inner indexing) used to set "region_id" extra-element integer of the control drum mesh elements

Definition at line 54 of file ControlDrumMeshGenerator.h.

Referenced by ControlDrumMeshGenerator(), generate(), and generateMetadata().

The documentation for this class was generated from the following files:

reactor/include/meshgenerators/ControlDrumMeshGenerator.h
reactor/src/meshgenerators/ControlDrumMeshGenerator.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ DepletionIDGenerationLevel

Constructor & Destructor Documentation

◆ ControlDrumMeshGenerator()

Member Function Documentation

◆ addDepletionId()

◆ addDepletionIDParams()

◆ callExtrusionMeshSubgenerators()

◆ createRGMBLattice()

◆ freeReactorParamsCSG()

◆ freeReactorParamsMesh()

◆ generate()

◆ generateData()

◆ generateMetadata()

◆ getAxialPlaneSurfaces()

◆ getDrumIdxFromRadialIdx()

◆ getElemIntegerFromMesh()

◆ getOuterRadialSurfacesForUnitCell()

◆ getReactorParam()

◆ hasReactorParam()

◆ initializeReactorMeshParams()

◆ print2dMetadataToConsole()

◆ printAssemblyMetadata()

◆ printCoreMetadata()

◆ printGlobalReactorMetadata()

◆ printMetadataToConsole()

◆ printPinMetadata()

◆ printReactorMetadata()

◆ updateElementBlockNameId()

◆ validParams()

Member Data Documentation

◆ _assembly_type

◆ _block_names

◆ _build_mesh

◆ _drum_inner_radius

◆ _drum_outer_radius

◆ _extrude

◆ _geom_type

◆ _has_block_names

◆ _has_pad_region

◆ _mesh_dimensions

◆ _pad_end_angle

◆ _pad_start_angle

◆ _reactor_params

◆ _region_ids