DiscreteNucleationAux

Project the DiscreteNucleationMap state onto an AuxVariable

This AuxKernel computes the value $var element = document.getElementById("moose-equation-ec03623f-cbee-4e96-8baa-fee2aaa736cf");katex.render("v", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ as

$var element = document.getElementById("moose-equation-04b6b1aa-72d8-4967-8c23-74844c491802");katex.render("v = M(r) \\cdot (v_1 - v_0) + v_0", element, {displayMode:true,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$

where $var element = document.getElementById("moose-equation-e5ca355c-f272-4886-9927-2fee9f621e41");katex.render("v", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ ist the variable the auxkernel is acting on and $var element = document.getElementById("moose-equation-dfce31b2-587b-4a57-970b-50f243562a60");katex.render("M", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is the DiscreteNucleationMap data. The map values $var element = document.getElementById("moose-equation-e41bb3de-f219-4dc0-92e3-a2c3c9068cb0");katex.render("M(r)", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ range from 0..1 and are remapped using the $var element = document.getElementById("moose-equation-bf731731-faf6-4755-8250-91f472603343");katex.render("v_0", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ (no_nucleus_value) and $var element = document.getElementById("moose-equation-526df28c-27c3-4b6b-be91-a1914094ffca");katex.render("v_1", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ (nucleus_value) parameters.

The DiscreteNucleationAux auxkernel is part of the Discrete Nucleation system. Its companion kernel is DiscreteNucleationForce.

Input Parameters

mapDiscreteNucleationMap user object
C++ Type:UserObjectName
Options:
Description:DiscreteNucleationMap user object
variableThe name of the variable that this object applies to
C++ Type:AuxVariableName
Options:
Description:The name of the variable that this object applies to

Required Parameters

blockThe list of block ids (SubdomainID) that this object will be applied
C++ Type:std::vector<SubdomainName>
Options:
Description:The list of block ids (SubdomainID) that this object will be applied
boundaryThe list of boundary IDs from the mesh where this boundary condition applies
C++ Type:std::vector<BoundaryName>
Options:
Description:The list of boundary IDs from the mesh where this boundary condition applies
check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
Default:True
C++ Type:bool
Options:
Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
execute_onLINEAR TIMESTEP_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, PRE_DISPLACE.
Default:LINEAR TIMESTEP_END
C++ Type:ExecFlagEnum
Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE
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, PRE_DISPLACE.
no_nucleus_value0Variable value indicating no nucleus is present
Default:0
C++ Type:double
Options:
Description:Variable value indicating no nucleus is present
nucleus_value1Variable value indicating the presence of a nucleus
Default:1
C++ Type:double
Options:
Description:Variable value indicating the presence of a nucleus

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Options:
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.
seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Options:
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
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.

Advanced Parameters

Input Files

(modules/phase_field/test/tests/Nucleation/auxkernel.i)
(modules/phase_field/test/tests/Nucleation/file2.i)
(modules/phase_field/test/tests/Nucleation/file.i)

References

(modules/phase_field/test/tests/Nucleation/auxkernel.i)

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 20
  ny = 20
  nz = 0
  xmin = 0
  xmax = 20
  ymin = 0
  ymax = 20
  elem_type = QUAD4
[]

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

[AuxKernels]
  [./c]
    type = DiscreteNucleationAux
    map = map
    variable = c
    no_nucleus_value = -1
    nucleus_value = 2
    execute_on = TIMESTEP_END
  [../]
[]

[UserObjects]
  [./inserter]
    type = DiscreteNucleationInserter
    hold_time = 0.4
    probability = 0.01
    seed = 12346
    radius = 3.27
  [../]
  [./map]
    type = DiscreteNucleationMap
    int_width = 2
    periodic = c
    inserter = inserter
  [../]
[]

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

[Problem]
  solve = false
  kernel_coverage_check = false
[]

[Outputs]
  execute_on = 'timestep_end'
  exodus = true
[]

(modules/phase_field/test/tests/Nucleation/file2.i)

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

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

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

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

[UserObjects]
  [./inserter]
    type = DiscreteNucleationFromFile
    hold_time = 2
    file = nuclei2.csv
  [../]
  [./map]
    type = DiscreteNucleationMap
    int_width = 3
    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/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
    radius = 2
  [../]
  [./map]
    type = DiscreteNucleationMap
    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
[]

Input Parameters
Input Files
References

Install MOOSE

New Users

Examples and Tutorials

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools

INL Applications and Remote Access