Thermal Hydraulics System Requirements Specification
This template follows INL template TEM-135, "IT System Requirements Specification".
This document serves as an addendum to Framework System Requirements Specification and captures information for SRS specific to the Thermal Hydraulics module.
- Framework System Requirements Specification
- Fluid Properties System Requirements Specification
- Heat Conduction System Requirements Specification
- Navier Stokes System Requirements Specification
- Misc System Requirements Specification
- Ray Tracing System Requirements Specification
- Reconstructed Discontinuous Galerkin System Requirements Specification
- Solid Properties System Requirements Specification
Introduction
System Purpose
The purpose of the MOOSE Thermal Hydraulics module is to provide capability for performing system-level thermal hydraulic simulations in MOOSE. This capability provides a convenient means of developing a system of connected components on multiple domains, focused primarily on low-fidelity (one-dimensional and two-dimensional) models. This allows large, complex systems, such as those present in reactor systems, to be modeled without impractical computational resources.
System Scope
The MOOSE Thermal Hydraulics module provides several additional systems, including a component system, a closures system, and a control logic system. The module includes basic components such as two-dimensional and three-dimensional heat structures, which solve the transient heat conduction equation, along with components that provide heat sources, boundary conditions, and interface conditions to these components. The module also includes a suite of components for solving single-phase flow, using numerical methods most suitable for compressible gas flows. These single-phase flow components include flow channels, junctions, valves, walls, and inlets/outlets. Additionally, the module provides turbomachinery components such as a shaft, motor, compressor, and turbine. In addition to components, the module provides basic closures for the single-phase flow model, as well as control logic objects such as delays, trips, and PID controllers.
System Overview
System Context
The Thermal Hydraulics 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 Thermal Hydraulics 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 Thermal Hydraulics module and other MOOSE-based applications.
System Functions
Since the Thermal Hydraulics 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 Thermal Hydraulics 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 Thermal Hydraulics module:
Thermal Hydraulics module Developers: These are the core developers of the Thermal Hydraulics 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 Thermal Hydraulics 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 Thermal Hydraulics 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 Thermal Hydraulics module is developed using MOOSE and can itself be based on various MOOSE modules, as such the SRS for the Thermal Hydraulics 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 Thermal Hydraulics module is designed with the fewest possible constraints on hardware and software. For more context on this point, the Thermal Hydraulics module SRS defers to the framework Assumptions and Dependencies. Any physics-based or mathematics-based assumptions in code simulations and code objects are highlighted in their respective documentation pages.
References
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
Acronym | Description |
---|---|
INL | Idaho National Laboratory |
LGPL | GNU Lesser General Public License |
MOOSE | Multiphysics Object Oriented Simulation Environment |
NQA-1 | Nuclear Quality Assurance Level 1 |
POSIX | Portable Operating System Interface |
SRS | Software 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
- thermal_hydraulics: Actions
- 21.1.1The system shall be able to couple solid heat conduction region to a 1-D flow channel via convective heat transfer
- Without sub-app positions provided.
- With sub-app positions provided.
- With multiple phases.
- 21.1.2The system shall report an error for the coupled heat transfer action if the mesh is not aligned with the x, y, or z axis.
- thermal_hydraulics: Auxkernels
- 21.2.1The system shall compute convective heat flux between fluid and wall temperature for 1-phase flow
- 21.2.2
- 21.2.3
- 21.2.4
- 21.2.5
- 21.2.6
- 21.2.7
- thermal_hydraulics: Base
- 21.3.1The system shall allow nesting components into groups in input files
- 21.3.2
- 21.3.3
- thermal_hydraulics: Closures
- 21.4.1
- 21.4.2
- 21.4.3
- 21.4.4
- thermal_hydraulics: Components
- 21.5.1
- 21.5.2
- 21.5.3The system shall report an error if the FreeBoundary component is used.
- 21.5.4The system shall report an error if the GateValve component is used.
- 21.5.5The system shall report an error if the SolidWall component is used.
- 21.5.6The system shall report an error if the JunctionOneToOne component is used.
- 21.5.7The system shall report an error if the HeatGeneration component is used.
- 21.5.8The system shall report an error if the HeatSourceVolumetric component is used.
- 21.5.9The system shall report an error if the PrescribedReactorPower component is used.
- 21.5.10
- 21.5.11The system shall generate a mesh for the FileMeshComponent test.
- 21.5.12The system shall provide a component that loads a mesh from an ExodusII file.
- 21.5.13The system shall report an error for FileMeshComponent when the file is not readable.
- 21.5.14
- 21.5.15
- 21.5.16
- 21.5.17
- 21.5.18
- 21.5.19The system shall generate a mesh for the FlowComponentNS tests.
- 21.5.20The system shall model the porous, incompressible Navier-Stokes equations with a finite volume discretization, using a component.
- 21.5.21
- 21.5.22
- 21.5.23
- 21.5.24
- 21.5.25
- 21.5.26
- 21.5.27
- 21.5.28
- 21.5.29
- 21.5.30
- 21.5.31
- 21.5.32
- 21.5.33
- 21.5.34
- 21.5.35
- 21.5.36The system shall provide the heat source shape when power density is supplied
- 21.5.37
- 21.5.38
- 21.5.39
- 21.5.40The system shall provide the heat source shape for a cylindrical heat structure when power component and power shape function are supplied
- 21.5.41The system shall provide the heat source shape for a plate heat structure when power component and power shape function are supplied
- 21.5.42
- 21.5.43
- 21.5.44
- 21.5.45
- 21.5.46
- 21.5.47
- 21.5.48
- 21.5.49
- 21.5.50
- 21.5.51The system shall be able to couple two 2D cylindrical heat structures.
- 21.5.52The system shall be able to couple two 2D plate heat structures.
- 21.5.53The system shall be able to couple two 2D cylindrical heat structures on separated surfaces.
- 21.5.54The system shall report an error for HeatStructure2DCoupler when
- the provided heat structure boundary does not exist.
- the types of the coupled heat structures do not match.
- the types of either coupled heat structure is invalid.
- the boundary meshes are not aligned.
- 21.5.55The system shall be able to couple two 2D cylindrical heat structures via radiation and conserve energy.
- 21.5.56The system shall report an error for HeatStructure2DRadiationCouplerRZ when
- the provided heat structure boundary does not exist.
- the type of either coupled heat structure is invalid.
- the boundary meshes are not aligned.
- 21.5.57
- 21.5.58
- 21.5.59
- 21.5.60
- 21.5.61
- 21.5.62
- 21.5.63
- 21.5.64
- 21.5.65
- 21.5.66
- 21.5.67
- 21.5.68
- 21.5.69
- 21.5.70
- 21.5.71
- 21.5.72
- 21.5.73
- 21.5.74
- 21.5.75
- 21.5.76
- 21.5.77
- 21.5.78
- 21.5.79
- 21.5.80
- 21.5.81
- 21.5.82
- 21.5.83The system shall be able to couple a flow channel and heat structure aligned with the x-axis.
- 21.5.84The system shall be able to couple a flow channel and heat structure with non-uniform meshes and opposite directions.
- 21.5.85The system shall be able to couple a flow channel and heat structure aligned with the y-axis.
- 21.5.86The system shall be able to couple a flow channel and heat structure aligned with the z-axis.
- 21.5.87The system shall conserve energy when a flow channel is coupled to a plate heat structure.
- 21.5.88The system shall conserve energy when a flow channel is coupled to a cylindrical heat structure.
- 21.5.89The system shall conserve energy when a flow channel is coupled to several heat structures.
- 21.5.90The system shall conserve energy after reaching steady-state when a flow channel is coupled to a heat structure.
- 21.5.91The system shall throw an error if the flow channel component is not of type 'FlowChannelBase'.
- 21.5.92The system shall throw an error if the heat structure component is not of type 'HeatStructureBase'.
- 21.5.93The system shall throw an error if the provided heat structure side is invalid.
- 21.5.94The system shall throw an error if the heat structure and flow channel components don't have the same number of axial elements.
- 21.5.95The system shall throw an error if the heat structure and flow channel components don't have the same length.
- 21.5.96The system shall throw an error if the center of the elements of the flow channel component don't align with the centers of the specified heat structure side.
- 21.5.97The system shall throw an error if the coupled flow channel and heat structure components don't have the same orientation.
- 21.5.98The system shall throw an error if the flow channel is coupled to the inner side of a heat structure that has a zero inner radius.
- 21.5.99The system shall throw an error if the heat transfer coefficient is not specified with simple closures.
- 21.5.100The system shall compute jacobians when a flow channel is coupled to the outer side of a cylindrical heat structure.
- 21.5.101The system shall compute jacobians when a flow channel is coupled to the inner side of a cylindrical heat structure.
- 21.5.102The system shall compute jacobians when a flow channel is coupled to the outer side of a plate heat structure.
- 21.5.103The system shall compute jacobians when a flow channel is coupled to the inner side of a plate heat structure.
- 21.5.104The system shall conserve energy when using HeatTransferFromHeatStructure3D1Phase.
- 21.5.105The system shall allow to connect multiple flow channels to a single boundary in HeatTransferFromHeatStructure3D1Phase.
- 21.5.106The system shall allow to connect flow channels that have negative orientation to a HeatTransferFromHeatStructure3D1Phase component.
- 21.5.107The system shall throw an error if a flow channel connected to a HeatTransferFromHeatStructure3D1Phase component is not a FlowChannel1Phase.
- 21.5.108The system shall throw an error if a flow channel connected to a HeatTransferFromHeatStructure3D1Phase component is not aligned with the x-, y-, or z- axis.
- 21.5.109The system shall throw an error if the heat structure connected to a HeatTransferFromHeatStructure3D1Phase component is not a HeatStructureFromFile3D component.
- 21.5.110The system shall throw an error if the heat structure boundary connected to a HeatTransferFromHeatStructure3D1Phase component doesn't exist.
- 21.5.111The system shall throw an error if the flow channels connected to a HeatTransferFromHeatStructure3D1Phase component are not aligned with the same axis.
- 21.5.112The system shall throw an error if the flow channels connected to a HeatTransferFromHeatStructure3D1Phase component don't have the same lnumber of elements.
- 21.5.113The system shall throw an error if the flow channels connected to a HeatTransferFromHeatStructure3D1Phase component don't have the same length.
- 21.5.114The system shall correctly compute Jacobians for HeatTransferFromHeatStructure3D1Phase.
- 21.5.115
- 21.5.116
- 21.5.117
- 21.5.118
- 21.5.119
- 21.5.120
- 21.5.121
- 21.5.122
- 21.5.123
- 21.5.124
- 21.5.125
- 21.5.126
- 21.5.127
- 21.5.128
- 21.5.129
- 21.5.130
- 21.5.131
- 21.5.132
- 21.5.133
- 21.5.134
- 21.5.135
- 21.5.136
- 21.5.137
- 21.5.138
- 21.5.139
- 21.5.140
- 21.5.141
- 21.5.142
- 21.5.143
- 21.5.144
- 21.5.145
- 21.5.146
- 21.5.147
- 21.5.148
- 21.5.149
- 21.5.150
- 21.5.151
- 21.5.152
- 21.5.153
- 21.5.154
- 21.5.155
- 21.5.156
- 21.5.157
- 21.5.158
- 21.5.159
- 21.5.160
- 21.5.161
- 21.5.162
- 21.5.163
- 21.5.164
- 21.5.165
- 21.5.166
- 21.5.167
- 21.5.168
- 21.5.169
- 21.5.170
- 21.5.171
- 21.5.172The system shall allow for controlling the pump head
- 21.5.173The system shall allow for controlling the pump head
- 21.5.174
- 21.5.175The system shall conserve mass and energy when using ShaftConnectedCompressor1Phase.
- 21.5.176The system shall be able to model a compressor with ShaftConnectedCompressor1Phase.
- 21.5.177The system shall allow ShaftConnectedCompressor1Phase to run with a zero shaft speed.
- 21.5.178The system shall correctly compute Jacobians for ShaftConnectedCompressor1Phase.
- 21.5.179The system shall throw an error if ShaftConnectedCompressor1Phase is not connected to a shaft component.
- 21.5.180The system shall throw an error if the initial shaft speed is not provided and the application is not restarting.
- 21.5.181The system shall throw an error if ShaftConnectedMotor is not connected to a shaft component.
- 21.5.182The system shall be able to model a motor connected to a shaft.
- 21.5.183The system shall be able to execute a restart a simulation involving a shaft-connected motor.
- 21.5.184The system shall allow the torque of a shaft-connected motor to be controlled.
- 21.5.185The system shall allow the inertia of a shaft-connected motor to be controlled.
- 21.5.186The system shall conserve mass and energy when using ShaftConnectedPump1Phase.
- 21.5.187The system shall be able to model a pump with ShaftConnectedPump1Phase.
- 21.5.188The system shall be able to model a pump coastdown with ShaftConnectedPump1Phase.
- 21.5.189The system shall correctly compute Jacobians for ShaftConnectedPump1Phase.
- 21.5.190The system shall throw an error if ShaftConnectedPump1Phase is not connected to a shaft component.
- 21.5.191
- 21.5.192The system shall conserve mass and energy when using ShaftConnectedTurbine1Phase.
- 21.5.193The system shall be able to model a turbine with ShaftConnectedTurbine1Phase.
- 21.5.194The system shall be able to model a turbine startup with ShaftConnectedTurbine1Phase.
- 21.5.195The system shall correctly compute Jacobians for ShaftConnectedTurbine1Phase.
- 21.5.196The system shall throw an error if ShaftConnectedTurbine1Phase is not connected to a shaft component.
- 21.5.197
- 21.5.198
- 21.5.199
- 21.5.200
- 21.5.201
- 21.5.202
- 21.5.203The system shall report an error if the SupersonicInlet component is used.
- 21.5.204
- 21.5.205
- 21.5.206The system shall be able model a flow junction to connect:
- 2 pipes of equal area in the x direction,
- 2 pipes of equal area not in the x direction,
- 2 pipes of unequal area,
- 3 pipes, 1 of which going to a dead-end,
- 2 pipes with different temperatures mixing together into a third pipe with correct syntax,
- 2 pipes with different temperatures mixing together into a third pipe with correct results,
- pipes with the calorically imperfect gas fluid properties,
- 21.5.207The system shall allow the user to prescribe form losses in the volume jucntion component:
- by specifying a constant loss coefficient and using the area of the first connected pipe,
- by specifying a constant loss coefficient and a reference flow area, and
- by specifying the loss coefficient through the control system.
- 21.5.208The system shall conserve mass and energy when a VolumJunction1Phase component is used
- 21.5.209The system shall throw an error if initial conditions for the VolumeJunction1Phase component are missing.
- 21.5.210The system shall throw an error if the parameter "A_ref" is specifed and the paramter "K" is not specified.
- thermal_hydraulics: Controls
- 21.6.1
- 21.6.2
- 21.6.3
- 21.6.4
- 21.6.5
- 21.6.6
- 21.6.7The system shall provide a control that evaluates a parsed function
- 21.6.8
- 21.6.9
- 21.6.10
- 21.6.11
- 21.6.12
- 21.6.13
- 21.6.14
- 21.6.15
- 21.6.16
- 21.6.17The system shall provide a unit trip component that report true if the trip condition was met and false otherwise.
- 21.6.18The system shall provide a unit trip component that stays in tripped state after the trip happened.
- 21.6.19The system shall report an error when an unit trip condition does not evaluate as boolean value.
- thermal_hydraulics: Functions
- 21.7.1
- 21.7.2
- 21.7.3
- 21.7.4
- 21.7.5
- 21.7.6
- 21.7.7
- 21.7.8
- thermal_hydraulics: Interfaces
- 21.8.1The system shall provide an interface to compute an axial coordinate from an arbitrary spatial point.
- 21.8.2The system shall provide an interface to compute a radial coordinate from an arbitrary spatial point.
- 21.8.3The system shall provide an interface to get the axial section index for an arbitrary spatial point.
- 21.8.4The system shall provide an interface to get the axial element index for an arbitrary spatial point.
- 21.8.5The system shall report an error for the discrete line segment interface
- if an invalid axial coordinate is provided.
- thermal_hydraulics: Jacobians
- 21.9.1
- 21.9.2
- 21.9.3
- 21.9.4
- 21.9.5
- 21.9.6
- 21.9.7
- 21.9.8
- 21.9.9
- 21.9.10
- 21.9.11
- 21.9.12
- 21.9.13
- 21.9.14
- 21.9.15
- 21.9.16
- 21.9.17
- 21.9.18
- 21.9.19
- 21.9.20
- 21.9.21
- 21.9.22
- 21.9.23
- 21.9.24
- 21.9.25
- 21.9.26
- 21.9.27
- 21.9.28
- 21.9.29
- 21.9.30
- 21.9.31
- 21.9.32
- 21.9.33
- 21.9.34
- 21.9.35
- 21.9.36
- 21.9.37
- thermal_hydraulics: Materials
- 21.10.1
- 21.10.2
- 21.10.3
- 21.10.4
- 21.10.5
- 21.10.6
- 21.10.7
- 21.10.8
- 21.10.9
- 21.10.10
- 21.10.11
- 21.10.12
- 21.10.13The system shall be able to compute the convective heat transfer coefficient using the Wolf-McCarthy correlation.
- 21.10.14
- 21.10.15
- 21.10.16
- 21.10.17
- 21.10.18
- 21.10.19
- 21.10.20
- 21.10.21
- 21.10.22
- 21.10.23
- 21.10.24
- thermal_hydraulics: Misc
- 21.11.1
- 21.11.2
- 21.11.3
- 21.11.4
- 21.11.5The system shall be able to produce an exodus file for setting initial conditions in flow channels
- 21.11.6The system shall be able to use an exodus file for setting initial conditions in flow channels
- 21.11.7The system shall report an error when a block is non found in the restart ExodusII file
- 21.11.8The system shall be able to produce an exodus file for setting initial conditions in heat structures
- 21.11.9The system shall be able to use an exodus file for setting initial conditions in heat structures
- 21.11.10The system shall be able to produce an exodus file for setting initial conditions in 3D heat structures
- 21.11.11The system shall be able to use an exodus file for setting initial conditions in 3D heat structures
- 21.11.12The system shall be able to produce an exodus file for setting initial conditions in volume junctions
- 21.11.13The system shall be able to use an exodus file for setting initial conditions in volume junctions
- 21.11.14The system shall be able to produce an exodus file for setting initial conditions in heat transfer from 3D heat structures
- 21.11.15The system shall be able to use an exodus file for setting initial conditions in heat transfer from 3D heat structures
- 21.11.16The system shall be able to produce an exodus file for setting initial conditions in shaft
- 21.11.17The system shall be able to use an exodus file for setting initial conditions in shaft
- 21.11.18The system shall be able to produce an exodus file for setting initial conditions in volume junctions
- 21.11.19The system shall be able to use an exodus file for setting initial conditions in volume junctions
- 21.11.20
- 21.11.21
- 21.11.22
- 21.11.23
- 21.11.24
- 21.11.25
- 21.11.26The system shall uniform refine mesh when specifid on the command line
- thermal_hydraulics: Output
- 21.12.1The system shall be able to disable the output of scalar variables to the console.
- 21.12.2The system shall be able to allow the output of scalar variables to the console.
- 21.12.3
- 21.12.4
- thermal_hydraulics: Postprocessors
- 21.13.1This system shall compute an RZ integral of a material property.
- 21.13.2
- 21.13.3
- 21.13.4The system should report an error when users set subdomain-restricted RZ-symmtrical THM-specific objects on RZ-subdomains.
- 21.13.5
- 21.13.6The system should error out when users set boundary-restricted RZ-symmtrical THM-specific objects on RZ-subdomains.
- 21.13.7The system shall compute the heat conduction rate across an RZ boundary.
- 21.13.8
- 21.13.9
- 21.13.10
- 21.13.11
- 21.13.12The system shall compute the heat rate for a user-provided heat flux function.
- 21.13.13The system shall compute the heat rate for a user-provided heat flux function for a cylindrical boundary.
- 21.13.14
- 21.13.15
- 21.13.16
- 21.13.17
- 21.13.18
- 21.13.19
- 21.13.20The system shall provide a post-processor to retrieve the torque and moment of inertia from a shaft-connected component.
- 21.13.21
- 21.13.22The system shall compute specific impulse from conditions on a boundary
- thermal_hydraulics: Problems
- 21.14.1
- 21.14.2
- 21.14.3The system shall be able to model an open Brayton cycle
- 21.14.4The system shall be able to model a closed Brayton cycle
- 21.14.5The system shall be able to model an open recuperated Brayton cycle
- 21.14.6
- 21.14.7
- 21.14.8The system shall produce an accurate solution to the Lax shock tube benchmark problem
- using an explicit temporal discretization, and
- using an implicit temporal discretization.
- 21.14.9
- 21.14.10The system shall simulate a natural circulation loop using flow channels and junctions.
- 21.14.11The system shall compute a pressure drop solution
- without a junction, and
- with a junction.
- 21.14.12
- 21.14.13
- 21.14.14
- 21.14.15
- 21.14.16
- 21.14.17
- 21.14.18
- 21.14.19
- 21.14.20
- 21.14.21
- 21.14.22
- thermal_hydraulics: Scalarkernels
- 21.15.1
- 21.15.2
- thermal_hydraulics: Userobjects
- 21.16.1
- 21.16.2
- 21.16.3The system shall allow computing changes in channel flow areas from deformation.
- thermal_hydraulics: Utils
- 21.17.1
- 21.17.2
- 21.17.3
- 21.17.4
- 21.17.5
- 21.17.6
- thermal_hydraulics: Vectorpostprocessors
- 21.18.1The system shall provide a vector post-processor to sample regular material properties in one or more blocks.
- 21.18.2The system shall provide a vector post-processor to sample AD material properties in one or more blocks.
- 21.18.3The system shall report an error if a non-existent material property is requested for the block material property sampler vector post-processor.
- 21.18.4
Usability Requirements
No requirements of this type exist for this application, beyond those of its dependencies.Performace 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 Thermal Hydraulics 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 Thermal Hydraulics module) does support optional coloring within the terminal's ability to display color, which may be disabled.
Maintainablity
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 Thermal Hydraulics module source code. As a MOOSE physics module, the license for the Thermal Hydraulics 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 90% of all lines of code within the Thermal Hydraulics module at all times. Known regressions will be recorded and tracked (see Maintainablity) 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 Flag | Description 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 |
--yaml | Output all object descriptions and available parameters in YAML format |
--json | Output all object descriptions and available parameters in JSON format |
--syntax | Output all registered syntax |
--registry | Output all known objects and actions |
--registry-hit | Output 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 |
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 Thermal Hydraulics module is software only with no associated physical media. See System Requirements for a description of the minimum required hardware necessary for running the Thermal Hydraulics module.
Environmental Conditions
Not Applicable
System Security
MOOSE-based applications such as the Thermal Hydraulics 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 Thermal Hydraulics 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 Thermal Hydraulics module source code. However, some MOOSE-based applications that use the Thermal Hydraulics 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.