TM0AntennaVertBC

A simple vertical antenna BC of the azimuthal component of the magnetizing field.

Overview

TM0AntennaVertBC is the boundary condition of the azimuthal component of the magnetizing field for a simple vertical antenna. TM0AntennaVertBC assumes an axisymmetric transverse magnetic (TM) wave, an incoming electric field of unity, and negligible current density compared to the displacement current.

The boundary condition of the azimuthal component of the magnetizing field normal to the antenna surface is

$var element = document.getElementById("moose-equation-9f2791ad-f288-4cf6-835a-b1a4af5a0d48");katex.render(" \\textbf{n} \\times \\left( \\nabla \\times \\textbf{H} \\right) = j \\omega \\epsilon \\textbf{E}", element, {displayMode:true,throwOnError:false});$

Where $var element = document.getElementById("moose-equation-c536daff-60b3-4c45-afa6-730d0335b339");katex.render("\\textbf{H}", element, {displayMode:false,throwOnError:false});$ is the magnetizing field, $var element = document.getElementById("moose-equation-d1d17f71-9202-470b-8afe-4bc012537030");katex.render("\\textbf{n}", element, {displayMode:false,throwOnError:false});$ is the normal vector of the boundary, $var element = document.getElementById("moose-equation-81d01e8f-d77a-4b3c-9d57-41dbfa073fd6");katex.render("\\epsilon", element, {displayMode:false,throwOnError:false});$ is the material permittivity, $var element = document.getElementById("moose-equation-5ddb9f73-8335-44ba-a098-68508a0c5eb8");katex.render("\\omega", element, {displayMode:false,throwOnError:false});$ is the drive frequency of the system, $var element = document.getElementById("moose-equation-1f3e66fe-dd18-45b7-a0d3-91fb18162d31");katex.render("\\textbf{E}", element, {displayMode:false,throwOnError:false});$ is the electric field, and $var element = document.getElementById("moose-equation-28fd74e9-ea7a-4141-9c7b-47913026f583");katex.render("j = \\sqrt{-1}", element, {displayMode:false,throwOnError:false});$ . By assuming the normal of azimuthal component of the magnetizing field to the surface is purely in the axial direction and an incoming electric field of unity (such that $var element = document.getElementById("moose-equation-5305beb9-4f08-49b9-a401-c9ab565406a4");katex.render("\\textbf{E} = (1 - j)", element, {displayMode:false,throwOnError:false});$ ), the integrated boundary condition simplifies to

$var element = document.getElementById("moose-equation-b562136f-4697-480c-87e7-d9d01205c998");katex.render(" \\nabla \\text{H}_{\\theta} \\cdot \\textbf{n} = \\frac{\\text{-} \\text{H}_{\\theta}}{r} + \\omega \\epsilon", element, {displayMode:true,throwOnError:false});$

Where $var element = document.getElementById("moose-equation-ce22f827-e14a-4fda-9844-59fcdcc1fba4");katex.render("H_{\\phi}", element, {displayMode:false,throwOnError:false});$ is the azimuthal component of the magnetizing field and $var element = document.getElementById("moose-equation-2cac0413-86b9-43fe-af86-296e42c30267");katex.render("r", element, {displayMode:false,throwOnError:false});$ is the radial distance from the axial centerline.

Example Input File Syntax

[BCs]
  [launcher]
    type = TM0AntennaVertBC
    boundary = Antenna
    variable = Hphi_vacuum
  []
[]

Input Parameters

boundaryThe list of boundary IDs from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Unit:(no unit assumed)
Controllable:No
Description:The list of boundary IDs from the mesh where this object applies
fThe drive frequency.
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The drive frequency.
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

displacementsThe displacements
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The displacements
eps_r1The relative permittivity.
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The relative permittivity.
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.
time_dependentFalseWhether the antenna boundary condition should oscillate in time.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether the antenna boundary condition should oscillate in time.
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.

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.
diag_save_inThe name of auxiliary variables to save this BC'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 BC'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
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
save_inThe name of auxiliary variables to save this BC'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 BC'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
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

Input Files

(test/tests/TM10_circular_wg/TM_steady.i)
(test/tests/TM10_circular_wg/TM_steady_dieletric.i)

(test/tests/TM10_circular_wg/TM_steady_dieletric.i)

[GlobalParams]
  f = 10e9
[]

[Mesh]
  [file]
    type = FileMeshGenerator
    file = 'TM_dieletric.msh'
    # construct_side_list_from_node_list = 1
  []
  [interface_dielectric]
    type = SideSetsBetweenSubdomainsGenerator
    primary_block = '1'
    paired_block = '0'
    new_boundary = 'interface_dielectric'
    input = file
  []
  coord_type = RZ
[]

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

[Executioner]
  type = Steady
  solve_type = NEWTON

  petsc_options_iname = '-pc_type'
  petsc_options_value = 'lu'
[]

[Outputs]
  perf_graph = true
  print_linear_residuals = true
  [out]
    type = Exodus
  []
  [csv]
    type = CSV
  []
[]

[Variables]
  [Hphi_dielectric]
    block = 1
    order = SECOND
  []
  [Hphi_vacuum]
    block = 0
    order = SECOND
  []
  [Ez_dielectric]
    block = 1
    order = SECOND
  []
  [Ez_vacuum]
    block = 0
    order = SECOND
  []
  [Er_dielectric]
    block = 1
    order = SECOND
  []
  [Er_vacuum]
    block = 0
    order = SECOND
  []
[]

[Kernels]
  [Hphi_dielectric]
    type = TM0Cylindrical
    variable = Hphi_dielectric
    block = 1
  []
  [Hphi_vacuum]
    type = TM0Cylindrical
    variable = Hphi_vacuum
    block = 0
  []
  [Ez_dielectric_kern]
    type = TM0CylindricalEz
    variable = Ez_dielectric
    block = 1
    Hphi = Hphi_dielectric
  []
  [Ez_vacuum_kern]
    type = TM0CylindricalEz
    variable = Ez_vacuum
    block = 0
    Hphi = Hphi_vacuum
  []
  [Er_dielectric]
    type = TM0CylindricalEr
    variable = Er_dielectric
    Hphi = Hphi_dielectric
    block = 1
  []
  [Er_vacuum]
    type = TM0CylindricalEr
    variable = Er_vacuum
    Hphi = Hphi_vacuum
    block = 0
  []
[]

[BCs]
  [launcher]
    type = TM0AntennaVertBC
    boundary = Antenna
    variable = Hphi_vacuum
  []
  [vert_wall]
    type = TM0PECVertBC
    variable = Hphi_vacuum
    boundary = vert_pec
  []
  [axis]
    type = DirichletBC
    variable = Hphi_dielectric
    boundary = Axis
    value = 0
  []
  [H_phi_interface]
    type = MatchedValueBC
    variable = Hphi_vacuum
    v = Hphi_dielectric
    boundary = interface
  []
  # [Ez_interface]
  #   type = MatchedValueBC
  #   variable = Ez_dielectric
  #   v = Ez_vacuum
  #   boundary = interface
  # []
[]

[InterfaceKernels]
  [Ez_continuous]
    type = HphiRadialInterface
    variable = Hphi_dielectric
    neighbor_var = Hphi_vacuum
    boundary = interface_dielectric
  []
[]

[Materials]
  [dielectric]
    type = ADGenericConstantMaterial
    prop_names = 'eps_r'
    prop_values = '3.8'
    block = 1
  []
  [vacuum]
    type = ADGenericConstantMaterial
    prop_names = 'eps_r'
    prop_values = '1'
    block = 0
  []
[]

# [AuxVariables]
#   [Hphi_mag]
#   []
#   [Er]
#     order = FIRST
#     family = MONOMIAL
#   []
#   # [Electric_z]
#   #   order = FIRST
#   #   family = MONOMIAL
#   # []
# []

# [AuxKernels]
#   [Hphi_mag]
#     type = AbsValueAux
#     u = Hphi
#     variable = Hphi_mag
#   []
#   [Er_dielectric]
#     type = TM0CylindricalEr
#     Hphi = Hphi
#     variable = Er
#     block = 1
#     eps_r = 16
#   []
#   [Er_vacuum]
#     type = TM0CylindricalEr
#     Hphi = Hphi
#     block = 0
#     eps_r = 1
#     variable = Er
#   []
#   # [Electric_z_dielectric]
#   #   type = TM0CylindricalEz
#   #   Hphi = Hphi
#   #   variable = Electric_z
#   #   block = 1
#   #   eps_r = 16
#   # []
#   # [Electric_z_vacuum]
#   #   type = TM0CylindricalEz
#   #   Hphi = Hphi
#   #   variable = Electric_z
#   #   block = 0
#   #   eps_r = 1
#   # []
# []

# [VectorPostprocessors]
#   [line0]
#     type = LineValueSampler
#     start_point = '0 .045 0'
#     end_point = '.015 .045 0'
#     num_points = 1000
#     sort_by = x
#     variable = Hphi
#     outputs = csv
#   []
#   [line1]
#     type = LineValueSampler
#     start_point = '0 .045 0'
#     end_point = '.015 .045 0'
#     num_points = 1000
#     sort_by = x
#     variable = Elec_z
#     outputs = csv
#   []
#   [line2]
#     type = LineValueSampler
#     start_point = '0 .045 0'
#     end_point = '.015 .045 0'
#     num_points = 1000
#     sort_by = x
#     variable = Er
#     outputs = csv
#   []
# []

(test/tests/TM10_circular_wg/TM_steady.i)

[GlobalParams]
  f = 10e9
[]

[Mesh]
  type = FileMesh
  file = 'TM.msh'
  coord_type = RZ
[]

[Problem]
  type = FEProblem
  # kernel_coverage_check = false
[]

[Preconditioning]
  [smp]
    type = SMP
    full = true
    ksp_norm = none
  []
[]

[Executioner]
  type = Steady
  solve_type = NEWTON
  # petsc_options = '-snes_converged_reason -snes_linesearch_monitor -ksp_converged_reason'
  petsc_options_iname = '-pc_type -pc_factor_shift_type -pc_factor_shift_amount -ksp_type -snes_linesearch_minlambda'
  petsc_options_value = 'lu NONZERO 1.e-10 preonly 1e-3'
  # petsc_options = '-snes_test_display'
  # petsc_options_iname = '-snes_type'
  # petsc_options_value = 'test'
  # nl_rel_tol = 1e-4
[]

[Outputs]
  perf_graph = true
  print_linear_residuals = false
  [out]
    type = Exodus
  []
[]

[Kernels]
  [TM]
    type = TM0Cylindrical
    variable = Hphi
  []
[]

[Variables]
  [Hphi]
  []
[]

[BCs]
  [launcher]
    type = TM0AntennaVertBC
    boundary = Antenna
    variable = Hphi
  []
  [vert_wall]
    type = TM0PECVertBC
    variable = Hphi
    boundary = vert_pec
  []
  [axis]
    type = DirichletBC
    variable = Hphi
    boundary = Axis
    value = 0
  []
[]

[AuxVariables]
  [Hphi_mag]
  []
  [Er]
    order = FIRST
    family = MONOMIAL
  []
  [Electric_z]
    order = FIRST
    family = MONOMIAL
  []
[]

[AuxKernels]
  [Hphi_mag]
    type = AbsValueAux
    u = Hphi
    variable = Hphi_mag
  []
  [Er]
    type = TM0CylindricalErAux
    Hphi = Hphi
    variable = Er
  []
  [Electric_z]
    type = TM0CylindricalEzAux
    Hphi = Hphi
    variable = Electric_z
  []
[]

[Materials]
  [vacuum]
    type = ADGenericConstantMaterial
    prop_names = 'eps_r'
    prop_values = '1'
    block = vacuum
  []
[]

(test/tests/TM10_circular_wg/TM_steady_dieletric.i)

[GlobalParams]
  f = 10e9
[]

[Mesh]
  [file]
    type = FileMeshGenerator
    file = 'TM_dieletric.msh'
    # construct_side_list_from_node_list = 1
  []
  [interface_dielectric]
    type = SideSetsBetweenSubdomainsGenerator
    primary_block = '1'
    paired_block = '0'
    new_boundary = 'interface_dielectric'
    input = file
  []
  coord_type = RZ
[]

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

[Executioner]
  type = Steady
  solve_type = NEWTON

  petsc_options_iname = '-pc_type'
  petsc_options_value = 'lu'
[]

[Outputs]
  perf_graph = true
  print_linear_residuals = true
  [out]
    type = Exodus
  []
  [csv]
    type = CSV
  []
[]

[Variables]
  [Hphi_dielectric]
    block = 1
    order = SECOND
  []
  [Hphi_vacuum]
    block = 0
    order = SECOND
  []
  [Ez_dielectric]
    block = 1
    order = SECOND
  []
  [Ez_vacuum]
    block = 0
    order = SECOND
  []
  [Er_dielectric]
    block = 1
    order = SECOND
  []
  [Er_vacuum]
    block = 0
    order = SECOND
  []
[]

[Kernels]
  [Hphi_dielectric]
    type = TM0Cylindrical
    variable = Hphi_dielectric
    block = 1
  []
  [Hphi_vacuum]
    type = TM0Cylindrical
    variable = Hphi_vacuum
    block = 0
  []
  [Ez_dielectric_kern]
    type = TM0CylindricalEz
    variable = Ez_dielectric
    block = 1
    Hphi = Hphi_dielectric
  []
  [Ez_vacuum_kern]
    type = TM0CylindricalEz
    variable = Ez_vacuum
    block = 0
    Hphi = Hphi_vacuum
  []
  [Er_dielectric]
    type = TM0CylindricalEr
    variable = Er_dielectric
    Hphi = Hphi_dielectric
    block = 1
  []
  [Er_vacuum]
    type = TM0CylindricalEr
    variable = Er_vacuum
    Hphi = Hphi_vacuum
    block = 0
  []
[]

[BCs]
  [launcher]
    type = TM0AntennaVertBC
    boundary = Antenna
    variable = Hphi_vacuum
  []
  [vert_wall]
    type = TM0PECVertBC
    variable = Hphi_vacuum
    boundary = vert_pec
  []
  [axis]
    type = DirichletBC
    variable = Hphi_dielectric
    boundary = Axis
    value = 0
  []
  [H_phi_interface]
    type = MatchedValueBC
    variable = Hphi_vacuum
    v = Hphi_dielectric
    boundary = interface
  []
  # [Ez_interface]
  #   type = MatchedValueBC
  #   variable = Ez_dielectric
  #   v = Ez_vacuum
  #   boundary = interface
  # []
[]

[InterfaceKernels]
  [Ez_continuous]
    type = HphiRadialInterface
    variable = Hphi_dielectric
    neighbor_var = Hphi_vacuum
    boundary = interface_dielectric
  []
[]

[Materials]
  [dielectric]
    type = ADGenericConstantMaterial
    prop_names = 'eps_r'
    prop_values = '3.8'
    block = 1
  []
  [vacuum]
    type = ADGenericConstantMaterial
    prop_names = 'eps_r'
    prop_values = '1'
    block = 0
  []
[]

# [AuxVariables]
#   [Hphi_mag]
#   []
#   [Er]
#     order = FIRST
#     family = MONOMIAL
#   []
#   # [Electric_z]
#   #   order = FIRST
#   #   family = MONOMIAL
#   # []
# []

# [AuxKernels]
#   [Hphi_mag]
#     type = AbsValueAux
#     u = Hphi
#     variable = Hphi_mag
#   []
#   [Er_dielectric]
#     type = TM0CylindricalEr
#     Hphi = Hphi
#     variable = Er
#     block = 1
#     eps_r = 16
#   []
#   [Er_vacuum]
#     type = TM0CylindricalEr
#     Hphi = Hphi
#     block = 0
#     eps_r = 1
#     variable = Er
#   []
#   # [Electric_z_dielectric]
#   #   type = TM0CylindricalEz
#   #   Hphi = Hphi
#   #   variable = Electric_z
#   #   block = 1
#   #   eps_r = 16
#   # []
#   # [Electric_z_vacuum]
#   #   type = TM0CylindricalEz
#   #   Hphi = Hphi
#   #   variable = Electric_z
#   #   block = 0
#   #   eps_r = 1
#   # []
# []

# [VectorPostprocessors]
#   [line0]
#     type = LineValueSampler
#     start_point = '0 .045 0'
#     end_point = '.015 .045 0'
#     num_points = 1000
#     sort_by = x
#     variable = Hphi
#     outputs = csv
#   []
#   [line1]
#     type = LineValueSampler
#     start_point = '0 .045 0'
#     end_point = '.015 .045 0'
#     num_points = 1000
#     sort_by = x
#     variable = Elec_z
#     outputs = csv
#   []
#   [line2]
#     type = LineValueSampler
#     start_point = '0 .045 0'
#     end_point = '.015 .045 0'
#     num_points = 1000
#     sort_by = x
#     variable = Er
#     outputs = csv
#   []
# []

Overview
Example Input File Syntax
Input Parameters
Input Files