DiscreteNucleationMap

Generates a spatial smoothed map of all nucleation sites with the data of the DiscreteNucleationInserter for use by the DiscreteNucleation material.

The map objects builds a smooth map of nucleation sites in the simulation domain, expanding the point description from the DiscreteNucleationInserter to a description in which nucleation sites have a finite size and a smooth interface. This object takes three parameters

  • radius - the radius of the area in which each nucleation site modifies the local free energy. This should be chosen sufficiently large to generate a stable precipitate, but small enough to minimize the influence on the phase field evolution

  • periodic - a variable to take the periodicity information of the simulation domain

  • inserter - the DiscreteNucleationInserter object that maintains the nucleus list

The map object only updates the map if during a timestep the nucleus list was changed.

The DiscreteNucleationMap is part of the Discrete Nucleation system.

Input Parameters

  • inserterDiscreteNucleationInserter user object

    C++ Type:UserObjectName

    Options:

    Description:DiscreteNucleationInserter user object

Required Parameters

  • execute_onTIMESTEP_BEGINThe 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:TIMESTEP_BEGIN

    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.

  • int_width0Nucleus interface width for smooth nuclei

    Default:0

    C++ Type:double

    Options:

    Description:Nucleus interface width for smooth nuclei

  • radius0Radius for the inserted nuclei

    Default:0

    C++ Type:double

    Options:

    Description:Radius for the inserted nuclei

  • blockThe list of block ids (SubdomainID) that this object will be applied

    C++ Type:std::vector

    Options:

    Description:The list of block ids (SubdomainID) that this object will be applied

  • periodicUse the periodicity settings of this variable to populate the grain map

    C++ Type:std::vector

    Options:

    Description:Use the periodicity settings of this variable to populate the grain map

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.

  • 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).

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Options:

    Description:The seed for the master random number generator

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Options:

    Description:Determines whether this object is calculated using an implicit or explicit form

Advanced Parameters

Input Files