Shifted Boundary Method Requirements Traceability Matrix

This template follows INL template TEM-214, "IT System Requirements Traceability Matrix."

note

This document serves as an addendum to Framework Requirements Traceability Matrix and captures information for RTM specific to the Shifted Boundary Method module.

Framework Requirements Traceability Matrix

Introduction

Minimum System Requirements

In general, the following is required for MOOSE-based development:

A POSIX compliant Unix-like operating system. This includes any modern Linux-based operating system (e.g., Ubuntu, Fedora, Rocky, etc.), or a Macintosh machine running either of the last two MacOS releases.

Hardware	Information
CPU Architecture	x86_64, ARM (Apple Silicon)
Memory	8 GB (16 GBs for debug compilation)
Disk Space	30GB

Libraries	Version / Information
GCC	9.0.0 - 13.3.1
LLVM/Clang	14.0.6 - 19
Intel (ICC/ICX)	Not supported at this time
Python	3.10 - 3.13
Python Packages	packaging pyaml jinja2

System Purpose

error:Missing Template Item: "system-purpose"

Summarize the reason(s) for the system being developed or modified.

The document must include the "system-purpose" template item, this can be included by adding the following to the markdown file (sqa/shifted_boundary_method_rtm.md):

!template! item key=system-purpose
Include text (in MooseDocs format) regarding the "system-purpose" template item here.
!template-end!

System Scope

error:Missing Template Item: "system-scope"

Delineate the following:

Identify the product(s) to be produced by name (Network Infrastructure, Host DBMS, Report Generator, HPC Server, etc.)
Explain what the product(s) will, and, if necessary, will not do
Describe the application of the product being specified, including relevant benefits, objectives, and goals.

note

Be consistent with similar statements in higher level specifications (e.g., business requirements specification).

The document must include the "system-scope" template item, this can be included by adding the following to the markdown file (sqa/shifted_boundary_method_rtm.md):

!template! item key=system-scope
Include text (in MooseDocs format) regarding the "system-scope" template item here.
!template-end!

Assumptions and Dependencies

The Shifted Boundary Method module is developed using MOOSE and can itself be based on various MOOSE modules, as such the RTM for the Shifted Boundary Method module is dependent upon the files listed at the beginning of this document.

Pre-test Instructions/Environment/Setup

Ideally all testing should be performed on a clean test machine following one of the supported configurations setup by the test system engineer. Testing may be performed on local workstations and cluster systems containing supported operating systems.

The repository should be clean prior to building and testing. When using "git" this can be done by doing a force clean in the main repository and each one of the submodules:


git clean -xfd
git submodule foreach 'git clean -xfd'

All tests must pass in accordance with the type of test being performed. This list can be found in the Software Test Plan.

Changelog Issue Revisions

Errors in changelog references can sometimes occur as a result of typos or conversion errors. If any need to be noted by the development team, they will be noted here.

error:Missing Template Item: "log-revisions"

If errors are found in issue references related to the changelog (e.g., commit history), these should be noted here. The commit in which the incorrect issue reference occurs should be listed, and the correct issue should be added alongside each entry. Relevant links to all items are required. An example of this is shown below:

MOOSE Commit	Incorrect Referenced Issue	Correct Referenced Issue
48db61	idaholab/sockeye#19845	idaholab/sockeye#130

The document must include the "log-revisions" template item, this can be included by adding the following to the markdown file (sqa/shifted_boundary_method_rtm.md):

!template! item key=log-revisions
Include text (in MooseDocs format) regarding the "log-revisions" template item here.
!template-end!

System Requirements Traceability

Functional Requirements

shifted_boundary_method: Coverage
18.1.1
The system shall
1. report the closest distance vector and surface normal at element centroids when parsed-function and mesh-based surfaces are combined in a single query.
2. build boundary element representations from an SBM surface mesh without a KDTree when KDTree construction is disabled.
3. report when an SBM surface mesh is not watertight.
4. return zero distance when the query point lies on the surface mesh.
Specification(s): coverage/omnibus, coverage/build_kd_tree_false, coverage/non_watertight, coverage/gradient_on_surface
Design: SBMSurfaceMeshBuilder ShortestDistanceToSurface UnsignedDistanceToSurfaceMesh
Issue(s): #31937
Collection(s): FUNCTIONAL
Type(s): RunAppExodiff

shifted_boundary_method: Distance Calc
18.2.1
The system shall compute
1. the distance field in 2D.
2. the distance field in 3D.
3. the distance field in 2D when signed level-set and mesh-based surfaces are combined.
4. the distance field in 3D when signed level-set and mesh-based surfaces are combined.
Specification(s): distance_test/2D_distance_refine, distance_test/3D_distance_refine, distance_test/2D_multiple_distance_refine, distance_test/3D_multiple_distance_refine
Design: UnsignedDistanceToSurfaceMesh ShortestDistanceToSurface
Issue(s): #31937
Collection(s): FUNCTIONAL
Type(s): Exodiff
18.2.2
The system shall throw an error
1. if ElementCentroidToSurfaceDistanceAux is applied to a nodal variable.
2. if ShortestDistanceToSurface receives a function whose type is not ParsedFunction or UnsignedDistanceToSurfaceMesh.
3. if the embedding mesh dimension does not match the SBM surface mesh dimension plus one.
4. if the SBM surface mesh contains element types other than EDGE2 or TRI3.
5. if the SBM surface mesh is distributed, since SBMSurfaceMeshBuilder requires a replicated mesh for its In-Out test.
6. if an UnsignedDistanceToSurfaceMesh function is paired with an SBMSurfaceMeshBuilder that was configured without a KDTree.
Specification(s): error_test/nodal_variable, error_test/unsupported_surface_function, error_test/dim_mismatch, error_test/unsupported_element_type, error_test/distributed_surface_mesh, error_test/unsigned_distance_without_kd_tree
Design: UnsignedDistanceToSurfaceMesh ShortestDistanceToSurface
Issue(s): #31937
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException

Usability Requirements

No requirements of this type exist for this application, beyond those of its dependencies.

Performance Requirements

No requirements of this type exist for this application, beyond those of its dependencies.

System Interface Requirements

No requirements of this type exist for this application, beyond those of its dependencies.

References

No citations exist within this document.


[omnibus]
  type = 'Exodiff'
  input = 'coverage_omnibus.i'
  exodiff = 'coverage_omnibus_out.e'
  allow_test_objects = true
  mesh_mode = REPLICATED
  recover = false
  detail = 'report the closest distance vector and surface normal at element centroids when parsed-function and mesh-based surfaces are combined in a single query.'
[]


[build_kd_tree_false]
  type = 'RunApp'
  input = 'build_kd_tree_false.i'
  mesh_mode = REPLICATED
  recover = false
  detail = 'build boundary element representations from an SBM surface mesh without a KDTree when KDTree construction is disabled.'
[]


[non_watertight]
  type = 'RunApp'
  input = 'non_watertight.i'
  expect_out = 'not watertight'
  mesh_mode = REPLICATED
  recover = false
  detail = 'report when an SBM surface mesh is not watertight.'
[]


[gradient_on_surface]
  type = 'Exodiff'
  input = 'gradient_on_surface.i'
  exodiff = 'gradient_on_surface_out.e'
  allow_test_objects = true
  mesh_mode = REPLICATED
  recover = false
  detail = 'return zero distance when the query point lies on the surface mesh.'
[]


[2D_distance_refine]
  type = 'Exodiff'
  input = '2D_distance_refine.i'
  exodiff = '2D_distance_refine_out.e-s004'
  mesh_mode = REPLICATED # SBMSurfaceMeshBuilder requires a serial mesh for its In-Out test
  recover = false
  detail = 'the distance field in 2D.'
[]


[3D_distance_refine]
  type = 'Exodiff'
  input = '3D_distance_refine.i'
  exodiff = '3D_distance_refine_out.e-s004'
  mesh_mode = REPLICATED # SBMSurfaceMeshBuilder requires a serial mesh for its In-Out test
  recover = false
  detail = 'the distance field in 3D.'
[]


[2D_multiple_distance_refine]
  type = 'Exodiff'
  input = '2D_multiple_distances_refine_test.i'
  exodiff = '2D_multiple_distances_refine_test_out.e-s004'
  mesh_mode = REPLICATED # SBMSurfaceMeshBuilder requires a serial mesh for its In-Out test
  recover = false
  detail = 'the distance field in 2D when signed level-set and mesh-based surfaces are combined.'
[]


[3D_multiple_distance_refine]
  type = 'Exodiff'
  input = '3D_multiple_distances_refine.i'
  exodiff = '3D_multiple_distances_refine_out.e-s003'
  mesh_mode = REPLICATED # SBMSurfaceMeshBuilder requires a serial mesh for its In-Out test
  recover = false
  detail = 'the distance field in 3D when signed level-set and mesh-based surfaces are combined.'
[]


[nodal_variable]
  type = 'RunException'
  input = '2D_distance_refine.i'
  cli_args = 'AuxVariables/distance/order=FIRST AuxVariables/distance/family=LAGRANGE'
  expect_err = 'This AuxKernel only supports Elemental fields'
  mesh_mode = REPLICATED
  recover = false
  detail = 'if ElementCentroidToSurfaceDistanceAux is applied to a nodal variable.'
[]


[unsupported_surface_function]
  type = 'RunException'
  input = '2D_distance_refine.i'
  cli_args = 'Functions/const_fun/type=ConstantFunction Functions/const_fun/value=1.0 UserObjects/distance_to_surface/surfaces=const_fun'
  expect_err = 'SBM distance helpers only support ParsedFunction or UnsignedDistanceToSurfaceMesh'
  mesh_mode = REPLICATED
  recover = false
  detail = 'if ShortestDistanceToSurface receives a function whose type is not ParsedFunction or UnsignedDistanceToSurfaceMesh.'
[]


[dim_mismatch]
  type = 'RunException'
  input = '2D_distance_refine.i'
  cli_args = 'Mesh/boundary_mesh/file=quad_surface.msh'
  expect_err = 'does not match the expected mesh dimension'
  mesh_mode = REPLICATED
  recover = false
  detail = 'if the embedding mesh dimension does not match the SBM surface mesh dimension plus one.'
[]


[unsupported_element_type]
  type = 'RunException'
  input = '3D_distance_refine.i'
  cli_args = 'Mesh/boundary_mesh/file=quad_surface.msh'
  expect_err = 'Unsupported element type in SBMSurfaceMeshBuilder'
  mesh_mode = REPLICATED
  recover = false
  detail = 'if the SBM surface mesh contains element types other than EDGE2 or TRI3.'
[]


[distributed_surface_mesh]
  type = 'RunException'
  input = '2D_distance_refine.i'
  cli_args = 'Mesh/parallel_type=DISTRIBUTED'
  expect_err = 'mesh is distributed'
  recover = false
  detail = 'if the SBM surface mesh is distributed, since SBMSurfaceMeshBuilder requires a replicated mesh for its In-Out test.'
[]


[unsigned_distance_without_kd_tree]
  type = 'RunException'
  input = '2D_distance_refine.i'
  cli_args = 'UserObjects/TreeBuilder/build_kd_tree=false'
  expect_err = "requires SBMSurfaceMeshBuilder"
  mesh_mode = REPLICATED
  recover = false
  detail = 'if an UnsignedDistanceToSurfaceMesh function is paired with an SBMSurfaceMeshBuilder that was configured without a KDTree.'
[]

Introduction
System Requirements Traceability
References