Reconstructed Discontinuous Galerkin Failure Analysis Report

Introduction

The FAR for the Reconstructed Discontinuous Galerkin module describes the system functional and non-functional requirements that describe the expected interactions that the software shall provide.

Dependencies

The Reconstructed Discontinuous Galerkin module is developed using MOOSE and can itself be based on various MOOSE modules, as such the FAR for the Reconstructed Discontinuous Galerkin module is dependent upon the following documents.

Framework Failure Analysis Report

Failure Analysis Requirements

The following is a complete list for all the requirements related to failure analysis for the Reconstructed Discontinuous Galerkin module.

rdg: Userobjects
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.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.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.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.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

rdg: Utils
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


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


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


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


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


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

Introduction
Dependencies
Failure Analysis Requirements