- inputName of an existing mesh generator to which we assign element IDs
C++ Type:MeshGeneratorName
Unit:(no unit assumed)
Controllable:No
Description:Name of an existing mesh generator to which we assign element IDs
DepletionIDGenerator
This DepletionIDGenerator source code is to assign depletion IDs for elements on a mesh based on material and other extra element IDs.
Overview
DepletionIDGenerator
object generates and assigns depletion IDs (extra element integers) on a mesh by finding unique combinations of reporting and material IDs. For a pin-level depletion case, the individual pins can be identified by the pin and assembly IDs, and the detailed depletion regions within a pin can be further divided by material IDs. For assembly-wise depletion, the user can set up the depletion IDs by combining the assembly and material IDs. Once the detailed depletion regions are determined, depletion IDs are uniquely assigned to those resulting regions.
Depletion ID Control
"id_name" lists extra element integer ID names used for setting up the depletion zones. Note that the material ID does not need to be defined in the list because it is included by default. A depletion zone (elements with the same depletion id) is always covered by one material region (elements with the same material id). The level of details in depletion zones can be controlled by the extra element integer IDs defined in "id_name". Any different combination of extra element integer IDs is considered a unique depletion zone.
For example, one can set up pin-by-pin and axial layer-by-layer arrangement of depletion zone by specifying those three reporting IDs: pin, assembly and plane IDs.
An alternative extra element integer ID name for the material ID can be optionally specified in "material_id_name". Its default value is set to material_id.
A list of extra element integer ID can be provided in "exclude_id_name" and "exclude_id_value" to exclude certain domains from being assigned depletion IDs. For those domains specified in "exclude_id_name" and "exclude_id_value", the depletion ID is set to zero because the depletion ID must be assigned for every mesh element even if not used in the actual depletion calculation.
Example Syntax
(contrib/moose/modules/reactor/test/tests/meshgenerators/reporting_id/depletion_id/depletion_id.i)Input Parameters
- exclude_id_nameExtra ID names that need to be excluded in the depletion ID generation
C++ Type:std::vector<ExtraElementIDName>
Unit:(no unit assumed)
Controllable:No
Description:Extra ID names that need to be excluded in the depletion ID generation
- exclude_id_valueExtra ID values corresponding to names defined in `exclude_id_name`
C++ Type:std::vector<std::vector<unsigned long>>
Unit:(no unit assumed)
Controllable:No
Description:Extra ID values corresponding to names defined in `exclude_id_name`
- exclude_material_idDefine a list of material IDs to be excluded in the depletion ID generation
C++ Type:std::vector<unsigned long>
Unit:(no unit assumed)
Controllable:No
Description:Define a list of material IDs to be excluded in the depletion ID generation
- id_nameExtra integer id names
C++ Type:std::vector<ExtraElementIDName>
Unit:(no unit assumed)
Controllable:No
Description:Extra integer id names
- material_id_namematerial_idMaterial id name
Default:material_id
C++ Type:ExtraElementIDName
Unit:(no unit assumed)
Controllable:No
Description:Material id name
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Set the enabled status of the MooseObject.
- save_with_nameKeep the mesh from this mesh generator in memory with the name specified
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:Keep the mesh from this mesh generator in memory with the name specified
Advanced Parameters
- nemesisFalseWhether or not to output the mesh file in the nemesisformat (only if output = true)
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether or not to output the mesh file in the nemesisformat (only if output = true)
- outputFalseWhether or not to output the mesh file after generating the mesh
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether or not to output the mesh file after generating the mesh
- show_infoFalseWhether or not to show mesh info after generating the mesh (bounding box, element types, sidesets, nodesets, subdomains, etc)
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether or not to show mesh info after generating the mesh (bounding box, element types, sidesets, nodesets, subdomains, etc)