RayTracingApp Failure Analysis Report
Introduction
The Software Requirement Specification (SRS) for RayTracingApp describes the system functional and non-functional requirements that describe the expected interactions that the software shall provide.
Dependencies
The RayTracingApp application is developed using MOOSE and is based on various modules, as such the SRS for RayTracingApp is dependent upon the following documents.
Failure Analysis Requirements
The following is a complete list for all the requirements related to failure analysis for RayTracingApp.
- ray_tracing: Actions
- 12.1.1The system shall throw an error when adding a RayBC and the provided RayTracingStudy
- could not be found
- or is not a RayTracingStudy.
Specification(s): provided/missing, provided/not_a_study
Design: AddRayBCAction
Issue(s): #16028
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 12.1.2The system shall throw an error when adding a RayBC and RayTracingStudy was not provided
- and multiple studies were found
- or when no studies were found.
Specification(s): not_provided/multiple, not_provided/missing
Design: AddRayBCAction
Issue(s): #16028
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 12.1.3The system shall throw an error when adding a RayKernel and the provided RayTracingStudy
- could not be found
- or is not a RayTracingStudy.
Specification(s): provided/missing, provided/not_a_study
Design: AddRayKernelAction
Issue(s): #16028
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 12.1.4The system shall throw an error when adding a RayKernel and RayTracingStudy was not provided
- and multiple studies were found
- or when no studies were found.
Specification(s): not_provided/multiple, not_provided/missing
Design: AddRayKernelAction
Issue(s): #16028
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- ray_tracing: Outputs
- 12.3.5The system shall report an error when ouputting rays in a mesh format when
- ray data is requested to be output but it is not cached,
- aux data is requested to be output but it is not cached,
- both nodal and non-nodal data is requested to be output,
- and when nodal data is requested to be output but segment-wise information is not cached.
Specification(s): errors/no_cached_data, errors/no_cached_aux_data, errors/data_nodal_and_non_nodal, errors/nodal_no_segments
Design: RayTracingMeshOutput
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 12.3.6The system shall report a warning when rays are requested to be output in a mesh format but cached ray inforamtion is not found.
Specification(s): no_segments_warning
Design: RayTracingMeshOutput
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- ray_tracing: Postprocessors
- 12.4.2The system shall report an error when ouputting a single data value stored on a ray when
- the RayTracingStudy does not support accessing rays by name,
- the RayTracingStudy does not support the banking of rays on completion,
- the named ray was not found,
- the named ray data was not found,
- the named ray aux data was not found,
- the ray with the given id was not found,
- neither an ID or name was provided, and
- both an ID and name was provided.
Specification(s): errors/no_registration, errors/no_banking, errors/ray_name_not_found, errors/data_name_not_found, errors/aux_data_name_not_found, errors/id_not_found, errors/neither_provided, errors/both_provided
Design: RayDataValue
Issue(s): #16028
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 12.4.3The system shall report an error when sampling the integrated value by a ray and
- the provided IntegralRayKernel is not an IntegralRayKernel,
- the provided IntegralRayKernel was not found,
- a Ray with the given name was not found,
- the provided study does not support Ray registration,
- or the provided study does not support Ray banking.
Specification(s): errors/not_integral_ray_kernel, errors/kernel_not_found, errors/ray_not_found, errors/no_registration, errors/no_banking
Design: RayIntegralValue
Issue(s): #16028
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- ray_tracing: Raybcs
- 12.5.2The system shall throw a reasonable error when adding a dependency for a RayBC that does not exist.
Specification(s): missing
Design: RayBCs
Issue(s): #16028
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 12.5.3The system shall report an error when changing a ray direction within a RayBC when
- the ray was set to not continue by another RayBC,
- the ray already had its direction changed,
- the end point of the ray was set upon generation,
- and when the direction is changed to the zero vector.
Specification(s): change_direction/should_not_continue, change_direction/again, change_direction/end_set, change_direction/zero
Design: RayBCs
Issue(s): #16028
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 12.5.5The system shall report a reasonable warning when using an approximation to reflect a ray on a side that is not planar.
Specification(s): non_planar_warning
Design: ReflectRayBCRayBCs
Issue(s): #16028
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- ray_tracing: Raykernels
- 12.6.1The system shall throw a reasonable error if an ADRayKernel
- is used with a coordinate system other than xyz or
- is used in an explicit manner.
Specification(s): errors/xyz_only, errors/implicit_only
Design: ADRayKernel
Issue(s): #16028
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 12.6.2The system shall throw a reasonable error if a non-supported auxiliary variable is used with a ray aux kernel.
Specification(s): const_monomial_only
Design: AuxRayKernel
Issue(s): #16028
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 12.6.8The system shall throw a reasonable error when adding a dependency for a RayKernel that does not exist.
Specification(s): missing
Design: RayKernels
Issue(s): #16028
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 12.6.9The system shall report an error when changing a ray start and/or direction within a RayKernel when
- the ray was set to not continue by another RayKernel,
- the ray was set to not continue by another RayKernel and it is at its end point,
- the ray's trajectory was already changed,
- the ray's end point has been set,
- the ray's start point is not within the current element, and
- when the ray's new direction is set to the zero vector.
Specification(s): change_direction/should_not_continue, change_direction/should_not_continue_at_end, change_direction/changed_again, change_direction/end_set, change_direction/out_of_elem, change_direction/zero_direction
Design: RayKernels
Issue(s): #16028
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 12.6.15The system shall throw a reasonable error if a RayKernel
- is utilized with a coordinate system other than xyz or
- if the execute flag for the associated ray study is not set correctly to use the RayKernel.
Specification(s): errors/xyz_only, errors/bad_execute_on
Design: RayKernel
Issue(s): #16028
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- ray_tracing: Traceray
- 12.7.11The system shall throw an error if RayBCs are defined on internal sidesets, but the study does not have internal sideset capability enabled.
Specification(s): internal_sidesets_disabled
Design: RayTracingStudy
Issue(s): #16028
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 12.7.12The system shall throw an error if RayBCs are defined on internal sidesets and said internal sidesets are not bounded by different subdomains.
Specification(s): not_subdomain_bounded
Design: RayTracingStudy
Issue(s): #16028
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 12.7.14The system shall by default warn that tracing on non-planar faces is an approximation.
Specification(s): warning
Design: RayTracingStudy
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 12.7.24The system shall report an error when a ray hits a boundary during tracing and
- the boundary does not have any RayBCs
- and then the boundary does not have any RayBCs that change the trajectory of the ray or end the ray.
Specification(s): error/both, error/one
Design: RayTracingStudy
Issue(s): #16028
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- ray_tracing: Userobjects
- 12.8.4The RayTracingStudy shall return a useful error when
- the same ray is added to be traced multiple times,
- when local rays that have the same ID are added to be traced,
- when rays that have the same ID on different processors are added to be traced,
- when checking if a ray is at its end point without an end point being set,
- when retrieving a ray's end point when its end point has not been set,
- when setting a ray's start point that has already been set,
- when setting a ray's start point that is not contained within the mesh bounding box,
- when setting a ray's starting incoming side without setting its starting element,
- when setting a ray's starting incoming side to an invalid side,
- when setting a ray's starting incoming side to one that does not contain the starting point,
- when setting a ray's starting point to a point that is not contained within a given starting element,
- when setting a ray's starting direction before setting its starting information,
- when setting a ray's starting direction multiple times without clearing it,
- when setting a ray's starting direction to the zero vector,
- when setting a ray's end point before setting its start point,
- when setting a ray's end point to the same as its start point,
- when setting a ray's end point and starting direction,
- when setting a ray's max distance after setting its end point,
- when setting a ray's end point after setting its max distance,
- when setting a ray's end point to a point that is not within the mesh bounding box,
- when setting a ray's starting maximum distance before setting its start information,
- when setting a ray's starting maximum distance to a negative value,
- when the domain is not covered with ray kernels,
- when ray names are provided to a ray tracing object and the study does not register ray names,
- when a ray name is provided to a ray tracing object and said name is not registered to a ray,
- when the study is set to execute with residual kernels and non-residual kernels,
- when the study is set to execute with residual kernels and an eigenvalue executioner,
- when the trajectory of a ray is changed after it has started tracing, and
- when a ray's counters are reset when not generating rays.
Specification(s): tests/duplicate_ray, tests/local_non_unique_id, tests/global_non_unique_id, tests/ray_at_end_without_set, tests/ray_end_point_without_set, tests/ray_set_start_again, tests/ray_set_start_fail_bbox, tests/ray_set_side_without_elem, tests/ray_set_invalid_side, tests/ray_set_bad_side, tests/ray_set_bad_start, tests/ray_set_direction_before_start, tests/ray_set_direction_again, tests/ray_set_zero_direction, tests/ray_set_end_before_start, tests/ray_set_end_equal_start, tests/ray_set_end_with_direction, tests/ray_set_distance_with_end, tests/ray_set_end_with_distance, tests/ray_set_end_fail_bbox, tests/ray_set_distance_before_start, tests/ray_set_distance_negative, tests/ray_kernel_coverage_check, tests/unneeded_rays, tests/ray_not_found, tests/mixed_pre_kernel_execute, tests/eigenvalue, tests/error_if_tracing, tests/reset_counters
Design: RayTracingStudy
Issue(s): #16848
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 12.8.12The system shall support the failure of a trace gracefully via a warning.
Specification(s): no_bc
Design: RayTracingStudy
Issue(s): #16028
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 12.8.14The system shall report an error when utilizing the repeatable ray study when
- both directions and points are provided,
- neither directions and points are provided,
- the number of start points provided is inconsistent,
- the number of directions provided is inconsistent,
- both end points and maximum distances are provided,
- the number of maximum distances provided is inconsistent,
- the provided maximum distance is non-positive,
- the number of end points provided is inconsistent,
- the initial data size is inconsistent with the number of rays,
- the initial data size is inconsistent with the provided data names,
- initial data is provided but data names are not provided,
- the initial aux data size is inconsistent with the number of rays,
- the initial aux data size is inconsistent with the provided aux data names,
- and aux initial data is provided but aux data names are not provided.
Specification(s): errors/directions_or_end_points, errors/neither_directions_or_end_points, errors/start_size, errors/directions_size, errors/max_distance_with_end, errors/max_distance_size, errors/max_distance_positive, errors/end_points_size, errors/initial_data_size, errors/initial_data_individual_size, errors/data_names_not_set, errors/initial_aux_data_size, errors/initial_aux_data_individual_size, errors/aux_data_names_not_set
Design: RepeatableRayStudy
Issue(s): #17030
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 12.8.16The RepeatableRayStudyBase shall return a useful error when a ray is added with a non-unique ID.
Specification(s): non_unique_id_error
Design: RepeatableRayStudyBase
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 12.8.17The RepeatableRayStudyBase shall return a useful error with replicated ray functionality when
- additional rays are created in a non-replicated manner on a subset of processors,
- a ray exists with a non-replicated ID on a processor,
- and a non-replicated ray exists on a processor.
Specification(s): replicated_errors/additional, replicated_errors/non_replicated_id, replicated_errors/non_replicated
Design: RepeatableRayStudyBase
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 12.8.18The RepeatableRayStudyBase shall return a useful error after defining rays when
- no rays were defined or
- a null ray was defined.
Specification(s): define_errors/no_rays, define_errors/null_ray
Design: RepeatableRayStudyBase
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException