DiscreteNucleationData

Output diagnostic data on a DiscreteNucleationInserter

The data to be extracted from the DiscreteNucleationInserter is selected using the value parameter, which has the following options:

valueOutput
COUNTNumber of currently active nucleation sites maintained by the inserter
UPDATEBoolean (0/1) value denoting if at least one new nucleus was inserted or removed (i.e. its hold time expired) for the current timestep
RATETotal nucleation rate per unit time for the entire domain
INSERTIONSNumber of new nucleation points added to the inserter's list
DELETIONSNumber of nucleation points that were removed due to their hold time having expired

The DiscreteNucleationData postprocessor is part of the Discrete Nucleation system.

Input Parameters

  • inserterDiscreteNucleationInserter user object

    C++ Type:UserObjectName

    Options:

    Description:DiscreteNucleationInserter user object

  • valueCOUNTSelect to output number of active nuclei, wether a change to the nucleus list occurred, the total rate over the entire domain, and numbers of insertions and deletions applied to the nucleus list.

    Default:COUNT

    C++ Type:MooseEnum

    Options:COUNT UPDATE RATE INSERTIONS DELETIONS

    Description:Select to output number of active nuclei, wether a change to the nucleus list occurred, the total rate over the entire domain, and numbers of insertions and deletions applied to the nucleus list.

Required Parameters

  • 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, FINAL, CUSTOM.

    Default:TIMESTEP_END

    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.

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.

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

    C++ Type:std::vector

    Options:

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

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

  • force_preauxFalseForces the GeneralUserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Options:

    Description:Forces the GeneralUserObject to be executed in PREAUX

Advanced Parameters

Input Files

References