FauxGrainTracker

under construction:Undocumented Class

The FauxGrainTracker has not been documented. The content contained on this page includes the basic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Fake grain tracker object for cases where the number of grains is equal to the number of order parameters.

Input Parameters

  • variableArray of coupled variables

    C++ Type:std::vector

    Options:

    Description:Array of coupled variables

Required Parameters

  • var_name_baseArray of coupled variables (base_name)

    C++ Type:std::string

    Options:

    Description:Array of coupled variables (base_name)

  • compute_halo_mapsFalseInstruct the Postprocessor to communicate proper halo information to all ranks

    Default:False

    C++ Type:bool

    Options:

    Description:Instruct the Postprocessor to communicate proper halo information to all ranks

  • reserve_op0Indicates the number of reserved ops (variables that cannot be remapped to)

    Default:0

    C++ Type:unsigned short

    Options:

    Description:Indicates the number of reserved ops (variables that cannot be remapped to)

  • tracking_step0The timestep for when we should start tracking grains

    Default:0

    C++ Type:int

    Options:

    Description:The timestep for when we should start tracking grains

  • connecting_threshold0.09The threshold for which an existing feature may be extended (defaults to "threshold")

    Default:0.09

    C++ Type:double

    Options:

    Description:The threshold for which an existing feature may be extended (defaults to "threshold")

  • use_less_than_threshold_comparisonTrueControls whether features are defined to be less than or greater than the threshold value.

    Default:True

    C++ Type:bool

    Options:

    Description:Controls whether features are defined to be less than or greater than the threshold value.

  • error_on_grain_creationFalseTerminate with an error if a grain is created (does not include initial callback to start simulation)

    Default:False

    C++ Type:bool

    Options:

    Description:Terminate with an error if a grain is created (does not include initial callback to start simulation)

  • op_numArray of coupled variables (num_name)

    C++ Type:unsigned int

    Options:

    Description:Array of coupled variables (num_name)

  • flood_entity_typeELEMENTALDetermines whether the flood algorithm runs on nodes or elements

    Default:ELEMENTAL

    C++ Type:MooseEnum

    Options:NODAL ELEMENTAL

    Description:Determines whether the flood algorithm runs on nodes or elements

  • compute_var_to_feature_mapFalseInstruct the Postprocessor to compute the active vars to features map

    Default:False

    C++ Type:bool

    Options:

    Description:Instruct the Postprocessor to compute the active vars to features map

  • polycrystal_ic_uoOptional: Polycrystal IC object

    C++ Type:UserObjectName

    Options:

    Description:Optional: Polycrystal IC object

  • threshold0.1The threshold value for which a new feature may be started

    Default:0.1

    C++ Type:double

    Options:

    Description:The threshold value for which a new feature may be started

  • execute_onINITIAL TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

    Default:INITIAL TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM

    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies

    C++ Type:std::vector

    Options:

    Description:The list of boundary IDs from the mesh where this boundary condition applies

  • halo_level2The thickness of the halo surrounding each feature.

    Default:2

    C++ Type:unsigned short

    Options:

    Description:The thickness of the halo surrounding each feature.

  • enable_var_coloringTrueInstruct the Postprocessor to populate the variable index map.

    Default:True

    C++ Type:bool

    Options:

    Description:Instruct the Postprocessor to populate the variable index map.

  • reserve_op_threshold0.95Threshold for locating a new feature on the reserved op variable(s)

    Default:0.95

    C++ Type:double

    Options:

    Description:Threshold for locating a new feature on the reserved op variable(s)

  • remap_grainsTrueIndicates whether remapping should be done or not (default: true)

    Default:True

    C++ Type:bool

    Options:

    Description:Indicates whether remapping should be done or not (default: true)

  • verbosity_level1Level 0: Silent during normal operation, Level 1: Informational messages but no detailed grain structure printouts, Level 2: Verbose output including data structure dumps, Level 3: Debugging mode.

    Default:1

    C++ Type:short

    Options:

    Description:Level 0: Silent during normal operation, Level 1: Informational messages but no detailed grain structure printouts, Level 2: Verbose output including data structure dumps, Level 3: Debugging mode.

Optional Parameters

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Options:

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

  • outputsVector of output names were you would like to restrict the output of variables(s) associated with this object

    C++ Type:std::vector

    Options:

    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object

  • use_single_mapFalseDetermine whether information is tracked per coupled variable or consolidated into one (default: true)

    Default:False

    C++ Type:bool

    Options:

    Description:Determine whether information is tracked per coupled variable or consolidated into one (default: true)

  • tolerate_failureFalseAllow the grain tracker to continue when it fails to find suitable grains for remapping. This will allow the simulation to continue but it will also allow non-physical grain coalesnce. DO NOT USE for production results!

    Default:False

    C++ Type:bool

    Options:

    Description:Allow the grain tracker to continue when it fails to find suitable grains for remapping. This will allow the simulation to continue but it will also allow non-physical grain coalesnce. DO NOT USE for production results!

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

    Default:False

    C++ Type:bool

    Options:

    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

  • condense_map_infoTrueDetermines whether we condense all the node values when in multimap mode (default: false)

    Default:True

    C++ Type:bool

    Options:

    Description:Determines whether we condense all the node values when in multimap mode (default: false)

  • use_global_numberingTrueDetermine whether or not global numbers are used to label features on multiple maps (default: true)

    Default:True

    C++ Type:bool

    Options:

    Description:Determine whether or not global numbers are used to label features on multiple maps (default: true)

  • force_preauxFalseForces the GeneralUserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Options:

    Description:Forces the GeneralUserObject to be executed in PREAUX

  • max_remap_recursion_depth6The recursion depth allowed when searching for remapping candidates. Note: Setting this value high may result in very computationally expensive searches with little benefit. (Recommended level: 6)

    Default:6

    C++ Type:unsigned short

    Options:

    Description:The recursion depth allowed when searching for remapping candidates. Note: Setting this value high may result in very computationally expensive searches with little benefit. (Recommended level: 6)

Advanced Parameters

Input Files

References