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

Go to the source code of this file.

Classes

class  ValueThresholdMarker
 

Functions

template<>
InputParameters validParams< ValueThresholdMarker > ()
 

Function Documentation

Definition at line 21 of file ValueThresholdMarker.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 falling in-between the coarsen and refine thresholds.");
30  params.addParam<Real>("coarsen",
31  "The threshold value for coarsening. Elements with variable "
32  "values beyond this will be marked for coarsening.");
33  params.addParam<Real>("refine",
34  "The threshold value for refinement. Elements with variable "
35  "values beyond this will be marked for refinement.");
36  params.addParam<bool>("invert",
37  false,
38  "If this is true then values _below_ 'refine' will be "
39  "refined and _above_ 'coarsen' will be coarsened.");
40  params.addRequiredCoupledVar("variable",
41  "The values of this variable will be compared to "
42  "'refine' and 'coarsen' to see what should be done with "
43  "the element");
44  params.addClassDescription(
45  "The the refinement state based on a threshold value compared to the specified variable.");
46  return params;
47 }
InputParameters validParams< Marker >()
Definition: Marker.C:25
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
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...