ADACInterface

Gradient energy Allen-Cahn Kernel

Implements the Allen-Cahn term for the $var element = document.getElementById("moose-equation-96d36a09-4b8e-4f34-8eb8-d339ff4100e6");katex.render("\\frac{\\kappa_i}2|\\nabla \\eta_i|^2", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ gradient energy contribution for the isotropic mobility case. Its weak form is

$var element = document.getElementById("moose-equation-ad984379-cddd-4a81-a76b-1b192585df8a");katex.render("\\left( \\kappa_i \\nabla \\eta_i, \\nabla (L_i \\psi_m ) \\right),", element, {displayMode:true,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$

where $var element = document.getElementById("moose-equation-675c48c4-5b0d-4f75-91a8-5ee4db7a267a");katex.render("\\kappa_i", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ (kappa_name) is the gradient energy coefficient, $var element = document.getElementById("moose-equation-c7653073-7686-4540-ab98-f83f8bbd36d4");katex.render("\\eta_i", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ the non-conserved non-linear order parameter variable the kernel is acting on, $var element = document.getElementById("moose-equation-6462e85c-9c35-4883-93a2-52fdd9174750");katex.render("L_i", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ (mob_name) is the scalar (isotropic) mobility associated with the order parameter, and $var element = document.getElementById("moose-equation-3a7a5692-8787-4bb4-9337-47a61edcea35");katex.render("\\psi_m", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is the test function.

Input Parameters

variableThe name of the variable that this Kernel operates on
C++ Type:NonlinearVariableName
Options:
Description:The name of the variable that this Kernel operates on

Required Parameters

argsVector of nonlinear variable arguments this object depends on
C++ Type:std::vector
Options:
Description:Vector of nonlinear variable arguments this object depends on
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
displacementsThe displacements
C++ Type:std::vector
Options:
Description:The displacements
kappa_namekappa_opThe kappa used with the kernel
Default:kappa_op
C++ Type:MaterialPropertyName
Options:
Description:The kappa used with the kernel
mob_nameLThe mobility used with the kernel
Default:L
C++ Type:MaterialPropertyName
Options:
Description:The mobility used with the kernel
variable_LTrueThe mobility is a function of any MOOSE variable (if this is set to false L must be constant over the entire domain!)
Default:True
C++ Type:bool
Options:
Description:The mobility is a function of any MOOSE variable (if this is set to false L must be constant over the entire domain!)

Optional Parameters

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.
diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
C++ Type:std::vector
Options:
Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.
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
save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
C++ Type:std::vector
Options:
Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
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

extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
C++ Type:std::vector
Options:
Description:The extra tags for the matrices this Kernel should fill
extra_vector_tagsThe extra tags for the vectors this Kernel should fill
C++ Type:std::vector
Options:
Description:The extra tags for the vectors this Kernel should fill
matrix_tagssystemThe tag for the matrices this Kernel should fill
Default:system
C++ Type:MultiMooseEnum
Options:nontime system
Description:The tag for the matrices this Kernel should fill
vector_tagsnontimeThe tag for the vectors this Kernel should fill
Default:nontime
C++ Type:MultiMooseEnum
Options:nontime time
Description:The tag for the vectors this Kernel should fill

Tagging Parameters

Input Files

modules/phase_field/test/tests/phase_field_kernels/ADAllenCahn.i
modules/phase_field/test/tests/phase_field_kernels/ADAllenCahnVariableL.i

modules/phase_field/test/tests/phase_field_kernels/ADAllenCahn.i

#
# Test the forward automatic differentiation Allen-Cahn Bulk kernel
#

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

[Variables]
  [./eta]
    order = FIRST
    family = LAGRANGE
    [./InitialCondition]
      type = SmoothCircleIC
      x1 = 0.0
      y1 = 0.0
      radius = 6.0
      invalue = 0.9
      outvalue = 0.1
      int_width = 3.0
    [../]
  [../]
[]

[Kernels]
  [./detadt]
    type = ADTimeDerivative
    variable = eta
  [../]

  [./ACBulk]
    type = ADAllenCahn
    variable = eta
    f_name = F
  [../]

  [./ACInterface]
    type = ADACInterface
    variable = eta
    kappa_name = 1
    variable_L = false
  [../]
[]

[Materials]
  [./consts]
    type = GenericConstantMaterial
    prop_names  = 'L'
    prop_values = '1'
  [../]

  [./free_energy]
    type = ADTestDerivativeFunction
    function = F1
    f_name = F
    op = 'eta'
  [../]
[]

[Executioner]
  type = Transient
  scheme = 'bdf2'
  solve_type = 'NEWTON'
  num_steps = 2
  dt = 0.5
[]

[Outputs]
  exodus = true
[]

modules/phase_field/test/tests/phase_field_kernels/ADAllenCahnVariableL.i

#
# Test the forward automatic differentiation Allen-Cahn Bulk kernel with a
# spatially varying mobility
#

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

[AuxVariables]
  [./chi]
    [./InitialCondition]
      type = FunctionIC
      function = 'x/24+0.5'
    [../]
  [../]
[]

[Variables]
  [./eta]
    order = FIRST
    family = LAGRANGE
    [./InitialCondition]
      type = SmoothCircleIC
      x1 = 0.0
      y1 = 0.0
      radius = 6.0
      invalue = 0.9
      outvalue = 0.1
      int_width = 3.0
    [../]
  [../]
[]

[Kernels]
  [./detadt]
    type = ADTimeDerivative
    variable = eta
  [../]

  [./ACBulk]
    type = ADAllenCahn
    variable = eta
    f_name = F
  [../]

  [./ACInterface]
    type = ADACInterface
    variable = eta
    kappa_name = 1
    variable_L = true
    args = chi
  [../]
[]

[Materials]
  [./L]
    type = ADTestDerivativeFunction
    function = F2
    f_name = L
    op = 'eta chi'
  [../]

  [./free_energy]
    type = ADTestDerivativeFunction
    function = F1
    f_name = F
    op = 'eta'
  [../]
[]

[Executioner]
  type = Transient
  scheme = 'bdf2'
  solve_type = 'NEWTON'
  num_steps = 2
  dt = 1
[]

[Outputs]
  exodus = true
[]

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools