- old_block_nameElements with this block name will be given the new_block_number or new_block_name. You must supply either old_block_id or old_block_name. You may supply a vector of old_block_name, in which case the new_block information must also be a vector.
C++ Type:std::vector
Description:Elements with this block name will be given the new_block_number or new_block_name. You must supply either old_block_id or old_block_name. You may supply a vector of old_block_name, in which case the new_block information must also be a vector.
- old_block_idElements with this block number will be given the new_block_number or new_block_name. You must supply either old_block_id or old_block_name. You may supply a vector of old_block_id, in which case the new_block information must also be a vector.
C++ Type:std::vector
Description:Elements with this block number will be given the new_block_number or new_block_name. You must supply either old_block_id or old_block_name. You may supply a vector of old_block_id, in which case the new_block information must also be a vector.
- force_prepareFalseNormally all MeshModifiers run before the mesh is prepared for use. This flag can be set on an individual modifier to force preperation between modifiers where they might be needed.
Default:False
C++ Type:bool
Description:Normally all MeshModifiers run before the mesh is prepared for use. This flag can be set on an individual modifier to force preperation between modifiers where they might be needed.
- depends_onThe MeshModifiers that this modifier relies upon (i.e. must execute before this one)
C++ Type:std::vector
Description:The MeshModifiers that this modifier relies upon (i.e. must execute before this one)
- new_block_idElements with the old block number (or name) will be given this block number. If the old blocks are named, their names will be passed onto the newly numbered blocks.
C++ Type:std::vector
Description:Elements with the old block number (or name) will be given this block number. If the old blocks are named, their names will be passed onto the newly numbered blocks.
- new_block_nameElements with the old block number (or name) will be given this block name. No change of block ID is performed, unless multiple old blocks are given the same name, in which case they are all given the first old block number.
C++ Type:std::vector
Description:Elements with the old block number (or name) will be given this block name. No change of block ID is performed, unless multiple old blocks are given the same name, in which case they are all given the first old block number.
RenameBlock
RenameBlock re-numbers or re-names an old_block_id or old_block_name with a new_block_id or new_block_name. If using RenameBlock to merge blocks (by giving them the same name, for instance) it is advisable to specify all your blocks in old_blocks to avoid inconsistencies
RenameBlock is usually used to provide meaningful names to blocks so that input files are easier to read. For instance
old_block_id = '1 2 3'
new_block_name = 'wheel engine axle'
Then the MOOSE input file can employ block = wheel rather than block = 1. RenameBlock may also be to provide more meaningful names to mesh blocks that are already named. For instance
old_block_name = 'silly meaningless crazy'
new_block_name = 'wheel engine axle'
Then the MOOSE input file can employ block = axle rather than block = crazy.
RenameBlock may also be used to merge blocks, but care must be taken.
For instance
old_block_id = '1 2 3'
new_block_id = '4 4 4'
Then blocks 1, 2 and 3 will be merged together into one block that may be used in the remainder of the input file. However, when merging blocks problems and even inconsistencies can occur.
Firstly, in the example just given, what if the blocks 1, 2 and 3 were named? What should the name of the block 4 be? The convention is that it is the name of the first old block that is given the block ID of 4, which is the name of the old block 1 in this case. The user needs to be aware of this convention. Similarly, if old_block_name = 'oldA oldB' and new_block_name = 'new1 new1', then the block ID of new1 is the block ID of oldA.
Secondly, in the example above, what if block 4 already existed? An inconsistency could arise in the input file, because block 4 is now given the name of the old block 1.
Thirdly, in this example old_block_id = '1 2' and new_block_name = 'wheel wheel'
what if another block, with a different ID, already had the name "wheel"? This can lead to great confusion in the MOOSE input file.
Given all these potential problems, when merging blocks it is strongly recommended to use just one** RenameBlock that includes the names or IDs of all** the blocks involved in the merging. This will make the new block IDs and new block names unequivocally obvious.
Input Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Description:Set the enabled status of the MooseObject.