Reconstructed Discontinuous Galerkin Requirements Traceability Matrix

This template follows INL template TEM-214, "IT System Requirements Traceability Matrix."

note

This document serves as an addendum to Framework Requirements Traceability Matrix and captures information for RTM specific to the Reconstructed Discontinuous Galerkin module.

Framework Requirements Traceability Matrix

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	9.0.0 - 12.2.1
LLVM/Clang	10.0.1 - 19
Intel (ICC/ICX)	Not supported at this time
Python	3.10 - 3.13
Python Packages	packaging pyaml jinja2

System Purpose

The MOOSE rDG module is a library for the implementation of simulation tools that solve convection-dominated problems using the class of so-called reconstructed discontinuous Galerkin (rDG) methods. The specific rDG method implemented in this module is rDG(P0P1), which is equivalent to the second-order cell-centered finite volume method (FVM). Cell-centered FVMs are regarded as a subset of rDG methods in the case when the baseline polynomial solution in each element is a constant monomial. The FVMs are the most widely used numerical methods in areas such as computational fluid dynamics (CFD) and heat transfer, computational acoustics, and magnetohydrodynamics (MHD).

System Scope

The purpose of this software is to provide capability to MOOSE-based applications to use a second-order, cell-centered finite volume method (FVM). This module provides a systematic solution for implementing all required components in a second-order FVM such as slope reconstruction, slope limiting, numerical flux, and proper boundary conditions. Additionally, this module provides an implementation of these components for the scalar advection equation.

Assumptions and Dependencies

The Reconstructed Discontinuous Galerkin module is developed using MOOSE and can itself be based on various MOOSE modules, as such the RTM for the Reconstructed Discontinuous Galerkin 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

rdg: Auxkernels
10.1.1The system shall be able compute a component of the negative gradient of a variable.
Specification(s): test
Design: NegativeVariableGradientComponent
Issue(s): #62
Collection(s): FUNCTIONAL
Type(s): Exodiff

rdg: Benchmarking
10.2.1
The system shall be capable of solving an ion wall loss problem, as described in chapter 1, pages 26-27 of Principles of Plasma Discharge and Material Processing (ISBN 0-471-72001-1), and reproduce the same
1. field variable results, and
2. kinetic particle results.
Specification(s): lieberman/field_variables, lieberman/kinetic_data
Design: NegativeVariableGradientComponent ParticleDataVectorPostprocessor UniformGridParticleInitializer
Issue(s): #27 #61 #63
Collection(s): FUNCTIONAL
Type(s): ExodiffCSVDiff

rdg: Kernels
10.3.1The system shall be able to solve a simple diffusion problem.
Specification(s): test
Design: Diffusion
Issue(s): #108
Collection(s): FUNCTIONAL
Type(s): Exodiff

rdg: Raybcs
10.4.1
The system shall be capable of reflecting computational particles off of boundaries and maintain consistent velocity data
1. in a 1D domain
2. in a 2D domain
3. in a 3D domain
Specification(s): reflection/1d, reflection/2d, reflection/3d
Design: ReflectParticleBC
Issue(s): #39
Collection(s): FUNCTIONAL
Type(s): CSVDiff

rdg: Userobjects
10.5.1
The system shall support placing particles within a bounding box uniformly in a parallel consistent manner in the element type
1. EDGE2
2. TRI3
3. QUAD4
4. HEX8
5. TET4
6. PYRAMID5
7. PRISM6
Specification(s): rays/edge2_rays, rays/tri3_rays, rays/quad4_rays, rays/hex8_rays, rays/tet4_rays, rays/pyramid5_rays, rays/prism6_rays
Design: ParticleInitializerBase BoundingBoxParticleInitializer ElementSampler
Issue(s): #42
Collection(s): FUNCTIONAL
Type(s): Exodiff
10.5.2
The system return a useful error when the user
1. requests an element type that initialization has not been verified for
2. tries to setup a bounding box where a component of bottom_left is greater than top_right
Specification(s): errors/unsupported_element, errors/top_right_less_than_bottom_left
Design: ParticleInitializerBase BoundingBoxParticleInitializer ElementSampler
Issue(s): #42
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
10.5.3
The system return a useful warning to remind the user that the
1. 2 extra components of the bottom_left and top_right inputs are ignored in 1D simulations
2. 1 extra component of the bottom_left and top_right inputs are ignored in 2D simulations
Specification(s): warnings/unused_input_warning_1d, warnings/unused_input_warning_2d
Design: ParticleInitializerBase BoundingBoxParticleInitializer ElementSampler
Issue(s): #42
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
10.5.4
The system shall be capable of placing particles inside of EDGE2 elements uniformly
1. and solve an electrostatic potential based on the particle positions
2. in a parallel consistent manner
3. and compute the error between an exact electrostatic potential and the finite element solution
Specification(s): edge2/fields, edge2/rays, edge2/errors
Design: ParticleInitializerBase PerElementParticleInitializer ElementSampler
Issue(s): #36
Collection(s): FUNCTIONAL
Type(s): ExodiffCSVDiff
10.5.5
The system shall be capable of placing particles inside of QUAD4 elements uniformly
1. and solve an electrostatic potential based on the particle positions
2. in a parallel consistent manner
3. and compute the error between an exact electrostatic potential and the finite element solution
Specification(s): quad4/fields, quad4/rays, quad4/errors
Design: ParticleInitializerBase PerElementParticleInitializer ElementSampler
Issue(s): #36
Collection(s): FUNCTIONAL
Type(s): ExodiffCSVDiff
10.5.6
The system shall be capable of placing particles inside of TRI3 elements uniformly
1. and solve an electrostatic potential based on the particle positions
2. in a parallel consistent manner
3. and compute the error between an exact electrostatic potential and the finite element solution
Specification(s): tri3/fields, tri3/rays, tri3/errors
Design: ParticleInitializerBase PerElementParticleInitializer ElementSampler
Issue(s): #36
Collection(s): FUNCTIONAL
Type(s): ExodiffCSVDiff
10.5.7
The system shall be capable of placing particles inside of HEX8 elements uniformly
1. and solve an electrostatic potential based on the particle positions
2. in a parallel consistent manner
3. and compute the error between an exact electrostatic potential and the finite element solution
Specification(s): hex8/fields, hex8/rays, hex8/errors
Design: ParticleInitializerBase PerElementParticleInitializer ElementSampler
Issue(s): #36
Collection(s): FUNCTIONAL
Type(s): ExodiffCSVDiff
10.5.8
The system shall be capable of placing particles inside of PRISM6 elements uniformly
1. and solve an electrostatic potential based on the particle positions
2. in a parallel consistent manner
3. and compute the error between an exact electrostatic potential and the finite element solution
Specification(s): prism6/fields, prism6/rays, prism6/errors
Design: ParticleInitializerBase PerElementParticleInitializer ElementSampler
Issue(s): #36
Collection(s): FUNCTIONAL
Type(s): ExodiffCSVDiff
10.5.9
The system shall be capable of placing particles inside of PYRAMID5 elements uniformly
1. and solve an electrostatic potential based on the particle positions
2. in a parallel consistent manner
3. and compute the error between an exact electrostatic potential and the finite element solution
Specification(s): pyramid5/fields, pyramid5/rays, pyramid5/errors
Design: ParticleInitializerBase PerElementParticleInitializer ElementSampler
Issue(s): #36
Collection(s): FUNCTIONAL
Type(s): ExodiffCSVDiff
10.5.10
The system shall be capable of placing particles inside of TET4 elements uniformly
1. and solve an electrostatic potential based on the particle positions
2. in a parallel consistent manner
3. and compute the error between an exact electrostatic potential and the finite element solution
Specification(s): tet4/fields, tet4/rays, tet4/errors
Design: ParticleInitializerBase PerElementParticleInitializer ElementSampler
Issue(s): #36
Collection(s): FUNCTIONAL
Type(s): ExodiffCSVDiff
10.5.11
The system return a useful error when the user
1. requests an element type that initialization has not been verified for
2. tries to give particles zero mass
3. tries to give particles a negative mass
4. does not provide enough distributions to sample for velocity initialization.
5. tries to put 0 particles in each element.
6. tries to request that a particle type be initialized with zero number density
7. tries to request that a particle type be initialized with a negative number density
Specification(s): errors/unsupported_element, errors/zero_mass_requested, errors/negative_mass_requested, errors/too_few_distributions, errors/zero_particles_per_element_requested, errors/zero_number_density_requested, errors/negative_number_density_requested
Design: ParticleInitializerBase PerElementParticleInitializer ElementSampler
Issue(s): #36
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
10.5.12
The system shall be capable of placing particles on a uniform grid on the mesh
1. in one dimension.
Specification(s): uniform_grid/1d
Design: UniformGridParticleInitializer
Issue(s): #61
Collection(s): FUNCTIONAL
Type(s): Exodiff
10.5.13
The system shall return a useful error when the user tries to use the UniformGridParticleInitializer in
1. a two-dimensional simulation, and
2. a three-dimensional simulation.
Specification(s): unsupported_dimensions/2d, unsupported_dimensions/3d
Design: UniformGridParticleInitializer
Issue(s): #61
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
10.5.14
The system shall be capable of contributing to the residual of a variable based on the computational particles'
1. charge density, and
2. number density.
Specification(s): residual_accumulation/simple_potential_solve, residual_accumulation/number_density_accumulator
Design: ChargeDensityAccumulator
Issue(s): #25
Collection(s): FUNCTIONAL
Type(s): Exodiff
10.5.15The system shall be capable of accurately capturing the path of charged particles in both an electric and a magnetic field
Specification(s): e_cross_b
Design: ParticleStepperBase PICStudyBase
Issue(s): #4 #19
Collection(s): FUNCTIONAL
Type(s): Exodiff
10.5.16The system shall be capable of accurately capturing the path of charged particles in a perpendicular magnetic field
Specification(s): cyclotron_motion
Design: ParticleStepperBase PICStudyBase
Issue(s): #4 #19
Collection(s): FUNCTIONAL
Type(s): Exodiff
10.5.17The system shall be capable of applying a linear impluse from a force field perpendicular to a particles initial velocity using the boris stepper when there is 0 magnetic field
Specification(s): projectile_motion
Design: ParticleStepperBase PICStudyBase
Issue(s): #4 #19
Collection(s): FUNCTIONAL
Type(s): Exodiff
10.5.18The system shall be capable of applying a linear impluse from a force field parallel to a particles velocity using the boris stepper when there is 0 magnetic field
Specification(s): parallel_acceleration
Design: ParticleStepperBase PICStudyBase
Issue(s): #4 #19
Collection(s): FUNCTIONAL
Type(s): Exodiff
10.5.19
The system shall report a reasonable error from the particle stepper when
1. the user does not provide 3 components of the electric field
2. the user does not provide 3 components of the magnetic field
Specification(s): errors/too_few_efield_components, errors/too_few_bfield_components
Design: ParticleStepperBase PICStudyBase
Issue(s): #4 #19
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
10.5.20The system shall be capable of applying a linear impulse from a force field perpendicular to a particle\'s initial velocity
Specification(s): projectile_motion
Design: ParticleStepperBase PICStudyBase
Issue(s): #4 #19
Collection(s): FUNCTIONAL
Type(s): Exodiff
10.5.21The system shall be capable of applying a linear impulse from a force field parallel to a particle's velocity
Specification(s): parallel_acceleration
Design: ParticleStepperBase PICStudyBase
Issue(s): #4 #19
Collection(s): FUNCTIONAL
Type(s): Exodiff
10.5.22
The system shall report a reasonable error from the particle stepper when
1. the user does not provide 3 components of the force field
Specification(s): errors/too_few_field_components
Design: ParticleStepperBase PICStudyBase
Issue(s): #4 #19
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
10.5.23The system shall be capable of tracking 3 velocity components within the PIC capability while propagating rays in lower dimensions
Specification(s): simple_stepping
Design: ParticleStepperBase PICStudyBase
Issue(s): #4
Collection(s): FUNCTIONAL
Type(s): Exodiff

rdg: Utils
10.6.1The system shall support the accumulation of point values as if they were point sources into an auxiliary field
Specification(s): test
Design: AuxAccumulator
Issue(s): #9
Collection(s): FUNCTIONAL
Type(s): Exodiff
10.6.2The system shall report a reasonable error when accumulating point values into an auxiliary field when the system is not properly finalized
Specification(s): error
Design: AuxAccumulator
Issue(s): #9
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
10.6.3The system shall support mapping data from rays to an aux variable and reset the aux variable to 0 on each time step
Specification(s): charge_mapping
Design: AuxAccumulator
Issue(s): #9
Collection(s): FUNCTIONAL
Type(s): Exodiff
10.6.4The system shall support mapping data from rays to an aux variable and reset the aux variable to 0 on each time step on a 2 dimensional mesh
Specification(s): charge_mapping2D
Design: AuxAccumulator
Issue(s): #9
Collection(s): FUNCTIONAL
Type(s): Exodiff
10.6.5The system shall support mapping data from rays to an aux variable and then solve differential equations based on the data mapped from rays
Specification(s): simple_potential_solve_aux
Design: AuxAccumulator
Issue(s): #9
Collection(s): FUNCTIONAL
Type(s): Exodiff
10.6.6The system shall support the accumulation of point values as if they were point sources into a nonlinear field
Specification(s): test
Design: ResidualAccumulator
Issue(s): #16
Collection(s): FUNCTIONAL
Type(s): Exodiff
10.6.7The system shall allow a ray to sample the value of field variable at any point in space as it moves through space
Specification(s): variable_sampling
Design: VariableSampler
Issue(s): #12
Collection(s): FUNCTIONAL
Type(s): Exodiff

Usability Requirements

No requirements of this type exist for this application, beyond those of its dependencies.

Performance Requirements

No requirements of this type exist for this application, beyond those of its dependencies.

System Interface Requirements

No requirements of this type exist for this application, beyond those of its dependencies.

References

No citations exist within this document.


[test]
  type = 'Exodiff'
  input = 'negative_gradient.i'
  exodiff = 'negative_gradient_out.e'
  requirement = 'The system shall be able compute a component of the negative gradient of a variable.'
[]


[field_variables]
  type = Exodiff
  input = 'lieberman.i'
  exodiff = 'lieberman_out.e'
  cli_args = "Executioner/num_steps=8
                  Executioner/dt=1e-9
                  Outputs/active=particle_population
                  Outputs/particle_population/show='ray_count ray_data'"
  allow_test_objects = true
  detail = 'field variable results, and'
[]


[kinetic_data]
  type = CSVDiff
  input = 'lieberman.i'
  csvdiff = 'lieberman.csv
                 lieberman_ray_data_0001.csv
                 lieberman_ray_data_0002.csv
                 lieberman_ray_data_0003.csv
                 lieberman_ray_data_0004.csv
                 lieberman_ray_data_0005.csv
                 lieberman_ray_data_0006.csv
                 lieberman_ray_data_0007.csv
                 lieberman_ray_data_0008.csv'
  should_execute = false
  detail = 'kinetic particle results.'
[]


[edge2_rays]
  input = '1d.i'
  type = 'Exodiff'
  cli_args = 'Mesh/gmg/elem_type=EDGE2
                  Outputs/rays/file_base=edge2_rays'
  exodiff = 'edge2_rays.e'
  allow_test_objects = true
  allow_warnings = true
  detail = 'EDGE2'
[]


[tri3_rays]
  input = '2d.i'
  type = 'Exodiff'
  cli_args = 'Mesh/gmg/elem_type=TRI3
                  Outputs/rays/file_base=tri3_rays'
  exodiff = 'tri3_rays.e'
  allow_test_objects = true
  allow_warnings = true
  detail = 'TRI3'
[]


[quad4_rays]
  input = '2d.i'
  type = 'Exodiff'
  cli_args = 'Mesh/gmg/elem_type=QUAD4
                  Outputs/rays/file_base=quad4_rays'
  exodiff = 'quad4_rays.e'
  allow_test_objects = true
  allow_warnings = true
  detail = 'QUAD4'
[]


[hex8_rays]
  input = '3d.i'
  type = 'Exodiff'
  cli_args = 'Mesh/gmg/elem_type=HEX8
                  Outputs/rays/file_base=hex8_rays'
  exodiff = 'hex8_rays.e'
  allow_test_objects = true
  detail = 'HEX8'
[]


[tet4_rays]
  input = '3d.i'
  type = 'Exodiff'
  cli_args = 'Mesh/gmg/elem_type=TET4
                  Outputs/rays/file_base=tet4_rays'
  exodiff = 'tet4_rays.e'
  allow_test_objects = true
  detail = 'TET4'
  mesh_mode = 'REPLICATED'
[]


[pyramid5_rays]
  input = '3d.i'
  type = 'Exodiff'
  cli_args = 'Mesh/gmg/elem_type=PYRAMID5
                  Outputs/rays/file_base=pyramid5_rays'
  exodiff = 'pyramid5_rays.e'
  allow_test_objects = true
  detail = 'PYRAMID5'
  mesh_mode = 'REPLICATED'
[]


[prism6_rays]
  input = '3d.i'
  type = 'Exodiff'
  cli_args = 'Mesh/gmg/elem_type=PRISM6
                  Outputs/rays/file_base=prism6_rays'
  exodiff = 'prism6_rays.e'
  allow_test_objects = true
  detail = 'PRISM6'
[]


[unsupported_element]
  type = 'RunException'
  input = 'errors.i'
  allow_test_objects = true
  allow_warnings = true
  cli_args = 'Mesh/gmg/dim=1
                  Mesh/gmg/elem_type=EDGE3'
  expect_err = 'Particle Initialization has not been implemented for elements of type EDGE3'
  detail = 'requests an element type that initialization has not been verified for'
[]


[top_right_less_than_bottom_left]
  type = 'RunException'
  input = 'errors.i'
  cli_args = "Mesh/gmg/dim=1
                  UserObjects/initializer/top_right='0 0 0'
                  UserObjects/initializer/bottom_left='1 0 0'"
  allow_test_objects = true
  expect_err = "Component 0 of 'top_right' is <= component 0 of 'bottom_left'"
  detail = 'tries to setup a bounding box where a component of bottom_left is greater than top_right'
[]


[unused_input_warning_1d]
  type = 'RunException'
  input = 'errors.i'
  cli_args = "Mesh/gmg/dim=1"
  allow_test_objects = true
  allow_warnings = False
  expect_err = "3 components are required for libMesh::Point input.\nHowever, your simulation is only 1 dimensional.\nThe extra component of the libMesh::Point input will be ignored.\n"
  detail = '2 extra components of the `bottom_left` and `top_right` inputs are ignored in 1D simulations'
[]


[unused_input_warning_2d]
  type = 'RunException'
  input = 'errors.i'
  cli_args = "Mesh/gmg/dim=2
                  UserObjects/initializer/bottom_left='0 0 0'
                  UserObjects/initializer/top_right='1 1 0'"
  allow_test_objects = true
  allow_warnings = False
  expect_err = "3 components are required for libMesh::Point input.\nHowever, your simulation is only 2 dimensional.\nThe extra components of the libMesh::Point input will be ignored.\n"
  detail = '1 extra component of the `bottom_left` and `top_right` inputs are ignored in 2D simulations'
[]


[fields]
  input = '1d.i'
  type = 'Exodiff'
  cli_args = 'Mesh/gmg/elem_type=EDGE2
                  Outputs/file_base=edge2_out
                  Outputs/rays/file_base=edge2_rays
                  charge_density=2'
  exodiff = 'edge2_out.e'
  allow_test_objects = true
  detail = "and solve an electrostatic potential based on the particle positions"
[]


[errors]
  input = '1d.i'
  type = 'CSVDiff'
  should_execute = False
  csvdiff = 'edge2_out.csv'
  prereq = edge2/fields
  detail = "and compute the error between an exact electrostatic potential and the finite element solution"
[]


[fields]
  input = '2d.i'
  type = 'Exodiff'
  cli_args = 'Mesh/gmg/elem_type=QUAD4
                  Outputs/file_base=quad4_out
                  Outputs/rays/file_base=quad4_rays
                  charge_density=4'
  exodiff = 'quad4_out.e'
  allow_test_objects = true
  detail = "and solve an electrostatic potential based on the particle positions"
[]


[errors]
  input = '2d.i'
  type = 'CSVDiff'
  should_execute = False
  csvdiff = quad4_out.csv
  prereq = quad4/fields
  detail = "and compute the error between an exact electrostatic potential and the finite element solution"
[]


[fields]
  input = '2d.i'
  type = 'Exodiff'
  cli_args = 'Mesh/gmg/elem_type=TRI3
                  Outputs/file_base=tri3_out
                  Outputs/rays/file_base=tri3_rays
                  charge_density=4'
  exodiff = 'tri3_out.e'
  allow_test_objects = true
  detail = "and solve an electrostatic potential based on the particle positions"
[]


[errors]
  input = '2d.i'
  type = 'CSVDiff'
  should_execute = False
  csvdiff = tri3_out.csv
  prereq = tri3/fields
  detail = "and compute the error between an exact electrostatic potential and the finite element solution"
[]


[fields]
  input = '3d.i'
  type = 'Exodiff'
  cli_args = 'Mesh/gmg/elem_type=HEX8
                  Outputs/file_base=hex8_out
                  Outputs/rays/file_base=hex8_rays
                  charge_density=6'
  exodiff = 'hex8_out.e'
  allow_test_objects = true
  detail = "and solve an electrostatic potential based on the particle positions"
[]


[errors]
  input = '3d.i'
  type = 'CSVDiff'
  should_execute = False
  csvdiff = hex8_out.csv
  prereq = hex8/fields
  detail = "and compute the error between an exact electrostatic potential and the finite element solution"
[]


[fields]
  input = '3d.i'
  type = 'Exodiff'
  cli_args = 'Mesh/gmg/elem_type=PRISM6
                  Outputs/file_base=prism6_out
                  Outputs/rays/file_base=prism6_rays
                  charge_density=6'
  exodiff = 'prism6_out.e'
  allow_test_objects = true
  detail = "and solve an electrostatic potential based on the particle positions"
[]


[errors]
  input = '3d.i'
  type = 'CSVDiff'
  should_execute = False
  csvdiff = prism6_out.csv
  prereq = prism6/fields
  detail = "and compute the error between an exact electrostatic potential and the finite element solution"
[]


[fields]
  input = '3d.i'
  type = 'Exodiff'
  cli_args = 'Mesh/gmg/elem_type=PYRAMID5
                  Outputs/file_base=pyramid5_out
                  Outputs/rays/file_base=pyramid5_rays
                  charge_density=6'
  exodiff = 'pyramid5_out.e'
  allow_test_objects = true
  detail = "and solve an electrostatic potential based on the particle positions"
  # this is set because these global element ids are not consistent when using a distributed mesh
  # this is despite the fact that allow_renumber = false in the input file
  mesh_mode = 'REPLICATED'
[]


[errors]
  input = '3d.i'
  type = 'CSVDiff'
  should_execute = False
  csvdiff = pyramid5_out.csv
  prereq = pyramid5/fields
  detail = "and compute the error between an exact electrostatic potential and the finite element solution"
[]


[fields]
  input = '3d.i'
  type = 'Exodiff'
  cli_args = 'Mesh/gmg/elem_type=TET4
                  Outputs/file_base=tet4_out
                  Outputs/rays/file_base=tet4_rays
                  charge_density=6'
  exodiff = 'tet4_out.e'
  allow_test_objects = true
  detail = "and solve an electrostatic potential based on the particle positions"
  # this is set because these global element ids are not consistent when using a distributed mesh
  # this is despite the fact that allow_renumber = false in the input file
  mesh_mode = 'REPLICATED'
[]


[errors]
  input = '3d.i'
  type = 'CSVDiff'
  should_execute = False
  csvdiff = tet4_out.csv
  prereq = tet4/fields
  detail = "and compute the error between an exact electrostatic potential and the finite element solution"
[]


[unsupported_element]
  type = 'RunException'
  input = 'errors.i'
  allow_test_objects = true
  cli_args = 'Mesh/gmg/elem_type=EDGE3'
  expect_err = 'Particle Initialization has not been implemented for elements of type EDGE3'
  detail = 'requests an element type that initialization has not been verified for'
[]


[zero_mass_requested]
  type = 'RunException'
  input = 'errors.i'
  allow_test_objects = true
  cli_args = 'UserObjects/initializer/mass=0'
  expect_err = 'Range check failed for parameter UserObjects/initializer/mass'
  detail = 'tries to give particles zero mass'
[]


[negative_mass_requested]
  type = 'RunException'
  input = 'errors.i'
  allow_test_objects = true
  cli_args = 'UserObjects/initializer/mass=-1'
  expect_err = 'Range check failed for parameter UserObjects/initializer/mass'
  detail = 'tries to give particles a negative mass'
[]


[too_few_distributions]
  type = 'RunException'
  input = 'errors.i'
  allow_test_objects = true
  cli_args = "UserObjects/initializer/velocity_distributions='zero zero'"
  expect_err = 'You must provide 3 distributions, one for each velocity component.'
  detail = 'does not provide enough distributions to sample for velocity initialization.'
[]


[zero_particles_per_element_requested]
  type = 'RunException'
  input = 'errors.i'
  allow_test_objects = true
  cli_args = "UserObjects/initializer/particles_per_element=0"
  expect_err = 'Range check failed for parameter UserObjects/initializer/particles_per_element'
  detail = 'tries to put 0 particles in each element.'
[]


[zero_number_density_requested]
  type = 'RunException'
  input = 'errors.i'
  allow_test_objects = true
  cli_args = "UserObjects/initializer/number_density=0"
  expect_err = 'Range check failed for parameter UserObjects/initializer/number_density'
  detail = 'tries to request that a particle type be initialized with zero number density'
[]


[negative_number_density_requested]
  type = 'RunException'
  input = 'errors.i'
  allow_test_objects = true
  cli_args = "UserObjects/initializer/number_density=-1"
  expect_err = 'Range check failed for parameter UserObjects/initializer/number_density'
  detail = 'tries to request that a particle type be initialized with a negative number density'
[]


[2d]
  type = RunException
  input = 'uniform_grid.i'
  allow_test_objects = true
  cli_args = 'Mesh/gmg/dim=2'
  expect_err = "The simulation must be in 1D in order to use the UniformGridParticleInitializer"
  detail = 'a two-dimensional simulation, and'
[]


[3d]
  type = RunException
  input = 'uniform_grid.i'
  allow_test_objects = true
  cli_args = 'Mesh/gmg/dim=3'
  expect_err = "The simulation must be in 1D in order to use the UniformGridParticleInitializer"
  detail = 'a three-dimensional simulation.'
[]


[e_cross_b]
  type = 'Exodiff'
  input = 'e_cross_b.i'
  exodiff = 'e_cross_b_rays.e
               e_cross_b_rays.e-s0001
               e_cross_b_rays.e-s0002
               e_cross_b_rays.e-s0003
               e_cross_b_rays.e-s0004
               e_cross_b_rays.e-s0005
               e_cross_b_rays.e-s0006
               e_cross_b_rays.e-s0007
               e_cross_b_rays.e-s0008
               e_cross_b_rays.e-s0009'
  allow_test_objects = true
  requirement = 'The system shall be capable of accurately capturing the path of charged particles in both an electric and a magnetic field'
[]


[cyclotron_motion]
  type = 'Exodiff'
  input = 'cyclotron_motion.i'
  exodiff = 'cyclotron_motion_rays.e
               cyclotron_motion_rays.e-s0001
               cyclotron_motion_rays.e-s0002
               cyclotron_motion_rays.e-s0003
               cyclotron_motion_rays.e-s0004
               cyclotron_motion_rays.e-s0005
               cyclotron_motion_rays.e-s0006
               cyclotron_motion_rays.e-s0007
               cyclotron_motion_rays.e-s0008
               cyclotron_motion_rays.e-s0009'
  allow_test_objects = true
  requirement = 'The system shall be capable of accurately capturing the path of charged particles in a perpendicular magnetic field'
[]


[projectile_motion]
  type = 'Exodiff'
  input = 'boris_projectile_motion.i'
  exodiff = 'projectile_motion_rays.e
               projectile_motion_rays.e-s0001
               projectile_motion_rays.e-s0002
               projectile_motion_rays.e-s0003
               projectile_motion_rays.e-s0004
               projectile_motion_rays.e-s0005
               projectile_motion_rays.e-s0006
               projectile_motion_rays.e-s0007
               projectile_motion_rays.e-s0008
               projectile_motion_rays.e-s0009'
  allow_test_objects = true
  requirement = 'The system shall be capable of applying a linear impluse from a force field perpendicular to a particles initial velocity using the boris stepper when there is 0 magnetic field'
[]


[parallel_acceleration]
  type = 'Exodiff'
  input = 'boris_parallel_acceleration.i'
  exodiff = 'parallel_acceleration_rays.e
               parallel_acceleration_rays.e-s0001
               parallel_acceleration_rays.e-s0002
               parallel_acceleration_rays.e-s0003
               parallel_acceleration_rays.e-s0004
               parallel_acceleration_rays.e-s0005
               parallel_acceleration_rays.e-s0006
               parallel_acceleration_rays.e-s0007
               parallel_acceleration_rays.e-s0008
               parallel_acceleration_rays.e-s0009'
  allow_test_objects = true
  requirement = 'The system shall be capable of applying a linear impluse from a force field parallel to a particles velocity using the boris stepper when there is 0 magnetic field'
[]


[too_few_efield_components]
  type = RunException
  input = 'cyclotron_motion.i'
  cli_args = "UserObjects/stepper/efield_components='Ex'"
  allow_test_objects = true
  detail = 'the user does not provide 3 components of the electric field'
  expect_err = 'You must provide 3 components representing the electric field'
[]


[too_few_bfield_components]
  type = RunException
  input = 'cyclotron_motion.i'
  cli_args = "UserObjects/stepper/bfield_components='Bx'"
  allow_test_objects = true
  detail = 'the user does not provide 3 components of the magnetic field'
  expect_err = 'You must provide 3 components representing the magnetic field'
[]


[projectile_motion]
  type = 'Exodiff'
  input = 'projectile_motion.i'
  exodiff = 'projectile_motion_rays.e
               projectile_motion_rays.e-s0001
               projectile_motion_rays.e-s0002
               projectile_motion_rays.e-s0003
               projectile_motion_rays.e-s0004
               projectile_motion_rays.e-s0005
               projectile_motion_rays.e-s0006
               projectile_motion_rays.e-s0007
               projectile_motion_rays.e-s0008
               projectile_motion_rays.e-s0009'
  allow_test_objects = true
  requirement = "The system shall be capable of applying a linear impulse from a force field perpendicular to a particle\'s initial velocity"
[]


[parallel_acceleration]
  type = 'Exodiff'
  input = 'parallel_acceleration.i'
  exodiff = 'parallel_acceleration_rays.e
               parallel_acceleration_rays.e-s0001
               parallel_acceleration_rays.e-s0002
               parallel_acceleration_rays.e-s0003
               parallel_acceleration_rays.e-s0004
               parallel_acceleration_rays.e-s0005
               parallel_acceleration_rays.e-s0006
               parallel_acceleration_rays.e-s0007
               parallel_acceleration_rays.e-s0008
               parallel_acceleration_rays.e-s0009'
  allow_test_objects = true
  requirement = "The system shall be capable of applying a linear impulse from a force field parallel to a particle's velocity"
[]


[too_few_field_components]
  type = RunException
  input = 'parallel_acceleration.i'
  cli_args = "UserObjects/stepper/field_components='Ex'"
  allow_test_objects = true
  detail = 'the user does not provide 3 components of the force field'
  expect_err = 'You must provide 3 components representing the force field'
[]


[simple_stepping]
  type = 'Exodiff'
  input = 'simple_stepping.i'
  exodiff = 'simple_stepping_rays.e
               simple_stepping_rays.e-s0001
               simple_stepping_rays.e-s0002
               simple_stepping_rays.e-s0003
               simple_stepping_rays.e-s0004
               simple_stepping_rays.e-s0005
               simple_stepping_rays.e-s0006
               simple_stepping_rays.e-s0007
               simple_stepping_rays.e-s0008
               simple_stepping_rays.e-s0009'
  allow_test_objects = true
  requirement = 'The system shall be capable of tracking 3 velocity components within the PIC capability while propagating rays in lower dimensions'
[]


[test]
  type = 'Exodiff'
  input = 'auxaccumulator.i'
  exodiff = 'auxaccumulator_out.e'
  allow_test_objects = true
  requirement = 'The system shall support the accumulation of point values as if they were point sources into an auxiliary field'
[]


[error]
  type = 'RunException'
  input = 'auxaccumulator.i'
  cli_args = 'Outputs/exodus=false UserObjects/auxaccumulator/skip_finalize=True'
  expect_err = 'AccumulatorBase was not finalized'
  allow_test_objects = true
  requirement = 'The system shall report a reasonable error when accumulating point values into an auxiliary field when the system is not properly finalized'
[]


[charge_mapping]
  type = 'Exodiff'
  input = 'charge_accumulator.i'
  exodiff = 'charge_accumulator_out.e'
  allow_test_objects = true
  requirement = 'The system shall support mapping data from rays to an aux variable and reset the aux variable to 0 on each time step'
[]


[charge_mapping2D]
  type = 'Exodiff'
  input = 'charge_accumulator2D.i'
  exodiff = 'charge_accumulator2D_out.e'
  allow_test_objects = true
  requirement = 'The system shall support mapping data from rays to an aux variable and reset the aux variable to 0 on each time step on a 2 dimensional mesh'
[]


[simple_potential_solve_aux]
  type = 'Exodiff'
  input = 'simple_potential_solve_aux.i'
  exodiff = 'simple_potential_solve_aux_out.e'
  allow_test_objects = true
  requirement = 'The system shall support mapping data from rays to an aux variable and then solve differential equations based on the data mapped from rays'
[]


[test]
  type = 'Exodiff'
  input = 'residualaccumulator.i'
  exodiff = 'residualaccumulator_out.e'
  allow_test_objects = true
  requirement = 'The system shall support the accumulation of point values as if they were point sources into a nonlinear field'
[]


[variable_sampling]
  type = 'Exodiff'
  input = 'variable_sampler.i'
  exodiff = 'variable_sampler_out.e
               variable_sampler_rays.e
               variable_sampler_rays.e-s0001
               variable_sampler_rays.e-s0002
               variable_sampler_rays.e-s0003
               variable_sampler_rays.e-s0004
               variable_sampler_rays.e-s0005
               variable_sampler_rays.e-s0006
               variable_sampler_rays.e-s0007
               variable_sampler_rays.e-s0008
               variable_sampler_rays.e-s0009'
  allow_test_objects = true
  requirement = 'The system shall allow a ray to sample the value of field variable at any point in space as it moves through space'
[]

Introduction
System Requirements Traceability
References