- boundaryThe list of boundary IDs from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundary IDs from the mesh where this object applies
- coupled_fieldCoupled field variable.
C++ Type:std::vector<VariableName>
Controllable:No
Description:Coupled field variable.
- variableThe name of the variable that this residual object operates on
C++ Type:NonlinearVariableName
Controllable:No
Description:The name of the variable that this residual object operates on
VectorEMRobinBC
First order Robin-style Absorbing/Port BC for vector variables.
Overview
The VectorEMRobinBC object is an implementation of the first-order Robin-style boundary condition outlined in (Jin, 2014) Equation 9.60 and (Jin, 2010) Equation 9.3.51 for vector field variables.
General (vector field) form
The generic Jin condition is, in turn, based on the Sommerfeld radiation condition for scattered fields. Given that any scattered field can be made up of a combination of the scattered field and the incident field (), then we have
where
is the total (i.e., the solution) electric field vector,
is the incoming electric field vector,
is the relative magnetic permeability,
,
is the wave number ( where is the wavelength),
is a radiation condition parameter ( if the condition is applied in free space), and
is the boundary normal vector.
Implemented form
In VectorEMRobinBC, this condition is slightly generalized. The ratio of is generalized to a coefficient function , and so the implemented form is
where
is a function containing the condition coefficients.
Note that generally is just the wavenumber , since this condition is generally applied in free space, but any function can be applied through the "beta" parameter.
Usage notes
It is important to note that when used as an absorber (strictly absorbing means "mode" is set to absorbing
and zero incoming wave but a port also has an absorbing component), care must be taken in setting the shape of the truncation boundary as well as the distance from the scattering object. Boundaries as close as away from the object was shown in (Jin, 2014), and several wavelengths were used in the Dipole Antenna Benchmark for VectorEMRobinBC. Also, this boundary condition is best applied on spherical boundaries (as a result of its origin from the Sommerfeld condition, which was derived for spherical boundaries). Of course, it is also valid on any non-spherical smooth surface with a trade-off in accuracy.
Example Input File Syntax
As a Port
[sides_real]
type = VectorEMRobinBC
variable = u_real
component = real
coupled_field = u_imaginary
imag_incoming = mms_imaginary
real_incoming = mms_real
boundary = 'left right top bottom'
[]
(../moose/modules/electromagnetics/test/tests/bcs/vector_robin_bc/portbc_waves.i)As an Absorber
[radiation_condition_real]
type = VectorEMRobinBC
variable = E_real
coupled_field = E_imag
boundary = boundary
component = real
mode = absorbing
beta = 20.9439510239 # wave number at 1 GHz
[]
(../moose/modules/electromagnetics/test/tests/benchmarks/dipole_antenna/dipole.i)Input Parameters
- beta1Scalar wave number.
Default:1
C++ Type:FunctionName
Controllable:No
Description:Scalar wave number.
- componentVariable field component (real or imaginary).
C++ Type:MooseEnum
Controllable:No
Description:Variable field component (real or imaginary).
- displacementsThe displacements
C++ Type:std::vector<VariableName>
Controllable:No
Description:The displacements
- imag_incoming0Imaginary incoming field vector.
Default:0
C++ Type:FunctionName
Controllable:No
Description:Imaginary incoming field vector.
- modeportMode of operation for VectorEMRobinBC.
Default:port
C++ Type:MooseEnum
Controllable:No
Description:Mode of operation for VectorEMRobinBC.
- 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
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.
- real_incoming0Real incoming field vector.
Default:0
C++ Type:FunctionName
Controllable:No
Description:Real incoming field vector.
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
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
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>
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>
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
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 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>
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
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.