ADFunctionDirichletBC

Imposes the essential boundary condition $var element = document.getElementById("moose-equation-cc1a959a-a447-4b5b-b36c-88cd4c1632f5");katex.render("u=g", element, {displayMode:false,throwOnError:false});$ , where $var element = document.getElementById("moose-equation-c657d663-103d-4725-a1eb-a64f5ab5197b");katex.render("g", element, {displayMode:false,throwOnError:false});$ is calculated by a function.

Description

ADFunctionDirichletBC is a generalization of DirichletBC which imposes a possibly temporally- and spatially-dependent value defined by a MOOSE Function object on a particular set of degrees of freedom (DOFs) defined by the boundary parameter. That is, for a PDE of the form

$var element = document.getElementById("moose-equation-c5f2a13b-2619-47e3-a1e9-c832b1c75269");katex.render("\\begin{aligned} -\\nabla^2 u &= f && \\quad \\in \\Omega \\\\ u &= g(t,\\vec{x}) && \\quad \\in \\partial \\Omega_D \\\\ \\frac{\\partial u}{\\partial n} &= h(t,\\vec{x}) && \\quad \\in \\partial \\Omega_N \\end{aligned}", element, {displayMode:true,throwOnError:false});$

where $var element = document.getElementById("moose-equation-309376f8-8b49-4cc4-9b73-f4841e81c216");katex.render("\\Omega \\subset \\mathbb{R}^n", element, {displayMode:false,throwOnError:false});$ is the domain, and $var element = document.getElementById("moose-equation-1ccc573d-c29f-433d-abc0-c432cfc44ad0");katex.render("\\partial \\Omega = \\partial \\Omega_D \\cup \\partial \\Omega_N", element, {displayMode:false,throwOnError:false});$ is its boundary, a ADFunctionDirichletBC object can be used to impose the condition (2) if the function is well-defined for $var element = document.getElementById("moose-equation-c617cd14-1eec-4fec-b059-c831376045c5");katex.render("\\vec{x} \\in \\partial \\Omega_D", element, {displayMode:false,throwOnError:false});$ . In this case, the function parameter corresponds to a MOOSE Function object which represents the mathematical function $var element = document.getElementById("moose-equation-8a3e20ab-9ba4-430c-b665-b399abf6c335");katex.render("g(t,\\vec{x})", element, {displayMode:false,throwOnError:false});$ , and the user must define one or more sidesets corresponding to the boundary subset $var element = document.getElementById("moose-equation-dce169c1-9bf7-4916-845f-f965087e5299");katex.render("\\partial \\Omega_D", element, {displayMode:false,throwOnError:false});$ via the boundary parameter.

Note that ADFunctionDirichletBC computes its Jacobian using automatic differentiation.

Preset boundary conditions

With the parameter preset = true, the value of the boundary condition is applied before the solve begins. With preset = false, the boundary condition is only enforced as the solve progresses. In most situations, presetting the boundary condition is better.

Example Input Syntax

[BCs]
  [left]
    type = ADFunctionDirichletBC
    variable = u
    boundary = left
    function = '1'
  []
  [right]
    type = ADRobinBC
    variable = u
    boundary = right
    coefficient = 2.0
  []
[]

Input Parameters

boundaryThe list of boundary IDs from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Unit:(no unit assumed)
Controllable:No
Description:The list of boundary IDs from the mesh where this object applies
variableThe name of the variable that this residual object operates on
C++ Type:NonlinearVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this residual object operates on

Required Parameters

diag_save_inThe name of auxiliary variables to save this BC'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<AuxVariableName>
Unit:(no unit assumed)
Controllable:No
Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
displacementsThe displacements
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The displacements
function0The function describing the Dirichlet condition
Default:0
C++ Type:FunctionName
Unit:(no unit assumed)
Controllable:No
Description:The function describing the Dirichlet condition
presetTrueWhether or not to preset the BC (apply the value before the solve begins).
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether or not to preset the BC (apply the value before the solve begins).
save_inThe name of auxiliary variables to save this BC'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<AuxVariableName>
Unit:(no unit assumed)
Controllable:No
Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

Optional Parameters

absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution
C++ Type:std::vector<TagName>
Unit:(no unit assumed)
Controllable:No
Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution
extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
C++ Type:std::vector<TagName>
Unit:(no unit assumed)
Controllable:No
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<TagName>
Unit:(no unit assumed)
Controllable:No
Description:The extra tags for the vectors this Kernel should fill
matrix_tagssystem timeThe tag for the matrices this Kernel should fill
Default:system time
C++ Type:MultiMooseEnum
Unit:(no unit assumed)
Options:nontime, system, time
Controllable:No
Description:The tag for the matrices this Kernel should fill
vector_tagsresidualThe tag for the vectors this Kernel should fill
Default:residual
C++ Type:MultiMooseEnum
Unit:(no unit assumed)
Options:nontime, time, residual
Controllable:No
Description:The tag for the vectors this Kernel should fill

Tagging Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:Yes
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
Unit:(no unit assumed)
Controllable:No
Description:Determines whether this object is calculated using an implicit or explicit form
seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
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
Unit:(no unit assumed)
Controllable:No
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

(moose/test/tests/bcs/ad_bcs/ad_bc.i)

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

[Variables]
  [u]
  []
[]

[Kernels]
  [diff]
    type = ADDiffusion
    variable = u
  []
[]

[BCs]
  [left]
    type = ADFunctionDirichletBC
    variable = u
    boundary = left
    function = '1'
  []
  [right]
    type = ADRobinBC
    variable = u
    boundary = right
    coefficient = 2.0
  []
[]

[Executioner]
  type = Steady
  solve_type = 'NEWTON'
[]

[Outputs]
  exodus = true
[]

Description
Preset boundary conditions
Example Input Syntax
Input Parameters