- variableArray of coupled variables
C++ Type:std::vector
Description:Array of coupled variables
PolycrystalHex
The PolycrystalHex object generates a set of points in 2D or 3D space such that hexagonal patterns are generated from a resulting Voronoi Tesselation. The number of grains must be choosen such that the root is an integer. Furthermore, a suitable number must be chosen that is supported by the mesh resolution and grain boundary width. Once the grain structure has been generated, a coloring algorithm is used to assign order parameters to grains so that a reduced number of order parameters may be used. Typical numbers are given here:
Dimension | Recommended OPs |
---|---|
2D | 8 |
3D | 25 |
See Polycrystal Initial Conditions for more information.
Typical usage in an input file:
[UserObjects]
[./voronoi]
type = PolycrystalVoronoi
grain_num = 100 # Number of grains
rand_seed = 10
[../]
[./grain_tracker]
type = GrainTracker
threshold = 0.2
connecting_threshold = 0.08
compute_halo_maps = true # Only necessary for displaying HALOS
[../]
[]
[ICs]
[./PolycrystalICs]
[./PolycrystalColoringIC]
polycrystal_ic_uo = voronoi
[../]
[../]
[]
(modules/phase_field/examples/grain_growth/grain_growth_2D_graintracker.i)Description and Syntax
PolycrystalHex
Perturbed hexagonal polycrystal
Input Parameters
- boundaryThe list of boundary IDs from the mesh where this boundary condition applies
C++ Type:std::vector
Description:The list of boundary IDs from the mesh where this boundary condition applies
- coloring_algorithmjpThe grain neighbor graph coloring algorithm to use: "jp" (DEFAULT) Jones and Plassmann, an efficient coloring algorithm, "power" an alternative stochastic algorithm, "greedy", a greedy assignment algorithm with stochastic updates to guarantee a valid coloring, "bt", a back tracking algorithm that produces good distributions but may experience exponential run time in the worst case scenario (works well on medium to large 2D problems)
Default:jp
C++ Type:MooseEnum
Description:The grain neighbor graph coloring algorithm to use: "jp" (DEFAULT) Jones and Plassmann, an efficient coloring algorithm, "power" an alternative stochastic algorithm, "greedy", a greedy assignment algorithm with stochastic updates to guarantee a valid coloring, "bt", a back tracking algorithm that produces good distributions but may experience exponential run time in the worst case scenario (works well on medium to large 2D problems)
- columnar_3DFalse3D microstructure will be columnar in the z-direction?
Default:False
C++ Type:bool
Description:3D microstructure will be columnar in the z-direction?
- compute_halo_mapsFalseInstruct the Postprocessor to communicate proper halo information to all ranks
Default:False
C++ Type:bool
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
Description:Instruct the Postprocessor to compute the active vars to features map
- connecting_thresholdThe threshold for which an existing feature may be extended (defaults to "threshold")
C++ Type:double
Description:The threshold for which an existing feature may be extended (defaults to "threshold")
- enable_var_coloringFalseInstruct the Postprocessor to populate the variable index map.
Default:False
C++ Type:bool
Description:Instruct the Postprocessor to populate the variable index map.
- execute_onINITIALThe 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
C++ Type:ExecFlagEnum
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.
- file_nameFile containing grain centroids, if file_name is provided, the centroids from the file will be used.
C++ Type:FileName
Description:File containing grain centroids, if file_name is provided, the centroids from the file will be used.
- flood_entity_typeELEMENTALDetermines whether the flood algorithm runs on nodes or elements
Default:ELEMENTAL
C++ Type:MooseEnum
Description:Determines whether the flood algorithm runs on nodes or elements
- grain_num0Number of grains being represented by the order parameters
Default:0
C++ Type:unsigned int
Description:Number of grains being represented by the order parameters
- int_width0Width of diffuse interfaces
Default:0
C++ Type:double
Description:Width of diffuse interfaces
- op_numArray of coupled variables (num_name)
C++ Type:unsigned int
Description:Array of coupled variables (num_name)
- output_adjacency_matrixFalseOutput the Grain Adjacency Matrix used in the coloring algorithms. Additionally, the grain to OP assignments will be printed
Default:False
C++ Type:bool
Description:Output the Grain Adjacency Matrix used in the coloring algorithms. Additionally, the grain to OP assignments will be printed
- perturbation_percent0The percent to randomly perturb centers of grains relative to the size of the grain
Default:0
C++ Type:double
Description:The percent to randomly perturb centers of grains relative to the size of the grain
- rand_seed0The random seed
Default:0
C++ Type:unsigned int
Description:The random seed
- secondary_percolation_boundariesPaired boundaries with "primaryary_percolation_boundaries" parameter
C++ Type:std::vector
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
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.5The threshold value for which a new feature may be started
Default:0.5
C++ Type:double
Description:The threshold value for which a new feature may be started
- use_less_than_threshold_comparisonTrueControls whether features are defined to be less than or greater than the threshold value.
Default:True
C++ Type:bool
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
Description:Array of coupled variables (base_name)
- x_offset0.5Specifies offset of hexagon grid in x-direction
Default:0.5
C++ Type:double
Description:Specifies offset of hexagon grid in x-direction
Optional Parameters
- allow_duplicate_execution_on_initialTrueIn 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:True
C++ Type:bool
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_infoFalseDetermines whether we condense all the node values when in multimap mode (default: false)
Default:False
C++ Type:bool
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
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Description:Set the enabled status of the MooseObject.
- force_preauxFalseForces the GeneralUserObject to be executed in PREAUX
Default:False
C++ Type:bool
Description:Forces the GeneralUserObject to be executed in PREAUX
- outputsnone Vector of output names were you would like to restrict the output of variables(s) associated with this object
Default:none
C++ Type:std::vector
Description:Vector of output names were 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
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
- 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
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
Description:Determine whether or not global numbers are used to label features on multiple maps (default: true)
- use_single_mapTrueDetermine whether information is tracked per coupled variable or consolidated into one (default: true)
Default:True
C++ Type:bool
Description:Determine whether information is tracked per coupled variable or consolidated into one (default: true)
Advanced Parameters
Input Files
- modules/phase_field/test/tests/grain_growth/hex.i
- modules/phase_field/test/tests/initial_conditions/HexPolycrystalIC.i
- modules/combined/examples/phase_field-mechanics/hex_grain_growth_2D_eldrforce.i