- extra_element_id_namesList of user-defined extra element ID names
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:List of user-defined extra element ID names
- extra_element_idsUser-defined extra element IDs corresponding to 'subdomains' in the same order
C++ Type:std::vector<std::vector<unsigned long>>
Unit:(no unit assumed)
Controllable:No
Description:User-defined extra element IDs corresponding to 'subdomains' in the same order
- 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
- subdomainsSubdomain names present in the input mesh
C++ Type:std::vector<SubdomainName>
Unit:(no unit assumed)
Controllable:No
Description:Subdomain names present in the input mesh
SubdomainExtraElementIDGenerator
Assign extra element IDs for elements on a mesh based on mesh subdomains.
Overview
The SubdomainExtraElementIDGenerator
assigns extra element IDs based on mesh subdomain IDs of an input mesh. If the extra element IDs do not exist in the input mesh, this mesh generator will add them. The "subdomains" parameter can accept both subdomain names and subdomain IDs. The "extra_element_ids" parameter is a two-dimensional vector separated by semicolon and then white space as normal MOOSE input syntax for two-dimensional vectors. Its first dimensionality must be equal to the size of the "extra_element_id_names" parameter and the size of each sub-vector must be equal to the size of the "subdomains" parameter.
Listing 1: A sample input for the extra_element_ids parameter
(contrib/moose/modules/reactor/test/tests/meshgenerators/subdomain_extra_element_id_generator/subdomain_elem_ids_test.i)In the above sample input, we have four subdomains listed in the "subdomains" parameter and three extra element id names in the "extra_element_id_names" parameter, thus we have two semicolons in "extra_element_ids" to separate the numbers into three groups for the three id names accordingly and each group has four numbers corresponding to the four subdomains.
Default element IDs can be provided through "default_extra_element_ids" for elements in subdomains that are not specified in the "subdomains" parameter. Because of this, "default_extra_element_ids" is active only when the "subdomains" parameter does not include all mesh subdomains.
If "default_extra_element_ids" is not set and "subdomains" does not contain all mesh subdomains, when the extra element IDs already existed in the mesh, the extra IDs for those elements of the missing subdomains will not be changed; or when the extra element IDs are newly added by this mesh generator, invalid IDs are set to elements of those missing subdomains.
Input Parameters
- default_extra_element_idsDefault extra element IDs for elements not in 'subdomains'
C++ Type:std::vector<unsigned long>
Unit:(no unit assumed)
Controllable:No
Description:Default extra element IDs for elements not in 'subdomains'
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)