VectorCurrentSource

Kernel to calculate the current source term in the Helmholtz wave equation.

Overview

The VectorCurrentSource object implements the volumetric current source term in the electric field Helmholtz wave equation. This term, in general, is

$var element = document.getElementById("moose-equation-6a99d6a2-1d80-4fb2-bf81-cfd34bf301e7");katex.render(" j \\; f(\\mathbf{r}, t) \\; \\vec{J}", element, {displayMode:true,throwOnError:false});$

where

$var element = document.getElementById("moose-equation-64b80806-69eb-4ecc-9345-60077e37de3a");katex.render("j = \\sqrt{-1}", element, {displayMode:false,throwOnError:false});$ ,
$var element = document.getElementById("moose-equation-5ed365b6-2976-4839-b76d-af02c9bbbaa8");katex.render("f(\\mathbf{r}, t)", element, {displayMode:false,throwOnError:false});$ is a time- and spatially-varying coefficient function, and
$var element = document.getElementById("moose-equation-f9b13aeb-1b1d-4098-bbf2-5e0416810dc8");katex.render("\\vec{J}", element, {displayMode:false,throwOnError:false});$ is the complex source vector field.

Note that $var element = document.getElementById("moose-equation-7012fb8d-22ec-40ac-8031-5eddf2e9d9e2");katex.render("\\vec{J}", element, {displayMode:false,throwOnError:false});$ is provided via vector-valued functions, using the "source_real" and "source_imag" parameters for the real and imaginary components respectively.

Example Input File Syntax

[Kernels<<<{"href": "../../syntax/Kernels/index.html"}>>>]
  [current_real]
    type = VectorCurrentSource<<<{"description": "Kernel to calculate the current source term in the Helmholtz wave equation.", "href": "VectorCurrentSource.html"}>>>
    variable<<<{"description": "The name of the variable that this residual object operates on"}>>> = u_real
    function_coefficient<<<{"description": "Function coefficient multiplier for current source (normally $\\omega$ or $\\omega \\cdot \\mu$)."}>>> = -1.0
    source_real<<<{"description": "Current Source vector, real component"}>>> = source_real
    source_imag<<<{"description": "Current Source vector, imaginary component"}>>> = source_imag
    component<<<{"description": "Component of field (real or imaginary)."}>>> = real
  []
[]

Input Parameters

source_imagCurrent Source vector, imaginary component
C++ Type:FunctionName
Unit:(no unit assumed)
Controllable:No
Description:Current Source vector, imaginary component
source_realCurrent Source vector, real component
C++ Type:FunctionName
Unit:(no unit assumed)
Controllable:No
Description:Current Source vector, real component
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>
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
componentComponent of field (real or imaginary).
C++ Type:MooseEnum
Options:real, imaginary
Controllable:No
Description:Component of field (real or imaginary).
displacementsThe displacements
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The displacements
function_coefficient1Function coefficient multiplier for current source (normally $\omega$ or $\omega \cdot \mu$).
Default:1
C++ Type:FunctionName
Unit:(no unit assumed)
Controllable:No
Description:Function coefficient multiplier for current source (normally $\omega$ or $\omega \cdot \mu$).
matrix_onlyFalseWhether this object is only doing assembly to matrices (no vectors)
Default:False
C++ Type:bool
Controllable:No
Description:Whether this object is only doing assembly to matrices (no vectors)

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

Contribution To Tagged Field Data 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>
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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

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
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.

Material Property Retrieval Parameters

(moose/modules/electromagnetics/test/tests/kernels/vector_helmholtz/vector_current_source.i)

# Test for VectorCurrentSource
# Manufactured solution: u_real = y^2 * x_hat - x^2 * y_hat
#                        u_imag = y^2 * x_hat - x^2 * y_hat

[Mesh]
  [gmg]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 10
    ny = 10
    xmin = -1
    ymin = -1
    elem_type = QUAD9
  []
[]

[Functions]
  [source_real]
    type = ParsedVectorFunction
    expression_x = 'y*y - 2'
    expression_y = '2 - x*x'
  []
  [source_imag]
    type = ParsedVectorFunction
    expression_x = '2 - y*y'
    expression_y = 'x*x - 2'
  []
[]

[Variables]
  [u_real]
    family = NEDELEC_ONE
    order = FIRST
  []
  [u_imag]
    family = NEDELEC_ONE
    order = FIRST
  []
[]

[Kernels]
  [curl_curl_real]
    type = CurlCurlField
    variable = u_real
  []
  [coeff_real]
    type = VectorFunctionReaction
    variable = u_real
  []
  [current_real]
    type = VectorCurrentSource
    variable = u_real
    function_coefficient = -1.0
    source_real = source_real
    source_imag = source_imag
    component = real
  []
  [curl_curl_imag]
    type = CurlCurlField
    variable = u_imag
  []
  [coeff_imag]
    type = VectorFunctionReaction
    variable = u_imag
  []
  [current_imag]
    type = VectorCurrentSource
    variable = u_imag
    function_coefficient = -1.0
    source_real = source_real
    source_imag = source_imag
    component = imaginary
  []
[]

[BCs]
  [sides_real]
    type = VectorCurlPenaltyDirichletBC
    variable = u_real
    function_x = 'y*y'
    function_y = '-x*x'
    penalty = 1e8
    boundary = 'left right top bottom'
  []
  [sides_imag]
    type = VectorCurlPenaltyDirichletBC
    variable = u_imag
    function_x = 'y*y'
    function_y = '-x*x'
    penalty = 1e8
    boundary = 'left right top bottom'
  []
[]

[Preconditioning]
  [SMP]
    type = SMP
    full = true
  []
[]

[Executioner]
  type = Steady
  solve_type = 'NEWTON'
  petsc_options_iname = '-pc_type'
  petsc_options_value = 'lu'
[]

[Outputs]
  exodus = true
[]

Overview
Example Input File Syntax
Input Parameters