ADBodyForce

Description

ADBodyForce implements a force term in momentum transport or structural mechanics or a source term in species/mass transport. The strong form, given a domain $var element = document.getElementById("moose-equation-651fb29f-e316-470d-953a-54f767eeb1d9");katex.render("\\Omega", element, {displayMode:false,throwOnError:false});$ is defined as

$var element = document.getElementById("moose-equation-1827aa62-0e5f-40ca-bf77-1204227cc84c");katex.render("\\underbrace{-f}_{\\textrm{ADBodyForce}} + \\sum_{i=1}^n \\beta_i = 0 \\in \\Omega", element, {displayMode:true,throwOnError:false});$ where $var element = document.getElementById("moose-equation-5548d15a-7682-4889-aeed-977f76722e0f");katex.render("f", element, {displayMode:false,throwOnError:false});$ is the source term (negative if a sink) and the second term on the left hand side represents the strong forms of other kernels. The ADBodyForce weak form, in inner-product notation, is defined as

$var element = document.getElementById("moose-equation-9b21d205-7e43-44d1-a0a1-169e5bc7c05c");katex.render("R_i(u_h) = (\\psi_i, -f) \\quad \\forall \\psi_i,", element, {displayMode:true,throwOnError:false});$ where the $var element = document.getElementById("moose-equation-d561b3d6-1332-4637-a22c-95c94117be5c");katex.render("\\psi_i", element, {displayMode:false,throwOnError:false});$ are the test functions, and $var element = document.getElementById("moose-equation-bc583f19-6ad8-4936-8ee1-dd667fbedb01");katex.render("u_h", element, {displayMode:false,throwOnError:false});$ are the trial solutions in the finite dimensional space $var element = document.getElementById("moose-equation-02af2d81-6a2a-413b-ab72-e111685c2d91");katex.render("\\mathcal{S}^h", element, {displayMode:false,throwOnError:false});$ for the unknown ( $var element = document.getElementById("moose-equation-395979b9-c71e-4c4e-9e46-8b7c0e8bca73");katex.render("u", element, {displayMode:false,throwOnError:false});$ ).

The force is constructed through a user supplied constant $var element = document.getElementById("moose-equation-21cbcd1a-c86b-4f75-a4e0-9f67f8ff2b8b");katex.render("c", element, {displayMode:false,throwOnError:false});$ , function value evaluated at the current time and quadrature point $var element = document.getElementById("moose-equation-24221ea7-268a-442f-8e4a-f9dd8612b92f");katex.render("f", element, {displayMode:false,throwOnError:false});$ , and/or postprocessor value $var element = document.getElementById("moose-equation-769e5b85-da23-4602-af92-384b21e29bb9");katex.render("p", element, {displayMode:false,throwOnError:false});$ . The constant $var element = document.getElementById("moose-equation-1b812ccd-2b8e-4f99-9395-13d9281ae730");katex.render("c", element, {displayMode:false,throwOnError:false});$ , supplied through the parameter value, may also be controlled over the course of a transient simulation with a Controls block. $var element = document.getElementById("moose-equation-5dc10423-e7f2-4783-b485-9dda79b77127");katex.render("c", element, {displayMode:false,throwOnError:false});$ , $var element = document.getElementById("moose-equation-cff09314-3492-4aca-b2f9-6dc08a04390a");katex.render("f", element, {displayMode:false,throwOnError:false});$ , $var element = document.getElementById("moose-equation-074e4fd0-7104-4158-b445-b8a045536721");katex.render("p", element, {displayMode:false,throwOnError:false});$ are supplied through the input parameters value, function, and postprocessor respectively. Not supplying $var element = document.getElementById("moose-equation-adada23f-91f4-4a00-bfc5-e568a5ef4876");katex.render("c", element, {displayMode:false,throwOnError:false});$ , $var element = document.getElementById("moose-equation-baf08aa7-094f-4db2-9f72-f53e4bb50259");katex.render("f", element, {displayMode:false,throwOnError:false});$ , or $var element = document.getElementById("moose-equation-e28a372f-b2f0-450f-a431-f83efa6723ba");katex.render("p", element, {displayMode:false,throwOnError:false});$ through its corresponding parameter is equivalent to setting its value to unity.

Example Syntax

The case below demonstrates the use of ADBodyForce where the force term is supplied solely through the a function (denoted by function):

[Kernels]
  active = 'diff'

  [./diff]
    type = ADDiffusion
    variable = u
  [../]
[]

Input Parameters

variableThe name of the variable that this residual object operates on
C++ Type:NonlinearVariableName
Controllable:No
Description:The name of the variable that this residual object operates on

Required Parameters

blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
displacementsThe displacements
C++ Type:std::vector<VariableName>
Controllable:No
Description:The displacements
function1A function that describes the body force
Default:1
C++ Type:FunctionName
Controllable:No
Description:A function that describes the body force
postprocessor1A postprocessor whose value is multiplied by the body force
Default:1
C++ Type:PostprocessorName
Controllable:No
Description:A postprocessor whose value is multiplied by the body force
prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
value1Coefficient to multiply by the body force term
Default:1
C++ Type:double
Controllable:Yes
Description:Coefficient to multiply by the body force term

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>
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>
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>
Controllable:No
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
Controllable:No
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
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>
Controllable:No
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<AuxVariableName>
Controllable:No
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
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
Controllable:No
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<AuxVariableName>
Controllable:No
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
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
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_bc_preset_nodal/bc_function_preset.i)

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 10
  ny = 10
  nz = 0
  zmin = 0
  zmax = 0
  elem_type = QUAD4
[]

[Variables]
  active = 'u'

  [./u]
    order = FIRST
    family = LAGRANGE
  [../]
[]

[Functions]
  [./left]
    type = ParsedFunction
    expression = 'y'
  [../]

  [./right]
    type = ParsedFunction
    expression = '1+y'
  [../]
[]

[Kernels]
  active = 'diff'

  [./diff]
    type = ADDiffusion
    variable = u
  [../]
[]

[BCs]
  active = 'left right'

   [./left]
    type = ADFunctionDirichletBC
    variable = u
    boundary = 3
    function = left
  [../]

  [./right]
    type = ADFunctionDirichletBC
    variable = u
    boundary = 1
    function = right
  [../]
[]

[Executioner]
  type = Steady

  solve_type = 'PJFNK'
[]

[Outputs]
  file_base = bc_func_out
  exodus = true
[]