www.mooseframework.org
Functions
SetupMeshAction.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< SetupMeshAction > ()
 

Function Documentation

Definition at line 24 of file SetupMeshAction.C.

25 {
27  params.set<std::string>("type") = "FileMesh";
28 
29  params.addParam<bool>("second_order",
30  false,
31  "Converts a first order mesh to a second order "
32  "mesh. Note: This is NOT needed if you are reading "
33  "an actual first order mesh.");
34 
35  params.addParam<std::vector<SubdomainID>>("block_id", "IDs of the block id/name pairs");
36  params.addParam<std::vector<SubdomainName>>(
37  "block_name", "Names of the block id/name pairs (must correspond with \"block_id\"");
38 
39  params.addParam<std::vector<BoundaryID>>("boundary_id", "IDs of the boundary id/name pairs");
40  params.addParam<std::vector<BoundaryName>>(
41  "boundary_name", "Names of the boundary id/name pairs (must correspond with \"boundary_id\"");
42 
43  params.addParam<bool>("construct_side_list_from_node_list",
44  false,
45  "If true, construct side lists from the nodesets in the mesh (i.e. if "
46  "every node on a give side is in a nodeset then add that side to a "
47  "sideset");
48 
49  params.addParam<std::vector<std::string>>(
50  "displacements",
51  "The variables corresponding to the x y z displacements of the mesh. If "
52  "this is provided then the displacements will be taken into account during "
53  "the computation.");
54  params.addParam<std::vector<BoundaryName>>("ghosted_boundaries",
55  "Boundaries to be ghosted if using Nemesis");
56  params.addParam<std::vector<Real>>("ghosted_boundaries_inflation",
57  "If you are using ghosted boundaries you will want to set "
58  "this value to a vector of amounts to inflate the bounding "
59  "boxes by. ie if you are running a 3D problem you might set "
60  "it to '0.2 0.1 0.4'");
61 
62  params.addParam<unsigned int>(
63  "uniform_refine", 0, "Specify the level of uniform refinement applied to the initial mesh");
64  params.addParam<bool>("skip_partitioning",
65  false,
66  "If true the mesh won't be partitioned. This may cause large load "
67  "imbalanced but is currently required if you "
68  "have a simulation containing uniform refinement, adaptivity and stateful "
69  "material properties");
70 
71  // groups
72  params.addParamNamesToGroup("displacements ghosted_boundaries ghosted_boundaries_inflation",
73  "Advanced");
74  params.addParamNamesToGroup("second_order construct_side_list_from_node_list skip_partitioning",
75  "Advanced");
76  params.addParamNamesToGroup("block_id block_name boundary_id boundary_name", "Add Names");
77 
78  return params;
79 }
T & set(const std::string &name, bool quiet_mode=false)
Returns a writable reference to the named parameters.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< MooseObjectAction >()
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...
void addParamNamesToGroup(const std::string &space_delim_names, const std::string group_name)
This method takes a space delimited list of parameter names and adds them to the specified group name...