www.mooseframework.org
Functions
SubdomainBoundingBox.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< SubdomainBoundingBox > ()
 

Function Documentation

Definition at line 21 of file SubdomainBoundingBox.C.

22 {
23  MooseEnum location("INSIDE OUTSIDE", "INSIDE");
24 
26  params.addClassDescription("Changes the subdomain ID of elements either (XOR) inside or outside "
27  "the specified box to the specified ID.");
29  "bottom_left", "The bottom left point (in x,y,z with spaces in-between).");
31  "top_right", "The bottom left point (in x,y,z with spaces in-between).");
32  params.addRequiredParam<SubdomainID>("block_id",
33  "Subdomain id to set for inside/outside the bounding box");
34  params.addParam<SubdomainName>(
35  "block_name", "Subdomain name to set for inside/outside the bounding box (optional)");
36  params.addParam<MooseEnum>(
37  "location", location, "Control of where the subdomain id is to be set");
38 
39  return params;
40 }
VectorValue< Real > RealVectorValue
Definition: Assembly.h:40
subdomain_id_type SubdomainID
Definition: MooseTypes.h:77
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:37
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