A class to store mesh information that is globally applicable to a reactor. More...

#include <ReactorMeshParams.h>

Inheritance diagram for ReactorMeshParams:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	ReactorMeshParams (const InputParameters &parameters)

std::unique_ptr< MeshBase >	generate () override

std::unique_ptr< CSG::CSGBase >	generateCSG () 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 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 Member Functions
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
const MooseEnum	_dim
	The number of dimension in the mesh. More...

const MooseEnum	_geom
	The geometry type for the reactor. More...

const Real	_assembly_pitch
	The the flat-to-flat size of assemblies in the reactor. More...

std::vector< Real >	_axial_regions
	The heights of the axial regions. More...

std::vector< unsigned int >	_axial_mesh_intervals
	The number of mesh divisions in each axial region. More...

boundary_id_type	_top_boundary
	Boundary id assigned to top boundary of extruded mesh. More...

boundary_id_type	_bottom_boundary
	Boundary id assigned to bottom boundary of extruded mesh. More...

boundary_id_type	_radial_boundary
	Boundary id assigned to outer radial boundary of core 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

A class to store mesh information that is globally applicable to a reactor.

Definition at line 18 of file ReactorMeshParams.h.

Constructor & Destructor Documentation

◆ ReactorMeshParams()

ReactorMeshParams::ReactorMeshParams ( const InputParameters & parameters )

Definition at line 67 of file ReactorMeshParams.C.

   : MeshGenerator(parameters),
     _dim(getParam<MooseEnum>("dim")),
     _geom(getParam<MooseEnum>("geom")),
     _assembly_pitch(getParam<Real>("assembly_pitch"))
 {
   if ((unsigned int)(_dim) == 2)
   {
     std::vector<std::string> invalid_params = {
         "axial_regions", "axial_mesh_intervals", "top_boundary_id", "bottom_boundary_id"};
     for (const auto & param : invalid_params)
       if (isParamValid(param))
         paramError(param, param + " should not be defined for 2-D meshes");
   }
   else
   {
     _axial_regions = getParam<std::vector<Real>>("axial_regions");
     _axial_mesh_intervals = getParam<std::vector<unsigned int>>("axial_mesh_intervals");
 
     if (_axial_regions.size() != _axial_mesh_intervals.size())
       mooseError(
           "The number of axial regions is not consistent with the number of axial intervals.");
     this->declareMeshProperty(RGMB::axial_mesh_sizes, _axial_regions);
     this->declareMeshProperty(RGMB::axial_mesh_intervals, _axial_mesh_intervals);
   }
 
   this->declareMeshProperty(RGMB::mesh_dimensions, (unsigned int)std::stoul(_dim));
   this->declareMeshProperty(RGMB::mesh_geometry, std::string(_geom));
   this->declareMeshProperty(RGMB::assembly_pitch, _assembly_pitch);
   this->declareMeshProperty(RGMB::region_id_as_block_name,
                             getParam<bool>(RGMB::region_id_as_block_name));
 
   const bool flexible_assembly_stitching = getParam<bool>(RGMB::flexible_assembly_stitching);
   this->declareMeshProperty(RGMB::flexible_assembly_stitching, flexible_assembly_stitching);
   if (flexible_assembly_stitching)
     this->declareMeshProperty(RGMB::num_sectors_flexible_stitching,
                               getParam<unsigned int>("num_sectors_at_flexible_boundary"));
   if (parameters.isParamSetByUser("num_sectors_at_flexible_boundary") &&
       !flexible_assembly_stitching)
     paramWarning(
         "num_sectors_at_flexible_boundary",
         "This parameter is only relevant when ReactorMeshParams/flexible_assembly_stitching is set "
         "to true. This value will be ignored");
 
   // Option to bypass mesh generation depends on whether the current generator is in data only mode
   bool bypass_meshgen = isDataOnly();
   this->declareMeshProperty(RGMB::bypass_meshgen, bypass_meshgen);
 
   if (isParamValid("top_boundary_id"))
   {
     _top_boundary = getParam<boundary_id_type>("top_boundary_id");
     this->declareMeshProperty(RGMB::top_boundary_id, _top_boundary);
   }
   if (isParamValid("bottom_boundary_id"))
   {
     _bottom_boundary = getParam<boundary_id_type>("bottom_boundary_id");
     this->declareMeshProperty(RGMB::bottom_boundary_id, _bottom_boundary);
   }
   if (isParamValid("radial_boundary_id"))
   {
     _radial_boundary = getParam<boundary_id_type>("radial_boundary_id");
     this->declareMeshProperty(RGMB::radial_boundary_id, _radial_boundary);
     if (isParamValid("top_boundary_id") && _radial_boundary == _top_boundary)
       mooseError("top_boundary_id and radial_boundary_id must be unique values");
     if (isParamValid("bottom_boundary_id") && _radial_boundary == _bottom_boundary)
       mooseError("bottom_boundary_id and radial_boundary_id must be unique values");
   }
   if (isParamValid("top_boundary_id") && isParamValid("bottom_boundary_id") &&
       (_bottom_boundary == _top_boundary))
     mooseError("top_boundary_id and bottom_boundary_id must be unique values");
 }

Member Function Documentation

◆ generate()

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

overridevirtual

Implements MeshGenerator.

Definition at line 140 of file ReactorMeshParams.C.

 {
   // If mesh generation is requested and bypass_mesh is true, return a null mesh. generate()
   // mesh should not be called with this option specified
   if (getMeshProperty<bool>(RGMB::bypass_meshgen))
   {
     auto null_mesh = nullptr;
     return null_mesh;
   }
   auto mesh = buildMeshBaseObject();
   return dynamic_pointer_cast<MeshBase>(mesh);
 }

◆ generateCSG()

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

overridevirtual

Reimplemented from MeshGenerator.

Definition at line 154 of file ReactorMeshParams.C.

 {
   // This MeshGenerator does not produce a mesh, therefore return an empty CSGBase object
   return std::make_unique<CSG::CSGBase>();
 }

◆ generateData()

void ReactorMeshParams::generateData ( )

inlineoverridevirtual

Reimplemented from MeshGenerator.

Definition at line 29 of file ReactorMeshParams.h.

29 {};

◆ validParams()

InputParameters ReactorMeshParams::validParams ( )

static

Definition at line 25 of file ReactorMeshParams.C.

 {
   InputParameters params = MeshGenerator::validParams();
   MooseEnum dims("2=2 3", "2");
   params.addRequiredParam<MooseEnum>("dim", dims, "The dimension of the mesh to be generated");
 
   MooseEnum geoms("Square Hex", "Square");
   params.addRequiredParam<MooseEnum>("geom", geoms, "The geometry type of the reactor mesh");
 
   params.addRequiredParam<Real>("assembly_pitch", "Center to center distance of assemblies");
   params.addParam<boundary_id_type>("top_boundary_id",
                                     "The boundary ID to set on top boundary of the extruded mesh");
   params.addParam<boundary_id_type>(
       "bottom_boundary_id", "The boundary ID to set on bottom boundary of the extruded mesh");
   params.addParam<boundary_id_type>(
       "radial_boundary_id",
       "The boundary ID to set on the outer radial boundary of a CoreMeshGenerator object");
   params.addParam<std::vector<Real>>("axial_regions", "Length of each axial region");
   params.addParam<std::vector<unsigned int>>(
       "axial_mesh_intervals",
       "Number of elements in the Z direction for each axial region");
   params.addParam<bool>("region_id_as_block_name", false, "Set block names based on region id");
   params.addParam<bool>(
       "flexible_assembly_stitching",
       false,
       "Use FlexiblePatternGenerator for stitching dissimilar assemblies together");
   params.addRangeCheckedParam<unsigned int>(
       "num_sectors_at_flexible_boundary",
       6,
       "num_sectors_at_flexible_boundary>2",
       "Number of sectors to use at assembly boundary interface when flexible patterning is used "
       "(Defaults to 6)");
   params.addClassDescription("This ReactorMeshParams object acts as storage for persistent "
                              "information about the reactor geometry.");
 
   // Declare that this generator has a generateData method
   MeshGenerator::setHasGenerateData(params);
   // Declare that this generator has a generateCSG method
   MeshGenerator::setHasGenerateCSG(params);
   return params;
 }

Member Data Documentation

◆ _assembly_pitch

const Real ReactorMeshParams::_assembly_pitch

protected

The the flat-to-flat size of assemblies in the reactor.

Definition at line 39 of file ReactorMeshParams.h.

Referenced by ReactorMeshParams().

◆ _axial_mesh_intervals

std::vector<unsigned int> ReactorMeshParams::_axial_mesh_intervals

protected

The number of mesh divisions in each axial region.

Definition at line 45 of file ReactorMeshParams.h.

Referenced by ReactorMeshParams().

◆ _axial_regions

std::vector<Real> ReactorMeshParams::_axial_regions

protected

The heights of the axial regions.

Definition at line 42 of file ReactorMeshParams.h.

Referenced by ReactorMeshParams().

◆ _bottom_boundary

boundary_id_type ReactorMeshParams::_bottom_boundary

protected

Boundary id assigned to bottom boundary of extruded mesh.

Definition at line 51 of file ReactorMeshParams.h.

Referenced by ReactorMeshParams().

◆ _dim

const MooseEnum ReactorMeshParams::_dim

protected

The number of dimension in the mesh.

Definition at line 29 of file ReactorMeshParams.h.

Referenced by ReactorMeshParams().

◆ _geom

const MooseEnum ReactorMeshParams::_geom

protected

The geometry type for the reactor.

Definition at line 36 of file ReactorMeshParams.h.

Referenced by ReactorMeshParams().

◆ _radial_boundary

boundary_id_type ReactorMeshParams::_radial_boundary

protected

Boundary id assigned to outer radial boundary of core mesh.

Definition at line 54 of file ReactorMeshParams.h.

Referenced by ReactorMeshParams().

◆ _top_boundary

boundary_id_type ReactorMeshParams::_top_boundary

protected

Boundary id assigned to top boundary of extruded mesh.

Definition at line 48 of file ReactorMeshParams.h.

Referenced by ReactorMeshParams().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ReactorMeshParams()

Member Function Documentation

◆ generate()

◆ generateCSG()

◆ generateData()

◆ validParams()

Member Data Documentation

◆ _assembly_pitch

◆ _axial_mesh_intervals

◆ _axial_regions

◆ _bottom_boundary

◆ _dim

◆ _geom

◆ _radial_boundary

◆ _top_boundary