BoxMarker.C File Reference

Go to the source code of this file.


InputParameters validParams< BoxMarker > ()

Function Documentation

Definition at line 19 of file BoxMarker.C.

20 {
23  "bottom_left", "The bottom left point (in x,y,z with spaces in-between).");
25  "top_right", "The bottom left point (in x,y,z with spaces in-between).");
27  MooseEnum marker_states = Marker::markerStates();
30  "inside", marker_states, "How to mark elements inside the box.");
32  "outside", marker_states, "How to mark elements outside the box.");
34  params.addClassDescription(
35  "Marks the region inside and outside of a 'box' domain for refinement or coarsening.");
36  return params;
37 }
InputParameters validParams< Marker >()
Definition: Marker.C:25
VectorValue< Real > RealVectorValue
Definition: Assembly.h:40
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...
static MooseEnum markerStates()
Helper function for getting the valid refinement flag states a marker can use as a MooseEnum...
Definition: Marker.C:72
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...