# RenameBoundaryGenerator

RenameBoundaryGenerator re-numbers or re-names an old_boundary_id or old_boundary_name with a new_boundary_id or new_boundary_name. If using RenameBoundaryGenerator to merge boundaries (by giving them the same name, for instance) it is advisable to specify all your boundaries in old_boundaries to avoid inconsistencies

RenameBoundaryGenerator is usually used to provide meaningful names to boundaries. For instance


old_boundary_id = '1 2 3'
new_boundary_name = 'right top left'


Then the MOOSE input file can employ boundary = right rather than boundary = 1. RenameBoundaryGenerator may also be used to provide more meaningful names to boundaries that are already named. For instance


old_boundary_name = 'silly meaningless crazy'
new_boundary_name = 'right top left'


Then the MOOSE input file can employ boundary = left rather than block = crazy.

warning

RenameBoundaryGenerator may also be used to merge boudaries, but care must be taken.

For instance


old_boundary_id = '1 2 3'
new_boundary_id = '4 4 4'


Then boudaries 1, 2 and 3 will be merged together into one boundary that may be used in the remainder of the input file. However, when merging boundaries problems and even inconsistencies can occur.

Firstly, in the example just given, what if the boundaries 1, 2 and 3 were named? What should the name of the boundary 4 be? The convention is that it is the name of the first old boundary that is given the boundary ID of 4, which is the name of the old boundary 1 in this case. The user needs to be aware of this convention. Similarly, if old_boundary_name = 'oldA oldB' and new_boundary_name = 'new1 new1', then the boundary ID of new1 is the boundary ID of oldA.

Secondly, in the example above, what if boundary 4 already existed? An inconsistency could arise in the input file, because boundary 4 is now given the name of the old boundary 1.

Thirdly, in this example old_boundary_id = '1 2' and new_boundary_name = 'wheel wheel'

what if another boundary, with a different ID, already had the name "wheel"? This can lead to great confusion in the MOOSE input file.

note

Given all these potential problems, when merging boundaries it is strongly recommended to use just one** RenameBoundaryGenerator that includes the names or IDs of all** the boundaries involved in the merging. This will make the new boundary IDs and new boundary names unequivocally obvious.

## Input Parameters

• inputThe mesh we want to modify

C++ Type:MeshGeneratorName

Options:

Description:The mesh we want to modify

### Required Parameters

• old_boundary_idElements with this boundary number will be given the new_boundary_number or new_boundary_name. You must supply either old_boundary_id or old_boundary_name. You may supply a vector of old_boundary_id, in which case the new_boundary information must also be a vector.

C++ Type:std::vector

Options:

Description:Elements with this boundary number will be given the new_boundary_number or new_boundary_name. You must supply either old_boundary_id or old_boundary_name. You may supply a vector of old_boundary_id, in which case the new_boundary information must also be a vector.

• new_boundary_idElements with the old boundary number (or name) will be given this boundary number. If the old boundaries are named, their names will be passed onto the newly numbered boundarys.

C++ Type:std::vector

Options:

Description:Elements with the old boundary number (or name) will be given this boundary number. If the old boundaries are named, their names will be passed onto the newly numbered boundarys.

• new_boundary_nameElements with the old boundary number (or name) will be given this boundary name. No change of boundary ID is performed, unless multiple old boundaries are given the same name, in which case they are all given the first old boundary number.

C++ Type:std::vector

Options:

Description:Elements with the old boundary number (or name) will be given this boundary name. No change of boundary ID is performed, unless multiple old boundaries are given the same name, in which case they are all given the first old boundary number.

• old_boundary_nameElements with this boundary name will be given the new_boundary_number or new_boundary_name. You must supply either old_boundary_id or old_boundary_name. You may supply a vector of old_boundary_name, in which case the new_boundary information must also be a vector.

C++ Type:std::vector

Options:

Description:Elements with this boundary name will be given the new_boundary_number or new_boundary_name. You must supply either old_boundary_id or old_boundary_name. You may supply a vector of old_boundary_name, in which case the new_boundary information must also be a vector.

### Optional Parameters

• control_tagsAdds user-defined labels for accessing object parameters via control logic.

C++ Type:std::vector

Options:

Description:Adds user-defined labels for accessing object parameters via control logic.

• enableTrueSet the enabled status of the MooseObject.

Default:True

C++ Type:bool

Options:

Description:Set the enabled status of the MooseObject.