DiscreteNucleationFromFile

Manages the list of currently active nucleation sites and adds new sites according to a predetermined list from a CSV file (use this with sync_times).

This inserter can be used for verification and test cases. Instead of the stochastic nucleus in the DiscreteNucleationInserter this object reads a CSV file with columns for nucleus insertion time (time) and the coordinates of the insertion point (x, y, z)

The DiscreteNucleationFromFile is part of the Discrete Nucleation system.

Input Parameters

hold_timeTime to keep each nucleus active
C++ Type:double
Options:
Description:Time to keep each nucleus active
fileCSV file with (time, x, y, z) coordinates for nucleation events.
C++ Type:FileName
Options:
Description:CSV file with (time, x, y, z) coordinates for nucleation events.

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.
tolerance1e-09Tolerance for determining insertion time
Default:1e-09
C++ Type:double
Options:
Description:Tolerance for determining insertion time
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

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

modules/phase_field/test/tests/Nucleation/file.i
modules/phase_field/test/tests/Nucleation/soft.i

modules/phase_field/test/tests/Nucleation/file.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 10
  ny = 10
  xmax = 10
  ymax = 10
[]

[Variables]
  [./dummy]
  []
[]

[AuxVariables]
  [./c]
    order = CONSTANT
    family = MONOMIAL
  [../]
[]

[AuxKernels]
  [./c]
    type = DiscreteNucleationAux
    variable = c
    map = map
  [../]
[]

[UserObjects]
  [./inserter]
    type = DiscreteNucleationFromFile
    hold_time = 1
    file = nuclei.csv
  [../]
  [./map]
    type = DiscreteNucleationMap
    radius = 2
    int_width = 1
    inserter = inserter
  [../]
[]

[Executioner]
  type = Transient
  solve_type = 'NEWTON'
  num_steps = 10
  dt = 0.5
[]

[Problem]
  kernel_coverage_check = false
[]

[Outputs]
  exodus = true
  hide = dummy
[]

modules/phase_field/test/tests/Nucleation/soft.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 10
  ny = 10
  xmin = -3
  xmax = 10
  ymin = -3
  ymax = 10
[]

[Variables]
  [./c]
    order = FIRST
    family = LAGRANGE
    initial_condition = 0
  [../]
[]

[Kernels]
  [./c]
    type = Diffusion
    #D_name = F
    variable = c
  [../]
  [./dt]
    type = TimeDerivative
    variable = c
  [../]
[]

[Materials]
  [./nucleation]
    type = DiscreteNucleation
    op_names  = c
    op_values = 1
    penalty = 10
    map = map
    outputs = exodus
  [../]
[]

[UserObjects]
  [./inserter]
    type = DiscreteNucleationFromFile
    hold_time = 1
    file = single.csv
  [../]
  [./map]
    type = DiscreteNucleationMap
    radius = 7
    int_width = 6
    inserter = inserter
  [../]
[]

[Executioner]
  type = Transient
  solve_type = 'NEWTON'
  num_steps = 2
  dt = 0.1
[]

[Outputs]
  execute_on = 'timestep_end'
  interval = 2
  exodus = true
  hide = c
[]

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools