www.mooseframework.org
Functions
RenameBlock.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< RenameBlock > ()
 

Function Documentation

Definition at line 20 of file RenameBlock.C.

21 {
23  params.addParam<std::vector<SubdomainID>>(
24  "old_block_id",
25  "Elements with this block number will be given the new_block_number or "
26  "new_block_name. You must supply either old_block_id or old_block_name. "
27  "You may supply a vector of old_block_id, in which case the new_block "
28  "information must also be a vector.");
29  params.addParam<std::vector<SubdomainName>>(
30  "old_block_name",
31  "Elements with this block name will be given the new_block_number or "
32  "new_block_name. You must supply either old_block_id or old_block_name. "
33  "You may supply a vector of old_block_name, in which case the new_block "
34  "information must also be a vector.");
35  params.addParam<std::vector<SubdomainID>>(
36  "new_block_id",
37  "Elements with the old block number (or name) will be given this block "
38  "number. You must supply either new_block_id or new_block_name. You may "
39  "supply a vector of new_block_id, in which case the old_block information "
40  "must also be a vector.");
41  params.addParam<std::vector<SubdomainName>>(
42  "new_block_name",
43  "Elements with the old block number (or name) will be given this block "
44  "name. You must supply either new_block_id or new_block_name. You may "
45  "supply a vector of new_block_id, in which case the old_block information "
46  "must also be a vector.");
47  params.addClassDescription("RenameBlock re-numbers or re-names an old_block_id or old_block_name "
48  "with a new_block_id or new_block_name");
49  return params;
50 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...
InputParameters validParams< MeshModifier >()
Definition: MeshModifier.C:20