FVBodyForce

Description

FVBodyForce 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-a3814eb2-b531-4d09-b795-e5cbb4710b64");katex.render("\\Omega", element, {displayMode:false,throwOnError:false});$ is defined as

$var element = document.getElementById("moose-equation-a6c37c5c-a1df-48a5-9182-1793d98febc7");katex.render("\\underbrace{-f}_{\\textrm{FVBodyForce}} + \\sum_{i=1}^n \\beta_i = 0 \\in \\Omega", element, {displayMode:true,throwOnError:false});$ where $var element = document.getElementById("moose-equation-90e5bb0d-12ee-409f-895e-7c2d433bdd23");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 Jacobian term for this kernel is zero: $var element = document.getElementById("moose-equation-e9566ee4-c0ac-469c-90d3-097aedb77033");katex.render("\\frac{\\partial R_i(u_h)}{\\partial u_j} = 0", element, {displayMode:false,throwOnError:false});$ , since it is assumed that $var element = document.getElementById("moose-equation-58ff3c7f-9d85-468f-a094-e9b2314393e4");katex.render("f", element, {displayMode:false,throwOnError:false});$ is not a function of the unknown $var element = document.getElementById("moose-equation-3df0574f-360f-4532-87ff-e559b03c7e42");katex.render("u", element, {displayMode:false,throwOnError:false});$ .

The force is constructed through a user supplied constant $var element = document.getElementById("moose-equation-c1d494c1-cdd9-44b3-993f-3a91bc11d7ae");katex.render("c", element, {displayMode:false,throwOnError:false});$ , function value evaluated at the current time and quadrature point $var element = document.getElementById("moose-equation-56ba4feb-ee25-4419-97db-f8c83d5e22fa");katex.render("f", element, {displayMode:false,throwOnError:false});$ , and/or postprocessor value $var element = document.getElementById("moose-equation-0e9a2e8d-011c-4d21-9b50-825af1224abf");katex.render("p", element, {displayMode:false,throwOnError:false});$ . The constant $var element = document.getElementById("moose-equation-58363bc0-4d95-46f7-b6c4-61b78cf70c14");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-32457a99-3c31-46ec-a74e-17b48e4d62e6");katex.render("c", element, {displayMode:false,throwOnError:false});$ , $var element = document.getElementById("moose-equation-b2b8bdeb-597a-48cc-a294-73ccda0213e6");katex.render("f", element, {displayMode:false,throwOnError:false});$ , $var element = document.getElementById("moose-equation-a41cc88f-488a-4545-8d82-5d918854615f");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-55b001e3-7899-4ba7-a491-51c4b552757e");katex.render("c", element, {displayMode:false,throwOnError:false});$ , $var element = document.getElementById("moose-equation-5618d162-17a2-4780-8717-f5c357f4e341");katex.render("f", element, {displayMode:false,throwOnError:false});$ , or $var element = document.getElementById("moose-equation-972bd4c8-9452-4d75-ba37-4a7a317bc370");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 FVBodyForce where the force term is supplied based upon a function form:

[FVKernels]
  [diff]
    type = FVDiffusion
    variable = u
    coeff = coeff
  []
  [force]
    type = FVBodyForce
    variable = u
    function = force
  []
[]

Input Parameters

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

blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Unit:(no unit assumed)
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
function1A function that describes the body force
Default:1
C++ Type:FunctionName
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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.
use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
value1Coefficient to multiply by the body force term
Default:1
C++ Type:double
Unit:(no unit assumed)
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>
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_tagssystemThe tag for the matrices this Kernel should fill
Default:system
C++ Type:MultiMooseEnum
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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>
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

ghost_layers1The number of layers of elements to ghost.
Default:1
C++ Type:unsigned short
Unit:(no unit assumed)
Controllable:No
Description:The number of layers of elements to ghost.
use_point_neighborsFalseWhether to use point neighbors, which introduces additional ghosting to that used for simple face neighbors.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether to use point neighbors, which introduces additional ghosting to that used for simple face neighbors.

Parallel Ghosting Parameters

(moose/test/tests/fvkernels/fv_adapt/transient-adapt.i)

[Mesh]
  [gen]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 10
    ny = 10
    elem_type = QUAD4
  []
[]

[Variables]
  [u]
    order = CONSTANT
    family = MONOMIAL
  []
  [v][]
[]

[Functions]
  [force]
    type = ParsedFunction
    expression = t
  []
[]

[Kernels]
  [diff]
    type = Diffusion
    variable = v
  []
  [force]
    type = BodyForce
    variable = v
    function = force
  []
[]

[FVKernels]
  [diff]
    type = FVDiffusion
    variable = u
    coeff = coeff
  []
  [force]
    type = FVBodyForce
    variable = u
    function = force
  []
[]

[FVBCs]
  [right]
    type = FVDirichletBC
    variable = u
    boundary = right
    value = 1
  []
  [left]
    type = FVDirichletBC
    variable = u
    boundary = left
    value = 0
  []
[]

[BCs]
  [right]
    type = DirichletBC
    variable = v
    boundary = right
    value = 1
  []
  [left]
    type = DirichletBC
    variable = v
    boundary = left
    value = 0
  []
[]

[Materials]
  [diff]
    type = ADGenericFunctorMaterial
    prop_names = 'coeff'
    prop_values = '1'
  []
[]

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

[Adaptivity]
  marker = box
  initial_steps = 1
  [Markers]
    [box]
      bottom_left = '0.3 0.3 0'
      inside = refine
      top_right = '0.6 0.6 0'
      outside = do_nothing
      type = BoxMarker
    []
  []
[]

[Outputs]
  exodus = true
[]

Description
Example Syntax
Input Parameters