Fluid Properties 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 Fluid Properties 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 | 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 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:
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: Auxkernels
- 3.1.1The system shall compute specific enthalpy from pressure and temperature
Specification(s): specific_enthalpy_aux
Design: SpecificEnthalpyAux
Issue(s): #19225
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 3.1.2The system shall compute stagnation pressure from specific volume, specific internal energy, and velocit
Specification(s): stagnation_pressure_aux
Design: StagnationPressureAux
Issue(s): #19225
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 3.1.3The system shall compute stagnation temperature from specific volume, specific internal energy, and velocity
Specification(s): stagnation_temperature_aux
Design: StagnationTemperatureAux
Issue(s): #19225
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 3.1.4The system shall compute fluid density from pressure and temperature.
Specification(s): fluid_density_aux
Design: FluidDensityAux
Issue(s): #17546
Collection(s): FUNCTIONAL
Type(s): Exodiff
- fluid_properties: Brine
- 3.2.1The system shall compute properties of brine
Specification(s): brine
Design: BrineFluidProperties
Issue(s): #6972
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.2.2The system shall compute properties of brine using tabulated water properties
Specification(s): brine_tabulated
Design: BrineFluidProperties
Collection(s): FUNCTIONAL
Type(s): CSVDiff
Prerequisite(s): 3.2.1
- fluid_properties: Calorically Imperfect Gas
- 3.3.1The system shall compute properties for a calorically imperfect but otherwise ideal gas
Specification(s): calorically_imperfect_gas
Design: CaloricallyImperfectGas
Issue(s): #20101
Collection(s): FUNCTIONAL
Type(s): Exodiff
- fluid_properties: Co2
- 3.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: External Submodules
- 3.5.1fluid properties from an external submodule for
- spline-based table-lookup air fluid properties,
- vapor carbon dioxide fluid properties,
- spline-based table-lookup Helium fluid properties,
- spline-based table-lookup Nitrogen fluid properties,
- liquid Potassium fluid properties,
- liquid Sodium fluid properties.
Specification(s): fps/air_pT, fps/CO2_pT, fps/helium_pT, fps/nitrogen_pT, fps/potassium_pT, fps/sodium_pT
Design: External Fluid Properties Submodules
Issue(s): #27097
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- fluid_properties: Fp Interrogator
- 3.6.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
- 3.6.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
- 3.6.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
- 3.6.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
- 3.6.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
- 3.6.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
- 3.6.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
- 3.6.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
- 3.6.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
- 3.6.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
- 3.6.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 when the NCG mass fraction is provided.
Specification(s): 2ph_ncg_p_T
Design: FluidPropertiesInterrogator
Issue(s): #12995
Collection(s): FUNCTIONAL
Type(s): RunApp
- 3.6.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 when the NCG mass fraction is not provided.
Specification(s): 2ph_ncg_p_T_sat
Design: FluidPropertiesInterrogator
Issue(s): #28335
Collection(s): FUNCTIONAL
Type(s): RunApp
- 3.6.13The 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
- 3.6.14The 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
- 3.6.15The 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
- 3.6.16The 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
- 3.6.17The 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
- 3.6.18The 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
- 3.6.19The 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
- 3.6.20The 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): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 3.6.21The 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): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 3.6.22The 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): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- fluid_properties: Functions
- 3.7.1The system shall provide a function that computes saturation density from a temperature function
- for the liquid phase
- for the vapor phase
Specification(s): test/liquid, test/vapor
Design: SaturationDensityFunction
Issue(s): #21256
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.7.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
- 3.7.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
- 3.8.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
- 3.8.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
- 3.8.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: Ideal Gas
- 3.9.1The system shall be able to compute the fluid properties of an ideal gas with the specific energy and volume variables.
Specification(s): conservative
Design: IdealGasFluidProperties
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 3.9.2The system shall be able to compute the fluid properties of an ideal gas with the pressure and temperature variables.
Specification(s): primitive
Design: IdealGasFluidProperties
Collection(s): FUNCTIONAL
Type(s): Exodiff
- fluid_properties: Interfaces
- 3.10.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
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 3.10.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
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 3.10.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
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 3.10.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
Collection(s): FUNCTIONAL
Type(s): RunApp
- 3.10.5The system should be able to return a warning when a fluid property evaluation encounters a NaN.
Specification(s): signaling_nan_warning
Design: NaNInterface
Collection(s): FUNCTIONAL
Type(s): RunApp
- 3.10.6The system should be able to throw an exception when a fluid property evaluation encounters a NaN.
Specification(s): signaling_nan_exception
Design: NaNInterface
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- fluid_properties: Materials
- 3.11.1The system shall provide an AD material that computes saturation temperature.
Specification(s): test
Design: ADSaturationTemperatureMaterial
Issue(s): #15308
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.11.2The system shall provide an AD material that computes surface tension.
Specification(s): test
Design: ADSurfaceTensionMaterial
Issue(s): #15308
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.11.3The system shall be able to compute material properties from fluid properties
- using a (pressure, temperature) variable set
- using a (pressure, enthalpy) variable set
- using a (specific volume, specific internal energy) variable set
Specification(s): fp_material/pressure_temperature, fp_material/pressure_enthalpy, fp_material/volume_energy
Design: FluidPropertiesMaterialVEFluidPropertiesMaterialPT
Issue(s): #20101
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 3.11.4The system shall provide a material that computes saturation pressure using automatic differentiation material properties.
Specification(s): ad
Design: SaturationPressureMaterial
Issue(s): #15860
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.11.5The system shall provide a material that computes saturation pressure using non-automatic differentiation material properties.
Specification(s): nonad
Design: SaturationPressureMaterial
Issue(s): #15860
Collection(s): FUNCTIONAL
Type(s): CSVDiff
Prerequisite(s): 3.11.4
- fluid_properties: Methane
- 3.12.1The system shall be able to compute fluid properties for methane in a gaseous phase.
Specification(s): methane
Design: MethaneFluidProperties
Collection(s): FUNCTIONAL
Type(s): Exodiff
- fluid_properties: Saline
- 3.13.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: Sodium
- 3.14.1The system shall be able to compute liquid sodium properties and compare exactly to analytical expressions.
Specification(s): exact
Design: Sodium Fluid PropertiesSodium Properties Material
Issue(s): #14798
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.14.2The system shall be able to compute liquid sodium properties given constant thermal conductivity and specific heat values.
Specification(s): constant
Design: Sodium Fluid PropertiesSodium Properties Material
Issue(s): #14798
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- fluid_properties: Stiffened Gas
- 3.15.1The system shall be able to compute fluid properties with a stiffened gas model using a conservative variable set.
Specification(s): test
Design: StiffenedGasFluidProperties
Collection(s): FUNCTIONAL
Type(s): Exodiff
- fluid_properties: Tabulated
- 3.16.1The system shall be able to generate a tabulation of fluid properties based on pressure and temperature, and use a tabulated interplation of these properties.
Specification(s): tabulated_bicubic
Design: TabulatedFluidProperties
Issue(s): #20101
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.16.2The system shall be able to read a tabulation of fluid properties, then compute these fluid properties using (volume, energy) primary variables
- using a regularly spaced interpolation grid
- using a log-spaced specific volume grid and a regularly spaced grid in specific internal energy
- using a linear specific volume grid and a log-spaced grid in specific internal energy
Specification(s): tabulated_v_e_bicubic_from_pT/regular_grids, tabulated_v_e_bicubic_from_pT/log_v, tabulated_v_e_bicubic_from_pT/log_e
Design: TabulatedFluidProperties
Issue(s): #20101
Collection(s): FUNCTIONAL
Type(s): CSVDiff
Prerequisite(s): 3.16.1
- 3.16.3The system shall be able to output tabulated fluid property data when requested by the user
- for the (specific volume, internal energy) conversion grids.
Specification(s): file_writing/ve
Design: TabulatedFluidProperties
Issue(s): #20101
Collection(s): FUNCTIONAL
Type(s): CSVDiff
Prerequisite(s): 3.16.1
- 3.16.4The system shall be able to read a tabulation of fluid properties with a (specific volume, specific internal energy) grid and use this tabulation directly.
Specification(s): tabulated_v_e_bicubic_direct
Design: TabulatedFluidProperties
Issue(s): #20101
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.16.5The system shall throw an error if
- if the user-specified pressure boundaries are inverted
- if the user-specified temperature boundaries are inverted
- if the user-specified pressure initial guess for variable set inversions is out of bounds
- if the user-specified temperature initial guess for variable set inversions is out of bounds
Specification(s): exceptions/bad_pressure_bounds, exceptions/bad_temperature_bounds, exceptions/bad_pressure_guess, exceptions/bad_temperature_guess
Design: TabulatedFluidProperties
Issue(s): #20101
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- 3.16.6The system shall be able to
- error if the desired pressure for a fluid property evaluation is outside the user-specified bounds, when prescribed to error in such conditions
- error if the desired temperature for a fluid property evaluation is outside the user-specified bounds, when prescribed to error in such conditions
- declare the solution invalid if the desired pressure for a fluid property evaluation is outside the user-specified bounds, when prescribed to do so in such conditions
- declare the solution invalid if the desired temperature for a fluid property evaluation is outside the user-specified bounds, when prescribed to do so in such conditions
- ignore if the desired pressure for a fluid property evaluation is outside the user-specified bounds, when prescribed to ignore in such conditions
- ignore if the desired temperature for a fluid property evaluation is outside the user-specified bounds, when prescribed to ignore in such conditions
Specification(s): out_of_bounds/error_pressure_out_of_bounds, out_of_bounds/error_temperature_out_of_bounds, out_of_bounds/invalid_pressure_out_of_bounds, out_of_bounds/invalid_temperature_out_of_bounds, out_of_bounds/ignore_pressure_out_of_bounds, out_of_bounds/ignore_temperature_out_of_bounds
Design: TabulatedFluidProperties
Issue(s): #20101
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunExceptionRunApp
- fluid_properties: Temperature Pressure Function
- 3.17.1The system shall be able to compute functionalized fluid properties.
Specification(s): exact
Design: TemperaturePressureFunctionFluidProperties
Issue(s): #21505
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.17.2The system shall be able to compute fluid properties defined through functions of pressure and temperature.
Specification(s): example
Design: TemperaturePressureFunctionFluidProperties
Issue(s): #21505
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- fluid_properties: Two Phase Fluid Properties Independent
- 3.18.1The system shall be able to mix two independent single-phase fluid properties to form a basic two-phase model.
Specification(s): test
Design: TwoPhaseFluidPropertiesIndependent
Issue(s): #11641
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.18.2The system shall be able to not error on unimplemented two-phase fluid properties routines if the user requested so.
Specification(s): no_error_on_unimplemented
Design: TwoPhaseFluidPropertiesIndependent
Issue(s): #11641
Collection(s): FUNCTIONAL
Type(s): RunApp
Prerequisite(s): 3.18.1
- 3.18.3The system shall report an error if 2-phase property interfaces are called on a class designed to handle two single-phase fluid properties.
Specification(s): error:error_on_unimplemented
Design: TwoPhaseFluidPropertiesIndependent
Issue(s): #11641
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- fluid_properties: Two Phase Ncg Partial Pressure
- 3.19.1The system shall be able to compute properties from a two-phase with non-condensable gas user object.
Specification(s): test
Design: TwoPhaseNCGPartialPressureFunction
Issue(s): #28335
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.19.2The system shall report an error if an incorrect number of arguments are provided when computing properties from a two-phase with non-condensable gas user object.
Specification(s): error_wrong_number_of_args
Design: TwoPhaseNCGPartialPressureFunction
Issue(s): #28335
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
- fluid_properties: Water
- 3.20.1The system shall be able to compute the fluid properties of water and steam following the IAPWS-IF97 formulations.
Specification(s): water
Design: Water97FluidProperties
Collection(s): FUNCTIONAL
Type(s): CSVDiff