www.mooseframework.org
Classes | Functions
ValueRangeMarker.h File Reference

Go to the source code of this file.

Classes

class  ValueRangeMarker
 

Functions

template<>
InputParameters validParams< ValueRangeMarker > ()
 

Function Documentation

Definition at line 21 of file ValueRangeMarker.C.

22 {
24 
25  MooseEnum third_state("DONT_MARK=-1 COARSEN DO_NOTHING REFINE", "DONT_MARK");
26  params.addParam<MooseEnum>(
27  "third_state",
28  third_state,
29  "The Marker state to apply to values in the buffer zone (both ends of the range).");
30  params.addRequiredParam<Real>("lower_bound", "The lower bound value for the range.");
31  params.addRequiredParam<Real>("upper_bound", "The upper bound value for the range.");
32  params.addParam<Real>("buffer_size",
33  0.0,
34  "A buffer zone value added to both ends of the range "
35  "where a third_state marker can be returned.");
36  params.addParam<bool>("invert",
37  false,
38  "If this is true then values inside the range will be "
39  "coarsened, and values outside the range will be "
40  "refined.");
41  params.addRequiredCoupledVar("variable", "The variable whose values are used in this marker.");
42  params.addClassDescription("Mark elements for adaptivity based on the supplied upper and lower "
43  "bounds and the specified variable.");
44  return params;
45 }
InputParameters validParams< Marker >()
Definition: Marker.C:25
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 addRequiredCoupledVar(const std::string &name, const std::string &doc_string)
This method adds a coupled variable name pair.
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...