Fluid Properties System Design Description
This template follows INL template TEM-140, "IT System Design Description."
This document serves as an addendum to Framework System Design Description and captures information for SDD specific to the Fluid Properties module.
Introduction
The MOOSE Fluid Properties module is based on the MOOSE framework and thus inherits the unique features and base characteristics of the framework, as outlined in the Framework System Design Description. Specific details unique to the module are outlined in this document.
System Purpose
The Software Design Description provided here is description of each object in the system. The pluggable architecture of the underlying framework of the Fluid Properties module makes MOOSE and MOOSE-based applications straightforward to develop as each piece of end-user (developer) code that goes into the system follows a well-defined interface for the underlying systems that those object plug into. These descriptions are provided through developer-supplied "markdown" files that are required for all new objects that are developed as part of the Fluid Properties module. More information about the design documentation for MOOSE-based applications and like the Fluid Properties module can be found in Documenting MOOSE.
System Scope
The purpose of this software is to provide physical properties of fluids to MOOSE-based applications, suitable for a variety of fluid formulations. Specifically, the following objectives are sought:
Provide uniform interfaces for accessing single-phase and two-phase fluid properties
Provide a library of fluid properties
Dependencies and Limitations
The Fluid Properties module inherits the software dependencies of the MOOSE framework, with no additional dependencies. The design of this module is already relatively stable; the majority of additional contributions aim to extend the list of fluid properties available and make various feature improvements. The design is not expected to be impacted significantly by factors such as budget, schedule, and staffing.
Definitions and Acronyms
This section defines, or provides the definition of, all terms and acronyms required to properly understand this specification.
Definitions
Pull (Merge) Request: A proposed change to the software (e.g. usually a code change, but may also include documentation, requirements, design, and/or testing).
Baseline: A specification or product (e.g., project plan, maintenance and operations (M&O) plan, requirements, or design) that has been formally reviewed and agreed upon, that thereafter serves as the basis for use and further development, and that can be changed only by using an approved change control process (NQA-1, 2009).
Validation: Confirmation, through the provision of objective evidence (e.g., acceptance test), that the requirements for a specific intended use or application have been fulfilled (24765:2010(E), 2010).
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
Acronym | Description |
---|---|
API | Application Programming Interface |
DOE-NE | Department of Energy, Nuclear Energy |
FE | finite element |
HIT | Hierarchical Input Text |
HPC | High Performance Computing |
I/O | Input/Output |
INL | Idaho National Laboratory |
MOOSE | Multiphysics Object Oriented Simulation Environment |
MPI | Message Passing Interface |
SDD | Software Design Description |
Design Stakeholders and Concerns
Design Stakeholders
Stakeholders for MOOSE include several of the funding sources including DOE-NE and the INL. However, Since MOOSE is an open-source project, several universities, companies, and foreign governments have an interest in the development and maintenance of the MOOSE project.
Stakeholder Design Concerns
Concerns from many of the stakeholders are similar. These concerns include correctness, stability, and performance. The mitigation plan for each of these can be addressed. For correctness, Fluid Properties module development requires either regression or unit testing for all new code added to the repository. The project contains several comparisons against analytical solutions where possible and also other verification methods such as MMS. For stability, the Fluid Properties module (located within the MOOSE repository) maintains multiple branches to incorporate several layers of testing both internally and for dependent applications. Finally, performance tests are also performed as part of the the normal testing suite to monitor code change impacts to performance.
System Design
The Fluid Properties module inherits the wide range of pluggable systems from MOOSE. More information regarding MOOSE system design can be found in the framework System Design section. The Fluid Properties module does not provide any physical models for fluid dynamics, only models for computing various physical properties of fluids. Documentation for each object, data structure, and process specific to the module are kept up-to-date alongside the MOOSE documentation. Expected failure modes and error conditions are accounted for via regression testing, and error conditions are noted in object documentation where applicable.
System Structure
The architecture of the Fluid Properties module consists of a core and several pluggable systems (both inherited from the MOOSE framework). The core of MOOSE consists of a number of key objects responsible for setting up and managing the user-defined objects of a finite element simulation. This core set of objects has limited extendability and exists for every simulation configuration that the module is capable of running.
AuxKernels
AuxVariables
FluidProperties
FluidPropertiesInterrogator
Functions
ICs
Materials
Modules
Modules/FluidProperties
UserObjects
Variables
The MooseApp is the top-level object used to hold all of the other objects in a simulation. In a normal simulation a single MooseApp object is created and "run()". This object uses its Factory objects to build user defined objects which are stored in a series of Warehouse objects and executed. The Finite Element data is stored in the Systems and Assembly object while the domain information (the Mesh) is stored in the Mesh object. A series of threaded loops are used to run parallel calculations on the objects created and stored within the warehouses.
MOOSE's pluggable systems are documented on MOOSE website, and those for the Fluid Properties module are on this webpage, accessible through the high-level system links above. Each of these systems has a set of defined polymorphic interfaces and are designed to accomplish a specific task within the simulation. The design of these systems is fluid and is managed through agile methods and ticket request system either on GitHub (for MOOSE) or on the defined software repository for this application.
Data Design and Control
At a high level, the system is designed to process HIT input files to construct several objects that will constitute an FE simulation. Some of the objects in the simulation may in turn load other file-based resources to complete the simulation. Examples include meshes or data files. The system will then assemble systems of equations and solve them using the libraries of the Code Platform. The system can then output the solution in one or more supported output formats commonly used for visualization.
Human-Machine Interface Design
The Fluid Properties module is a command-line driven program. All interaction with the Fluid Properties module is ultimately done through the command line. This is typical for HPC applications that use the MPI interface for running on super computing clusters. Optional GUIs may be used to assist in creating input files and launching executables on the command line.
System Design Interface
All external system interaction is performed either through file I/O or through local API calls. Neither the Fluid Properties module, nor the MOOSE framework, nor the other MOOSE modules are designed to interact with any external system directly through remote procedure calls. Any code to code coupling performed using the framework are done directly through API calls either in a static binary or after loading shared libraries.
Security Structure
The Fluid Properties module does not require any elevated privileges to operate and does not run any stateful services, daemons or other network programs. Distributed runs rely on the MPI library.
Requirements Cross-Reference
- fluid_properties: SpecificEnthalpyAux
- 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
- fluid_properties: StagnationPressureAux
- 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
- fluid_properties: StagnationTemperatureAux
- 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
- fluid_properties: FluidDensityAux
- 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: BrineFluidProperties
- 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
- fluid_properties: CaloricallyImperfectGas
- 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: CO2FluidProperties
- 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 Fluid Properties 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: FluidPropertiesInterrogator
- 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: SaturationDensityFunction
- 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
- fluid_properties: SaturationPressureFunction
- 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
- fluid_properties: SaturationTemperatureFunction
- 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: RhoFromPressureTemperatureIC
- 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
- fluid_properties: RhoVaporMixtureFromPressureTemperatureIC
- 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
- fluid_properties: SpecificEnthalpyFromPressureTemperatureIC
- 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: IdealGasFluidProperties
- 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: NaNInterface
- 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: ADSaturationTemperatureMaterial
- 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
- fluid_properties: ADSurfaceTensionMaterial
- 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
- fluid_properties: FluidPropertiesMaterialVE
- 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
- fluid_properties: FluidPropertiesMaterialPT
- 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
- fluid_properties: SaturationPressureMaterial
- 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
- fluid_properties: MethaneFluidProperties
- 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: SalineMoltenSaltFluidProperties
- 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 Fluid Properties
- 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: Sodium Properties Material
- 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: StiffenedGasFluidProperties
- 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: TabulatedFluidProperties
- 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
- 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
- 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: TemperaturePressureFunctionFluidProperties
- 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: TwoPhaseFluidPropertiesIndependent
- 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
- 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: TwoPhaseNCGPartialPressureFunction
- 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: Water97FluidProperties
- 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