www.mooseframework.org
Functions
PolycrystalUserObjectBase.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< PolycrystalUserObjectBase > ()
 

Function Documentation

template<>
InputParameters validParams< PolycrystalUserObjectBase > ( )

Run this user object more than once on the initial condition to handle initial adaptivity

Definition at line 21 of file PolycrystalUserObjectBase.C.

Referenced by validParams< PolycrystalCircles >(), validParams< PolycrystalEBSD >(), and validParams< PolycrystalVoronoi >().

22 {
23  InputParameters params = validParams<FeatureFloodCount>();
24  params.addClassDescription("This object provides the base capability for creating proper reduced "
25  "order parameter polycrystal initial conditions.");
26  params.addRequiredCoupledVarWithAutoBuild(
27  "variable", "var_name_base", "op_num", "Array of coupled variables");
28  params.addParam<bool>("output_adjacency_matrix",
29  false,
30  "Output the Grain Adjacency Matrix used in the coloring algorithms. "
31  "Additionally, the grain to OP assignments will be printed");
32  params.addParam<MooseEnum>("coloring_algorithm",
35 
36  // Hide the output of the IC objects by default, it doesn't change over time
37  params.set<std::vector<OutputName>>("outputs") = {"none"};
38 
40  params.set<bool>("allow_duplicate_execution_on_initial") = true;
41 
42  // This object should only be executed _before_ the initial condition
43  MultiMooseEnum execute_options(SetupInterface::getExecuteOptions());
44  execute_options = "initial";
45  params.set<MultiMooseEnum>("execute_on") = execute_options;
46 
47  return params;
48 }
static std::string coloringAlgorithmDescriptions()
Returns corresponding descriptions of available coloring algorithms.
InputParameters validParams< FeatureFloodCount >()
static MooseEnum coloringAlgorithms()
Returns all available coloring algorithms as an enumeration type for input files. ...