Fluid Properties Requirements Traceability Matrix

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

commentnote

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

Introduction

Minimum System Requirements

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

  • GCC/Clang C++17 compliant compiler (GCC @ 7.5.0, Clang @ 10.0.1 or greater)

    • Note: Intel compilers are not supported.

  • Memory: 8 GBs of RAM for optimized compilation (16 GBs for debug compilation), 2 GB per core execution

  • Processor: 64-bit x86 or ARM64 (specifically, Apple Silicon)

  • Disk: 30GB

  • A POSIX compliant Unix-like operating system, including the two most recent versions of MacOS and most current versions of Linux.

  • Git version control system

  • Python @ 3.7 or greater

System Purpose

The MOOSE Fluid Properties module provides uniform interfaces to numerous physical properties of fluids and a library of fluid objects based on these interfaces. This module is intended to be used by a variety of MOOSE-based applications involving the simulation of fluid flow.

System Scope

The scope of the Fluid Properties module includes properties of both liquids and gases, as well as two-phase liquid-vapor properties. Additionally, the module includes some generic capability for defining a fluid's equation of state from user-defined functions or tabular data from files.

Assumptions and Dependencies

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

  • fluid_properties: Co2
  • 5.4.1The system shall be able to compute fluid properties for carbon dioxide in a gaseous phase.

    Specification(s): co2

    Design: CO2FluidProperties

    Issue(s): #6972

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • fluid_properties: Fp Interrogator
  • 5.5.1The fluid properties interrogator shall output static-state fluid properties for (p, T) input.

    Specification(s): 1ph.p_T

    Design: FluidPropertiesInterrogator

    Issue(s): #12995

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 5.5.2The fluid properties interrogator shall output static-state fluid properties for (p, T) input in JSON format.

    Specification(s): 1ph.p_T.json

    Design: FluidPropertiesInterrogator

    Issue(s): #13741

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 5.5.3The fluid properties interrogator shall output static-state fluid properties for (rho, e) input.

    Specification(s): 1ph.rho_e

    Design: FluidPropertiesInterrogator

    Issue(s): #12995

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 5.5.4The fluid properties interrogator shall output static-state fluid properties for (rho, e) input in JSON format.

    Specification(s): 1ph.rho_e.json

    Design: FluidPropertiesInterrogator

    Issue(s): #13741

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 5.5.5The fluid properties interrogator shall output static-state fluid properties for (rho, p) input.

    Specification(s): 1ph.rho_p

    Design: FluidPropertiesInterrogator

    Issue(s): #12995

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 5.5.6The fluid properties interrogator shall output static-state fluid properties for (rho, p) input in JSON format.

    Specification(s): 1ph.rho_p.json

    Design: FluidPropertiesInterrogator

    Issue(s): #13741

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 5.5.7The fluid properties interrogator shall output static-state and stagnation-state fluid properties for (rho, rhou, rhoE) input with a single-phase fluid properties object.

    Specification(s): 1ph.rho_rhou_rhoE

    Design: FluidPropertiesInterrogator

    Issue(s): #12995

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 5.5.8The fluid properties interrogator shall output static-state and stagnation-state fluid properties for (rho, rhou, rhoE) input with a single-phase fluid properties object in JSON format.

    Specification(s): 1ph.rho_rhou_rhoE.json

    Design: FluidPropertiesInterrogator

    Issue(s): #13741

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 5.5.9The fluid properties interrogator shall output two-phase and static-state, single-phase fluid properties for (p, T) input with a two-phase fluid properties object.

    Specification(s): 2ph.p_T

    Design: FluidPropertiesInterrogator

    Issue(s): #12995

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 5.5.10The fluid properties interrogator shall output two-phase and static-state, single-phase fluid properties for (p, T) input with a two-phase fluid properties object in JSON format.

    Specification(s): 2ph.p_T.json

    Design: FluidPropertiesInterrogator

    Issue(s): #13741

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 5.5.11The fluid properties interrogator shall output two-phase and static-state, single-phase fluid properties for (p, T) input with a two-phase NCG fluid properties object.

    Specification(s): 2ph_ncg_p_T

    Design: FluidPropertiesInterrogator

    Issue(s): #12995

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 5.5.12The fluid properties interrogator shall output two-phase and static-state, single-phase fluid properties for (p, T) input with a two-phase NCG fluid properties object in JSON format.

    Specification(s): 2ph_ncg_p_T.json

    Design: FluidPropertiesInterrogator

    Issue(s): #13741

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 5.5.13The fluid properties interrogator shall output static-state, single-phase fluid properties for (rho, e) input with a vapor mixture fluid properties object.

    Specification(s): vapor_mixture_rho_e

    Design: FluidPropertiesInterrogator

    Issue(s): #12995

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 5.5.14The fluid properties interrogator shall output static-state, single-phase fluid properties for (rho, e) input with a vapor mixture fluid properties object in JSON format.

    Specification(s): vapor_mixture_rho_e.json

    Design: FluidPropertiesInterrogator

    Issue(s): #13741

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 5.5.15The fluid properties interrogator shall output two-phase fluid properties for (p) input with a two-phase fluid properties object.

    Specification(s): 2ph_p

    Design: FluidPropertiesInterrogator

    Issue(s): #12995

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 5.5.16The fluid properties interrogator shall output two-phase fluid properties for (p) input with a two-phase fluid properties object in JSON format.

    Specification(s): 2ph_p.json

    Design: FluidPropertiesInterrogator

    Issue(s): #13741

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 5.5.17The fluid properties interrogator shall output two-phase fluid properties for (T) input with a two-phase fluid properties object.

    Specification(s): 2ph_T

    Design: FluidPropertiesInterrogator

    Issue(s): #12995

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 5.5.18The fluid properties interrogator shall output two-phase fluid properties for (T) input with a two-phase fluid properties object in JSON format.

    Specification(s): 2ph_T.json

    Design: FluidPropertiesInterrogator

    Issue(s): #13741

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • 5.5.19The fluid properties interrogator shall throw an error if an incompatible fluid properties object is supplied.

    Specification(s): err.wrong_fp_type

    Design: FluidPropertiesInterrogator

    Issue(s): #12995

    Collection(s): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 5.5.20The fluid properties interrogator shall throw an error if an extraneous parameter(s) are supplied.

    Specification(s): err.extraneous_parameter

    Design: FluidPropertiesInterrogator

    Issue(s): #12995

    Collection(s): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 5.5.21The fluid properties interrogator shall throw an error if an no valid input sets were supplied.

    Specification(s): err.no_params

    Design: FluidPropertiesInterrogator

    Issue(s): #12995

    Collection(s): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • fluid_properties: Functions
  • 5.6.1The system shall provide a function that computes saturation density from a temperature function
    1. for the liquid phase
    2. for the vapor phase

    Specification(s): test/liquid, test/vapor

    Design: SaturationDensityFunction

    Issue(s): #21256

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 5.6.2The system shall provide a function that computes saturation pressure from a temperature function

    Specification(s): test

    Design: SaturationPressureFunction

    Issue(s): #14755

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 5.6.3The system shall provide a function that computes saturation temperature from a pressure function

    Specification(s): test

    Design: SaturationTemperatureFunction

    Issue(s): #14755

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • fluid_properties: Ics
  • 5.7.1The system shall be able to set an initial condition for density given pressure and temperature as variables

    Specification(s): test

    Design: RhoFromPressureTemperatureIC

    Issue(s): #15524

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 5.7.2The system shall be able to set an initial condition for density of vapor mixture given pressure and temperature as variables

    Specification(s): test

    Design: RhoVaporMixtureFromPressureTemperatureIC

    Issue(s): #15524

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 5.7.3The system shall be able to set an initial condition for specific enthalpy given pressure and temperature as variables

    Specification(s): test

    Design: SpecificEnthalpyFromPressureTemperatureIC

    Issue(s): #15561

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • fluid_properties: Interfaces
  • 5.9.1The system should produce a warning when a scalar NaN is produced and user required that the execution would not terminate

    Specification(s): quiet_nan_scalar

    Design: NaNInterface

    Issue(s): #12234#12350

    Collection(s): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 5.9.2The system should produce a warning when a vector NaN is produced and user required that the execution would not terminate

    Specification(s): quiet_nan_vector

    Design: NaNInterface

    Issue(s): #12234#12350

    Collection(s): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 5.9.3The system should report an error when a NaN is produced by a computation in DEBUG mode, by default

    Specification(s): signaling_nan_dbg

    Design: NaNInterface

    Issue(s): #12234#12350

    Collection(s): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

  • 5.9.4The system should not report an error when a NaN is produced by a computation in OPT mode, by default

    Specification(s): signaling_nan_opt

    Design: NaNInterface

    Issue(s): #12234#12350

    Collection(s): FUNCTIONAL

    Type(s): RunApp

  • fluid_properties: Methane
  • 5.11.1The system shall be able to compute fluid properties for methane in a gaseous phase.

    Specification(s): methane

    Design: MethaneFluidProperties

    Issue(s): #6972#12445

    Collection(s): FUNCTIONAL

    Type(s): Exodiff

  • fluid_properties: Saline
  • 5.12.1The system shall be able to leverage the Saline submodule to compute composed salt fluid properties

    Specification(s): test

    Design: SalineMoltenSaltFluidProperties

    Issue(s): #22724

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • fluid_properties: Stiffened Gas
  • 5.14.1The system shall be able to compute fluid properties with a stiffened gas model using a conservative variable set.

    Specification(s): test

    Design: StiffenedGasFluidProperties

    Issue(s): #9613#12815

    Collection(s): FUNCTIONAL

    Type(s): Exodiff

  • fluid_properties: Water
  • 5.18.1The system shall be able to compute the fluid properties of water and steam following the IAPWS-IF97 formulations.

    Specification(s): water

    Design: Water97FluidProperties

    Issue(s): #6972#8849#10234

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

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.