www.mooseframework.org
UniformMarker.C
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 #include "UniformMarker.h"
16 
17 template <>
20 {
22  MooseEnum marker_states = Marker::markerStates();
23 
24  params.addRequiredParam<MooseEnum>("mark", marker_states, "How to mark elements.");
25  params.addClassDescription("Uniformly mark all elements for refinement or coarsening.");
26  return params;
27 }
28 
30  : Marker(parameters), _mark((MarkerValue)(int)parameters.get<MooseEnum>("mark"))
31 {
32 }
33 
36 {
37  return _mark;
38 }
InputParameters validParams< Marker >()
Definition: Marker.C:25
InputParameters validParams< UniformMarker >()
Definition: UniformMarker.C:19
MarkerValue _mark
Definition: UniformMarker.h:33
Definition: Marker.h:42
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
MarkerValue
This mirrors the main refinement flag values in libMesh in Elem::RefinementState but adds "dont_mark"...
Definition: Marker.h:58
UniformMarker(const InputParameters &parameters)
Definition: UniformMarker.C:29
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...
virtual MarkerValue computeElementMarker() override
Definition: UniformMarker.C:35