PolycrystalUserObjectBase.h File Reference

Go to the source code of this file.

Classes
class	PolycrystalUserObjectBase
	This object provides the base capability for creating proper polycrystal ICs. More...

Functions
template<>
InputParameters	validParams< PolycrystalUserObjectBase > ()

Function Documentation

validParams< PolycrystalUserObjectBase >()

template<>

InputParameters validParams< PolycrystalUserObjectBase >

(

)

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

Definition at line 24 of file PolycrystalUserObjectBase.C.

{
  InputParameters params = validParams<FeatureFloodCount>();
  params.addClassDescription("This object provides the base capability for creating proper reduced "
                             "order parameter polycrystal initial conditions.");
  params.addRequiredCoupledVarWithAutoBuild(
      "variable", "var_name_base", "op_num", "Array of coupled variables");
  params.addParam<bool>("output_adjacency_matrix",
                        false,
                        "Output the Grain Adjacency Matrix used in the coloring algorithms. "
                        "Additionally, the grain to OP assignments will be printed");
  params.addParam<MooseEnum>("coloring_algorithm",
                             PolycrystalUserObjectBase::coloringAlgorithms(),
                             PolycrystalUserObjectBase::coloringAlgorithmDescriptions());
 
  // FeatureFloodCount adds a relationship manager, but we need to extend that for PolycrystalIC
  params.clearRelationshipManagers();
 
  params.addRelationshipManager(
      "ElementSideNeighborLayers",
      Moose::RelationshipManagerType::GEOMETRIC,
 
      [](const InputParameters & /*obj_params*/, InputParameters & rm_params) {
        rm_params.set<unsigned short>("layers") = 2;
      }
 
  );
 
  params.addRelationshipManager("ElementSideNeighborLayers",
                                Moose::RelationshipManagerType::ALGEBRAIC);
 
  // Hide the output of the IC objects by default, it doesn't change over time
  params.set<std::vector<OutputName>>("outputs") = {"none"};
 
  params.set<bool>("allow_duplicate_execution_on_initial") = true;
 
  // This object should only be executed _before_ the initial condition
  ExecFlagEnum execute_options = MooseUtils::getDefaultExecFlagEnum();
  execute_options = EXEC_INITIAL;
  params.set<ExecFlagEnum>("execute_on") = execute_options;
 
  return params;
}

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