Shifted Boundary Method System Requirements Specification
This template follows INL template TEM-135, "IT System Requirements Specification".
This document serves as an addendum to Framework System Requirements Specification and captures information for SRS specific to the Shifted Boundary Method module.
Introduction
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_srs.md):
!template! item key=system-purpose
Include text (in MooseDocs format) regarding the "system-purpose" template item here.
!template-end!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.
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_srs.md):
!template! item key=system-scope
Include text (in MooseDocs format) regarding the "system-scope" template item here.
!template-end!System Overview
System Context
The Shifted Boundary Method module is command-line driven. Like MOOSE, this is typical for a high-performance software that is designed to run across several nodes of a cluster system. As such, all usage of the software is through any standard terminal program generally available on all supported operating systems. Similarly, for the purpose of interacting through the software, there is only a single user, "the user", which interacts with the software through the command-line. The Shifted Boundary Method module does not maintain any back-end database or interact with any system daemons. It is an executable, which may be launched from the command line and writes out various result files as it runs.
-based applications.](../media/sqa/usage_diagram_uml.svg)
Figure 1: Usage of the Shifted Boundary Method module and other MOOSE-based applications.
System Functions
Since the Shifted Boundary Method module is a command-line driven application, all functionality provided in the software is operated through the use of standard UNIX command line flags and the extendable MOOSE input file. The Shifted Boundary Method module is completely extendable so individual design pages should be consulted for specific behaviors of each user-defined object.
User Characteristics
Like MOOSE, there are three kinds of users working on the Shifted Boundary Method module:
Shifted Boundary Method module Developers: These are the core developers of the Shifted Boundary Method module. They are responsible for following and enforcing the software development standards of the module, as well as designing, implementing, and maintaining the software.
Developers: A scientist or engineer that uses the Shifted Boundary Method module alongside MOOSE to build their own application. This user will typically have a background in modeling or simulation techniques (and perhaps numerical analysis) but may only have a limited skillset when it comes to code development using the C++ language. This is the primary focus group of the module. In many cases, these developers will be encouraged to contribute module-appropriate code back to the Shifted Boundary Method module, or to MOOSE itself.
Analysts: These are users that will run the code and perform analysis on the simulations they perform. These users may interact with developers of the system requesting new features and reporting bugs found and will typically make heavy use of the input file format.
Assumptions and Dependencies
The Shifted Boundary Method module is developed using MOOSE and can itself be based on various MOOSE modules, as such the SRS for the Shifted Boundary Method module is dependent upon the files listed at the beginning of this document. Any further assumptions or dependencies are outlined in the remainder of this section.
List each of the factors that affect the requirements and should be taken into consideration for derivation of lower level requirements and design. These factors should include design inputs, design constraints, and installation considerations. Changes to these can affect the requirements in the specification. For example, an assumption may be that a specific operating system will be available on the hardware designated for the product. If, in fact, the operating system is not available, the specification would then have to change accordingly.
The document must include the "assumptions-and-dependencies" template item, this can be included by adding the following to the markdown file (sqa/shifted_boundary_method_srs.md):
!template! item key=assumptions-and-dependencies
Include text (in MooseDocs format) regarding the "assumptions-and-dependencies" template item here.
!template-end!References
Definitions and Acronyms
This section defines, or provides the definition of, all terms and acronyms required to properly understand this specification.
Definitions
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
| Acronym | Description |
|---|---|
| INL | Idaho National Laboratory |
| LGPL | GNU Lesser General Public License |
| MOOSE | Multiphysics Object Oriented Simulation Environment |
| NQA-1 | Nuclear Quality Assurance Level 1 |
| POSIX | Portable Operating System Interface |
| SRS | Software Requirement Specification |
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 |
Functional Requirements
- shifted_boundary_method: Coverage
- 18.1.1The system shall
- 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 boundary element representations from an SBM surface mesh without a KDTree when KDTree construction is disabled.
- report when an SBM surface mesh is not watertight.
- return zero distance when the query point lies on the surface mesh.
- shifted_boundary_method: Distance Calc
- 18.2.1The system shall compute
- the distance field in 2D.
- the distance field in 3D.
- the distance field in 2D when signed level-set and mesh-based surfaces are combined.
- the distance field in 3D when signed level-set and mesh-based surfaces are combined.
- 18.2.2The system shall throw an error
- if ElementCentroidToSurfaceDistanceAux is applied to a nodal variable.
- if ShortestDistanceToSurface receives a function whose type is not ParsedFunction or UnsignedDistanceToSurfaceMesh.
- if the embedding mesh dimension does not match the SBM surface mesh dimension plus one.
- if the SBM surface mesh contains element types other than EDGE2 or TRI3.
- if the SBM surface mesh is distributed, since SBMSurfaceMeshBuilder requires a replicated mesh for its In-Out test.
- if an UnsignedDistanceToSurfaceMesh function is paired with an SBMSurfaceMeshBuilder that was configured without a KDTree.
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 Interfaces
No requirements of this type exist for this application, beyond those of its dependencies.System Operations
Human System Integration Requirements
The Shifted Boundary Method module is command line driven and conforms to all standard terminal behaviors. Specific human system interaction accommodations shall be a function of the end-user's terminal. MOOSE (and therefore the Shifted Boundary Method module) does support optional coloring within the terminal's ability to display color, which may be disabled.
Maintainability
The latest working version (defined as the version that passes all tests in the current regression test suite) shall be publicly available at all times through the repository host provider.
Flaws identified in the system shall be reported and tracked in a ticket or issue based system. The technical lead will determine the severity and priority of all reported issues and assign resources at their discretion to resolve identified issues.
The software maintainers will entertain all proposed changes to the system in a timely manner (within two business days).
The core software in its entirety will be made available under the terms of a designated software license. These license terms are outlined in the LICENSE file alongside the Shifted Boundary Method module source code. As a MOOSE physics module, the license for the Shifted Boundary Method module is identical to that of the framework - that is, the LGPL version 2.1 license.
Reliability
Specify the system reliability requirements in quantitative terms, including the conditions under which the reliability requirements are to be met. This may also include the reliability apportionment model to support allocation of reliability values assigned to system functions for their share in achieving desired system reliability.
The document must include the "reliability" template item, this can be included by adding the following to the markdown file (sqa/shifted_boundary_method_srs.md):
!template! item key=reliability
Include text (in MooseDocs format) regarding the "reliability" template item here.
!template-end!System Modes and States
MOOSE applications normally run in normal execution mode when an input file is supplied. However, there are a few other modes that can be triggered with various command line flags as indicated here:
| Command Line Flag | Description of mode |
|---|---|
-i <input_file> | Normal execution mode |
--split-mesh <splits> | Read the mesh block splitting the mesh into two or more pieces for use in a subsequent run |
--use-split | (implies -i flag) Execute the simulation but use pre-split mesh files instead of the mesh from the input file |
--yaml | Output all object descriptions and available parameters in YAML format |
--json | Output all object descriptions and available parameters in JSON format |
--syntax | Output all registered syntax |
--registry | Output all known objects and actions |
--registry-hit | Output all known objects and actions in HIT format |
--mesh-only (implies -i flag) | Run only the mesh related tasks and output the final mesh that would be used for the simulation |
--start-in-debugger <debugger> | Start the simulation attached to the supplied debugger |
The list of system-modes may not be extensive as the system is designed to be extendable to end-user applications. The complete list of command line options for applications can be obtained by running the executable with zero arguments. See the command line usage.
Physical Characteristics
The Shifted Boundary Method module is software only with no associated physical media. See System Requirements for a description of the minimum required hardware necessary for running the Shifted Boundary Method module.
Environmental Conditions
Not Applicable
System Security
MOOSE-based applications such as the Shifted Boundary Method module have no requirements or special needs related to system security. The software is designed to run completely in user-space with no elevated privileges required nor recommended.
Information Management
The core framework and all modules in their entirety will be made publicly available on an appropriate repository hosting site. Day-to-day backups and security services will be provided by the hosting service. More information about MOOSE backups of the public repository on INL-hosted services can be found on the following page: GitHub Backups
Polices and Regulations
MOOSE-based applications must comply with all export control restrictions.
System Life Cycle Sustainment
MOOSE-based development follows various agile methods. The system is continuously built and deployed in a piecemeal fashion since objects within the system are more or less independent. Every new object requires a test, which in turn requires an associated requirement and design description. The Shifted Boundary Method module development team follows the NQA-1 standards.
Packaging, Handling, Shipping and Transportation
No special requirements are needed for packaging or shipping any media containing MOOSE and Shifted Boundary Method module source code. However, some MOOSE-based applications that use the Shifted Boundary Method module may be export-controlled, in which case all export control restrictions must be adhered to when packaging and shipping media.
Verification
The regression test suite will employ several verification tests using comparison against known analytical solutions, the method of manufactured solutions, and convergence rate analysis.