- C_ijklUnrotated stiffness tensor
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Unrotated stiffness tensor
- euler_angle_providerName of Euler angle provider user object
C++ Type:UserObjectName
Unit:(no unit assumed)
Controllable:No
Description:Name of Euler angle provider user object
- variableArray of coupled variables
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Array of coupled variables
GrainTrackerElasticity
buildconstruction:Undocumented Class
The GrainTrackerElasticity 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.
Grain Tracker object for running reduced order parameter simulations without grain coalescence.
Overview
Example Input File Syntax
Input Parameters
- bound_value0Absolute value of the lower bound for the variable value that represents a region not assigned to the grain. Must be positive, but the actual value used is -bound_value.
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Absolute value of the lower bound for the variable value that represents a region not assigned to the grain. Must be positive, but the actual value used is -bound_value.
- boundaryThe list of boundaries (ids or names) from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:INITIAL TIMESTEP_END
C++ Type:ExecFlagEnum
Unit:(no unit assumed)
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
- fill_methodsymmetric9The fill method
Default:symmetric9
C++ Type:MooseEnum
Unit:(no unit assumed)
Controllable:No
Description:The fill method
- flood_entity_typeELEMENTALDetermines whether the flood algorithm runs on nodes or elements
Default:ELEMENTAL
C++ Type:MooseEnum
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:No
Description:The thickness of the halo surrounding each feature.
- op_numArray of coupled variables (num_name)
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:Array of coupled variables (num_name)
- polycrystal_ic_uoOptional: Polycrystal IC object
C++ Type:UserObjectName
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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.
- random_rotationsTrueGenerate random rotations when the Euler Angle provider runs out of data (otherwise error out)
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Generate random rotations when the Euler Angle provider runs out of data (otherwise error out)
- remap_grainsTrueIndicates whether remapping should be done or not (default: true)
Default:True
C++ Type:bool
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:No
Description:Determine whether information is tracked per coupled variable or consolidated into one (default: true)