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

Go to the source code of this file.

Classes

class  GrainTrackerInterface
 This class defines the interface for the GrainTracking objects. More...
 

Functions

template<>
InputParameters validParams< GrainTrackerInterface > ()
 

Function Documentation

template<>
InputParameters validParams< GrainTrackerInterface > ( )

Definition at line 13 of file GrainTrackerInterface.C.

Referenced by validParams< FauxGrainTracker >(), and validParams< GrainTracker >().

14 {
15  InputParameters params = validParams<FeatureFloodCount>();
16  params.addParam<int>("tracking_step", 0, "The timestep for when we should start tracking grains");
17  params.addParam<unsigned int>(
18  "halo_level", 2, "The thickness of the halo surrounding each feature.");
19  params.addParam<bool>(
20  "remap_grains", true, "Indicates whether remapping should be done or not (default: true)");
21  params.addParam<unsigned short>(
22  "reserve_op",
23  0,
24  "Indicates the number of reserved ops (variables that cannot be remapped to)");
25  params.addParam<Real>("reserve_op_threshold",
26  0.95,
27  "Threshold for locating a new feature on the reserved op variable(s)");
28  params.addParam<UserObjectName>("polycrystal_ic_uo", "Optional: Polycrystal IC object");
29  params.addParam<bool>("error_on_grain_creation",
30  false,
31  "Terminate with an error if a grain is created "
32  "(does not include initial callback to start simulation)");
33 
34  params.addRequiredCoupledVarWithAutoBuild(
35  "variable", "var_name_base", "op_num", "Array of coupled variables");
36 
37  // Set suitable default parameters for grain tracking
38  params.set<Real>("threshold") = 0.1; // flood out to a fairly low value for grain remapping
39  params.set<Real>("connecting_threshold") =
40  0.09; // connecting threshold should be just slightly lower than threshold
41  params.set<bool>("use_single_map") =
42  false; // This is needed to allow for arbitrary feature overlap during remapping
43  params.set<bool>("condense_map_info") =
44  true; // It's better to have all information in one map for normal visualization
45  params.set<bool>("enable_var_coloring") =
46  true; // Generally we need to see the variable (OP) indices
47 
48  MultiMooseEnum execute_options(SetupInterface::getExecuteOptions());
49  execute_options = "initial timestep_end";
50  params.set<MultiMooseEnum>("execute_on") = execute_options;
51 
52  return params;
53 }
InputParameters validParams< FeatureFloodCount >()