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

Go to the source code of this file.

Classes

class  ErrorFractionMarker
 

Functions

template<>
InputParameters validParams< ErrorFractionMarker > ()
 

Function Documentation

Definition at line 21 of file ErrorFractionMarker.C.

22 {
24  params.addRangeCheckedParam<Real>("coarsen",
25  0,
26  "coarsen>=0 & coarsen<=1",
27  "Elements within this percentage of the min error "
28  "will be coarsened. Must be between 0 and 1!");
29  params.addRangeCheckedParam<Real>("refine",
30  0,
31  "refine>=0 & refine<=1",
32  "Elements within this percentage of the max error will "
33  "be refined. Must be between 0 and 1!");
34 
35  params.addParam<bool>("clear_extremes",
36  true,
37  "Whether or not to clear the extremes during each error calculation. "
38  " Changing this to `false` will result in the global extremes ever "
39  "encountered during the run to be used as the min and max error.");
40 
41  params.addClassDescription("Marks elements for refinement or coarsening based on the fraction of "
42  "the min/max error from the supplied indicator.");
43  return params;
44 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< IndicatorMarker >()
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...
void addRangeCheckedParam(const std::string &name, const T &value, const std::string &parsed_function, const std::string &doc_string)