Ray Tracing System Design Description

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

commentnote

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

Introduction

Frameworks are a software development construct aiming to simplify the creation of specific classes of applications through abstraction of low-level details. The main object of creating a framework is to provide an interface to application developers that saves time and provides advanced capabilities not attainable otherwise. The MOOSE, mission is just that: provide a framework for engineers and scientists to build state-of-the-art, computationally scalable finite element based simulation tools.

MOOSE was conceived with one major objective: to be as easy and straightforward to use by scientists and engineers as possible. MOOSE is meant to be approachable by non-computational scientists who have systems of PDEs they need to solve. Every single aspect of MOOSE was driven by this singular principle from the build system to the API to the software development cycle. At every turn, decisions were made to enable this class of users to be successful with the framework. The pursuit of this goal has led to many of the unique features of MOOSE:

  • A streamlined build system

  • An API aimed at extensible

  • Straightforward APIs providing sensible default information

  • Integrated, automatic, and rigorous testing

  • Rapid, continuous integration development cycle

  • Codified, rigorous path for contributing

  • Applications are modular and composable

Each of these characteristics is meant to build trust in the framework by those attempting to use it. For instance, the build system is the first thing potential framework users come into contact with when they download a new software framework. Onerous dependency issues, complicated, hard to follow instructions or build failure can all result in a user passing on the platform. Ultimately, the decision to utilize a framework comes down to whether or not you trust the code in the framework and those developing it to be able to support your desired use-case. No matter the technical capabilities of a framework, without trust users will look elsewhere. This is especially true of those not trained in software development or computational science.

Developing trust in a framework goes beyond utilizing "best practices" for the code developed, it is equally important that the framework itself is built upon tools that are trusted. For this reason, MOOSE relies on a well-established code base of libMesh and PETSc. The libMesh library provides foundational capability for the finite element method and provides interfaces to leading-edge numerical solution packages such as PETSc.

With these principles in mind, an open source, massively parallel, finite element, multiphysics framework has been conceived. MOOSE is an on-going project started in 2008 aimed toward a common platform for creation of new multiphysics tools. This document provides design details pertinent to application developers as well as framework developers.

Use Cases

The MOOSE Framework is targeted at two main groups of actors: Developers and Users. Developers are the main use case. These are typically students and professionals trained in science and engineering fields with some level of experience with coding but typically very little formal software development training. The other user group is Users. Those who intend to use an application built upon the framework without writing any computer code themselves. Instead they may modify or create input files for driving a simulation, run the application, and analyze the results. All interactions through MOOSE are primarily through the command-line interface and through a customizable block-based input file.

System Purpose

The Software Design Description provided here is description of each object in the system. The pluggable architecture of the framework 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 the framework, modules and derivative applications. More information about the design documentation can be found in Documenting MOOSE.

System Scope

The purpose of this software is to provide several libraries that can be used to build an application based upon the framework. Additionally, several utilities are provided for assisting developers and users in end-to-end FEM analysis. A brief overview of the major components are listed here:

ComponentDescription
framework libraryThe base system from which all MOOSE-based applications are created
module librariesOptional "physics" libraries that may be used in an application to provide capability
build systemThe system responsible for creating applications for a series of libraries and applications
test harnessThe extendable testing system for finding, scheduling, running, and reporting regression tests
"peacock"The graphical user interface (GUI) for building input files, executing applications, and displaying results
MooseDocsThe extendable markdown system for MOOSE providing common documentation and requirements enforcement
"stork"The script and templates for generating a new MOOSE-based application ready for building and testing
examplesA set of complete applications demonstrating the use of MOOSE's pluggable systems
tutorialsStep by step guides to building up an application using MOOSE's pluggable systems
unitAn application for unit testing individual classes or methods of C++ code

Dependencies and Limitations

The MOOSE platform has several dependencies on other software packages and has scope that is constantly evolving based upon funding, resources, priorities, and lab direction. However, the software is open-source and many features and even bugs can be offloaded to developers with appropriate levels of knowledge and direction from the main design team. The primary list of software dependencies is listed below. This list is not meant to be exhaustive. Individual operating systems may require specific packages to be installed prior to using MOOSE, which can be found on the Install MOOSE pages.

Software DependencyDescription
libMeshFinite Element Library and I/O routines
PETScSolver Package
hypreMultigrid Preconditioner
MPIA distributed parallel processing library (MPICH)

Figure 1: A diagram of the MOOSE code platform.

References

  1. ISO/IEC/IEEE 24765:2010(E). Systems and software engineering—Vocabulary. first edition, December 15 2010.[BibTeX]
  2. 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.[BibTeX]

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

AcronymDescription
APIApplication Programming Interface
DOE-NEDepartment of Energy, Nuclear Energy
FEfinite element
FEMFinite Element Method
GUIgraphical user interface
HITHierarchical Input Text
HPCHigh Performance Computing
I/OInput/Output
INLIdaho National Laboratory
MOOSEMultiphysics Object Oriented Simulation Environment
MPIMessage Passing Interface
PDEspartial differential equations
SDDSoftware Design Description

Design Stakeholders and Concerns

Design Stakeholders

Stakeholders for MOOSE include several of the funding sources including Department of Energy, Nuclear Energy (DOE-NE) and the INL. However, Since MOOSE is an open-source project, several universities, companies, and foreign governments have an interest in the development and maintenance of the MOOSE 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, MOOSE 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, MOOSE 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

The MOOSE framework itself is composed of a wide range of pluggable systems. Each system is generally composed of a single or small set of C++ objects intended to be specialized by a Developer to solve a specific problem. To accomplish this design goal, MOOSE uses several modern object-oriented design patterns. The primary overarching pattern is the "Factory Pattern". Users needing to extend MOOSE may inherit from one of MOOSE's systems to providing an implementation meeting his or her needs. The design of each of these systems is documented on the mooseframework.org wiki in the Tutorial section. Additionally, up-to-date documentation extracted from the source is maintained on the the mooseframework.org documentation site after every successful merge to MOOSE's stable branch. After these objects are created, the can be registered with the framework and used immediately in a MOOSE input file.

System Structure

The MOOSE framework architecture consists of a core and several pluggable systems. The core of MOOSE consists of a number of key objects responsible for setting up and managing the user-defined objects of a finite element simulation. This core set of objects has limited extendability and exist for every simulation configuration that the framework is capable of running.

Adaptivity

Adaptivity/Indicators

Adaptivity/Markers

AuxKernels

AuxKernels/MatVecRealGradAuxKernel

AuxKernels/MaterialVectorAuxKernel

AuxKernels/MaterialVectorGradAuxKernel

AuxScalarKernels

AuxVariables

AuxVariables/MultiAuxVariables

BCs

BCs/CavityPressure

BCs/CoupledPressure

BCs/InclinedNoDisplacementBC

BCs/Periodic

BCs/Pressure

Bounds

Closures

Components

Constraints

Contact

ControlLogic

Controls

CoupledHeatTransfers

Covariance

DGKernels

Dampers

Debug

Debug/MaterialDerivativeTest

DeprecatedBlock

DiracKernels

Distributions

DomainIntegral

Executioner

Executioner/Adaptivity

Executioner/Predictor

Executioner/Quadrature

Executioner/TimeIntegrator

Executioner/TimeStepper

Executors

FVBCs

FVInterfaceKernels

FVKernels

FluidPropertiesInterrogator

Functions

GeochemicalModelInterrogator

GlobalParams

GrayDiffuseRadiation

HeatStructureMaterials

ICs

ICs/PolycrystalICs

ICs/PolycrystalICs/BicrystalBoundingBoxIC

ICs/PolycrystalICs/BicrystalCircleGrainIC

ICs/PolycrystalICs/PolycrystalColoringIC

ICs/PolycrystalICs/PolycrystalRandomIC

ICs/PolycrystalICs/PolycrystalVoronoiVoidIC

ICs/PolycrystalICs/Tricrystal2CircleGrainsIC

InterfaceKernels

Kernels

Kernels/CHPFCRFFSplitKernel

Kernels/DynamicTensorMechanics

Kernels/HHPFCRFFSplitKernel

Kernels/PFCRFFKernel

Kernels/PolycrystalElasticDrivingForce

Kernels/PolycrystalKernel

Kernels/PolycrystalStoredEnergy

Kernels/PoroMechanics

Kernels/RigidBodyMultiKernel

Kernels/TensorMechanics

Materials

Mesh

Mesh/Partitioner

Modules

Modules/CompressibleNavierStokes

Modules/FluidProperties

Modules/HeatConduction

Modules/HeatConduction/ThermalContact

Modules/HeatConduction/ThermalContact/BC

Modules/IncompressibleNavierStokes

Modules/NavierStokesFV

Modules/Peridynamics

Modules/Peridynamics/Mechanics

Modules/Peridynamics/Mechanics/GeneralizedPlaneStrain
Modules/Peridynamics/Mechanics/Master

Modules/PhaseField

Modules/PhaseField/Conserved

Modules/PhaseField/DisplacementGradients

Modules/PhaseField/EulerAngles2RGB

Modules/PhaseField/GrainGrowth

Modules/PhaseField/GrandPotential

Modules/PhaseField/Nonconserved

Modules/PorousFlow

Modules/PorousFlow/BCs

Modules/TensorMechanics

Modules/TensorMechanics/CohesiveZoneMaster

Modules/TensorMechanics/DynamicMaster

Modules/TensorMechanics/GeneralizedPlaneStrain

Modules/TensorMechanics/GlobalStrain

Modules/TensorMechanics/LineElementMaster

Modules/TensorMechanics/Master

Modules/TensorMechanics/MaterialVectorBodyForce

MortarGapHeatTransfer

MultiApps

NodalKernels

NodalNormals

Outputs

PorousFlowBasicTHM

PorousFlowFullySaturated

PorousFlowUnsaturated

Postprocessors

Preconditioning

Problem

RayBCs

RayKernels

ReactionNetwork

ReactionNetwork/AqueousEquilibriumReactions

ReactionNetwork/SolidKineticReactions

Reporters

Samplers

ScalarKernels

SpatialReactionSolver

StochasticTools

Surrogates

ThermalContact

TimeDependentReactionSolver

TimeIndependentReactionSolver

Trainers

Transfers

UserObjects

Variables

Variables/CHPFCRFFSplitVariables

Variables/HHPFCRFFSplitVariables

Variables/PFCRFFVariables

Variables/PolycrystalVariables

VectorPostprocessors

XFEM

The MooseApp is the top-level object used to hold all of the other objects in a simulation. In a normal simulation a single MooseApp object is created and "run()". This object uses it's Factory objects to build user defined objects which are stored in a series of Warehouse objects and executed. The Finite Element data is stored in the Systems and Assembly object while the domain information (the Mesh) is stored in the Mesh object. A series of threaded loops are used to run parallel calculations on the objects created and stored within the warehouses.

MOOSE's pluggable systems are documented on the mooseframework.org wiki. Each of these systems has set of defined polymorphic interfaces and are designed to accomplish a specific task within the simulation. The design of these systems is fluid and is managed through agile methods and ticket request system on the Github.org website.

Data Design and Control

At a high level, the system is designed to process HIT input files to construct several objects that will constitute an 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

MOOSE is a command-line driven program. All interaction with MOOSE and MOOSE-based codes 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 Application Programming Interface (API) calls. Neither the framework, nor the 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 framework 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

  • ray_tracing: RayTracingStudy
  • 13.2.1A RayTracingObject shall return a useful error when
    1. the study is provided via param and is of the wrong type
    2. the study is provided by default and is of the wrong type

    Specification(s): errors/get_study_bad_param, errors/get_study_bad_default

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 13.5.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.

    Specification(s): test

    Design: RayTracingStudyResultRayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 13.8.1The system shall support the console output of information pertaining to a Ray.

    Specification(s): get_info

    Design: RayTracingStudyRay

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 13.8.2The system shall provide a method for determining the equality of rays

    Specification(s): equality

    Design: RayTracingStudyRay

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 13.8.3The system shall report a reasonable error from a ray when
    1. checking if a ray is at its end point without an end point being set
    2. retrieving a ray's end point when its end point has not been set
    3. setting a ray's start point that has already been set
    4. setting a ray's starting direction multiple times without clearing it
    5. setting a ray's start point that is not contained within the mesh bounding box
    6. setting a ray's starting incoming side without setting its starting element
    7. setting a ray's starting incoming side to an invalid side
    8. setting a ray's starting incoming side to one that does not contain the starting point
    9. setting a ray's starting point to a point that is not contained within a given starting element
    10. setting a ray's starting direction before setting its starting information,
    11. setting a ray's starting direction to the zero vector
    12. setting a ray's end point before setting its start point
    13. setting a ray's end point to the same as its start point
    14. setting a ray's end point and starting direction
    15. setting a ray's max distance after setting its end point
    16. setting a ray's end point after setting its max distance
    17. setting a ray's end point to a point that is not within the mesh bounding box
    18. setting a ray's starting maximum distance before setting its start information
    19. setting a ray's starting maximum distance to a negative value
    20. setting the starting element for a ray to an inactive element

    Specification(s): errors/at_end_without_set, errors/end_point_without_set, errors/set_start_again, errors/set_direction_again, errors/set_start_fail_bbox, errors/set_side_without_elem, errors/set_invalid_side, errors/set_bad_side, errors/set_bad_start, errors/set_direction_before_start, errors/set_zero_direction, errors/set_end_before_start, errors/set_end_equal_start, errors/set_end_with_direction, errors/set_distance_with_end, errors/set_end_with_distance, errors/set_end_fail_bbox, errors/set_distance_before_start, errors/set_distance_negative, errors/set_start_inactive

    Design: RayTracingStudyRay

    Issue(s): #16028

    Collection(s): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.9.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

  • 13.10.3The system shall be able to create additional rays during tracing with RayBCs in
    1. two-dimensional meshes
    2. and in three-dimensional meshes.

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

    Design: RayBCsRayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 13.10.4The system shall be able to trace rays using a
    1. last in, first out buffer
    2. and with a circular buffer.

    Specification(s): tests/lifo, tests/circular

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 13.10.5The 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 the domain is not covered with ray kernels,
    5. when ray names are provided to a ray tracing object and the study does not register ray names,
    6. when a ray name is provided to a ray tracing object and said name is not registered to a ray,
    7. when the study is set to execute with residual kernels and non-residual kernels,
    8. when the study is set to execute with residual kernels and an eigenvalue executioner,
    9. when the trajectory of a ray is changed after it has started tracing,
    10. when a ray's counters are reset when not generating rays
    11. when tracing in a mesh with adaptivity and an unsupported element type
    12. when tracing in a mesh when the average subdomain hmax is a poor approximation due to stretched elements
    13. when ray data is registered too late
    14. when ray data is registered with the same name across systems
    15. when requesting a ray data index for an invalid name
    16. when requesting a ray data name for an invalid index
    17. when requesting ray kernels before they are setup
    18. when requesting ray bcs before they are setup
    19. when obtaining the ray bank when banking is disabled
    20. when obtaining the ray bank when it is not available
    21. when registering a ray when ray registration is disabled
    22. when getting a registered ray ID when ray registration is disabled
    23. when getting a registered ray name when ray registration is disabled
    24. when requesting a registered ray ID for a ray that is not registered
    25. when requesting a registered ray name for a ray that is not registered
    26. when reserving space in the ray buffer outside of registration, and
    27. when requesting a subdomain hmax for an invalid subdomain
    28. building an element extrema edge for invalid vertices
    29. requesting cached element normals when element normal caching has not been setup
    30. getting the index of ray data when aux data with the same name exists
    31. getting the index of ray aux data when data with the same name exists
    32. registering a ray more than once with the same name

    Specification(s): tests/duplicate_ray, tests/local_non_unique_id, tests/global_non_unique_id, 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, tests/adapt_bad_type, tests/hmax_vary, tests/register_ray_data_late, tests/register_ray_data_same_name, tests/ray_data_index_bad_name, tests/ray_data_name_bad_index, tests/get_ray_kernels_early, tests/get_ray_bcs_early, tests/get_bank_disabled, tests/get_bank_bad, tests/register_ray_no_registration, tests/registered_ray_id_no_registration, tests/registered_ray_name_no_registration, tests/registered_ray_id_missing, tests/registered_ray_name_missing, tests/reserve_bad, tests/subdomain_hmax_missing, tests/elem_extrema_build_edge, tests/get_elem_normals_unimplemented, tests/ray_data_index_other_exists, tests/ray_data_aux_index_other_exists, tests/register_ray_again

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 13.10.6The system shall be able to change the trajectory of rays during tracing within RayKernels.

    Specification(s): test

    Design: RayKernelsRayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 13.10.7The system shall be able to create additional rays during tracing within RayKernels in
    1. two-dimensional meshes
    2. and in three-dimensional meshes.

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

    Design: RayBCsRayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 13.10.8The system shall support the tracing of rays using
    1. an asynchronous method,
    2. a bulk-synchronous method,
    3. and the harm method.

    Specification(s): tests/smart, tests/bs, tests/harm

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 13.10.9The system shall support the tracing of rays across multiple subdomains.

    Specification(s): test

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): Exodiff

  • 13.10.10The 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.

    Specification(s): test/sized, test/unsized

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 13.10.11The system shall support the re-use of traced rays.

    Specification(s): test

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 13.10.12The system shall support the failure of a trace gracefully via a warning.

    Specification(s): no_bc

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 13.10.13The system shall support ending rays by a user-set maximum distance.

    Specification(s): max_distance

    Design: RayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

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

    Specification(s): test

    Design: RayBCs

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 13.6.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

  • 13.6.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

  • 13.6.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

  • 13.6.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

  • 13.10.3The system shall be able to create additional rays during tracing with RayBCs in
    1. two-dimensional meshes
    2. and in three-dimensional meshes.

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

    Design: RayBCsRayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 13.10.7The system shall be able to create additional rays during tracing within RayKernels in
    1. two-dimensional meshes
    2. and in three-dimensional meshes.

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

    Design: RayBCsRayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • ray_tracing: ReflectRayBC
  • 13.6.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

  • 13.6.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: AuxRayKernel
  • 13.7.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

  • ray_tracing: RayKernels
  • 13.7.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

  • 13.7.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

  • 13.7.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

  • 13.7.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

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

    Specification(s): test

    Design: RayKernels

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 13.7.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

  • 13.7.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

  • 13.10.6The system shall be able to change the trajectory of rays during tracing within RayKernels.

    Specification(s): test

    Design: RayKernelsRayTracingStudy

    Issue(s): #16028

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • ray_tracing: RayDistanceAux
  • 13.7.16The 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

  • ray_tracing: RayKernel
  • 13.7.17The 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