www.mooseframework.org
Functions
FeatureFloodCountAux.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< FeatureFloodCountAux > ()
 

Function Documentation

template<>
InputParameters validParams< FeatureFloodCountAux > ( )

Definition at line 16 of file FeatureFloodCountAux.C.

17 {
18  InputParameters params = validParams<AuxKernel>();
19  params.addClassDescription("Feature detection by connectivity analysis");
20  params.addDeprecatedParam<UserObjectName>("bubble_object",
21  "The FeatureFloodCount UserObject to get values from.",
22  "Use \"flood_counter\" instead.");
23  params.addRequiredParam<UserObjectName>("flood_counter",
24  "The FeatureFloodCount UserObject to get values from.");
25  params.addParam<unsigned int>("map_index",
26  "The index of which map to retrieve values from when "
27  "using FeatureFloodCount with multiple maps.");
28  MooseEnum field_display(
29  "UNIQUE_REGION VARIABLE_COLORING GHOSTED_ENTITIES HALOS CENTROID ACTIVE_BOUNDS",
30  "UNIQUE_REGION");
31  params.addParam<MooseEnum>("field_display",
32  field_display,
33  "Determines how the auxilary field should be colored. "
34  "(UNIQUE_REGION and VARIABLE_COLORING are nodal, CENTROID is "
35  "elemental, default: UNIQUE_REGION)");
36 
37  MultiMooseEnum execute_options(SetupInterface::getExecuteOptions());
38  execute_options = "initial timestep_end";
39  params.set<MultiMooseEnum>("execute_on") = execute_options;
40 
41  return params;
42 }