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

Go to the source code of this file.

Classes

class  ComboMarker
 

Functions

template<>
InputParameters validParams< ComboMarker > ()
 Combines multiple marker fields. More...
 

Function Documentation

Combines multiple marker fields.

The most conservative wins.

Definition at line 19 of file ComboMarker.C.

20 {
22  params.addRequiredParam<std::vector<MarkerName>>(
23  "markers", "A list of marker names to combine into a single marker.");
24  params.addClassDescription("A marker that converts many markers into a single marker by "
25  "considering the maximum value of the listed markers (i.e., "
26  "refinement takes precedent).");
27  return params;
28 }
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...
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...