SALAMANDER System Design Description

This template follows INL template TEM-140, "IT System Design Description."

note

This document serves as an addendum to Framework System Design Description and captures information for Software Design Description (SDD) specific to the SALAMANDER application.

Introduction

Many of the phenomena related to magnetic confinement fusion energy systems depend on the solutions of multiple physics models, which can be described by partial differential equations that provide spatially- and temporally-varying values of solution variables. These models for individual physics often depend on each other. Software for Advanced Large-scale Analysis of MAgnetic confinement for Numerical Design, Engineering & Research (SALAMANDER) relies on the MOOSE framework to solve these physics models, accounting for the couplings that may occur between them. This document describes the system design of SALAMANDER.

System Purpose

The Software Design Description provided here is description of each object in the system. The pluggable architecture of the underlying framework of SALAMANDER makes MOOSE and MOOSE-based applications straightforward to develop as each piece of end-user (developer) code that goes into the system follows a well-defined interface for the underlying systems that those object plug into. These descriptions are provided through developer-supplied "markdown" files that are required for all new objects that are developed as part of SALAMANDER. More information about the design documentation for MOOSE-based applications like SALAMANDER can be found in Documenting MOOSE.

System Scope

SALAMANDER is an application for performing system-level, engineering scale (i.e., at the scale of centimeters and meters), and microstructure-scale (i.e., at the scale of microns) multiphysics calculations related to magnetic confinement fusion energy systems. These models often include highly coupled systems of equations related to plasma physics, electromagnetics, heat conduction, scalar transport, thermal hydraulics, CFD, and thermomechanics, amongst others. Interfaces to other MOOSE-based codes, including tritium transport (TMAP8) and neutronics (Cardinal) are also included to support SALAMANDER simulations. SALAMANDER will enable high-fidelity modeling of irradiation levels and plasma exposure conditions of plasma facing components and their impact on heat and tritium distributions, as well as the resulting mechanical constraints experienced by the plasma facing components. The MultiApp System is leveraged to allow for the multiscale, multiphysics coupling. Further, other MOOSE capabilities (such as the stochastic tools module) will eventually enable engineering studies, allowing for extended uncertainty quantification and risk analysis studies for particular system designs. Interfaces for CAD meshing workflows to model complex geometries are also included. SALAMANDER therefore supports design, safety, engineering, and research projects.

Dependencies and Limitations

SALAMANDER inherits the software dependencies of the MOOSE framework, with no additional dependencies.

Definitions and Acronyms

This section defines, or provides the definition of, all terms and acronyms required to properly understand this specification.

Definitions

Pull (Merge) Request: A proposed change to the software (e.g. usually a code change, but may also include documentation, requirements, design, and/or testing).
Baseline: A specification or product (e.g., project plan, maintenance and operations (M&O) plan, requirements, or design) that has been formally reviewed and agreed upon, that thereafter serves as the basis for use and further development, and that can be changed only by using an approved change control process (NQA-1, 2009).
Validation: Confirmation, through the provision of objective evidence (e.g., acceptance test), that the requirements for a specific intended use or application have been fulfilled (24765:2010(E), 2010).
Verification: (1) The process of: evaluating a system or component to determine whether the products of a given development phase satisfy the conditions imposed at the start of that phase. (2) Formal proof of program correctness (e.g., requirements, design, implementation reviews, system tests) (24765:2010(E), 2010).

Acronyms

Acronym	Description
API	Application Programming Interface
CAD	computer-aided design
CFD	computational fluid dynamics
DOE	Department of Energy
FE	finite element
HIT	Hierarchical Input Text
HPC	High Performance Computing
I/O	Input/Output
INL	Idaho National Laboratory
MOOSE	Multiphysics Object Oriented Simulation Environment
MPI	Message Passing Interface
PIC	particle-in-cell
SALAMANDER	Software for Advanced Large-scale Analysis of MAgnetic confinement for Numerical Design, Engineering & Research
SDD	Software Design Description

Design Stakeholders and Concerns

Design Stakeholders

Stakeholders for SALAMANDER include several of the funding sources including Department of Energy (DOE) and INL. However, since SALAMANDER is an open-source project, several universities, companies, and foreign governments have an interest in the development and maintenance of the SALAMANDER project.

Stakeholder Design Concerns

Concerns from many of the stakeholders are similar. These concerns include correctness, stability, and performance. The mitigation plan for each of these can be addressed. For correctness, SALAMANDER development requires either regression or unit testing for all new code added to the repository. The project contains several comparisons against analytical solutions where possible and also other verification methods such as MMS. For stability, SALAMANDER maintains multiple branches to incorporate several layers of testing both internally and for dependent applications. Finally, performance tests are also performed as part of the the normal testing suite to monitor code change impacts to performance.

System Design

SALAMANDER relies on MOOSE to solve the coupled physics models underlying magnetic confinement fusion energy systems, accounting for the couplings that may occur between various components and sub-systems of this class of devices. The design of MOOSE is based on the concept of modular code objects that define all of the aspects of the physics model. SALAMANDER follows this design, providing code objects that define specific aspects of the solutions for its physics that derive from the base classes defined by the MOOSE framework and the modules that it depends on. SALAMANDER provides specialized UserObject classes that compute data for velocity updating, charge accumulation, and Ray data necessary for simple particle-in-cell (PIC) simulations. It also provides specialized utilities for accumulating field data on rays. Much of the remaining functionality is provided by MOOSE modules (electromagnetics, ray tracing), the Cardinal application (CFD and Monte Carlo radiation transport), and the Tritium Migration Analysis Program Version 8 (TMAP8) application (tritium migration) that SALAMANDER builds on.

System Structure

SALAMANDER relies on the MOOSE framework to provide the core functionality of solving multiphysics problems using the finite element method. It also relies on the MOOSE modules for much of its core functionality. A summary listing of the current modules required for complete SALAMANDER operation are shown below:

The structure of SALAMANDER is based on defining C++ classes that derive from classes in the MOOSE framework or modules that provide functionality that is specifically tailored to fusion device modeling and simulation. By using the interfaces defined in MOOSE base classes for these classes, SALAMANDER is able to rely on MOOSE to execute these models at the appropriate times during the simulation and use their results in the desired ways.

Data Design and Control

At a high level, the system is designed to process Hierarchical Input Text (HIT) input files to construct several objects that will constitute an finite element (FE) simulation. Some of the objects in the simulation may in turn load other file-based resources to complete the simulation. Examples include meshes or data files. The system will then assemble systems of equations and solve them using the libraries of the Code Platform. The system can then output the solution in one or more supported output formats commonly used for visualization.

Human-Machine Interface Design

The SALAMANDER application is a command-line driven program. All interaction with SALAMANDER is ultimately done through the command line. This is typical for HPC applications that use the MPI interface for running on super computing clusters. Optional GUIs may be used to assist in creating input files and launching executables on the command line.

System Design Interface

All external system interaction is performed either through file Input/Output (I/O) or through local API calls. Neither SALAMANDER, nor the MOOSE framework, nor the MOOSE modules are designed to interact with any external system directly through remote procedure calls. Any code to code coupling performed using the framework are done directly through API calls either in a static binary or after loading shared libraries.

Security Structure

The SALAMANDER application does not require any elevated privileges to operate and does not run any stateful services, daemons or other network programs. Distributed runs rely on the MPI library.

Requirements Cross-Reference

salamander: NegativeVariableGradientComponent
1.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
1.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

salamander: ParticleDataVectorPostprocessor
1.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

salamander: UniformGridParticleInitializer
1.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
1.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
1.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

salamander: Diffusion
1.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

salamander: ReflectParticleBC
1.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

salamander: ParticleInitializerBase
1.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
1.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
1.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
1.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
1.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
1.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
1.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
1.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
1.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
1.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
1.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

salamander: BoundingBoxParticleInitializer
1.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
1.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
1.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

salamander: ElementSampler
1.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
1.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
1.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
1.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
1.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
1.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
1.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
1.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
1.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
1.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
1.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

salamander: PerElementParticleInitializer
1.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
1.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
1.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
1.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
1.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
1.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
1.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
1.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

salamander: ChargeDensityAccumulator
1.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

salamander: ParticleStepperBase
1.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
1.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
1.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
1.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
1.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
1.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
1.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
1.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
1.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

salamander: PICStudyBase
1.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
1.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
1.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
1.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
1.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
1.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
1.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
1.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
1.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

salamander: AuxAccumulator
1.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
1.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
1.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
1.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
1.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

salamander: ResidualAccumulator
1.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

salamander: VariableSampler
1.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

References

ISO/IEC/IEEE 24765:2010(E). Systems and software engineering—Vocabulary. first edition, December 15 2010.

@manual{ISO-systems-software,
    author = "24765:2010(E), ISO/IEC/IEEE",
    title = "Systems and software engineering---Vocabulary",
    edition = "First",
    year = "2010",
    month = "December 15"
}

ASME NQA-1. ASME NQA-1-2008 with the NQA-1a-2009 addenda: Quality Assurance Requirements for Nuclear Facility Applications. first edition, August 31 2009.

@manual{ASME-NQA-1-2008,
    author = "NQA-1, ASME",
    title = "ASME NQA-1-2008 with the NQA-1a-2009 addenda: Quality Assurance Requirements for Nuclear Facility Applications",
    orginization = "American Socieity of Mechanical Engineers",
    year = "2009",
    month = "August 31",
    edition = "First"
}


[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.'
[]


[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.'
[]


[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.'
[]


[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.'
[]


[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'
[]


[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'
[]


[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'
[]


[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'
[]


[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'
[]


[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
Definitions and Acronyms
Design Stakeholders and Concerns
System Design
Requirements Cross - Reference
References
ActionComponents
Adaptivity
Application
AuxKernels
AuxScalarKernels
AuxVariables
BCs
Bounds
Cardinal
ChainControls
ChemicalComposition
Closures
Components
Constraints
ControlLogic
Controls
Convergence
Correctors
CoupledHeatTransfers
Covariance
DGKernels
Dampers
Debug
DeprecatedBlock
DiracKernels
Distributions
DomainIntegral
Executioner
Executors
FVBCs
FVICs
FVInterfaceKernels
FVKernels
FluidProperties
FluidPropertiesInterrogator
Functions
FunctorMaterials
GlobalParams
GrayDiffuseRadiation
HDGKernels
HeatStructureMaterials
ICs
InterfaceKernels
Kernels
Likelihood
LinearFVBCs
LinearFVKernels
Materials
Mesh
MeshDivisions
MeshModifiers
Modules
MortarGapHeatTransfer
MultiApps
NEML2
NodalKernels
NodalNormals
Outputs
ParameterStudy
Physics
Positions
Postprocessors
Preconditioning
Problem
ProjectedStatefulMaterialStorage
QuadInterWrapperMesh
QuadSubChannelMesh
RayBCs
RayKernels
ReactionNetwork
Reporters
Samplers
ScalarKernels
SolidProperties
StochasticTools
SubChannel
Surrogates
ThermalContact
Times
Trainers
Transfers
TriInterWrapperMesh
TriSubChannelMesh
UserObjects
VariableMappings
Variables
VectorPostprocessors