CoupledForce

Description

CoupledForce implements a source term within the domain $var element = document.getElementById("moose-equation-816f8d24-6d33-4bea-a8be-42006f016b0b");katex.render("\\Omega", element, {displayMode:false,throwOnError:false});$ proportional to a coupled variable: $(1)var element = document.getElementById("moose-equation-6a81b6e5-f556-4dca-90e4-a1b1cf2afa36");katex.render("\\underbrace{-\\sigma v}_{\\textrm{CoupledForce}} + \\sum_{i=1}^n \\beta_i = 0 \\in \\Omega,", element, {displayMode:true,throwOnError:false});$ where $var element = document.getElementById("moose-equation-9a8f9742-4743-4718-bb85-e2eafce5a41c");katex.render("\\sigma", element, {displayMode:false,throwOnError:false});$ is a known scalar coefficient, $var element = document.getElementById("moose-equation-099e416b-e80c-4f0b-976a-a42396e04d75");katex.render("v", element, {displayMode:false,throwOnError:false});$ is a coupled unknown value, and the second term on the left hand side corresponds to the strong forms of other kernels. In a species transport context, the value $var element = document.getElementById("moose-equation-9d1faa3c-8622-41c3-ab1b-d671964da3df");katex.render("\\sigma", element, {displayMode:false,throwOnError:false});$ can be regarded as a reaction rate coefficient.

The weak form, in inner-product notation, is defined as

$(2)var element = document.getElementById("moose-equation-99954ac4-517b-4977-8a18-405e557777d8");katex.render("R_i(u_h) = (\\psi_i, -\\sigma v) \\quad \\forall \\psi_i,", element, {displayMode:true,throwOnError:false});$ where $var element = document.getElementById("moose-equation-efed6ebc-8bdd-4a88-b8b2-e795f3f610c5");katex.render("\\psi_i", element, {displayMode:false,throwOnError:false});$ are the test functions and $var element = document.getElementById("moose-equation-41eb6cd0-e4cd-4a9b-a285-b4fc034d3161");katex.render("u_h \\in \\mathcal{S}^h", element, {displayMode:false,throwOnError:false});$ is the finite element solution of the weak formulation.

The corresponding Jacobian is $(3)var element = document.getElementById("moose-equation-9134db01-03a3-4a61-83a1-84031f8d2d9c");katex.render("\\frac{\\partial R_i(u_h)}{\\partial u_j} = (\\psi_i, -\\sigma \\phi_j).", element, {displayMode:true,throwOnError:false});$

Example Syntax

The kernel block below shows a variable $var element = document.getElementById("moose-equation-813564d5-c24b-4788-8283-21d2c0e8d99d");katex.render("u", element, {displayMode:false,throwOnError:false});$ that is diffusing and being produced at a rate proportional to the concentration of a variable $var element = document.getElementById("moose-equation-3b430ac4-cdf4-4fb4-bf53-0b4441276209");katex.render("v", element, {displayMode:false,throwOnError:false});$ which is also diffusing.


[Kernels]
  [./diff_u]
    type = Diffusion
    variable = u
  [../]

  [./coupled_force_u]
    type = CoupledForce
    variable = u
    v = v
  [../]

  [./diff_v]
    type = Diffusion
    variable = v
  [../]
[]

note

In this example the input parameter "coef" that corresponds to $var element = document.getElementById("moose-equation-e4c0f763-0577-4e27-999a-4cba4115481d");katex.render("\\sigma", element, {displayMode:false,throwOnError:false});$ is omitted. In this case the "coef" value defaults to one.

Input Parameters

variableThe name of the variable that this Kernel operates on
C++ Type:NonlinearVariableName
Description:The name of the variable that this Kernel operates on
vThe coupled variable which provides the force
C++ Type:std::vector
Description:The coupled variable which provides the force

Required Parameters

blockThe list of block ids (SubdomainID) that this object will be applied
C++ Type:std::vector
Description:The list of block ids (SubdomainID) that this object will be applied
coef1Coefficent ($\sigma$) multiplier for the coupled force term.
Default:1
C++ Type:double
Description:Coefficent ($\sigma$) multiplier for the coupled force term.

Optional Parameters

enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Description:Set the enabled status of the MooseObject.
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
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.)
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
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
Description:Adds user-defined labels for accessing object parameters via control logic.
seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Description:The seed for the master random number generator
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
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.)
implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Description:Determines whether this object is calculated using an implicit or explicit form

Advanced Parameters

vector_tagsnontimeThe tag for the vectors this Kernel should fill
Default:nontime
C++ Type:MultiMooseEnum
Description:The tag for the vectors this Kernel should fill
extra_vector_tagsThe extra tags for the vectors this Kernel should fill
C++ Type:std::vector
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
Description:The tag for the matrices this Kernel should fill
extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
C++ Type:std::vector
Description:The extra tags for the matrices this Kernel should fill

Tagging Parameters

Description
Example Syntax
Input Parameters