Fluid Properties System Requirements Specification

This template follows INL template TEM-135, "IT System Requirements Specification".

commentnote

This document serves as an addendum to Framework System Requirements Specification and captures information for SRS specific to the Fluid Properties module.

Introduction

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.

System Overview

System Context

The Fluid Properties module is command-line driven. Like MOOSE, this is typical for a high-performance software that is designed to run across several nodes of a cluster system. As such, all usage of the software is through any standard terminal program generally available on all supported operating systems. Similarly, for the purpose of interacting through the software, there is only a single user, "the user", which interacts with the software through the command-line. The Fluid Properties module does not maintain any back-end database or interact with any system daemons. It is an executable, which may be launched from the command line and writes out various result files as it runs.

Figure 1: Usage of the Fluid Properties module and other MOOSE-based applications.

System Functions

Since the Fluid Properties module is a command-line driven application, all functionality provided in the software is operated through the use of standard UNIX command line flags and the extendable MOOSE input file. The Fluid Properties module is completely extendable so individual design pages should be consulted for specific behaviors of each user-defined object.

User Characteristics

Like MOOSE, there are three kinds of users working on the Fluid Properties module:

  • Fluid Properties module Developers: These are the core developers of the Fluid Properties module. They are responsible for following and enforcing the software development standards of the module, as well as designing, implementing, and maintaining the software.

  • Developers: A scientist or engineer that uses the Fluid Properties module alongside MOOSE to build their own application. This user will typically have a background in modeling or simulation techniques (and perhaps numerical analysis) but may only have a limited skillset when it comes to code development using the C++ language. This is the primary focus group of the module. In many cases, these developers will be encouraged to contribute module-appropriate code back to the Fluid Properties module, or to MOOSE itself.

  • Analysts: These are users that will run the code and perform analysis on the simulations they perform. These users may interact with developers of the system requesting new features and reporting bugs found and will typically make heavy use of the input file format.

Assumptions and Dependencies

The Fluid Properties module is developed using MOOSE and can itself be based on various MOOSE modules, as such the SRS for the Fluid Properties module is dependent upon the files listed at the beginning of this document. Any further assumptions or dependencies are outlined in the remainder of this section.

The Fluid Properties module is designed with the fewest possible constraints on hardware and software. For more context on this point, the Fluid Properties module SRS defers to the framework Assumptions and Dependencies. Any physics-based assumptions in code simulations and code objects are highlighted in their respective documentation pages.

References

  1. ISO/IEC/IEEE 24765:2010(E). Systems and software engineering—Vocabulary. first edition, December 15 2010.[BibTeX]
  2. ASME NQA-1. ASME NQA-1-2008 with the NQA-1a-2009 addenda: Quality Assurance Requirements for Nuclear Facility Applications. first edition, August 31 2009.[BibTeX]

Definitions and Acronyms

This section defines, or provides the definition of, all terms and acronyms required to properly understand this specification.

Definitions

  • Verification: (1) The process of: evaluating a system or component to determine whether the products of a given development phase satisfy the conditions imposed at the start of that phase. (2) Formal proof of program correctness (e.g., requirements, design, implementation reviews, system tests) (24765:2010(E), 2010).

Acronyms

AcronymDescription
INLIdaho National Laboratory
LGPLGNU Lesser General Public License
MOOSEMultiphysics Object Oriented Simulation Environment
NQA-1Nuclear Quality Assurance Level 1
POSIXPortable Operating System Interface
SRSSoftware Requirement Specification

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

Functional Requirements

  • fluid_properties: Auxkernels
  • 5.1.1The system shall compute specific enthalpy from pressure and temperature
  • 5.1.2The system shall compute stagnation pressure from specific volume, specific internal energy, and velocit
  • 5.1.3The system shall compute stagnation temperature from specific volume, specific internal energy, and velocity
  • 5.1.4The system shall compute fluid density from pressure and temperature.
  • fluid_properties: Brine
  • 5.2.1The system shall compute properties of brine
  • 5.2.2The system shall compute properties of brine using tabulated water properties
  • fluid_properties: Calorically Imperfect Gas
  • 5.3.1The system shall compute properties for a calorically imperfect but otherwise ideal gas
  • fluid_properties: Co2
  • 5.4.1The system shall be able to compute fluid properties for carbon dioxide in a gaseous phase.
  • fluid_properties: Fp Interrogator
  • 5.5.1The fluid properties interrogator shall output static-state fluid properties for (p, T) input.
  • 5.5.2The fluid properties interrogator shall output static-state fluid properties for (p, T) input in JSON format.
  • 5.5.3The fluid properties interrogator shall output static-state fluid properties for (rho, e) input.
  • 5.5.4The fluid properties interrogator shall output static-state fluid properties for (rho, e) input in JSON format.
  • 5.5.5The fluid properties interrogator shall output static-state fluid properties for (rho, p) input.
  • 5.5.6The fluid properties interrogator shall output static-state fluid properties for (rho, p) input in JSON format.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 5.5.15The fluid properties interrogator shall output two-phase fluid properties for (p) input with a two-phase fluid properties object.
  • 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.
  • 5.5.17The fluid properties interrogator shall output two-phase fluid properties for (T) input with a two-phase fluid properties object.
  • 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.
  • 5.5.19The fluid properties interrogator shall throw an error if an incompatible fluid properties object is supplied.
  • 5.5.20The fluid properties interrogator shall throw an error if an extraneous parameter(s) are supplied.
  • 5.5.21The fluid properties interrogator shall throw an error if an no valid input sets were supplied.
  • 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
  • 5.6.2The system shall provide a function that computes saturation pressure from a temperature function
  • 5.6.3The system shall provide a function that computes saturation temperature from a pressure function
  • fluid_properties: Ics
  • 5.7.1The system shall be able to set an initial condition for density given pressure and temperature as variables
  • 5.7.2The system shall be able to set an initial condition for density of vapor mixture given pressure and temperature as variables
  • 5.7.3The system shall be able to set an initial condition for specific enthalpy given pressure and temperature as variables
  • fluid_properties: Ideal Gas
  • 5.8.1The system shall be able to compute the fluid properties of an ideal gas with the specific energy and volume variables.
  • 5.8.2The system shall be able to compute the fluid properties of an ideal gas with the pressure and temperature variables.
  • 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
  • 5.9.2The system should produce a warning when a vector NaN is produced and user required that the execution would not terminate
  • 5.9.3The system should report an error when a NaN is produced by a computation in DEBUG mode, by default
  • 5.9.4The system should not report an error when a NaN is produced by a computation in OPT mode, by default
  • fluid_properties: Materials
  • 5.10.1The system shall provide an AD material that computes saturation temperature.
  • 5.10.2The system shall provide an AD material that computes surface tension.
  • 5.10.3The system shall be able to compute material properties from fluid properties
    1. using a (pressure, temperature) variable set
    2. using a (pressure, enthalpy) variable set
    3. using a (specific volume, specific internal energy) variable set
  • The system shall provide a material that computes saturation pressure using automatic differentiation material properties.
  • 5.10.5The system shall provide a material that computes saturation pressure using non-automatic differentiation material properties.
  • fluid_properties: Methane
  • 5.11.1The system shall be able to compute fluid properties for methane in a gaseous phase.
  • fluid_properties: Saline
  • 5.12.1The system shall be able to leverage the Saline submodule to compute composed salt fluid properties
  • fluid_properties: Sodium
  • 5.13.1The system shall be able to compute liquid sodium properties and compare exactly to analytical expressions.
  • 5.13.2The system shall be able to compute liquid sodium properties given constant thermal conductivity and specific heat values.
  • 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.
  • fluid_properties: Tabulated
  • 5.15.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.
  • 5.15.2The system shall be able to read a tabulation of fluid properties, then compute these fluid properties using (volume, energy) primary variables
    1. using a regularly spaced interpolation grid
    2. using a log-spaced specific volume grid and a regularly spaced grid in specific energy
  • 5.15.3The system shall throw an error if
    1. if the user-specified pressure boundaries are inverted
    2. if the user-specified temperature boundaries are inverted
    3. if the user-specified pressure initial guess for variable set inversions is out of bounds
    4. if the user-specified temperature initial guess for variable set inversions is out of bounds
    5. if the desired pressure for a fluid property evaluation is outside the user-specified bounds, when prescribed to error in such conditions
    6. if the desired temperature for a fluid property evaluation is outside the user-specified bounds, when prescribed to error in such conditions
  • fluid_properties: Temperature Pressure Function
  • 5.16.1The system shall be able to compute functionalized fluid properties.
  • 5.16.2The system shall be able to compute fluid properties defined through functions of pressure and temperature.
  • fluid_properties: Two Phase Fluid Properties Independent
  • 5.17.1The system shall be able to mix two independent single-phase fluid properties to form a basic two-phase model.
  • 5.17.2The system shall be able to not error on unimplemented two-phase fluid properties routines if the user requested so.
  • 5.17.3The system shall report an error if 2-phase property interfaces are called on a class designed to handle two single-phase fluid properties.
  • fluid_properties: Water
  • 5.18.1The system shall be able to compute the fluid properties of water and steam following the IAPWS-IF97 formulations.

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 Interfaces

No requirements of this type exist for this application, beyond those of its dependencies.

System Operations

Human System Integration Requirements

The Fluid Properties module is command line driven and conforms to all standard terminal behaviors. Specific human system interaction accommodations shall be a function of the end-user's terminal. MOOSE (and therefore the Fluid Properties module) does support optional coloring within the terminal's ability to display color, which may be disabled.

Maintainability

  • The latest working version (defined as the version that passes all tests in the current regression test suite) shall be publicly available at all times through the repository host provider.

  • Flaws identified in the system shall be reported and tracked in a ticket or issue based system. The technical lead will determine the severity and priority of all reported issues and assign resources at their discretion to resolve identified issues.

  • The software maintainers will entertain all proposed changes to the system in a timely manner (within two business days).

  • The core software in its entirety will be made available under the terms of a designated software license. These license terms are outlined in the LICENSE file alongside the Fluid Properties module source code. As a MOOSE physics module, the license for the Fluid Properties module is identical to that of the framework - that is, the LGPL version 2.1 license.

Reliability

The regression test suite will cover at least 84% of all lines of code within the Fluid Properties module at all times. Known regressions will be recorded and tracked (see Maintainability) to an independent and satisfactory resolution.

System Modes and States

MOOSE applications normally run in normal execution mode when an input file is supplied. However, there are a few other modes that can be triggered with various command line flags as indicated here:

Command Line FlagDescription of mode
-i <input_file>Normal execution mode
--split-mesh <splits>Read the mesh block splitting the mesh into two or more pieces for use in a subsequent run
--use-split(implies -i flag) Execute the the simulation but use pre-split mesh files instead of the mesh from the input file
--yamlOutput all object descriptions and available parameters in YAML format
--jsonOutput all object descriptions and available parameters in JSON format
--syntaxOutput all registered syntax
--registryOutput all known objects and actions
--registry-hitOutput all known objects and actions in HIT format
--mesh-only (implies -i flag)Run only the mesh related tasks and output the final mesh that would be used for the simulation
--start-in-debugger <debugger>Start the simulation attached to the supplied debugger
commentnote

The list of system-modes may not be extensive as the system is designed to be extendable to end-user applications. The complete list of command line options for applications can be obtained by running the executable with zero arguments. See the command line usage.

Physical Characteristics

The Fluid Properties module is software only with no associated physical media. See System Requirements for a description of the minimum required hardware necessary for running the Fluid Properties module.

Environmental Conditions

Not Applicable

System Security

MOOSE-based applications such as the Fluid Properties module have no requirements or special needs related to system security. The software is designed to run completely in user-space with no elevated privileges required nor recommended.

Information Management

The core framework and all modules in their entirety will be made publicly available on an appropriate repository hosting site. Day-to-day backups and security services will be provided by the hosting service. More information about MOOSE backups of the public repository on INL-hosted services can be found on the following page: GitHub Backups

Polices and Regulations

MOOSE-based applications must comply with all export control restrictions.

System Life Cycle Sustainment

MOOSE-based development follows various agile methods. The system is continuously built and deployed in a piecemeal fashion since objects within the system are more or less independent. Every new object requires a test, which in turn requires an associated requirement and design description. The Fluid Properties module development team follows the NQA-1 standards.

Packaging, Handling, Shipping and Transportation

No special requirements are needed for packaging or shipping any media containing MOOSE and Fluid Properties module source code. However, some MOOSE-based applications that use the Fluid Properties module may be export-controlled, in which case all export control restrictions must be adhered to when packaging and shipping media.

Verification

The regression test suite will employ several verification tests using comparison against known analytical solutions, the method of manufactured solutions, and convergence rate analysis.