Level Set 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 Level Set 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 purpose of the MOOSE Level Set module is to provides basic functionality to solve the level set equation. The Level Set module can be very easily coupled with other physics modules in MOOSE. The level set method has become popular in many disciplines, such as image processing, computer graphics, computational geometry, optimization, computational fluid dynamics, and computational biology.

System Scope

The MOOSE Level Set module provides capabilities for solving a set of level set equations. The level set method is commonly used for front tracking problems. The advection of the level set equation is solved using the Galerkin finite element method, and is stabilized with streamline Upwind/Petrov-Galerkin method. To preserve the smooth profile of the regularized level set variable, a re-initialization step can be used through the MOOSE multi-app system. The solutions are verified against classical benchmark problems.

Assumptions and Dependencies

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

level_set: Functions
8.1.1The level set module shall include the bubble function defined in Olsson and Kreiss (2005).
Specification(s): test
Design: LevelSetOlssonBubble
Issue(s): #8465
Collection(s): FUNCTIONAL
Type(s): Exodiff
74
8.1.2The Olsson bubble function shall return correct derivatives for dual number points.
Specification(s): adjac
Design: LevelSetOlssonBubble
Issue(s): #20193
Collection(s): FUNCTIONAL
Type(s): PetscJacobianTester
64
8.1.3The level set module shall include the plane function defined in Olsson and Kreiss (2005).
Specification(s): test
Design: LevelSetOlssonPlane
Issue(s): #15167
Collection(s): FUNCTIONAL
Type(s): Exodiff
74
8.1.4The level set module shall include the vortex function defined in Olsson and Kreiss (2005) with an instantaneous reverse feature.
Specification(s): instantenous
Design: LevelSetOlssonVortex
Issue(s): #8465
Collection(s): FUNCTIONAL
Type(s): Exodiff
74
8.1.5The level set module shall include the vortex function defined in Olsson and Kreiss (2005) with an cosine reverse feature.
Specification(s): cosine
Design: LevelSetOlssonVortex
Issue(s): #8465
Collection(s): FUNCTIONAL
Type(s): Exodiff
74

level_set: Kernels
8.2.1The LevelSetAdvection Kernel shall converage at the correct rate as tested by the method of manufactured solutions.
Specification(s): mms
Design: LevelSetAdvection
Issue(s): #8465
Collection(s): FUNCTIONAL
Type(s): CSVDiff
74
8.2.2The level set module shall include the reinitialization scheme presented by Olsson and Kreiss (2005).
Specification(s): test
Design: LevelSetAdvection
Issue(s): #8465
Collection(s): FUNCTIONAL
Type(s): Exodiff
74

level_set: Reinitialization
8.3.1The level set module shall be capable of solving the level set equation with original reinitialization.
Specification(s): full_original_reinitialization
Design: Level Set Module
Issue(s): #14849
Collection(s): FUNCTIONAL
Type(s): Exodiff
66
8.3.2The level set module shall be capable of solving the level set equation with modified reinitialization.
Specification(s): full_modified_reinitialization
Design: Level Set Module
Issue(s): #8465
Collection(s): FUNCTIONAL
Type(s): Exodiff
66

level_set: Transfers
8.4.1The level set module shall include the ability to transfer a non-linear variable between the parent and a sub-application.
Specification(s): copy
Design: Level Set Module
Issue(s): #8465
Collection(s): FUNCTIONAL
Type(s): Exodiff
74
8.4.2The level set module shall include the ability to transfer refinement patterns, with multiple levels of refinement, to a sub-application.
Specification(s): test
Design: Level Set Module LevelSetMeshRefinementTransfer
Issue(s): #8465
Collection(s): FUNCTIONAL
Type(s): Exodiff
74
8.4.3The level set module shall include the ability to transfer refinement patterns, with a single level of refinement, to a sub-application.
Specification(s): test
Design: Level Set Module LevelSetMeshRefinementTransfer
Issue(s): #8465
Collection(s): FUNCTIONAL
Type(s): Exodiff
74
8.4.4The system shall return an error if parameters for an unsupported direction are passed to a transfer
Specification(s): parameter_error
Design: Level Set Module LevelSetMeshRefinementTransfer
Issue(s): #19451
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
74

level_set: Verification
8.5.1The level set module shall use the method of manufactured solutions to test convergence of the level set equation and ensure that the level 0 solution is consistent.
Specification(s): level_00
Design: Level Set Module
Issue(s): #8465
Collection(s): FUNCTIONAL
Type(s): CSVDiff
74
8.5.2The level set module shall use the method of manufactured solutions to test convergence of the level set equation and ensure that the level 1 solution is consistent.
Specification(s): level_01
Design: Level Set Module
Issue(s): #8465
Collection(s): FUNCTIONAL
Type(s): CSVDiff
74
8.5.3The level set module shall use the method of manufactured solutions to test convergence of the level set equation and ensure that the level 2 solution is consistent.
Specification(s): level_02
Design: Level Set Module
Issue(s): #8465
Collection(s): FUNCTIONAL
Type(s): CSVDiff
74
8.5.4The level set module shall use the method of manufactured solutions to test convergence of the level set equation and ensure that the level 3 solution is consistent.
Specification(s): level_03
Design: Level Set Module
Issue(s): #8465
Collection(s): FUNCTIONAL
Type(s): CSVDiff
74
8.5.5The level set module shall use the method of manufactured solutions to test convergence of the level set equation and ensure that the level 4 solution is consistent.
Specification(s): level_04
Design: Level Set Module
Issue(s): #8465
Collection(s): FUNCTIONAL
Type(s): CSVDiff
74
8.5.6The level set module shall use the method of manufactured solutions to test convergence of the level set equation with SUPG and ensure that the level 0 solution is consistent.
Specification(s): level_00
Design: Level Set Module
Issue(s): #8465
Collection(s): FUNCTIONAL
Type(s): CSVDiff
74
8.5.7The level set module shall use the method of manufactured solutions to test convergence of the level set equation with SUPG and ensure that the level 1 solution is consistent.
Specification(s): level_01
Design: Level Set Module
Issue(s): #8465
Collection(s): FUNCTIONAL
Type(s): CSVDiff
74
8.5.8The level set module shall use the method of manufactured solutions to test convergence of the level set equation with SUPG and ensure that the level 2 solution is consistent.
Specification(s): level_02
Design: Level Set Module
Issue(s): #8465
Collection(s): FUNCTIONAL
Type(s): CSVDiff
74
8.5.9The level set module shall use the method of manufactured solutions to test convergence of the level set equation with SUPG and ensure that the level 3 solution is consistent.
Specification(s): level_03
Design: Level Set Module
Issue(s): #8465
Collection(s): FUNCTIONAL
Type(s): CSVDiff
74
8.5.10The level set module shall use the method of manufactured solutions to test convergence of the level set equation with SUPG and ensure that the level 4 solution is consistent.
Specification(s): level_04
Design: Level Set Module
Issue(s): #8465
Collection(s): FUNCTIONAL
Type(s): CSVDiff
74

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

Elin Olsson and Gunilla Kreiss. A conservative level set method for two phase flow. Journal of computational physics, 210(1):225–246, 2005. URL: http://dx.doi.org/10.1016/j.jcp.2005.04.007.

@article{olsson2005conservative,
    author = "Olsson, Elin and Kreiss, Gunilla",
    title = "A conservative level set method for two phase flow",
    journal = "Journal of computational physics",
    volume = "210",
    number = "1",
    pages = "225--246",
    year = "2005",
    publisher = "Elsevier",
    url = "http://dx.doi.org/10.1016/j.jcp.2005.04.007"
}


[./test]
  type = Exodiff
  input = olsson_bubble.i
  exodiff = olsson_bubble_out.e
  issues = '#8465'
  requirement = "The level set module shall include the bubble function defined in [!cite](olsson2005conservative)."
[../]


[./adjac]
  type = PetscJacobianTester
  input = olsson_bubble_adjac.i
  ratio_tol = 1e-7
  issues = '#20193'
  requirement = "The Olsson bubble function shall return correct derivatives for dual number points."
[../]


[./instantenous]
  type = Exodiff
  input = olsson_vortex.i
  exodiff = olsson_vortex_out.e
  requirement = "The level set module shall include the vortex function defined in [!cite](olsson2005conservative) with an instantaneous reverse feature."
[../]


[./cosine]
  type = Exodiff
  input = olsson_vortex.i
  cli_args = "Functions/velocity_func/reverse_type=cosine Outputs/file_base=olsson_vortex_cosine_out"
  exodiff = olsson_vortex_cosine_out.e
  requirement = "The level set module shall include the vortex function defined in [!cite](olsson2005conservative) with an cosine reverse feature."
[../]


[./mms]
  type = CSVDiff
  input = advection_mms.i
  csvdiff = advection_mms_out.csv
  # This problem uses SuperLU.
  superlu = true
  requirement = "The LevelSetAdvection Kernel shall converage at the correct rate as tested by the method of manufactured solutions."
[../]


[./test]
  type = Exodiff
  input = olsson_1d.i
  exodiff = olsson_1d_out.e
  requirement = "The level set module shall include the reinitialization scheme presented by [!cite](olsson2005conservative)."
  valgrind = HEAVY
[../]


[./full_original_reinitialization]
  # Runs two steps of a full original reinitialization problem just to make sure it continues to work
  type = Exodiff
  input = parent.i
  exodiff = parent_original.e
  cli_args = 'Executioner/num_steps=2 Outputs/file_base=parent_original'
  method = '!dbg' # complete reinitilization solve, debug is slow and not needed
  valgrind = HEAVY
  requirement = "The level set module shall be capable of solving the level set equation with original reinitialization."
  issues = '#14849'
[../]


[./full_modified_reinitialization]
  # Runs two steps of a full modified reinitialization problem just to make sure it continues to work
  type = Exodiff
  input = parent.i
  exodiff = parent_modified.e
  cli_args = 'Executioner/num_steps=2 MultiApps/reinit/input_files=reinit_modified.i Outputs/file_base=parent_modified'
  method = '!dbg' # complete reinitilization solve, debug is slow and not needed
  valgrind = HEAVY
  requirement = "The level set module shall be capable of solving the level set equation with modified reinitialization."
  issues = '#8465'
[../]


[./copy]
  type = Exodiff
  input = parent.i
  exodiff = parent_out_sub0.e
  requirement = "The level set module shall include the ability to transfer a non-linear variable between the parent and a sub-application."
[../]


[./test]
  type = Exodiff
  input = parent.i
  exodiff = 'parent_out.e parent_out.e-s002 parent_out.e-s003 parent_out.e-s004 parent_out_sub0.e parent_out_sub0.e-s002 parent_out_sub0.e-s003 parent_out_sub0.e-s004'
  requirement = "The level set module shall include the ability to transfer refinement patterns, with multiple levels of refinement, to a sub-application."
[../]


[test]
  type = Exodiff
  input = parent.i
  exodiff = 'parent_out.e parent_out_sub0_out.e'
  requirement = "The level set module shall include the ability to transfer refinement patterns, with a single level of refinement, to a sub-application."
  issues = '#8465'
[]


[parameter_error]
  type = RunException
  input = parent.i
  expect_err = 'from_multiapp or between_multiapp transfers are not supported'
  cli_args = 'Transfers/marker_to_sub/from_multi_app=sub'
  requirement = "The system shall return an error if parameters for an unsupported direction are passed to a transfer"
  issues = '#19451'
[]


[./level_00]
  type = CSVDiff
  input = level_set_mms.i
  csvdiff = level_set_mms_00.csv
  cli_args = 'Mesh/uniform_refine=0 Outputs/file_base=level_set_mms_00'
  requirement = "The level set module shall use the method of manufactured solutions to test convergence of the level set equation and ensure that the level 0 solution is consistent."
[../]


[./level_01]
  type = CSVDiff
  input = level_set_mms.i
  csvdiff = level_set_mms_01.csv
  cli_args = 'Mesh/uniform_refine=1 Outputs/file_base=level_set_mms_01'
  requirement = "The level set module shall use the method of manufactured solutions to test convergence of the level set equation and ensure that the level 1 solution is consistent."
[../]


[./level_02]
  type = CSVDiff
  input = level_set_mms.i
  csvdiff = level_set_mms_02.csv
  cli_args = 'Mesh/uniform_refine=2 Outputs/file_base=level_set_mms_02'
  requirement = "The level set module shall use the method of manufactured solutions to test convergence of the level set equation and ensure that the level 2 solution is consistent."
[../]


[./level_03]
  type = CSVDiff
  input = level_set_mms.i
  csvdiff = level_set_mms_03.csv
  cli_args = 'Mesh/uniform_refine=3 Outputs/file_base=level_set_mms_03'
  requirement = "The level set module shall use the method of manufactured solutions to test convergence of the level set equation and ensure that the level 3 solution is consistent."
[../]


[./level_04]
  type = CSVDiff
  input = level_set_mms.i
  csvdiff = level_set_mms_04.csv
  cli_args = 'Mesh/uniform_refine=4 Outputs/file_base=level_set_mms_04'
  requirement = "The level set module shall use the method of manufactured solutions to test convergence of the level set equation and ensure that the level 4 solution is consistent."
  valgrind = HEAVY
[../]


[./level_00]
  type = CSVDiff
  input = 1d_level_set_supg_mms.i
  csvdiff = 1d_level_set_supg_mms_00.csv
  cli_args = 'Mesh/uniform_refine=0 Outputs/file_base=1d_level_set_supg_mms_00'
  requirement = "The level set module shall use the method of manufactured solutions to test convergence of the level set equation with SUPG and ensure that the level 0 solution is consistent."
[../]


[./level_01]
  type = CSVDiff
  input = 1d_level_set_supg_mms.i
  csvdiff = 1d_level_set_supg_mms_01.csv
  cli_args = 'Mesh/uniform_refine=1 Outputs/file_base=1d_level_set_supg_mms_01'
  requirement = "The level set module shall use the method of manufactured solutions to test convergence of the level set equation with SUPG and ensure that the level 1 solution is consistent."
[../]


[./level_02]
  type = CSVDiff
  input = 1d_level_set_supg_mms.i
  csvdiff = 1d_level_set_supg_mms_02.csv
  cli_args = 'Mesh/uniform_refine=2 Outputs/file_base=1d_level_set_supg_mms_02'
  requirement = "The level set module shall use the method of manufactured solutions to test convergence of the level set equation with SUPG and ensure that the level 2 solution is consistent."
[../]


[./level_03]
  type = CSVDiff
  input = 1d_level_set_supg_mms.i
  csvdiff = 1d_level_set_supg_mms_03.csv
  cli_args = 'Mesh/uniform_refine=3 Outputs/file_base=1d_level_set_supg_mms_03'
  requirement = "The level set module shall use the method of manufactured solutions to test convergence of the level set equation with SUPG and ensure that the level 3 solution is consistent."
[../]


[./level_04]
  type = CSVDiff
  input = 1d_level_set_supg_mms.i
  csvdiff = 1d_level_set_supg_mms_04.csv
  cli_args = 'Mesh/uniform_refine=4 Outputs/file_base=1d_level_set_supg_mms_04'
  requirement = "The level set module shall use the method of manufactured solutions to test convergence of the level set equation with SUPG and ensure that the level 4 solution is consistent."
[../]

Introduction
System Requirements Traceability
References