FauxGrainTracker

buildconstruction:Undocumented Class

The FauxGrainTracker has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic 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.

Overview

Example Input File Syntax

Input Parameters

  • variableArray of coupled variables

    C++ Type:std::vector<VariableName>

    Controllable:No

    Description:Array of coupled variables

Required Parameters

  • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

    C++ Type:std::vector<BoundaryName>

    Controllable:No

    Description:The list of boundaries (ids or names) from the mesh where this object applies

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

    Default:False

    C++ Type:bool

    Controllable:No

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

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

    Default:False

    C++ Type:bool

    Controllable:No

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

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

    Default:0.09

    C++ Type:double

    Controllable:No

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

  • enable_var_coloringTrueInstruct the Postprocessor to populate the variable index map.

    Default:True

    C++ Type:bool

    Controllable:No

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

  • 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

    Controllable:No

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

  • execute_onINITIAL TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

    Default:INITIAL TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, TRANSFER

    Controllable:No

    Description:The list of flag(s) indicating when this object should be executed, the available options include FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

  • flood_entity_typeELEMENTALDetermines whether the flood algorithm runs on nodes or elements

    Default:ELEMENTAL

    C++ Type:MooseEnum

    Options:NODAL, ELEMENTAL

    Controllable:No

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

  • halo_level2The thickness of the halo surrounding each feature.

    Default:2

    C++ Type:unsigned short

    Controllable:No

    Description:The thickness of the halo surrounding each feature.

  • op_numArray of coupled variables (num_name)

    C++ Type:unsigned int

    Controllable:No

    Description:Array of coupled variables (num_name)

  • polycrystal_ic_uoOptional: Polycrystal IC object

    C++ Type:UserObjectName

    Controllable:No

    Description:Optional: Polycrystal IC object

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

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

    Default:True

    C++ Type:bool

    Controllable:No

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

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

    Default:0

    C++ Type:unsigned short

    Controllable:No

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

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

    Default:0.95

    C++ Type:double

    Controllable:No

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

  • secondary_percolation_boundariesPaired boundaries with "primaryary_percolation_boundaries" parameter

    C++ Type:std::vector<BoundaryName>

    Controllable:No

    Description:Paired boundaries with "primaryary_percolation_boundaries" parameter

  • specified_boundariesAn optional list of boundaries; if supplied, each feature is checked to determine whether it intersects any of the specified boundaries in this list.

    C++ Type:std::vector<BoundaryName>

    Controllable:No

    Description:An optional list of boundaries; if supplied, each feature is checked to determine whether it intersects any of the specified boundaries in this list.

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

    Default:0.1

    C++ Type:double

    Controllable:No

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

  • tracking_step0The timestep for when we should start tracking grains

    Default:0

    C++ Type:int

    Controllable:No

    Description:The timestep for when we should start tracking grains

  • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

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

    Default:True

    C++ Type:bool

    Controllable:No

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

  • var_name_baseArray of coupled variables (base_name)

    C++ Type:std::string

    Controllable:No

    Description:Array of coupled variables (base_name)

  • 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

    Controllable:No

    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

  • 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

    Controllable:No

    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

    Controllable:No

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

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

    C++ Type:std::vector<std::string>

    Controllable:No

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

  • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

    Default:0

    C++ Type:int

    Controllable:No

    Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

  • force_postauxFalseForces the UserObject to be executed in POSTAUX

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in POSTAUX

  • force_preauxFalseForces the UserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in PREAUX

  • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in PREIC during initial setup

  • 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

    Controllable:No

    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)

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

    C++ Type:std::vector<OutputName>

    Controllable:No

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

  • primary_percolation_boundariesA list of boundaries used in conjunction with the corresponding "secondary_percolation_boundaries" parameter for determining if a feature creates a path connecting any pair of boundaries

    C++ Type:std::vector<BoundaryName>

    Controllable:No

    Description:A list of boundaries used in conjunction with the corresponding "secondary_percolation_boundaries" parameter for determining if a feature creates a path connecting any pair of boundaries

  • 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 coalescence. DO NOT USE for production results!

    Default:False

    C++ Type:bool

    Controllable:No

    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 coalescence. DO NOT USE for production results!

  • 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

    Controllable:No

    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.

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

    Default:True

    C++ Type:bool

    Controllable:No

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

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

    Default:False

    C++ Type:bool

    Controllable:No

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

Advanced Parameters

Input Files