- hold_timeTime to keep each nucleus active
C++ Type:double
Controllable:No
Description:Time to keep each nucleus active
- probabilityProbability density for inserting a discrete nucleus
C++ Type:MaterialPropertyName
Controllable:No
Description:Probability density for inserting a discrete nucleus
DiscreteNucleationInserter
Manages the list of currently active nucleation sites and adds new sites according to a given probability function.
The inserter manages the global list of currently active nucleus stabilization sites. The inserter object keeps track if any changes to the nucleus list occurred in the current timestep.
This user object takes two required parameters
hold_time- the duration in time for which a stabilization site remains activeprobability- a material property containing a nucleation rate density. This material property can be calculated using classical nucleation theory for example.
In addition, the user has the option of specifying whether this nuclei with a fixed radius will be inserted, or whether the radius can vary based on an internal calculation. A constant radius can be supplied via the input file to the radius parameter, while a variable radius can be used by providing a material property name to radius (a default name is provided).
The final parameter, time_dependent_statistics, is a boolean that defaults to true. This parameter indicates whether time-dependent nucleation statistics are used or not. The default of true indicates that time-dependent statistics are used, i.e., that the nucleation probability depends on time step size. A value of false indicates time-independent nucleation statistics. This might be used in a situation in which the physics driving nucleus formation occur at much faster time scales than the other physics in microstructure evolution. For example, grain boundary motion during recrystallization is much slower than dislocation motion to organize into cells or the nuclei of new grains. As a result, time-independent statistics can be applied.
The DiscreteNucleationInserter is part of the Discrete Nucleation system.
Input Parameters
- blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
- execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Controllable:No
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, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS.
- 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.
- radiusr_critvariable radius material property name, supply a value if radius is constant in the simulation
Default:r_crit
C++ Type:MaterialPropertyName
Controllable:No
Description:variable radius material property name, supply a value if radius is constant in the simulation
- time_dependent_statisticsTrueflag if time-dependent or time-independent statistics are used
Default:True
C++ Type:bool
Controllable:No
Description:flag if time-dependent or time-independent statistics are used
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).
- 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
- implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Controllable:No
Description:Determines whether this object is calculated using an implicit or explicit form
- seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Controllable:No
Description:The seed for the master random number generator
- 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.