LinearFVReaction

Description

This kernel contributes to the system matrix of a system which is solved for a linear finite volume variable MooseVariableLinearFVReal. The contribution for each cell is the numerical integral of the reaction coefficient ( $var element = document.getElementById("moose-equation-85edb482-3fb8-4c49-bb8a-612afc912ad2");katex.render("c", element, {displayMode:false,throwOnError:false});$ ) times the field quantity ( $var element = document.getElementById("moose-equation-1728c6f8-0b22-4d0d-8719-572836c3c1f3");katex.render("u", element, {displayMode:false,throwOnError:false});$ ) in the following form:

var element = document.getElementById("moose-equation-941420af-c606-48b2-870f-2c823070e7f0");katex.render("\\int\\limits_{V_C} c u dV \\approx c_C u_C V_C~,", element, {displayMode:true,throwOnError:false});

where $var element = document.getElementById("moose-equation-cf636b28-6322-4963-a018-1e03d3791649");katex.render("u_C", element, {displayMode:false,throwOnError:false});$ , $var element = document.getElementById("moose-equation-0caea3a5-caa4-4748-84cf-513ddc4576c4");katex.render("c_C", element, {displayMode:false,throwOnError:false});$ and $var element = document.getElementById("moose-equation-0324b87e-4d79-40f2-b46e-75e31d47c5b3");katex.render("V_C", element, {displayMode:false,throwOnError:false});$ denote the cell centroid values of $var element = document.getElementById("moose-equation-d53d9044-e8f9-4e99-a063-04cff16bcc20");katex.render("u", element, {displayMode:false,throwOnError:false});$ and $var element = document.getElementById("moose-equation-bf344d72-2a91-4908-a7f8-64baa2ee30ef");katex.render("c", element, {displayMode:false,throwOnError:false});$ and the volume, respectively. This means that the diagonal entry of the system matrix corresponding to cell $var element = document.getElementById("moose-equation-5525aa29-8f7a-4d7c-951d-9dde8100223e");katex.render("C", element, {displayMode:false,throwOnError:false});$ will be increased by $var element = document.getElementById("moose-equation-9b26bee0-4134-4a62-b570-2119e313fb99");katex.render("c_C V_C", element, {displayMode:false,throwOnError:false});$ .

The reaction coefficient parameter ("coeff") accepts anything that supports functor-based evaluations. For more information on functors in MOOSE, see Functor system.

Example Syntax

The case below demonstrates the use of LinearFVReaction where the reaction coefficient is supplied based upon a function form:

[LinearFVKernels]
  [reaction]
    type = LinearFVReaction
    variable = u
    coeff = coeff_func
  []
  [source]
    type = LinearFVSource
    variable = u
    source_density = source_func
  []
[]

Input Parameters

variableThe name of the variable whose linear system this object contributes to
C++ Type:LinearVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable whose linear system this object contributes to

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
coeff1The reaction coefficient. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
Default:1
C++ Type:MooseFunctorName
Unit:(no unit assumed)
Controllable:No
Description:The reaction coefficient. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

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_tagsrhsThe tag for the vectors this Kernel should fill
Default:rhs
C++ Type:MultiMooseEnum
Unit:(no unit assumed)
Options:rhs, 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/linearfvkernels/reaction/reaction-1d.i)

[Mesh]
  [gmg]
    type = GeneratedMeshGenerator
    dim = 1
    nx = 10
  []
[]

[Problem]
  linear_sys_names = 'u_sys'
[]

[Variables]
  [u]
    type = MooseLinearVariableFVReal
    solver_sys = 'u_sys'
    initial_condition = 1.0
  []
[]

[LinearFVKernels]
  [reaction]
    type = LinearFVReaction
    variable = u
    coeff = coeff_func
  []
  [source]
    type = LinearFVSource
    variable = u
    source_density = source_func
  []
[]

[Functions]
  [coeff_func]
    type = ParsedFunction
    expression = '1+sin(x)'
  []
  [source_func]
    type = ParsedFunction
    expression = '(1+sin(x))*(1+cos(x))'
  []
  [analytic_solution]
    type = ParsedFunction
    expression = '1+cos(x)'
  []
[]

[Postprocessors]
  [l2error]
    type = ElementL2FunctorError
    approximate = u
    exact = analytic_solution
    execute_on = TIMESTEP_END
  []
[]

[Executioner]
  type = Steady
  system_names = u_sys
  l_abs_tol = 1e-10
[]

[Outputs]
  [exodus]
    type = Exodus
    execute_on = TIMESTEP_END
  []
[]

Description
Example Syntax
Input Parameters