Fluid Properties Software Design Description
Introduction
The Software Design Description (SDD) for Fluid Properties is a description of the software product and serves as guideline that describes the architecture of the system and all of its parts.
Dependencies
The Fluid Properties application is developed using MOOSE and is based on various modules, as such the SDD for Fluid Properties is dependent upon the following documents.
Requirements Cross Reference
The following is a list of all design documents and the associated requirements for Fluid Properties.
- fluid_properties: BrineFluidProperties
- F6.1.1The system shall compute properties of brine
Specification: brine:brine
Design: BrineFluidProperties
Issue(s): #6972
- F6.1.2The system shall compute properties of brine using tabulated water properties
Specification: brine:brine_tabulated
Design: BrineFluidProperties
- fluid_properties: FluidPropertiesInterrogator
- F6.2.1The fluid properties interrogator shall output static-state fluid properties for (p, T) input.
Specification: fp_interrogator:1ph.p_T
Design: FluidPropertiesInterrogator
Issue(s): #12995
- F6.2.2The fluid properties interrogator shall output static-state fluid properties for (p, T) input in JSON format.
Specification: fp_interrogator:1ph.p_T.json
Design: FluidPropertiesInterrogator
Issue(s): #13741
- F6.2.3The fluid properties interrogator shall output static-state fluid properties for (rho, e) input.
Specification: fp_interrogator:1ph.rho_e
Design: FluidPropertiesInterrogator
Issue(s): #12995
- F6.2.4The fluid properties interrogator shall output static-state fluid properties for (rho, e) input in JSON format.
Specification: fp_interrogator:1ph.rho_e.json
Design: FluidPropertiesInterrogator
Issue(s): #13741
- F6.2.5The fluid properties interrogator shall output static-state fluid properties for (rho, p) input.
Specification: fp_interrogator:1ph.rho_p
Design: FluidPropertiesInterrogator
Issue(s): #12995
- F6.2.6The fluid properties interrogator shall output static-state fluid properties for (rho, p) input in JSON format.
Specification: fp_interrogator:1ph.rho_p.json
Design: FluidPropertiesInterrogator
Issue(s): #13741
- F6.2.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: fp_interrogator:1ph.rho_rhou_rhoE
Design: FluidPropertiesInterrogator
Issue(s): #12995
- F6.2.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: fp_interrogator:1ph.rho_rhou_rhoE.json
Design: FluidPropertiesInterrogator
Issue(s): #13741
- F6.2.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: fp_interrogator:2ph.p_T
Design: FluidPropertiesInterrogator
Issue(s): #12995
- F6.2.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: fp_interrogator:2ph.p_T.json
Design: FluidPropertiesInterrogator
Issue(s): #13741
- F6.2.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: fp_interrogator:2ph_ncg_p_T
Design: FluidPropertiesInterrogator
Issue(s): #12995
- F6.2.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: fp_interrogator:2ph_ncg_p_T.json
Design: FluidPropertiesInterrogator
Issue(s): #13741
- F6.2.13The fluid properties interrogator shall output static-state, single-phase fluid properties for (rho, e) input with a vapor mixture fluid properties object.
Specification: fp_interrogator:vapor_mixture_rho_e
Design: FluidPropertiesInterrogator
Issue(s): #12995
- F6.2.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: fp_interrogator:vapor_mixture_rho_e.json
Design: FluidPropertiesInterrogator
Issue(s): #13741
- F6.2.15The fluid properties interrogator shall output two-phase fluid properties for (p) input with a two-phase fluid properties object.
Specification: fp_interrogator:2ph_p
Design: FluidPropertiesInterrogator
Issue(s): #12995
- F6.2.16The fluid properties interrogator shall output two-phase fluid properties for (p) input with a two-phase fluid properties object in JSON format.
Specification: fp_interrogator:2ph_p.json
Design: FluidPropertiesInterrogator
Issue(s): #13741
- F6.2.17The fluid properties interrogator shall output two-phase fluid properties for (T) input with a two-phase fluid properties object.
Specification: fp_interrogator:2ph_T
Design: FluidPropertiesInterrogator
Issue(s): #12995
- F6.2.18The fluid properties interrogator shall output two-phase fluid properties for (T) input with a two-phase fluid properties object in JSON format.
Specification: fp_interrogator:2ph_T.json
Design: FluidPropertiesInterrogator
Issue(s): #13741
- F6.2.19The fluid properties interrogator shall throw an error if an incompatible fluid properties object is supplied.
Specification: fp_interrogator:err.wrong_fp_type
Design: FluidPropertiesInterrogator
Issue(s): #12995
- F6.2.20The fluid properties interrogator shall throw an error if an extraneous parameter(s) are supplied.
Specification: fp_interrogator:err.extraneous_parameter
Design: FluidPropertiesInterrogator
Issue(s): #12995
- F6.2.21The fluid properties interrogator shall throw an error if an no valid input sets were supplied.
Specification: fp_interrogator:err.no_params
Design: FluidPropertiesInterrogator
Issue(s): #12995
- fluid_properties: NaNInterface
- F6.3.1The system should produce a warning when a NaN is produced and user required that the execution would not terminate
Specification: interfaces/nan_interface:quiet_nan
Design: NaNInterface
- F6.3.2The system should report an error when a NaN is produced by a computation in DEBUG mode, by default
Specification: interfaces/nan_interface:signaling_nan_dbg
Design: NaNInterface
- F6.3.3The system should not report an error when a NaN is produced by a computation in OPT mode, by default
Specification: interfaces/nan_interface:signaling_nan_opt
Design: NaNInterface