Electromagnetics Requirements Traceability Matrix
This template follows INL template TEM-214, "IT System Requirements Traceability Matrix."
This document serves as an addendum to Framework Requirements Traceability Matrix and captures information for RTM specific to the Electromagnetics module.
Introduction
Minimum System Requirements
In general, the following is required for MOOSE-based development:
A POSIX compliant Unix-like operating system. This includes any modern Linux-based operating system (e.g., Ubuntu, Fedora, Rocky, etc.), or a Macintosh machine running either of the last two MacOS releases.
Hardware | Information |
---|---|
CPU Architecture | x86_64, ARM (Apple Silicon) |
Memory | 8 GB (16 GBs for debug compilation) |
Disk Space | 30GB |
Libraries | Version / Information |
---|---|
GCC | 8.5.0 - 12.2.1 |
LLVM/Clang | 10.0.1 - 16.0.6 |
Intel (ICC/ICX) | Not supported at this time |
Python | 3.7 - 3.11 |
Python Packages | packaging pyaml jinja2 |
System Purpose
The MOOSE Electromagnetics module provides an interface to and library containing Maxwell's equations within the MOOSE application ecosystem. It is intended to be used as either a standalone simulation code for electrodynamics or coupled to other MOOSE ecosystem codes (including MOOSE-wrapped applications). Thus, the Electromagnetics module uses the same object-oriented design as MOOSE in order to make simulation design and new development straightforward for engineers and researchers.
System Scope
The scope of the Electromagnetics module is to provide a set of interfaces and objects for building electrodynamics simulations based on the finite element method (FEM). Regarding solvers, meshing libraries, as well as solution/coupling methods and interfaces, the Electromagnetics module relies on the infrastructure provided by the MOOSE framework.
The system contains, generally, a base set of kernels, boundary conditions, and interface conditions designed for the solution of vector fields derived from Maxwell's equations. Further, it currently contains more specific capability in the following general areas:
Wave reflection, transmission, and absorption
Electrostatic contact on electrically imperfect surfaces
Electromagnetics module developers work with framework and other module and application developers to ensure that the Electromagnetics module provides adequate capability to support on-going and prospective research opportunities involving aspects of electromagnetics.
Assumptions and Dependencies
The Electromagnetics module is developed using MOOSE and can itself be based on various MOOSE modules, as such the RTM for the Electromagnetics module is dependent upon the files listed at the beginning of this document.
Pre-test Instructions/Environment/Setup
Ideally all testing should be performed on a clean test machine following one of the supported configurations setup by the test system engineer. Testing may be performed on local workstations and cluster systems containing supported operating systems.
The repository should be clean prior to building and testing. When using "git" this can be done by doing a force clean in the main repository and each one of the submodules:
git clean -xfd
git submodule foreach 'git clean -xfd'
All tests must pass in accordance with the type of test being performed. This list can be found in the Software Test Plan.
Changelog Issue Revisions
Errors in changelog references can sometimes occur as a result of typos or conversion errors. If any need to be noted by the development team, they will be noted here.
The changelog for all code residing in the MOOSE repository is located in the MOOSE RTM.
System Requirements Traceability
Functional Requirements
- electromagnetics: Auxkernels
- 4.1.1The system shall calculate the current density provided with electrostatic field calculations, using an AD material property for electrical conductivity.
Specification(s): ad_exodiff
Design: CurrentDensity / ADCurrentDensity
Issue(s): #21095
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 4.1.2The system shall calculate the current density provided with electrostatic field calculations, using a non-AD material property for electrical conductivity.
Specification(s): non_ad_exodiff
Design: CurrentDensity / ADCurrentDensity
Issue(s): #21095
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 4.1.3The system shall calculate the current density when provided with a vector field variable, simulating the case when an electromagnetic vector field is provided.
Specification(s): em_ad_exodiff
Design: CurrentDensity / ADCurrentDensity
Issue(s): #21095
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 4.1.4The system shall provide an error while
- calculating the current density when both electrostatic and electromagnetic field variables are provided by the user.
- calculating the current density when an electrostatic calculation is requested but an electromagnetic field variable is provided.
- calculating the current density when an electromagnetic calculation is requested but an electrostatic field variable is provided.
Specification(s): errors/two_vars, errors/ES_electric_field_var, errors/EM_potential_var
Design: CurrentDensity / ADCurrentDensity
Issue(s): #21095
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- electromagnetics: Bcs
- 4.2.1The system shall be able to simulate the field result of an incoming wave reflected on a biased surface and properly absorb the reflected wave in a boundary condition.
Specification(s): test
Design: EMRobinBC
Issue(s): #21098
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 4.2.2The system shall be able to simulate a first order electromagnetic wave launching/absorbing port as a boundary condition, given the incoming/outgoing wave, for real and imaginary components of the field and for vector variables.
Specification(s): waves
Design: VectorEMRobinBC
Issue(s): #21077
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 4.2.3The system shall use the correct jacobian contribution for a first order electromagnetics wave launching/absorbing port boundary condition for vector field variables.
Specification(s): waves_jacobian_test
Design: VectorEMRobinBC
Issue(s): #21077
Collection(s): FUNCTIONAL
Type(s): PetscJacobianTester
Prerequisite(s): 4.2.2
- 4.2.4The system shall present an error to the user whenever the mode of operation for VectorEMRobinBC is set to absorbing, but incoming wave information is supplied.
Specification(s): waves_absorbing_error
Design: VectorEMRobinBC
Issue(s): #21100
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
Prerequisite(s): 4.2.2
- electromagnetics: Benchmarks
- 4.3.1The system shall calculate the static far field pattern of a half-wave dipole antenna.
Specification(s): time_harmonic
Design: Dipole Antenna Benchmark
Issue(s): #21086
Collection(s): FUNCTIONAL
Type(s): Exodiff
Verification: Dipole Antenna Benchmark
- 4.3.2The system shall calculate the transient far field pattern of a half-wave dipole antenna.
Specification(s): transient
Design: Dipole Antenna Benchmark
Issue(s): #21086
Collection(s): FUNCTIONAL
Type(s): Exodiff
Verification: Dipole Antenna Benchmark
- 4.3.3The system shall calculate the fundamental waveguide cutoff wavenumber for a TM mode for a rectangular waveguide geometry.
Specification(s): rectangular
Design: Waveguide Eigenvalue Benchmark
Issue(s): #21202
Collection(s): FUNCTIONAL
Type(s): CSVDiff
Verification: Waveguide Eigenvalue Benchmark
- 4.3.4The system shall calculate the fundamental waveguide cutoff wavenumber for a TM mode for a circular waveguide geometry.
Specification(s): circular
Design: Waveguide Eigenvalue Benchmark
Issue(s): #21202
Collection(s): FUNCTIONAL
Type(s): CSVDiff
Verification: Waveguide Eigenvalue Benchmark
- 4.3.5The system shall calculate the fundamental waveguide cutoff wavenumber for a TM mode for a coaxial waveguide geometry.
Specification(s): coaxial
Design: Waveguide Eigenvalue Benchmark
Issue(s): #21202
Collection(s): FUNCTIONAL
Type(s): CSVDiff
Verification: Waveguide Eigenvalue Benchmark
- 4.3.6The system shall calculate the evanescent wave decay for a waveguide structure below the cutoff frequency.
Specification(s): time_harmonic
Design: Evanescent Wave Decay Benchmark
Issue(s): #13744
Collection(s): FUNCTIONAL
Type(s): Exodiff
Verification: Evanescent Wave Decay Benchmark
- 4.3.7The system shall calculate the reflection of a 1D electric field plane wave in a metal backed dielectric slab.
Specification(s): electric
Design: 1D Reflection Benchmark
Issue(s): #13744
Collection(s): FUNCTIONAL
Type(s): CSVDiff
Verification: 1D Reflection Benchmark
- 4.3.8The system shall be able to simulate a 2D electric field waveguide with boundary conditions for wave launching, absorption, and conducting walls for scalar field variables.
Specification(s): test
Design: ADMatReactionEMRobinBCWaveguide Transmission Benchmark
Issue(s): #21098
Collection(s): FUNCTIONAL
Type(s): Exodiff
Verification: Waveguide Transmission Benchmark
- 4.3.9The system shall present an error to the user whenever the mode of operation for EMRobinBC is set to absorbing, but incoming wave information is supplied.
Specification(s): absorbing_error
Design: EMRobinBC
Issue(s): #21100
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
Prerequisite(s): 4.3.8
- electromagnetics: InterfaceKernel Objects
- 4.4.1The system shall calculate the appropriate parallel component equivalence interface condition dictated by Maxwell's Equations for parallel electromangetic vector fields.
Specification(s): parallel
Design: ParallelElectricFieldInterface
Issue(s): #21075
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 4.4.2The system shall calculate the appropriate perpendicular equivalence interface condition dictated by Maxwell's Equations for perpendicular electromagnetic vector fields, when properties are identical on either side of the interface.
Specification(s): perpendicular
Design: PerpendicularElectricFieldInterface
Issue(s): #21075
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 4.4.3The system shall calculate the appropriate equivalence interface condition dictated by Maxwell's Equations for both perpendicular and parallel components of electromagnetic vector fields at the same time with default, identical material property parameters.
Specification(s): combined_default
Design: ParallelElectricFieldInterfacePerpendicularElectricFieldInterface
Issue(s): #21075
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 4.4.4The system shall calculate the appropriate interface condition dictated by Maxwell's Equations for both perpendicular (subject to material properties) and parallel (equivalent) components of electromagnetic vector fields at an interface at the same time, with user-supplied material property parameters and zero free charge.
Specification(s): combined_props_zero_free_charge
Design: ParallelElectricFieldInterfacePerpendicularElectricFieldInterface
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 4.4.5The system shall calculate the appropriate interface condition dictated by Maxwell's Equations for both perpendicular (subject to material properties) and parallel (equivalent) components of electromagnetic vector fields at an interface at the same time, with user-supplied material property and free charge parameters.
Specification(s): combined_props
Design: ParallelElectricFieldInterfacePerpendicularElectricFieldInterface
Issue(s): #22036
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 4.4.6The system shall be capable of calculating the effect of electrostatic contact at an interface between two different materials, given a user-supplied contact conductance.
Specification(s): electrostatic_contact_conductance_supplied
Design: ElectrostaticContactCondition
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 4.4.7The system shall calculate the correct AD jacobian contribution for electrostatic contact at an interface, given a user-supplied contact conductance.
Specification(s): electrostatic_contact_conductance_supplied_jacobian
Design: ElectrostaticContactCondition
Issue(s): #21091
Collection(s): FUNCTIONAL
Type(s): PetscJacobianTester
Prerequisite(s): 4.4.6
- 4.4.8The system shall supply an error if both user-supplied and system-calculated contact conductance is requested when determining the effect of electrostatic contact on an interface.
Specification(s): electrostatic_contact_conductance_error
Design: ElectrostaticContactCondition
Issue(s): #21091
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
Prerequisite(s): 4.4.6
- 4.4.9The system shall be capable of calculating the effect of electrostatic contact at an interface between two different materials, given a system-calculated contact conductance.
Specification(s): electrostatic_contact_conductance_calculated
Design: ElectrostaticContactCondition
Issue(s): #21091
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 4.4.10The system shall calculate the correct AD jacobian contribution for electrostatic contact at an interface, given a system-calculated contact conductance.
Specification(s): electrostatic_contact_conductance_calculated_jacobian
Design: ElectrostaticContactCondition
Issue(s): #21091
Collection(s): FUNCTIONAL
Type(s): PetscJacobianTester
Prerequisite(s): 4.4.9
- 4.4.11The system shall calculate the correct electrostatic contact potential solution when compared to an analytic result, given a one-dimensional, two-material-block scenario.
Specification(s): electrostatic_contact_analytic_solution_test_two_block
Design: ElectrostaticContactCondition
Issue(s): #21096
Collection(s): FUNCTIONAL
Type(s): CSVDiff
Verification: Electrostatic Contact Verification (Two Block Test)
- 4.4.12The system shall calculate the correct electrostatic contact potential solution when compared to an analytic result, given a one-dimensional, three-material-block scenario.
Specification(s): electrostatic_contact_analytic_solution_test_three_block
Design: ElectrostaticContactCondition
Issue(s): #21096
Collection(s): FUNCTIONAL
Type(s): CSVDiff
Verification: Electrostatic Contact Verification (Three Block Test)
- electromagnetics: Kernels
- 4.5.1The system shall be capable of modeling the Helmholtz equation for scalar complex field variables, where real/imaginary coupling occurs for both the diffusion and reaction terms and coefficient values vary spatially.
Specification(s): scalar_complex_helmholtz
Design: FunctionDiffusionADMatReactionADMatCoupledForce
Issue(s): #13744
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 4.5.2The system shall be capable of modeling the vector Helmholtz equation for vector fields.
Specification(s): vector_kernels
Design: CurlCurlFieldVectorFunctionReaction
Issue(s): #21078
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 4.5.3The system shall be capable of modeling the vector Helmholtz equation for vector fields with a vector current density source for real and imaginary components.
Specification(s): vector_current_source
Design: VectorCurrentSource
Issue(s): #21080
Collection(s): FUNCTIONAL
Type(s): Exodiff
- electromagnetics: Postprocessors
- 4.6.1The system shall supply an error if the ReflectionCoefficient object is used on meshes with a dimension larger than one.
Specification(s): dim_error
Design: ReflectionCoefficient
Issue(s): #13744
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException