Scalar Transport 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 Scalar Transport 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	8.5.0 - 12.2.1
LLVM/Clang	10.0.1 - 16.0.6
Intel (ICC/ICX)	Not supported at this time
Python	3.7 - 3.11
Python Packages	packaging pyaml jinja2

System Purpose

The MOOSE Scalar Transport module purpose is to model mass transfer due to advection, diffusion, and reaction.

System Scope

The MOOSE Scalar Transport module scope is to model mass transfer due to advection, diffusion, and reaction.

Assumptions and Dependencies

The Scalar Transport module is developed using MOOSE and can itself be based on various MOOSE modules, as such the RTM for the Scalar Transport 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

scalar_transport: Multiple-Species
17.1.1The system shall be able to solve for multiple species masss transport with various dissociation and recombination reactions occurring at boundaries
Specification(s): exo
Design: DissociationFluxBC BinaryRecombinationBC
Issue(s): #22442
Collection(s): FUNCTIONAL
Type(s): Exodiff
78
17.1.2The system shall calculate a domain averaged flux consistent with the theoretical value for the surface limited case
Specification(s): surface_limited
Design: DissociationFluxBC BinaryRecombinationBC
Issue(s): #22442
Collection(s): FUNCTIONAL
Type(s): Exodiff
78

scalar_transport: Ncp-Lms
17.2.1The system shall be able to solve a positively constrained system of ODEs using NCP and have a non-singular matrix
Specification(s): lm_ncp
Design: LowerBoundNodalKernel
Issue(s): #22443
Collection(s): FUNCTIONAL
Type(s): Exodiff
72
17.2.2The system shall be able to solve a positively constrained PDE using nodal NCP, have diagonal components for the LM variable because of PSPG-type stabilization, and have a non-singular matrix
Specification(s): diagonal_lm_ncp_nodal_enforcement
Design: LowerBoundNodalKernel
Issue(s): #22443
Collection(s): FUNCTIONAL
Type(s): Exodiff
72
17.2.3Nodal enforcement of the positivity constraint shall be solvable using algebraic multi-grid
Specification(s): diagonal_lm_ncp_nodal_amg
Design: LowerBoundNodalKernel
Issue(s): #22443
Collection(s): FUNCTIONAL
Type(s): Exodiff
78
17.2.4The system shall be able to solve a positively constrained PDE using nodal NCP and have a non-singular matrix
Specification(s): interpolated_lm_ncp_nodal_constraint_enforcement
Design: LowerBoundNodalKernel
Issue(s): #22443
Collection(s): FUNCTIONAL
Type(s): Exodiff
72
17.2.5The system shall be able to solve a positively constrained PDE using nodal NCP, and nodal application of resultant forces, and have a non-singular matrix
Specification(s): interpolated_lm_ncp_nodal_constraint_enforcement_nodal_forces
Design: LowerBoundNodalKernel
Issue(s): #22443
Collection(s): FUNCTIONAL
Type(s): Exodiff
72
17.2.6The system shall be able to solve a positively constrained PDE using nodal NCP and nodal application of resultant forces, have diagonal components because of PSPG-type stabilization, and and have a non-singular matrix
Specification(s): diagonal_lm_ncp_nodal_constraint_enforcement_nodal_forces
Design: LowerBoundNodalKernel
Issue(s): #22443
Collection(s): FUNCTIONAL
Type(s): Exodiff
72

scalar_transport: Physics
17.3.1
The system shall be able to restart several diffused Physics in the shorthand Physics-syntax
1. with a user-defined initial condition,
2. when performing a regular checkpoint restart, but still obeying the user-defined initial condition,
3. when performing manual restart from a mesh file, ignoring the default initial condition.
Specification(s): restart/user_ics, restart/restart_with_user_ics, restart/restart_from_file
Design: MultiSpeciesDiffusionCG
Issue(s): #28730
Collection(s): FUNCTIONAL
Type(s): CSVDiff
156 156 156
17.3.2
The system shall be able to solve a diffusion equation for multiple species with a continuous Galerkin discretization with a shorthand syntax and
1. without automatic differentiation for several terms,
2. with automatic differentiation,
3. with diffusivities and heat sources provided in a flexible manner.
Specification(s): diffusion_multi_cg/non-ad, diffusion_multi_cg/ad, diffusion_multi_cg/multi_options
Design: MultiSpeciesDiffusionCG
Issue(s): #25642
Collection(s): FUNCTIONAL
Type(s): CSVDiff
78 78 78

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.


[exo]
  type = Exodiff
  input = multiple-species.i
  exodiff = multiple-species_out.e
  requirement = 'The system shall be able to solve for multiple species masss transport with various dissociation and recombination reactions occurring at boundaries'
[]


[surface_limited]
  type = Exodiff
  input = single-specie.i
  exodiff = single-specie_out.e
  requirement = 'The system shall calculate a domain averaged flux consistent with the theoretical value for the surface limited case'
[]


[lm_ncp]
  input = ncp-lm.i
  type = Exodiff
  exodiff = ncp-lm_out.e
  requirement = 'The system shall be able to solve a positively constrained system of ODEs using NCP and have a non-singular matrix'
  absent_out = '[1-9]+[0-9]* of 22 singular values'
  expect_out = '0 of 22 singular values'
  custom_cmp = nodal.cmp
[]


[diagonal_lm_ncp_nodal_enforcement]
  input = diagonal-ncp-lm-nodal-enforcement.i
  type = Exodiff
  exodiff = diagonal-ncp-lm-nodal-enforcement_out.e
  requirement = 'The system shall be able to solve a positively constrained PDE using nodal NCP, have diagonal components for the LM variable because of PSPG-type stabilization, and have a non-singular matrix'
  absent_out = '[1-9]+[0-9]* of 32 singular values'
  expect_out = '0 of 32 singular values'
  cli_args = 'nx=10 num_steps=5 -pc_type svd -pc_svd_monitor'
  custom_cmp = nodal.cmp
[]


[diagonal_lm_ncp_nodal_amg]
  input = diagonal-ncp-lm-nodal-enforcement.i
  type = Exodiff
  exodiff = diagonal-ncp-lm-nodal-enforcement-amg.e
  cli_args = 'Outputs/file_base=diagonal-ncp-lm-nodal-enforcement-amg -pc_type hypre -pc_hypre_type boomeramg'
  requirement = 'Nodal enforcement of the positivity constraint shall be solvable using algebraic multi-grid'
  custom_cmp = nodal.cmp
[]


[interpolated_lm_ncp_nodal_constraint_enforcement]
  input = interpolated-ncp-lm-nodal-enforcement.i
  type = Exodiff
  exodiff = interpolated-ncp-lm-nodal-enforcement_out.e
  requirement = 'The system shall be able to solve a positively constrained PDE using nodal NCP and have a non-singular matrix'
  absent_out = '[1-9]+[0-9]* of 32 singular values'
  expect_out = '0 of 32 singular values'
  cli_args = 'nx=10 num_steps=5 -pc_type svd -pc_svd_monitor'
  custom_cmp = nodal.cmp
[]


[interpolated_lm_ncp_nodal_constraint_enforcement_nodal_forces]
  input = interpolated-ncp-lm-nodal-enforcement-nodal-forces.i
  type = Exodiff
  exodiff = interpolated-ncp-lm-nodal-enforcement-nodal-forces_out.e
  requirement = 'The system shall be able to solve a positively constrained PDE using nodal NCP, and nodal application of resultant forces, and have a non-singular matrix'
  absent_out = '[1-9]+[0-9]* of 22 singular values'
  expect_out = '0 of 22 singular values'
  cli_args = 'nx=10 num_steps=5 -pc_type svd -pc_svd_monitor'
  custom_cmp = nodal.cmp
[]


[diagonal_lm_ncp_nodal_constraint_enforcement_nodal_forces]
  input = diagonal-ncp-lm-nodal-enforcement-nodal-forces.i
  type = Exodiff
  exodiff = diagonal-ncp-lm-nodal-enforcement-nodal-forces_out.e
  requirement = 'The system shall be able to solve a positively constrained PDE using nodal NCP and nodal application of resultant forces, have diagonal components because of PSPG-type stabilization, and and have a non-singular matrix'
  absent_out = '[1-9]+[0-9]* of 42 singular values'
  expect_out = '0 of 42 singular values'
  cli_args = 'nx=10 num_steps=5 -pc_type svd -pc_svd_monitor'
  # custom_cmp = nodal.cmp
[]


[user_ics]
  type = CSVDiff
  input = test_cg.i
  csvdiff = 'user_ics.csv'
  cli_args = "Physics/MultiSpeciesDiffusion/ContinuousGalerkin/diff/initial_conditions_species='1 2 3' Outputs/file_base=user_ics"
  detail = 'with a user-defined initial condition,'
[]


[restart_with_user_ics]
  type = CSVDiff
  input = test_cg.i
  csvdiff = 'restart_user_ics.csv'
  cli_args = "Physics/MultiSpeciesDiffusion/ContinuousGalerkin/diff/initial_conditions_species='2 3 4'
                  Problem/restart_file_base=user_ics_cp/LATEST Problem/allow_initial_conditions_with_restart=true
                  Outputs/file_base=restart_user_ics"
  detail = 'when performing a regular checkpoint restart, but still obeying the user-defined initial condition,'
[]


[restart_from_file]
  type = CSVDiff
  input = test_cg.i
  csvdiff = 'from_file.csv'
  cli_args = "Mesh/active='fmg_restart' Outputs/file_base=from_file"
  detail = 'when performing manual restart from a mesh file, ignoring the default initial condition.'
[]


[non-ad]
  type = CSVDiff
  input = 'diffusion_multi_cg.i'
  cli_args = 'Physics/MultiSpeciesDiffusion/ContinuousGalerkin/diff/use_automatic_differentiation=false Materials/diff_coeffs/type=GenericConstantMaterial'
  csvdiff = 'diffusion_multi_cg_out_sample_0010.csv'
  detail = 'without automatic differentiation for several terms,'
[]


[multi_options]
  type = CSVDiff
  input = 'diffusion_multi_options.i'
  csvdiff = 'diffusion_multi_options_out_sample_0010.csv'
  detail = 'with diffusivities and heat sources provided in a flexible manner.'
[]

Introduction
System Requirements Traceability
References