RayTracingApp Requirement Traceability Matrix

Introduction

The Requirement Traceability Matrix (RTM) for RayTracingApp captures all requirements and maps each to the associated design documentation and associated test case.

Dependencies

The RayTracingApp application is developed using MOOSE and is based on various modules, as such the RTM for RayTracingApp is dependent upon the following documents.

Requirements

The following is a complete list for all the functional requirements including links to the design documents and test cases for RayTracingApp.

Functional Requirements

  • ray_tracing: Raybcs
  • 12.5.1The system shall support the dependency resolution of RayBCs.

    Specification(s): test

    Design: RayBCs

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 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): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 12.5.3The system shall report an error when changing a ray direction within a RayBC when
    1. the ray was set to not continue by another RayBC,
    2. the ray already had its direction changed,
    3. the end point of the ray was set upon generation,
    4. 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): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 12.5.4The system shall support the specular reflection of rays on a boundary.

    Specification(s): test

    Design: ReflectRayBCRayBCs

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 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): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • ray_tracing: Raykernels
  • 12.6.1The system shall throw a reasonable error if an ADRayKernel
    1. is used with a coordinate system other than xyz or
    2. is used in an explicit manner.

    Specification(s): errors/xyz_only, errors/implicit_only

    Design: ADRayKernel

    Issue(s): #16028

    Collection(s): FAILURE_ANALYSISFUNCTIONAL

    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): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 12.6.3The system shall support the coupling of variables on rays that contribute to the residual and Jacobian.

    Specification(s): test

    Design: RayKernels

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): Exodiff

  • 12.6.4The system shall be able to produce the exact Jacobian with coupled variables on rays.

    Specification(s): test_jac

    Design: RayKernels

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): PetscJacobianTester

  • 12.6.5The system shall support the coupling of variables using automatic differentiation on rays that contribute to the residual and Jacobian.

    Specification(s): test_ad

    Design: RayKernels

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): Exodiff

  • 12.6.6The system shall be able to produce the exact Jacobian using automatic differentiation on rays.

    Specification(s): test_ad_jac

    Design: RayKernels

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): PetscJacobianTester

  • 12.6.7The system shall support the dependency resolution of RayKernels.

    Specification(s): test

    Design: RayKernels

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 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): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 12.6.9The system shall report an error when changing a ray start and/or direction within a RayKernel when
    1. the ray was set to not continue by another RayKernel,
    2. the ray was set to not continue by another RayKernel and it is at its end point,
    3. the ray's trajectory was already changed,
    4. the ray's end point has been set,
    5. the ray's start point is not within the current element, and
    6. 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): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 12.6.10The system shall provide the ability to compute the integral of a Function along a line.

    Specification(s): test

    Design: FunctionIntegralRayKernel

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.6.11The system shall provide an ability to produce a source term along a line.

    Specification(s): test

    Design: LineSourceRayKernel

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): Exodiff

  • 12.6.12The system shall provide an ability to solve a 2D diffusion problem with a line source term, with
    1. finite elements
    2. and finite volumes.

    Specification(s): simple_diffusion/fe, simple_diffusion/fv

    Design: LineSourceRayKernel

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): Exodiff

  • 12.6.13The system shall provide the ability to compute the integral of a material property along a line.

    Specification(s): test

    Design: MaterialIntegralRayKernel

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.6.14The system shall be able to store the distance traversed by a ray in each element in an auxiliary field.

    Specification(s): test

    Design: RayDistanceAux

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): Exodiff

  • 12.6.15The system shall throw a reasonable error if a RayKernel
    1. is utilized with a coordinate system other than xyz or
    2. 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): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 12.6.16The system shall provide the ability to compute the integral of a variable along a line.

    Specification(s): test

    Design: VariableIntegralRayKernel

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.6.17The system shall provide the ability to output the segment wise accumulated integral of a variable along a line with a 2D, finite-element diffusion problem.

    Specification(s): simple_diffusion_rays

    Design: VariableIntegralRayKernelRayTracingMeshOutput

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): Exodiff

  • 12.6.18The system shall provide the ability to output the segment wise, linearly approximated, accumulated integral of a variable along a line with a 2D, finite-element diffusion problem.

    Specification(s): simple_diffusion_rays_nodal

    Design: VariableIntegralRayKernelRayTracingMeshOutput

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): Exodiff

  • 12.6.19The system shall provide the ability to compute the line integral of a variable for a 2D diffusion problem, with
    1. finite elements
    2. and finite volumes.

    Specification(s): simple_diffusion/fe, simple_diffusion/fv

    Design: VariableIntegralRayKernel

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • ray_tracing: Traceray
  • 12.7.1The system shall be able to trace rays in a mesh that utilizes adaptiviy with the element types
    1. QUAD4,
    2. TRI3,
    3. HEX8,
    4. and EDGE2.

    Specification(s): elem_tests/quad4, elem_tests/tri3, elem_tests/hex8, elem_tests/edge2

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.2The system shall support the use of side normals to cull potential exiting sides within ray tracing for
    1. two-dimensional meshes
    2. and for three-dimensional meshes.

    Specification(s): dim/2d, dim/3d

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.3The system shall be able to trace rays within EDGE2 elements.

    Specification(s): test

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.4The system shall be able to trace rays within EDGE3 elements.

    Specification(s): test

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.5The system shall be able to trace rays within EDGE4 elements.

    Specification(s): test

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.6The system shall be able to trace rays within planar HEX20 elements
    1. from boundary vertices on boundary sides in the direction of the vertices on the other side of the same boundary element,
    2. from the centroids of boundary sides in the direction of all other vertices in the same boundary element,
    3. from the centroids of all boundary sides to the centroids of all other boundary elements,
    4. from the centroids of boundary edges in the direction of all other edge centroids in the same element,
    5. from boundary sides centroids using an angular quadrature,
    6. and from boundary element centroids using an angular quadrature.

    Specification(s): tests/vtv, tests/ctv, tests/ctc, tests/ete, tests/side_aq, tests/centroid_aq

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.7The system shall be able to trace rays within planar HEX27 elements
    1. from boundary vertices on boundary sides in the direction of the vertices on the other side of the same boundary element,
    2. from the centroids of boundary sides in the direction of all other vertices in the same boundary element,
    3. from the centroids of all boundary sides to the centroids of all other boundary elements,
    4. from the centroids of boundary edges in the direction of all other edge centroids in the same element,
    5. from boundary sides centroids using an angular quadrature,
    6. and from boundary element centroids using an angular quadrature.

    Specification(s): tests/vtv, tests/ctv, tests/ctc, tests/ete, tests/side_aq, tests/centroid_aq

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.8The system shall be able to trace rays within planar HEX8 elements
    1. from boundary vertices on boundary sides in the direction of the vertices on the other side of the same boundary element,
    2. from the centroids of boundary sides in the direction of all other vertices in the same boundary element,
    3. from the centroids of all boundary sides to the centroids of all other boundary elements,
    4. from the centroids of boundary edges in the direction of all other edge centroids in the same element,
    5. from boundary sides centroids using an angular quadrature,
    6. and from boundary element centroids using an angular quadrature.

    Specification(s): tests/vtv, tests/ctv, tests/ctc, tests/ete, tests/side_aq, tests/centroid_aq

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.9The system shall support the ending of traced rays on internal sidesets in
    1. one-dimensional meshes,
    2. two-dimensional meshes,
    3. and three-dimensional meshes.

    Specification(s): kill/1d, kill/2d, kill/3d

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.10The system shall support the specular reflection of traced rays on internal sidesets in
    1. one-dimensional meshes,
    2. two-dimensional meshes,
    3. and three-dimensional meshes.

    Specification(s): reflect/1d, reflect/2d, reflect/3d

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 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): FAILURE_ANALYSISFUNCTIONAL

    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): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 12.7.13The system shall be able to trace rays on 3D meshes that have nonplanar faces.

    Specification(s): test

    Design: RayTracingStudy

    Issue(s): #16028#16170

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.14The system shall by default warn that tracing on non-planar faces is an approximation.

    Specification(s): warning

    Design: RayTracingStudy

    Issue(s): #16028#16170

    Collection(s): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 12.7.15The system shall be able to trace rays within planar PRISM15 elements
    1. from boundary vertices on boundary sides in the direction of the vertices on the other side of the same boundary element,
    2. from the centroids of boundary sides in the direction of all other vertices in the same boundary element,
    3. from the centroids of all boundary sides to the centroids of all other boundary elements,
    4. from the centroids of boundary edges in the direction of all other edge centroids in the same element,
    5. from boundary sides centroids using an angular quadrature,
    6. and from boundary element centroids using an angular quadrature.

    Specification(s): tests/vtv, tests/ctv, tests/ctc, tests/ete, tests/side_aq, tests/centroid_aq

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.16The system shall be able to trace rays within planar PRISM18 elements
    1. from boundary vertices on boundary sides in the direction of the vertices on the other side of the same boundary element,
    2. from the centroids of boundary sides in the direction of all other vertices in the same boundary element,
    3. from the centroids of all boundary sides to the centroids of all other boundary elements,
    4. from the centroids of boundary edges in the direction of all other edge centroids in the same element,
    5. from boundary sides centroids using an angular quadrature,
    6. and from boundary element centroids using an angular quadrature.

    Specification(s): tests/vtv, tests/ctv, tests/ctc, tests/ete, tests/side_aq, tests/centroid_aq

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.17The system shall be able to trace rays within planar PRISM6 elements
    1. from boundary vertices on boundary sides in the direction of the vertices on the other side of the same boundary element,
    2. from the centroids of boundary sides in the direction of all other vertices in the same boundary element,
    3. from the centroids of all boundary sides to the centroids of all other boundary elements,
    4. from the centroids of boundary edges in the direction of all other edge centroids in the same element,
    5. from boundary sides centroids using an angular quadrature,
    6. and from boundary element centroids using an angular quadrature.

    Specification(s): tests/vtv, tests/ctv, tests/ctc, tests/ete, tests/side_aq, tests/centroid_aq

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.18The system shall be able to trace rays within planar PYRAMID13 elements
    1. from boundary vertices on boundary sides in the direction of the vertices on the other side of the same boundary element,
    2. from the centroids of boundary sides in the direction of all other vertices in the same boundary element,
    3. from the centroids of all boundary sides to the centroids of all other boundary elements,
    4. from the centroids of boundary edges in the direction of all other edge centroids in the same element,
    5. from boundary sides centroids using an angular quadrature,
    6. and from boundary element centroids using an angular quadrature.

    Specification(s): tests/vtv, tests/ctv, tests/ctc, tests/ete, tests/side_aq, tests/centroid_aq

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.19The system shall be able to trace rays within planar PYRAMID14 elements
    1. from boundary vertices on boundary sides in the direction of the vertices on the other side of the same boundary element,
    2. from the centroids of boundary sides in the direction of all other vertices in the same boundary element,
    3. from the centroids of all boundary sides to the centroids of all other boundary elements,
    4. from the centroids of boundary edges in the direction of all other edge centroids in the same element,
    5. from boundary sides centroids using an angular quadrature,
    6. and from boundary element centroids using an angular quadrature.

    Specification(s): tests/vtv, tests/ctv, tests/ctc, tests/ete, tests/side_aq, tests/centroid_aq

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.20The system shall be able to trace rays within planar PYRAMID5 elements
    1. from boundary vertices on boundary sides in the direction of the vertices on the other side of the same boundary element,
    2. from the centroids of boundary sides in the direction of all other vertices in the same boundary element,
    3. from the centroids of all boundary sides to the centroids of all other boundary elements,
    4. from the centroids of boundary edges in the direction of all other edge centroids in the same element,
    5. from boundary sides centroids using an angular quadrature,
    6. and from boundary element centroids using an angular quadrature.

    Specification(s): tests/vtv, tests/ctv, tests/ctc, tests/ete, tests/side_aq, tests/centroid_aq

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.21The system shall be able to trace rays within planar QUAD4 elements
    1. from boundary vertices on boundary sides in the direction of the vertices on the other side of the same boundary element,
    2. from the centroids of boundary sides in the direction of all other vertices in the same boundary element,
    3. from the centroids of all boundary sides to the centroids of all other boundary elements,
    4. from boundary sides centroids using an angular quadrature,
    5. and from boundary element centroids using an angular quadrature.

    Specification(s): tests/vtv, tests/ctv, tests/ctc, tests/side_aq, tests/centroid_aq

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.22The system shall be able to trace rays within planar QUAD8 elements
    1. from boundary vertices on boundary sides in the direction of the vertices on the other side of the same boundary element,
    2. from the centroids of boundary sides in the direction of all other vertices in the same boundary element,
    3. from the centroids of all boundary sides to the centroids of all other boundary elements,
    4. from boundary sides centroids using an angular quadrature,
    5. and from boundary element centroids using an angular quadrature.

    Specification(s): tests/vtv, tests/ctv, tests/ctc, tests/side_aq, tests/centroid_aq

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.23The system shall be able to trace rays within planar QUAD9 elements
    1. from boundary vertices on boundary sides in the direction of the vertices on the other side of the same boundary element,
    2. from the centroids of boundary sides in the direction of all other vertices in the same boundary element,
    3. from the centroids of all boundary sides to the centroids of all other boundary elements,
    4. from boundary sides centroids using an angular quadrature,
    5. and from boundary element centroids using an angular quadrature.

    Specification(s): tests/vtv, tests/ctv, tests/ctc, tests/side_aq, tests/centroid_aq

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.24The system shall report an error when a ray hits a boundary during tracing and
    1. the boundary does not have any RayBCs
    2. 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): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 12.7.25The system shall be able to trace rays within planar TET10 elements
    1. from boundary vertices on boundary sides in the direction of the vertices on the other side of the same boundary element,
    2. from the centroids of boundary sides in the direction of all other vertices in the same boundary element,
    3. from the centroids of all boundary sides to the centroids of all other boundary elements,
    4. from the centroids of boundary edges in the direction of all other edge centroids in the same element,
    5. from boundary sides centroids using an angular quadrature,
    6. and from boundary element centroids using an angular quadrature.

    Specification(s): tests/vtv, tests/ctv, tests/ctc, tests/ete, tests/side_aq, tests/centroid_aq

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.26The system shall be able to trace rays within planar TET4 elements
    1. from boundary vertices on boundary sides in the direction of the vertices on the other side of the same boundary element,
    2. from the centroids of boundary sides in the direction of all other vertices in the same boundary element,
    3. from the centroids of all boundary sides to the centroids of all other boundary elements,
    4. from the centroids of boundary edges in the direction of all other edge centroids in the same element,
    5. from boundary sides centroids using an angular quadrature,
    6. and from boundary element centroids using an angular quadrature.

    Specification(s): tests/vtv, tests/ctv, tests/ctc, tests/ete, tests/side_aq, tests/centroid_aq

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.27The system shall be able to trace rays within planar TRI3 elements
    1. from boundary vertices on boundary sides in the direction of the vertices on the other side of the same boundary element,
    2. from the centroids of boundary sides in the direction of all other vertices in the same boundary element,
    3. from the centroids of all boundary sides to the centroids of all other boundary elements,
    4. from boundary sides centroids using an angular quadrature,
    5. and from boundary element centroids using an angular quadrature.

    Specification(s): tests/vtv, tests/ctv, tests/ctc, tests/side_aq, tests/centroid_aq

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.28The system shall be able to trace rays within planar TRI6 elements
    1. from boundary vertices on boundary sides in the direction of the vertices on the other side of the same boundary element,
    2. from the centroids of boundary sides in the direction of all other vertices in the same boundary element,
    3. from the centroids of all boundary sides to the centroids of all other boundary elements,
    4. from boundary sides centroids using an angular quadrature,
    5. and from boundary element centroids using an angular quadrature.

    Specification(s): tests/vtv, tests/ctv, tests/ctc, tests/side_aq, tests/centroid_aq

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 12.7.29The system shall support not setting the incoming side at the beginning of a trace.

    Specification(s): test

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

Usability Requirements

Performance Requirements

System Requirements