- 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
VectorTransientAbsorbingBC
First order transient absorbing boundary condition for vector variables.
Overview
The VectorTransientAbsorbingBC implements the first-order absorbing boundary condition mentioned in (Jin, 2014) Equation 12.83 for vector variables. This condition is given by
where
is the electric field vector with complex components,
is the vacuum magnetic permeability,
is the intrinsic admittance of the infinite medium, and
is the boundary normal vector.
The intrinsic admittance of the infinite medium is set to a default of free space, which is defined as
where
is the vacuum electric permittivity,
is the vacuum magnetic permeability, and
is the speed of light.
Example Input File Syntax
[radiation_condition_real] # First order absorbing boundary condition
type = VectorTransientAbsorbingBC
variable = E_real
coupled_field = E_imag
boundary = boundary
component = real
[]
(../moose/modules/electromagnetics/test/tests/benchmarks/dipole_antenna/dipole_transient.i)Input Parameters
- admittance1/(4*pi*1e-7*3e8)Intrinsic admittance of the infinite medium (default is $\sqrt{\frac{\epsilon_0}{\mu_0}} = \frac{1}{\mu_0 c}$, or the admittance of free space).
Default:1/(4*pi*1e-7*3e8)
C++ Type:FunctionName
Controllable:No
Description:Intrinsic admittance of the infinite medium (default is $\sqrt{\frac{\epsilon_0}{\mu_0}} = \frac{1}{\mu_0 c}$, or the admittance of free space).
- 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
- 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.
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.
Advanced Parameters
References
- Jian-Ming Jin.
The Finite Element Method in Electromagnetics.
John Wiley & Sons, Hoboken, New Jersey, USA, 3rd edition, 2014.[BibTeX]