SubChannel Requirements Traceability Matrix
This template follows INL template TEM-214, "IT System Requirements Traceability Matrix."
This document serves as an addendum to Framework Requirements Traceability Matrix and captures information for RTM specific to the SubChannel module.
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 - 12.2.1 |
LLVM/Clang | 10.0.1 - 19 |
Intel (ICC/ICX) | Not supported at this time |
Python | 3.10 - 3.13 |
Python Packages | packaging pyaml jinja2 |
System Purpose
The purpose of the Subchannel Module (SCM) is to equip the MOOSE family of codes with a modern, fast and efficient subchannel solver. As a MOOSE module, SCM seamlessly couples with other MOOSE modules and applications, providing intermediate fidelity thermal-hydraulic solutions in a multiphysics context.
System Scope
The scope of SCM is the single-phase modeling, of ducted subchannel sub-assemblies, with bare pins in a square arrangement enclosed in a square duct, or wire-wrapped/bare pins, in a triangular arrangement enclosed in a hexagonal duct. In the first case, the coolant is water, in the second case it can be various liquid metals (Lead,Lead-Bismuth Eutectic, Sodium, Sodium–Potassium) or water.
Assumptions and Dependencies
The SubChannel module is developed using MOOSE and can itself be based on various MOOSE modules, as such the RTM for the SubChannel 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.
The changelog for all code residing in the MOOSE repository is located in the MOOSE RTM.
System Requirements Traceability
Functional Requirements
- subchannel: Auxkernels
- 20.1.1The system shall apply inlet boundary massflow conditions for a blocked/partially blocked inlet
Specification(s): blockedtest
Design: SCMBlockedMassFlowRateAux
Issue(s): #29237
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.1.2The system shall apply inlet boundary massflow conditions
Specification(s): test
Design: SCMMassFlowRateAux
Issue(s): #29511
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.1.3The system shall calculate linear heat rate on fuel pin surface
Specification(s): test
Design: SCMRZPinQPrimeAux
Issue(s): #29511
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.1.4The system shall calculate a uniform massflow rate inlet boundary
Specification(s): test
Design: SCMFlatMassFlowRateAux
Issue(s): #29213
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- subchannel: Ics
- 20.2.1The system will calculate the geometric parameters for FCTF
Specification(s): test
Design: FCTFdisplacementIC
Issue(s): #29501
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.2.2The system shall calculate the flow area and wetted perimeter for a MARVEL-type microreactor core modeled in SCM
Specification(s): test
Design: MarvelTriFlowAreaICMarvelTriWettedPerimIC
Issue(s): #30295
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.2.3The system will apply initial massflow rate
Specification(s): test
Design: SCMMassFlowRateIC
Issue(s): #29513
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.2.4The system will calculate the subchannel flow area for quadrilateral assemblies
Specification(s): test
Design: SCMQuadFlowAreaIC
Issue(s): #29194
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.2.5The system will calculate the linear heat rate on subchannels/fuel-pins in a quadrilateral lattice
Specification(s): test
Design: SCMQuadPowerIC
Issue(s): #29233
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.2.6The system will calculate the wetted perimeter of subchannels in a quadrilateral lattice
Specification(s): test
Design: SCMQuadWettedPerimIC
Issue(s): #29233
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.2.7The system will calculate the subchannel flow area for triangular assemblies
Specification(s): test
Design: SCMTriFlowAreaIC
Issue(s): #29194
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.2.8The system will calculate the linear heat rate on subchannels/fuel-pins in a triangular lattice
Specification(s): test_pin_power
Design: SCMTriPowerIC
Issue(s): #29194
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.2.9The system will calculate the linear heat rate on subchannels/fuel-pins in a triangular lattice, but with an axial power profile
Specification(s): test_axial_shape
Design: SCMTriPowerIC
Issue(s): #29194
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.2.10The system will calculate the wetted perimeter of subchannels in a triangular lattice
Specification(s): test
Design: SCMTriWettedPerimIC
Issue(s): #29194
Collection(s): FUNCTIONAL
Type(s): Exodiff
- subchannel: Mesh
- 20.3.1The system will create a detailed mesh of the inter-wrapper for quadrilateral assemblies
Specification(s): coords
Design: SCMDetailedQuadInterWrapperMeshGenerator
Issue(s): #29484
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.3.2The system will create a detailed mesh of the fuel pins for quadrilateral assemblies
Specification(s): coords
Design: SCMDetailedQuadPinMeshGenerator
Issue(s): #29246
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.3.3The system will create a detailed mesh of the subchannels for quadrilateral assemblies (3x3)
Specification(s): coords
Design: SCMDetailedQuadSubChannelMeshGenerator
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.3.4The system will create a detailed mesh of the subchannels for quadrilateral assemblies (1x2)
Specification(s): 1x2
Design: SCMDetailedQuadSubChannelMeshGenerator
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.3.5The system will create a detailed mesh of the subchannels for quadrilateral assemblies (1x3)
Specification(s): 1x3
Design: SCMDetailedQuadSubChannelMeshGenerator
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.3.6The system will create a detailed mesh of the subchannels for quadrilateral assemblies (3x1)
Specification(s): 3x1
Design: SCMDetailedQuadSubChannelMeshGenerator
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.3.7The system will create a detailed mesh of the fuel pins for triangular assemblies
Specification(s): coords
Design: SCMDetailedTriPinMeshGenerator
Issue(s): #29484
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.3.8The system will create a detailed mesh of the subchannels in triangular assemblies
Specification(s): coords
Design: SCMDetailedTriSubChannelMeshGenerator
Issue(s): #29493
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.3.9The system will create a mesh of the inter-wrapper for quadrilateral assemblies
Specification(s): coords
Design: SCMQuadInterWrapperMeshGenerator
Issue(s): #29484
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.3.10The system will create a mesh of the subchannels for quadrilateral assemblies
Specification(s): coords
Design: SCMQuadSubChannelMeshGenerator
Issue(s): #29241
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.3.11The system shall check the minimum number of subchannels
Specification(s): subchannel_number
Design: SCMQuadSubChannelMeshGenerator
Issue(s): #29224
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 20.3.12The system will create a mesh of the fuel pins for quadrilateral assemblies
Specification(s): coords
Design: SCMQuadPinMeshGenerator
Issue(s): #29241
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.3.13The system will create a mesh of the inter-wrapper for triangualar assemblies
Specification(s): coords
Design: SCMTriInterWrapperMeshGenerator
Issue(s): #29484
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.3.14The system will create a hexagonal duct mesh and a pin mesh for triangular assemblies
Specification(s): coords
Design: SCMTriDuctMeshGenerator
Issue(s): #29484
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.3.15The system will create a hexagonal duct mesh for triangular assemblies
Specification(s): test
Design: SCMTriDuctMeshGenerator
Issue(s): #28497
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.3.16The system will create a subchannel mesh for triangular assemblies
Specification(s): tricoords3
Design: SCMTriSubChannelMeshGenerator
Issue(s): #29194
Collection(s): FUNCTIONAL
Type(s): Exodiff
- subchannel: Multiapp
- 20.4.1The system shall be able to solve a subchannel problem as a child application.
Specification(s): check
Design: TriSubChannel1PhaseProblem
Issue(s): #30401
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- subchannel: Outputs
- 20.5.1The system will print a variable on a plane in a quadrilateral assembly
Specification(s): test
Design: QuadSubChannelNormalSliceValues
Issue(s): #29226
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- subchannel: Postprocessors
- 20.6.1The system will print a variable on a specific subchannel and height in quadrilateral assemblies
Specification(s): test
Design: SubChannelPointValue
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 20.6.2The system will test the user provided height
Specification(s): subchannel_height
Design: SubChannelPointValue
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 20.6.3The system will print a variable on a specific subchannel and height in triangular assemblies
Specification(s): test
Design: SubChannelPointValue
Issue(s): #29226
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- subchannel: Problems
- 20.7.1The system will examine the tri subchannel solver for lead bismuth eutetic coolant
Specification(s): test_LBE
Design: TriSubChannel1PhaseProblem
Issue(s): #29486
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 20.7.2The system will examine the tri subchannel solver for lead coolant
Specification(s): test_LEAD
Design: TriSubChannel1PhaseProblem
Issue(s): #29486
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 20.7.3The system will examine the subchannel solver for the EBR-II case
Specification(s): SHRT-17_SS_test
Design: TriSubChannel1PhaseProblem
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 20.7.4The system will examine the subchannel explicit solver for a 19pin liquid sodium cooled assembly
Specification(s): test_explicit
Design: TriSubChannel1PhaseProblem
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 20.7.5The system will examine the subchannel implicit solver for a 19pin liquid sodium cooled assembly
Specification(s): test_implicit
Design: TriSubChannel1PhaseProblem
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 20.7.6The system will examine the subchannel monolithic solver for a 19pin liquid sodium cooled assembly
Specification(s): test_monolithic
Design: TriSubChannel1PhaseProblem
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 20.7.7The system will examine the subchannel full monolithic solver for a 19pin liquid sodium cooled assembly
Specification(s): test_full_monolithic
Design: TriSubChannel1PhaseProblem
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 20.7.8The system will examine the coupling using SCM as main app
Specification(s): coupling_test
Design: QuadSubChannel1PhaseProblem
Issue(s): #29247
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 20.7.9The system will examine the explicit interwrapper solver for quadrilateral assemblies
Specification(s): quad_interwrapper
Design: QuadInterWrapper1PhaseProblem
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.7.10The system will examine the monolithic interwrapper solver for quadrilateral assemblies
Specification(s): quad_interwrapper_monolithic
Design: QuadInterWrapper1PhaseProblem
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.7.11The system will examine the monolitich staggered grid interwrapper solver for quadrilateral assemblies
Specification(s): quad_interwrapper_monolithic_staggered
Design: QuadInterWrapper1PhaseProblem
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.7.12The system will examine the explicit interwrapper solver for triangular assemblies
Specification(s): tri_interwrapper
Design: QuadInterWrapper1PhaseProblem
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.7.13The system will examine the explicit interwrapper solver for triangular assemblies and side bypass
Specification(s): tri_interwrapper_tight_side
Design: QuadInterWrapper1PhaseProblem
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.7.14The system will examine the implicit interwrapper solver for triangular assemblies
Specification(s): tri_interwrapper_implicit
Design: QuadInterWrapper1PhaseProblem
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.7.15The system will examine the monolithic interwrapper solver for triangular assemblies
Specification(s): tri_interwrapper_monolithic
Design: QuadInterWrapper1PhaseProblem
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.7.16The system will examine the monolithic staggered grif interwrapper solver for triangular assemblies
Specification(s): tri_interwrapper_monolithic_staggered
Design: QuadInterWrapper1PhaseProblem
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.7.17The system shall be able to solve a PSBT-type case with the subchannel solver using an explicit algorithm.
Specification(s): psbt_regression_test_explicit
Design: QuadSubChannel1PhaseProblem
Issue(s): #29196#29199#29237#29505
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 20.7.18The system shall be able to solve a PSBT-type case with the subchannel solver using the non-default friction/mixing model.
Specification(s): psbt_regression_test_explicit_friction2
Design: QuadSubChannel1PhaseProblem
Issue(s): #29196#29199#29237#29505
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 20.7.19The system shall be able to solve a PSBT-type case with the subchannel solver using an explicit algorithm and a staggered pressure formulation.
Specification(s): psbt_regression_test_explicit_staggered
Design: QuadSubChannel1PhaseProblem
Issue(s): #29196#29199#29237#29505
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 20.7.20The system shall be able to solve a PSBT-type case with the subchannel solver using an implicit algorithm.
Specification(s): psbt_regression_test_implicit
Design: QuadSubChannel1PhaseProblem
Issue(s): #29196#29199#29237#29505
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 20.7.21The system shall be able to solve a PSBT-type case with the subchannel solver using a monolithic algorithm.
Specification(s): psbt_regression_test_monolithic
Design: QuadSubChannel1PhaseProblem
Issue(s): #29196#29199#29237#29505
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 20.7.22The system shall be able to solve a PSBT-type case with the subchannel solver using a full-monolithic algorithm.
Specification(s): psbt_regression_test_full_monolithic
Design: QuadSubChannel1PhaseProblem
Issue(s): #29196#29199#29237#29505
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 20.7.23The system shall be able to solve a PSBT-type case with the subchannel solver using a full-monolithic algorithm and a staggered pressure formulation.
Specification(s): psbt_regression_test_full_monolithic_staggered
Design: QuadSubChannel1PhaseProblem
Issue(s): #29196#29199#29237#29505
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- subchannel: Restart
- 20.8.1The system shall be able to restart after a steady state solution
Specification(s): steady
Design: QuadSubChannel1PhaseProblem
Issue(s): #28497
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.8.2The system shall be able to restart after a transient solution
Specification(s): transient
Design: QuadSubChannel1PhaseProblem
Issue(s): #28497
Collection(s): FUNCTIONAL
Type(s): Exodiff
Prerequisite(s): 20.8.1
- subchannel: Transfers
- 20.9.1The system shall be able to transger the subchannel/pin solution onto a detailed mesh
Specification(s): quad
Design: SCMSolutionTransfer
Issue(s): #29251
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 20.9.2The system shall be able to transger the interwrapper solution onto a detailed mesh
Specification(s): quad_iw
Design: InterWrapperSolutionTransfer
Issue(s): #29258
Collection(s): FUNCTIONAL
Type(s): Exodiff