Install MOOSE link

New Users link

Examples and Tutorials link

Application Usage link

Physics and Syntax

Application Development link

Framework Development link

MOOSEDocs link

Infrastructure

Questions

Information and Tools

INL Applications and Remote Access link

RayTracingApp System Requirement Specification

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.

Requirements

The following is a complete list for all the functional requirements for RayTracingApp.

Functional Requirements

  • ray_tracing: Actions
  • 12.1.1The system shall throw an error when adding a RayBC and the provided RayTracingStudy
    1. could not be found
    2. or is not a RayTracingStudy.
  • 12.1.2The system shall throw an error when adding a RayBC and RayTracingStudy was not provided
    1. and multiple studies were found
    2. or when no studies were found.
  • 12.1.3The system shall throw an error when adding a RayKernel and the provided RayTracingStudy
    1. could not be found
    2. or is not a RayTracingStudy.
  • 12.1.4The system shall throw an error when adding a RayKernel and RayTracingStudy was not provided
    1. and multiple studies were found
    2. or when no studies were found.
  • ray_tracing: Coord Type
  • 12.2.1The system shall support line integrals in the
    1. rz coordinate system
    2. and in the rspherical coordinate system.
  • ray_tracing: Outputs
  • 12.3.1The system shall support the mesh output of traced rays on meshes of element types
    1. QUAD4,
    2. TRI3,
    3. HEX8, and
    4. TET4.
  • 12.3.2The system shall support the mesh output of traced rays using the Nemesis format.
  • 12.3.3The system shall support the mesh output of traced rays using the fewest segments possible to represent the trace in
    1. Exodus format and
    2. in Nemesis format.
  • 12.3.4The sytem shall support the output of ray data when outputting rays in a mesh format using
    1. exodus and
    2. nemesis formats.
  • 12.3.5The system shall report an error when ouputting rays in a mesh format when
    1. ray data is requested to be output but it is not cached,
    2. aux data is requested to be output but it is not cached,
    3. both nodal and non-nodal data is requested to be output,
    4. and when nodal data is requested to be output but segment-wise information is not cached.
  • 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.
  • ray_tracing: Postprocessors
  • 12.4.1The system shall support the ability to output the data stored on a ray.
  • 12.4.2The system shall report an error when ouputting a single data value stored on a ray when
    1. the RayTracingStudy does not support accessing rays by name,
    2. the RayTracingStudy does not support the banking of rays on completion,
    3. the named ray was not found,
    4. the named ray data was not found,
    5. the named ray aux data was not found,
    6. the ray with the given id was not found,
    7. neither an ID or name was provided, and
    8. both an ID and name was provided.
  • 12.4.3The system shall report an error when sampling the integrated value by a ray and
    1. the provided IntegralRayKernel is not an IntegralRayKernel,
    2. the provided IntegralRayKernel was not found,
    3. a Ray with the given name was not found,
    4. the provided study does not support Ray registration,
    5. or the provided study does not support Ray banking.
  • 12.4.4The system shall support the output of the total number of rays started, the total distance traveled by rays, and the number of processor crossings the rays have encountered.
  • ray_tracing: Raybcs
  • 12.5.1The system shall support the dependency resolution of RayBCs.
  • 12.5.2The system shall throw a reasonable error when adding a dependency for a RayBC that does not exist.
  • 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.
  • 12.5.4The system shall support the specular reflection of rays on a boundary.
  • 12.5.5The system shall report a reasonable warning when using an approximation to reflect a ray on a side that is not planar.
  • 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.
  • 12.6.2The system shall throw a reasonable error if a non-supported auxiliary variable is used with a ray aux kernel.
  • 12.6.3The system shall support the coupling of variables on rays that contribute to the residual and Jacobian.
  • 12.6.4The system shall be able to produce the exact Jacobian with coupled variables on rays.
  • 12.6.5The system shall support the coupling of variables using automatic differentiation on rays that contribute to the residual and Jacobian.
  • 12.6.6The system shall be able to produce the exact Jacobian using automatic differentiation on rays.
  • 12.6.7The system shall support the dependency resolution of RayKernels.
  • 12.6.8The system shall throw a reasonable error when adding a dependency for a RayKernel that does not exist.
  • 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.
  • 12.6.10The system shall provide the ability to compute the integral of a Function along a line.
  • 12.6.11The system shall provide an ability to produce a source term along a line.
  • 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.
  • 12.6.13The system shall provide the ability to compute the integral of a material property along a line.
  • 12.6.14The system shall be able to store the distance traversed by a ray in each element in an auxiliary field.
  • 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.
  • 12.6.16The system shall provide the ability to compute the integral of a variable along a line.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 12.7.3The system shall be able to trace rays within EDGE2 elements.
  • 12.7.4The system shall be able to trace rays within EDGE3 elements.
  • 12.7.5The system shall be able to trace rays within EDGE4 elements.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 12.7.13The system shall be able to trace rays on 3D meshes that have nonplanar faces.
  • 12.7.14The system shall by default warn that tracing on non-planar faces is an approximation.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 12.7.29The system shall support not setting the incoming side at the beginning of a trace.
  • ray_tracing: Userobjects
  • 12.8.1The system shall be able to generate rays emitting from a point in a cone using angular quadrature in
    1. two-dimensional meshes
    2. and in three-dimensional meshes.
  • 12.8.2The system shall be able to create additional rays during tracing with RayBCs in
    1. two-dimensional meshes
    2. and in three-dimensional meshes.
  • 12.8.3The system shall be able to trace rays using a
    1. last in, first out buffer
    2. and with a circular buffer.
  • 12.8.4The RayTracingStudy shall return a useful error when
    1. the same ray is added to be traced multiple times,
    2. when local rays that have the same ID are added to be traced,
    3. when rays that have the same ID on different processors are added to be traced,
    4. when checking if a ray is at its end point without an end point being set,
    5. when retrieving a ray's end point when its end point has not been set,
    6. when setting a ray's start point that has already been set,
    7. when setting a ray's start point that is not contained within the mesh bounding box,
    8. when setting a ray's starting incoming side without setting its starting element,
    9. when setting a ray's starting incoming side to an invalid side,
    10. when setting a ray's starting incoming side to one that does not contain the starting point,
    11. when setting a ray's starting point to a point that is not contained within a given starting element,
    12. when setting a ray's starting direction before setting its starting information,
    13. when setting a ray's starting direction multiple times without clearing it,
    14. when setting a ray's starting direction to the zero vector,
    15. when setting a ray's end point before setting its start point,
    16. when setting a ray's end point to the same as its start point,
    17. when setting a ray's end point and starting direction,
    18. when setting a ray's max distance after setting its end point,
    19. when setting a ray's end point after setting its max distance,
    20. when setting a ray's end point to a point that is not within the mesh bounding box,
    21. when setting a ray's starting maximum distance before setting its start information,
    22. when setting a ray's starting maximum distance to a negative value,
    23. when the domain is not covered with ray kernels,
    24. when ray names are provided to a ray tracing object and the study does not register ray names,
    25. when a ray name is provided to a ray tracing object and said name is not registered to a ray,
    26. when the study is set to execute with residual kernels and non-residual kernels,
    27. when the study is set to execute with residual kernels and an eigenvalue executioner,
    28. when the trajectory of a ray is changed after it has started tracing, and
    29. when a ray's counters are reset when not generating rays.
  • 12.8.5The system shall be able to change the trajectory of rays during tracing within RayKernels.
  • 12.8.6The system shall be able to create additional rays during tracing within RayKernels in
    1. two-dimensional meshes
    2. and in three-dimensional meshes.
  • 12.8.7The system shall support the tracing of rays using
    1. an asynchronous method,
    2. a bulk-synchronous method,
    3. and the harm method.
  • 12.8.8The system shall support the tracing of rays across multiple subdomains.
  • 12.8.9The system shall support the storage and manipulation of data and auxiliary data on a ray when
    1. sizing the Ray data on acquire
    2. and when not sizing the Ray data on acquire.
  • 12.8.10The system shall support the console output of information pertaining to a Ray.
  • 12.8.11The system shall support the re-use of traced rays.
  • 12.8.12The system shall support the failure of a trace gracefully via a warning.
  • 12.8.13The system shall support ending rays by a user-set maximum distance.
  • 12.8.14The system shall report an error when utilizing the repeatable ray study when
    1. both directions and points are provided,
    2. neither directions and points are provided,
    3. the number of start points provided is inconsistent,
    4. the number of directions provided is inconsistent,
    5. both end points and maximum distances are provided,
    6. the number of maximum distances provided is inconsistent,
    7. the provided maximum distance is non-positive,
    8. the number of end points provided is inconsistent,
    9. the initial data size is inconsistent with the number of rays,
    10. the initial data size is inconsistent with the provided data names,
    11. initial data is provided but data names are not provided,
    12. the initial aux data size is inconsistent with the number of rays,
    13. the initial aux data size is inconsistent with the provided aux data names,
    14. and aux initial data is provided but aux data names are not provided.
  • 12.8.15The RepeatableRayStudyBase shall support the
    1. outputting of checkpoint files and
    2. shall be capable of restarting from the output data.
  • 12.8.16The RepeatableRayStudyBase shall return a useful error when a ray is added with a non-unique ID.
  • 12.8.17The RepeatableRayStudyBase shall return a useful error with replicated ray functionality when
    1. additional rays are created in a non-replicated manner on a subset of processors,
    2. a ray exists with a non-replicated ID on a processor,
    3. and a non-replicated ray exists on a processor.
  • 12.8.18The RepeatableRayStudyBase shall return a useful error after defining rays when
    1. no rays were defined or
    2. a null ray was defined.
  • ray_tracing: Vector Postprocessors
  • 12.9.1The system shall support the output of information pretaining to the tracing of rays on a per-processor basis.

Usability Requirements

Performance Requirements

System Requirements