Stochastic Tools 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 Software Design Description (SDD) specific to the Stochastic Tools application.
Introduction
Frameworks are a software development construct aiming to simplify the creation of specific classes of applications through abstraction of low-level details. The main object of creating a framework is to provide an interface to application developers that saves time and provides advanced capabilities not attainable otherwise. The MOOSE, mission is just that: provide a framework for engineers and scientists to build state-of-the-art, computationally scalable finite element based simulation tools.
MOOSE was conceived with one major objective: to be as easy and straightforward to use by scientists and engineers as possible. MOOSE is meant to be approachable by non-computational scientists who have systems of partial differential equations (PDEs) they need to solve. Every single aspect of MOOSE was driven by this singular principle from the build system to the API to the software development cycle. At every turn, decisions were made to enable this class of users to be successful with the framework. The pursuit of this goal has led to many of the unique features of MOOSE:
A streamlined build system
An API aimed at extensible
Straightforward APIs providing sensible default information
Integrated, automatic, and rigorous testing
Rapid, continuous integration development cycle
Codified, rigorous path for contributing
Applications are modular and composable
Each of these characteristics is meant to build trust in the framework by those attempting to use it. For instance, the build system is the first thing potential framework users come into contact with when they download a new software framework. Onerous dependency issues, complicated, hard to follow instructions or build failure can all result in a user passing on the platform. Ultimately, the decision to utilize a framework comes down to whether or not you trust the code in the framework and those developing it to be able to support your desired use-case. No matter the technical capabilities of a framework, without trust users will look elsewhere. This is especially true of those not trained in software development or computational science.
Developing trust in a framework goes beyond utilizing "best practices" for the code developed, it is equally important that the framework itself is built upon tools that are trusted. For this reason, MOOSE relies on a well-established code base of libMesh and PETSc. The libMesh library provides foundational capability for the finite element method and provides interfaces to leading-edge numerical solution packages such as PETSc.
With these principles in mind, an open source, massively parallel, finite element, multiphysics framework has been conceived. MOOSE is an on-going project started in 2008 aimed toward a common platform for creation of new multiphysics tools. This document provides design details pertinent to application developers as well as framework developers.
Use Cases
The MOOSE Framework is targeted at two main groups of actors: Developers and Users. Developers are the main use case. These are typically students and professionals trained in science and engineering fields with some level of experience with coding but typically very little formal software development training. The other user group is Users. Those who intend to use an application built upon the framework without writing any computer code themselves. Instead they may modify or create input files for driving a simulation, run the application, and analyze the results. All interactions through MOOSE are primarily through the command-line interface and through a customizable block-based input file.
System Purpose
The Software Design Description provided here is description of each object in the system. The pluggable architecture of the framework 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 framework, modules and derivative applications. More information about the design documentation can be found in Documenting MOOSE.
System Scope
The purpose of this software is to provide several libraries that can be used to build an application based upon the framework. Additionally, several utilities are provided for assisting developers and users in end-to-end FEM analysis. A brief overview of the major components are listed here:
Component | Description |
---|---|
framework library | The base system from which all MOOSE-based applications are created |
module libraries | Optional "physics" libraries that may be used in an application to provide capability |
build system | The system responsible for creating applications for a series of libraries and applications |
test harness | The extendable testing system for finding, scheduling, running, and reporting regression tests |
"peacock" | The graphical user interface (GUI) for building input files, executing applications, and displaying results |
MooseDocs | The extendable markdown system for MOOSE providing common documentation and requirements enforcement |
"stork" | The script and templates for generating a new MOOSE-based application ready for building and testing |
examples | A set of complete applications demonstrating the use of MOOSE's pluggable systems |
tutorials | Step by step guides to building up an application using MOOSE's pluggable systems |
unit | An application for unit testing individual classes or methods of C++ code |
Dependencies and Limitations
The MOOSE platform has several dependencies on other software packages and has scope that is constantly evolving based upon funding, resources, priorities, and lab direction. However, the software is open-source and many features and even bugs can be offloaded to developers with appropriate levels of knowledge and direction from the main design team. The primary list of software dependencies is listed below. This list is not meant to be exhaustive. Individual operating systems may require specific packages to be installed prior to using MOOSE, which can be found on the Install MOOSE pages.
Software Dependency | Description |
---|---|
libMesh | Finite Element Library and I/O routines |
PETSc | Solver Package |
hypre | Multigrid Preconditioner |
MPI | A distributed parallel processing library (MPICH) |

Figure 1: A diagram of the MOOSE code platform.
References
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 |
FEM | Finite Element Method |
GUI | graphical user interface |
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 |
PDEs | partial differential equations |
SDD | Software Design Description |
Design Stakeholders and Concerns
Design Stakeholders
Stakeholders for MOOSE include several of the funding sources including Department of Energy, Nuclear Energy (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, MOOSE 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, MOOSE 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 MOOSE framework itself is composed of a wide range of pluggable systems. Each system is generally composed of a single or small set of C++ objects intended to be specialized by a Developer to solve a specific problem. To accomplish this design goal, MOOSE uses several modern object-oriented design patterns. The primary overarching pattern is the "Factory Pattern". Users needing to extend MOOSE may inherit from one of MOOSE's systems to providing an implementation meeting his or her needs. The design of each of these systems is documented on the mooseframework.org wiki in the Tutorial section. Additionally, up-to-date documentation extracted from the source is maintained on the the mooseframework.org documentation site after every successful merge to MOOSE's stable branch. After these objects are created, the can be registered with the framework and used immediately in a MOOSE input file.
System Structure
The MOOSE framework architecture consists of a core and several pluggable systems. 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 exist for every simulation configuration that the framework is capable of running.
Adaptivity
Adaptivity/Indicators
Adaptivity/Markers
AuxKernels
AuxKernels/MatVecRealGradAuxKernel
AuxKernels/MaterialVectorAuxKernel
AuxKernels/MaterialVectorGradAuxKernel
AuxScalarKernels
AuxVariables
AuxVariables/MultiAuxVariables
BCs
BCs/CavityPressure
BCs/CoupledPressure
BCs/InclinedNoDisplacementBC
BCs/Periodic
BCs/Pressure
Bounds
Closures
Components
Constraints
Contact
ControlLogic
Controls
CoupledHeatTransfers
Covariance
DGKernels
Dampers
Debug
Debug/MaterialDerivativeTest
DeprecatedBlock
DiracKernels
Distributions
DomainIntegral
Executioner
Executioner/Adaptivity
Executioner/Predictor
Executioner/Quadrature
Executioner/TimeIntegrator
Executioner/TimeStepper
Executors
FVBCs
FVInterfaceKernels
FVKernels
FluidPropertiesInterrogator
Functions
GeochemicalModelInterrogator
GlobalParams
GrayDiffuseRadiation
HeatStructureMaterials
ICs
ICs/PolycrystalICs
ICs/PolycrystalICs/BicrystalBoundingBoxIC
ICs/PolycrystalICs/BicrystalCircleGrainIC
ICs/PolycrystalICs/PolycrystalColoringIC
ICs/PolycrystalICs/PolycrystalRandomIC
ICs/PolycrystalICs/PolycrystalVoronoiVoidIC
ICs/PolycrystalICs/Tricrystal2CircleGrainsIC
InterfaceKernels
Kernels
Kernels/CHPFCRFFSplitKernel
Kernels/DynamicTensorMechanics
Kernels/HHPFCRFFSplitKernel
Kernels/PFCRFFKernel
Kernels/PolycrystalElasticDrivingForce
Kernels/PolycrystalKernel
Kernels/PolycrystalStoredEnergy
Kernels/PoroMechanics
Kernels/RigidBodyMultiKernel
Kernels/TensorMechanics
Materials
Mesh
Mesh/Partitioner
Modules
Modules/CompressibleNavierStokes
Modules/FluidProperties
Modules/HeatConduction
Modules/HeatConduction/ThermalContact
Modules/HeatConduction/ThermalContact/BC
Modules/IncompressibleNavierStokes
Modules/NavierStokesFV
Modules/Peridynamics
Modules/Peridynamics/Mechanics
Modules/Peridynamics/Mechanics/GeneralizedPlaneStrain
Modules/Peridynamics/Mechanics/Master
Modules/PhaseField
Modules/PhaseField/Conserved
Modules/PhaseField/DisplacementGradients
Modules/PhaseField/EulerAngles2RGB
Modules/PhaseField/GrainGrowth
Modules/PhaseField/GrandPotential
Modules/PhaseField/Nonconserved
Modules/PorousFlow
Modules/PorousFlow/BCs
Modules/TensorMechanics
Modules/TensorMechanics/CohesiveZoneMaster
Modules/TensorMechanics/DynamicMaster
Modules/TensorMechanics/GeneralizedPlaneStrain
Modules/TensorMechanics/GlobalStrain
Modules/TensorMechanics/LineElementMaster
Modules/TensorMechanics/Master
Modules/TensorMechanics/MaterialVectorBodyForce
MortarGapHeatTransfer
MultiApps
NodalKernels
NodalNormals
Outputs
PorousFlowBasicTHM
PorousFlowFullySaturated
PorousFlowUnsaturated
Postprocessors
Preconditioning
Problem
RayBCs
RayKernels
ReactionNetwork
ReactionNetwork/AqueousEquilibriumReactions
ReactionNetwork/SolidKineticReactions
Reporters
Samplers
ScalarKernels
SpatialReactionSolver
StochasticTools
Surrogates
ThermalContact
TimeDependentReactionSolver
TimeIndependentReactionSolver
Trainers
Transfers
UserObjects
Variables
Variables/CHPFCRFFSplitVariables
Variables/HHPFCRFFSplitVariables
Variables/PFCRFFVariables
Variables/PolycrystalVariables
VectorPostprocessors
XFEM
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 it's 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 the mooseframework.org wiki. Each of these systems has 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 on the Github.org website.
Data Design and Control
At a high level, the system is designed to process Hierarchical Input Text (HIT) input files to construct several objects that will constitute an finite element (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
MOOSE is a command-line driven program. All interaction with MOOSE and MOOSE-based codes is ultimately done through the command line. This is typical for High Performance Computing (HPC) applications that use the Message Passing Interface (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 Input/Output (I/O) or through local Application Programming Interface (API) calls. Neither the framework, nor the 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 framework 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
- stochastic_tools: Uniform
- 3.1.1The system shall provide distribution function including
- uniform,
- Weibull (3 parameter),
- Kernel Density 1D with a Gaussian kernel and data file as input,
- Kernel Density 1D with a Uniform kernel and data file as input,
- Kernel Density 1D with a Gaussian kernel and data vector as input,
- Kernel Density 1D with a Gaussian kernel and user defined bandwidth,
- Kernel Density 1D with a Gaussian kernel and standard deviation as bandwidth,
- normal,
- truncated normal,
- lognormal,
- Johnson Special Bounded (SB), and
- logistic distributions.
Specification(s): distributions/uniform, distributions/weibull, distributions/kernel1d_gaussian, distributions/kernel1d_uniform, distributions/kernel1d_datvec, distributions/kernel1d_userbw, distributions/kernel1d_sdbw, distributions/normal, distributions/truncated_normal, distributions/lognormal, distributions/johnsonsb, distributions/logistic
Design: UniformWeibullNormalTruncatedNormalJohnsonSBLogistic
Issue(s): #12720
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- stochastic_tools: Weibull
- 3.1.1The system shall provide distribution function including
- uniform,
- Weibull (3 parameter),
- Kernel Density 1D with a Gaussian kernel and data file as input,
- Kernel Density 1D with a Uniform kernel and data file as input,
- Kernel Density 1D with a Gaussian kernel and data vector as input,
- Kernel Density 1D with a Gaussian kernel and user defined bandwidth,
- Kernel Density 1D with a Gaussian kernel and standard deviation as bandwidth,
- normal,
- truncated normal,
- lognormal,
- Johnson Special Bounded (SB), and
- logistic distributions.
Specification(s): distributions/uniform, distributions/weibull, distributions/kernel1d_gaussian, distributions/kernel1d_uniform, distributions/kernel1d_datvec, distributions/kernel1d_userbw, distributions/kernel1d_sdbw, distributions/normal, distributions/truncated_normal, distributions/lognormal, distributions/johnsonsb, distributions/logistic
Design: UniformWeibullNormalTruncatedNormalJohnsonSBLogistic
Issue(s): #12720
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- stochastic_tools: Normal
- 3.1.1The system shall provide distribution function including
- uniform,
- Weibull (3 parameter),
- Kernel Density 1D with a Gaussian kernel and data file as input,
- Kernel Density 1D with a Uniform kernel and data file as input,
- Kernel Density 1D with a Gaussian kernel and data vector as input,
- Kernel Density 1D with a Gaussian kernel and user defined bandwidth,
- Kernel Density 1D with a Gaussian kernel and standard deviation as bandwidth,
- normal,
- truncated normal,
- lognormal,
- Johnson Special Bounded (SB), and
- logistic distributions.
Specification(s): distributions/uniform, distributions/weibull, distributions/kernel1d_gaussian, distributions/kernel1d_uniform, distributions/kernel1d_datvec, distributions/kernel1d_userbw, distributions/kernel1d_sdbw, distributions/normal, distributions/truncated_normal, distributions/lognormal, distributions/johnsonsb, distributions/logistic
Design: UniformWeibullNormalTruncatedNormalJohnsonSBLogistic
Issue(s): #12720
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.1.2The system shall provide a normal distribution with the ability to directly call methods with distribution inputs.
Specification(s): normal_direct
Design: Normal
Issue(s): #12720
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.1.3The system shall produce an error if a distribution is retrieved with the differing type than supplied.
Specification(s): normal_direct_type_error
Design: Normal
Issue(s): #12720
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- stochastic_tools: TruncatedNormal
- 3.1.1The system shall provide distribution function including
- uniform,
- Weibull (3 parameter),
- Kernel Density 1D with a Gaussian kernel and data file as input,
- Kernel Density 1D with a Uniform kernel and data file as input,
- Kernel Density 1D with a Gaussian kernel and data vector as input,
- Kernel Density 1D with a Gaussian kernel and user defined bandwidth,
- Kernel Density 1D with a Gaussian kernel and standard deviation as bandwidth,
- normal,
- truncated normal,
- lognormal,
- Johnson Special Bounded (SB), and
- logistic distributions.
Specification(s): distributions/uniform, distributions/weibull, distributions/kernel1d_gaussian, distributions/kernel1d_uniform, distributions/kernel1d_datvec, distributions/kernel1d_userbw, distributions/kernel1d_sdbw, distributions/normal, distributions/truncated_normal, distributions/lognormal, distributions/johnsonsb, distributions/logistic
Design: UniformWeibullNormalTruncatedNormalJohnsonSBLogistic
Issue(s): #12720
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- stochastic_tools: JohnsonSB
- 3.1.1The system shall provide distribution function including
- uniform,
- Weibull (3 parameter),
- Kernel Density 1D with a Gaussian kernel and data file as input,
- Kernel Density 1D with a Uniform kernel and data file as input,
- Kernel Density 1D with a Gaussian kernel and data vector as input,
- Kernel Density 1D with a Gaussian kernel and user defined bandwidth,
- Kernel Density 1D with a Gaussian kernel and standard deviation as bandwidth,
- normal,
- truncated normal,
- lognormal,
- Johnson Special Bounded (SB), and
- logistic distributions.
Specification(s): distributions/uniform, distributions/weibull, distributions/kernel1d_gaussian, distributions/kernel1d_uniform, distributions/kernel1d_datvec, distributions/kernel1d_userbw, distributions/kernel1d_sdbw, distributions/normal, distributions/truncated_normal, distributions/lognormal, distributions/johnsonsb, distributions/logistic
Design: UniformWeibullNormalTruncatedNormalJohnsonSBLogistic
Issue(s): #12720
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- stochastic_tools: Logistic
- 3.1.1The system shall provide distribution function including
- uniform,
- Weibull (3 parameter),
- Kernel Density 1D with a Gaussian kernel and data file as input,
- Kernel Density 1D with a Uniform kernel and data file as input,
- Kernel Density 1D with a Gaussian kernel and data vector as input,
- Kernel Density 1D with a Gaussian kernel and user defined bandwidth,
- Kernel Density 1D with a Gaussian kernel and standard deviation as bandwidth,
- normal,
- truncated normal,
- lognormal,
- Johnson Special Bounded (SB), and
- logistic distributions.
Specification(s): distributions/uniform, distributions/weibull, distributions/kernel1d_gaussian, distributions/kernel1d_uniform, distributions/kernel1d_datvec, distributions/kernel1d_userbw, distributions/kernel1d_sdbw, distributions/normal, distributions/truncated_normal, distributions/lognormal, distributions/johnsonsb, distributions/logistic
Design: UniformWeibullNormalTruncatedNormalJohnsonSBLogistic
Issue(s): #12720
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- stochastic_tools: RandomIC
- 3.2.1The system shall generate parallel agnostic random initial conditions using a distribution function.
Specification(s): generate
Design: RandomIC
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.2.2The system shall generate an error the random initial condition is used with both a distribution and min or max value defined.
Specification(s): test_err_distribution_and_min_max
Design: RandomIC
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- stochastic_tools: SamplerFullSolveMultiApp
- 3.3.1The system shall be able to set command line parameter(s) for sub-application that executes completely from a sample distribution for
- for a single parameter,
- for a single parameter for a batch of sub-applications,
- for multiple parameters, and
- for vector parameters for a batch of sub-applications,
- for multiple parameters for a batch of sub-applications.
- for multiple parameters using their global column indexes for a batch of sub-applications.
Specification(s): master/single_normal, master/single_batch, master/multiple_normal, master/vector, master/multiple_batch, master/multiple_batch_with_index
Design: SamplerFullSolveMultiAppMultiAppCommandLineControl
Issue(s): #13320
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.3.2The system shall error when the supplied sampler object operates in a mode that does not allow for command line arguments to be modified.
Specification(s): wrong_batch_mode
Design: SamplerFullSolveMultiAppMultiAppCommandLineControl
Issue(s): #13320
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.3.3The system shall error when the supplied sampler does not use the correct execution flags.
Specification(s): wrong_execute_on
Design: SamplerFullSolveMultiAppMultiAppCommandLineControl
Issue(s): #13320
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.3.4The system shall error when '[]' syntax is not used for all parameters.
Specification(s): vector_no_bracket
Design: SamplerFullSolveMultiAppMultiAppCommandLineControl
Issue(s): #13320
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.3.5The system shall error when provided global column index is out of bound.
Specification(s): vector_out_of_bound
Design: SamplerFullSolveMultiAppMultiAppCommandLineControl
Issue(s): #13320
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.3.6The system shall support pulling postprocessor data from a sub-application for each row of sampled data.
Specification(s): normal
Design: SamplerPostprocessorTransferSamplerFullSolveMultiApp
Issue(s): #8863
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.3.7The system shall support running sub-applications in a batches on a
- on a single processor and
- on a multiple processors.
Specification(s): batch/exodus_1, batch/exodus_2
Design: SamplerPostprocessorTransferSamplerFullSolveMultiApp
Issue(s): #8863
Collection(s): FUNCTIONAL
Type(s): CheckFiles
- 3.3.8The stochastic tools module shall support pulling postprocessor data from a single sub-application running a batch of sampled data
- on a single processor,
- on multiple processors, and
- on multiple processors using in-memory backup.
Specification(s): batch_csv/n1, batch_csv/n2, batch_csv/n2_restore
Design: SamplerPostprocessorTransferSamplerFullSolveMultiApp
Issue(s): #8863
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.3.14The system shall support the modification of the number of complete sub-application simulations performed with
- normal execution,
- batch execution with memory-based restoring, and
- batch execution with reset-based restoring.
Specification(s): dynamic/normal, dynamic/batch-restore, dynamic/batch-reset
Design: Samplers SystemSamplerFullSolveMultiApp
Issue(s): #16842
Collection(s): FUNCTIONAL
Type(s): JSONDiff
- 3.3.15The system shall error when the size of a sampler is altered an sub-applications are progressing with time with the main application.
Specification(s): error
Design: Samplers SystemSamplerFullSolveMultiApp
Issue(s): #16842
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.3.16The system shall have consistent partitioning between multiapps and sampler for full solves
- with less processors than rows in normal mode;
- with more processors than rows in normal mode;
- with specified minimum processors per app in normal mode;
- with less processors than rows in batch-reset mode;
- with more processors than rows in batch-reset mode;
- with specified minimum processors per app in batch-reset mode;
- with less processors than rows in batch-restore mode;
- with more processors than rows in batch-restore mode;
- with specified minimum processors per app in batch-restore mode;
- error when partitionings do not match;
Specification(s): full_solve/normal_less_procs, full_solve/normal_more_procs, full_solve/normal_min_procs, full_solve/reset_less_procs, full_solve/reset_more_procs, full_solve/reset_min_procs, full_solve/restore_less_procs, full_solve/restore_more_procs, full_solve/restore_min_procs, full_solve/error_min_procs
Design: SamplerFullSolveMultiApp
Issue(s): #15787
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunExceptionCSVDiff
- 3.3.18The system shall provide the ability to create a full-solve type sub-application from sampled data from distributions.
Specification(s): full_solve
Design: SamplerFullSolveMultiApp
Issue(s): #9923
Collection(s): FUNCTIONAL
Type(s): CheckFiles
- 3.3.21The system shall support performing complete solves within a sub-application that include perturbed inputs that yield repeatable results
- using normal operation;
- using in memory backup operation;
- using reset operation.
Specification(s): repeat/normal, repeat/batch-restore, repeat/batch-reset
Design: SamplerFullSolveMultiApp
Issue(s): #16476
Collection(s): FUNCTIONAL
Type(s): JSONDiff
- 3.3.22The system shall support performing complete solves within a sub-application that include perturbed inputs that yield changing results
- using normal operation;
- using in memory backup operation;
- using reset operation.
Specification(s): new/normal, new/batch-restore, new/batch-reset
Design: SamplerFullSolveMultiApp
Issue(s): #16476
Collection(s): FUNCTIONAL
Type(s): JSONDiff
- 3.3.23The system shall be able to perform stochastic simulations of steady-state models while obeying unperturbed command line arguements with:
- command line control in normal mode;
- command line control in batch mode;
- parameter transfer in normal mode;
- parameter transfer in batch-reset mode;
- parameter transfer in batch-restore mode;
Specification(s): full_solve/cmdline_normal, full_solve/cmdline_batch, full_solve/transfer_normal, full_solve/transfer_batch_reset, full_solve/transfer_batch_restore
Design: SamplerFullSolveMultiApp
Issue(s): #19105
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.5.8The system shall support generating random samples of data
- that remain constant in size and
- that are dynamic in size.
Specification(s): no_change/constant, no_change/dynamic
Design: Samplers SystemSamplerFullSolveMultiApp
Issue(s): #16842
Collection(s): FUNCTIONAL
Type(s): JSONDiff
- stochastic_tools: MultiAppCommandLineControl
- 3.3.1The system shall be able to set command line parameter(s) for sub-application that executes completely from a sample distribution for
- for a single parameter,
- for a single parameter for a batch of sub-applications,
- for multiple parameters, and
- for vector parameters for a batch of sub-applications,
- for multiple parameters for a batch of sub-applications.
- for multiple parameters using their global column indexes for a batch of sub-applications.
Specification(s): master/single_normal, master/single_batch, master/multiple_normal, master/vector, master/multiple_batch, master/multiple_batch_with_index
Design: SamplerFullSolveMultiAppMultiAppCommandLineControl
Issue(s): #13320
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.3.2The system shall error when the supplied sampler object operates in a mode that does not allow for command line arguments to be modified.
Specification(s): wrong_batch_mode
Design: SamplerFullSolveMultiAppMultiAppCommandLineControl
Issue(s): #13320
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.3.3The system shall error when the supplied sampler does not use the correct execution flags.
Specification(s): wrong_execute_on
Design: SamplerFullSolveMultiAppMultiAppCommandLineControl
Issue(s): #13320
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.3.4The system shall error when '[]' syntax is not used for all parameters.
Specification(s): vector_no_bracket
Design: SamplerFullSolveMultiAppMultiAppCommandLineControl
Issue(s): #13320
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.3.5The system shall error when provided global column index is out of bound.
Specification(s): vector_out_of_bound
Design: SamplerFullSolveMultiAppMultiAppCommandLineControl
Issue(s): #13320
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.3.11The system shall be able to set a sub-application command line parameters from a sample distribution
- for a single parameter and
- for a multiple parameters.
Specification(s): master/single, master/multiple
Design: MultiAppCommandLineControl
Issue(s): #12576
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.3.12The system shall error when sub-apps are constructed too early thus unable to be changed by samplers.
Specification(s): wrong_multiapp_type
Design: MultiAppCommandLineControl
Issue(s): #12576
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.3.13The system shall error when the number of samples differs from the number of command line parameters.
Specification(s): wrong_num_params
Design: MultiAppCommandLineControl
Issue(s): #12576
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- stochastic_tools: SamplerPostprocessorTransfer
- 3.3.6The system shall support pulling postprocessor data from a sub-application for each row of sampled data.
Specification(s): normal
Design: SamplerPostprocessorTransferSamplerFullSolveMultiApp
Issue(s): #8863
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.3.7The system shall support running sub-applications in a batches on a
- on a single processor and
- on a multiple processors.
Specification(s): batch/exodus_1, batch/exodus_2
Design: SamplerPostprocessorTransferSamplerFullSolveMultiApp
Issue(s): #8863
Collection(s): FUNCTIONAL
Type(s): CheckFiles
- 3.3.8The stochastic tools module shall support pulling postprocessor data from a single sub-application running a batch of sampled data
- on a single processor,
- on multiple processors, and
- on multiple processors using in-memory backup.
Specification(s): batch_csv/n1, batch_csv/n2, batch_csv/n2_restore
Design: SamplerPostprocessorTransferSamplerFullSolveMultiApp
Issue(s): #8863
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.7.10The system shall support the ability to transfer a single value from each sub-application for a set of stochastic data.
Specification(s): sobol_from_multiapp
Design: SamplerPostprocessorTransfer
Issue(s): #8065
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.7.11The system shall error if the supplied name is invalid when attempting to transfer a single value from a sub-application.
Specification(s): invalid_sub_pp_name
Design: SamplerPostprocessorTransfer
Issue(s): #8065
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.7.12When sub-application solve does not converge, the system shall either
- abort run,
- transfer last computed postprocessor value,
- or transfer NaN.
Specification(s): solve_not_converge/abort, solve_not_converge/last_computed, solve_not_converge/nan
Design: SamplerPostprocessorTransfer
Issue(s): #8065
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunExceptionCSVDiffCheckFiles
- stochastic_tools: SamplerTransientMultiApp
- 3.3.9The system shall support running sub-applications with input parameters varying at each time step
- with individual sub-applications,
- with sub-applications batches using in-memory restore functionality.
Specification(s): transient/normal, transient/batch
Design: SamplerTransientMultiApp
Issue(s): #13320
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.3.10The SamplerTransientMultiApp object shall error if the 'batch-reset' mode is supplied.
Specification(s): mode_error
Design: SamplerTransientMultiApp
Issue(s): #13320
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.3.17The system shall have consistent partitioning between multiapps and sampler for transient solves
- with less processors than rows in normal mode;
- with more processors than rows in normal mode;
- with specified minimum processors per app in normal mode;
- with less processors than rows in batch-restore mode;
- with more processors than rows in batch-restore mode;
- with specified minimum processors per app in batch-restore mode;
- error when partitionings do not match;
Specification(s): transient/normal_less_procs, transient/normal_more_procs, transient/normal_min_procs, transient/restore_less_procs, transient/restore_more_procs, transient/restore_min_procs, transient/error_min_procs
Design: SamplerTransientMultiApp
Issue(s): #15787
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunExceptionCSVDiff
- 3.3.19The system shall provide the ability to create a transient sub-application from the sample data generated from distributions.
Specification(s): transient
Design: SamplerTransientMultiApp
Issue(s): #9923
Collection(s): FUNCTIONAL
Type(s): CheckFiles
- 3.3.20The system shall provide the ability to set a transient sub-application command line parameters from a sample distribution.
Specification(s): transient_cmdline_control
Design: SamplerTransientMultiApp
Collection(s): FUNCTIONAL
Type(s): Exodiff
- 3.3.24The system shall be able to perform stochastic simulations of transient models while obeying unperturbed command line arguements with:
- command line control;
- parameter transfer in normal mode;
- parameter transfer in batch mode;
Specification(s): transient/cmdline, transient/transfer_normal, transient/transfer_batch
Design: SamplerTransientMultiApp
Issue(s): #19105
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.7.15The system shall produce an error if the sampler sub-application does not contain a Control object with the name 'stochastic'.
Specification(s): control_missing
Design: SamplerTransientMultiApp
Issue(s): #11363
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.7.16The system shall produce an error if the sampler sub-application does not have a correct Control object with 'to_control' parameter being 'SamplerReceiver' type.
Specification(s): wrong_control
Design: SamplerTransientMultiApp
Issue(s): #11363
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- stochastic_tools: Samplers System
- 3.3.14The system shall support the modification of the number of complete sub-application simulations performed with
- normal execution,
- batch execution with memory-based restoring, and
- batch execution with reset-based restoring.
Specification(s): dynamic/normal, dynamic/batch-restore, dynamic/batch-reset
Design: Samplers SystemSamplerFullSolveMultiApp
Issue(s): #16842
Collection(s): FUNCTIONAL
Type(s): JSONDiff
- 3.3.15The system shall error when the size of a sampler is altered an sub-applications are progressing with time with the main application.
Specification(s): error
Design: Samplers SystemSamplerFullSolveMultiApp
Issue(s): #16842
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.5.8The system shall support generating random samples of data
- that remain constant in size and
- that are dynamic in size.
Specification(s): no_change/constant, no_change/dynamic
Design: Samplers SystemSamplerFullSolveMultiApp
Issue(s): #16842
Collection(s): FUNCTIONAL
Type(s): JSONDiff
- stochastic_tools: StatisticsReporter
- 3.4.1The system shall support the calculation of statistics using
- vectors of data from the postprocessing system and include
- confidence level intervals for statistics calculations.
Specification(s): vpp/statistics, vpp/ci
Design: StatisticsReporter
Issue(s): #16584
Collection(s): FUNCTIONAL
Type(s): JSONDiff
- 3.4.2The system shall support the calculation of statistics using
- vector of data from the reporting system; including
- confidence level intervals for statistics calculations
- and error if the supplied type is not supported.
Specification(s): reporters/statistics, reporters/ci, reporters/error
Design: StatisticsReporter
Issue(s): #16584
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunExceptionJSONDiff
- 3.4.3The system shall support computing bias corrected and accelerated confidence level intervals of statistics
- of a vector of data
- of a vector of vector data
- using data that is replicated and
- using data that is distributed.
Specification(s): bca/basic, bca/vector, bca/replicated, bca/distributed
Design: StatisticsReporter
Collection(s): FUNCTIONAL
Type(s): JSONDiff
- 3.4.4The system shall error when computing confidence level intervals when
- the confidence level intervals are omitted;
- the confidence level intervals are less than or equal to zero;
- the confidence level intervals are greater than or equal to one;
- input is not provided.
Specification(s): errors/no_ci_levels, errors/ci_levels_zero, errors/ci_levels_one, errors/no_input
Design: StatisticsReporter
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.4.5The system shall support computing percentile confidence level intervals of statistics
- of a vector of data
- of a vector of vector data
- using data that is replicated or
- distributed across processors.
Specification(s): percentile/basic, percentile/vector, percentile/replicated, percentile/distributed
Design: StatisticsReporter
Collection(s): FUNCTIONAL
Type(s): JSONDiff
- 3.4.8The system shall be capable of computing the statistics of a data vector that
- is replicated and
- distributed.
Specification(s): tests/replicated, tests/distributed
Design: StatisticsReporter
Collection(s): FUNCTIONAL
Type(s): JSONDiff
- 3.4.9The system shall be capable of computing the statistics from vector reporter values.
Specification(s): reporter
Design: StatisticsReporter
Collection(s): FUNCTIONAL
Type(s): JSONDiff
- stochastic_tools: SobolReporter
- 3.4.6The system shall support the ability to compute first, second, and total-effect Sobol sensitivity indices with a reporter.
Specification(s): sobol
Design: SobolReporter
Issue(s): #15558
Collection(s): FUNCTIONAL
Type(s): JSONDiff
- 3.4.7The system shall support the ability to compute Sobol sensitivity indices for vector-type data.
Specification(s): sobol_vec
Design: SobolReporter
Issue(s): #15558
Collection(s): FUNCTIONAL
Type(s): JSONDiff
- stochastic_tools: StochasticReporter
- 3.4.10The system shall support the ability to use transferred reporter data to
- compute statistics.
Specification(s): sr/stats
Design: StochasticReporter
Issue(s): #16166
Collection(s): FUNCTIONAL
Type(s): JSONDiff
- stochastic_tools: Adaptive Importance Sampling (AIS)
- 3.5.1The system shall include an Adaptive Importance Sampling method for sampling distribution data.
Specification(s): ais
Design: Adaptive Importance Sampling (AIS)
Issue(s): #17664
Collection(s): FUNCTIONAL
Type(s): JSONDiff
- stochastic_tools: Parallel Subset Simulation (PSS)
- 3.5.2The system shall include an Parallel Subset Simulation method for sampling distribution data.
Specification(s): pss1
Design: Parallel Subset Simulation (PSS)
Issue(s): #19398
Collection(s): FUNCTIONAL
Type(s): JSONDiff
- 3.5.3The system shall throw an error when
- the selected sampler type is not of an adaptive type.
Specification(s): pss_errors/pss_error1
Design: Parallel Subset Simulation (PSS)
Issue(s): #19398
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- stochastic_tools: CartesianProductSampler
- 3.5.4The system shall include the ability to create a Cartesian product sampling scheme.
Specification(s): test
Design: CartesianProductSampler
Issue(s): #14457
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- stochastic_tools: CSVSampler
- 3.5.5The CSV Sampler shall read samples from a CSV file while the sample data is
- distributed across processors,
- replicated across processors, and
- distributed across processors with the output also distributed.
Specification(s): csv_sampler/sampling_test, csv_sampler/sampling_test_global, csv_sampler/sampling_test_distributed
Design: CSVSampler
Issue(s): #16462
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.5.6The CSV Sampler shall sample from a CSV file when column indices are provided.
Specification(s): csv_sampler_indices
Design: CSVSampler
Issue(s): #16462
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.5.7The CSV Sampler shall sample from a CSV file when column names are provided.
Specification(s): csv_sampler_names
Design: CSVSampler
Issue(s): #16462
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- stochastic_tools: Sampler
- 3.5.9The system shall support the creation of data sampled from distribution during the initial setup of a simulation.
Specification(s): initial
Design: Sampler
Issue(s): #8065
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- stochastic_tools: LatinHypercube
- 3.5.10The system shall support the ability to sample data using the Latin Hypercube method that can operate
- using global matrix,
- a local matrix,
- or row-by-row.
Specification(s): modes/global, modes/local, modes/row
Design: LatinHypercube
Issue(s): #14830
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.5.11The system shall support the ability to sample data using the Latin Hypercube method with more processors than rows that can operate
- using global matrix,
- a local matrix,
- or row-by-row.
Specification(s): more_procs/global, more_procs/local, more_procs/row
Design: LatinHypercube
Issue(s): #14830
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.5.12The system shall include a utility that visually displays results of plotting Latin Hypercube test.
Specification(s): visualize
Design: LatinHypercube
Issue(s): #14830
Collection(s): FUNCTIONAL
Type(s): CheckFiles
- stochastic_tools: MonteCarlo
- 3.5.13The system shall include a Monte Carlo method for sampling distribution data including
- a uniform distribution distributed across processors,
- a uniform distribution replicated across processors,
- a uniform distribution distributed across processors (output is also distributed),
- a Wiebull distribution distributed across processors, and
- a Weibull distribution replicated across processors.
Specification(s): monte_carlo/uniform, monte_carlo/uniform_global, monte_carlo/uniform_distributed, monte_carlo/weibull, monte_carlo/weibull_global
Design: MonteCarlo
Issue(s): #8065
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.7.7The system shall support the creation of a sub-application for each row of the stochastic data.
Specification(s): monte_carlo
Design: MonteCarloSamplerParameterTransfer
Issue(s): #8863
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- stochastic_tools: NestedMonteCarlo
- 3.5.14The system shall include a nested Monte Carlo sampling scheme where sets of distributions are sampled as nested loops of rows
- in serial;
- in parallel;
Specification(s): nested_monte_carlo/serial, nested_monte_carlo/parallel
Design: NestedMonteCarlo
Issue(s): #20130
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.5.15The system shall error out when the number of nested Monte Carlo loops does not match the number of sets of distributions.
Specification(s): error
Design: NestedMonteCarlo
Issue(s): #20130
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- stochastic_tools: Sobol
- 3.5.16The system shall include a SOBOL method for sampling distribution data:
- with the re-sampling matrix and
- without the re-sampling matrix.
Specification(s): sobol/resample, sobol/no_resample
Design: Sobol
Issue(s): #8065
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.5.17The system shall error if the SOBOL sampling method is setup with input sampling matrices
- with differing number of rows;
- with differing number of columns; and
- if the matrices are the same.
Specification(s): errors/row_mismatch, errors/col_mismatch, errors/same_matrix
Design: Sobol
Issue(s): #8065
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.7.22The system shall support the creation of a sub-application for each row sampled data generated from a Sobol scheme.
Specification(s): sobol
Design: SobolSamplerParameterTransfer
Issue(s): #8863
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- stochastic_tools: GaussianProcessTrainer
- 3.6.1The system shall demonstrate a gaussian process surrogate by
- training a Gaussian process model and
- evaluating the trained Gaussian process model
Specification(s): store_load/GP_training, store_load/GP_testing
Design: GaussianProcessTrainerGaussianProcess
Issue(s): #15482
Collection(s): FUNCTIONAL
Type(s): CSVDiffCheckFiles
- 3.6.2The system shall be able to produce a Gaussian process surrogate with
- a squared exponential kernel;
- an exponential kernel;
- Matern half integer kernel;
Specification(s): kernels/GP_squared_exponential, kernels/GP_exponential, kernels/GP_Matern_half_int
Design: GaussianProcessTrainerGaussianProcess
Issue(s): #15482
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.6.3The system shall be be able to tune hyperparameters of a Gaussian process surrogate with
- a squared exponential kernel;
- an exponential kernel;
- a Matern half integer kernel;
Specification(s): tuning/GP_squared_exponential_tuned, tuning/GP_exponential_tuned, tuning/GP_Matern_half_int_tuned
Design: GaussianProcessTrainerGaussianProcess
Issue(s): #15482
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.6.4The system shall throw an error when
- the no optimization is selected while parameter tuning is required.
Specification(s): errors/optimization
Design: GaussianProcessTrainerGaussianProcess
Issue(s): #15482
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- stochastic_tools: GaussianProcess
- 3.6.1The system shall demonstrate a gaussian process surrogate by
- training a Gaussian process model and
- evaluating the trained Gaussian process model
Specification(s): store_load/GP_training, store_load/GP_testing
Design: GaussianProcessTrainerGaussianProcess
Issue(s): #15482
Collection(s): FUNCTIONAL
Type(s): CSVDiffCheckFiles
- 3.6.2The system shall be able to produce a Gaussian process surrogate with
- a squared exponential kernel;
- an exponential kernel;
- Matern half integer kernel;
Specification(s): kernels/GP_squared_exponential, kernels/GP_exponential, kernels/GP_Matern_half_int
Design: GaussianProcessTrainerGaussianProcess
Issue(s): #15482
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.6.3The system shall be be able to tune hyperparameters of a Gaussian process surrogate with
- a squared exponential kernel;
- an exponential kernel;
- a Matern half integer kernel;
Specification(s): tuning/GP_squared_exponential_tuned, tuning/GP_exponential_tuned, tuning/GP_Matern_half_int_tuned
Design: GaussianProcessTrainerGaussianProcess
Issue(s): #15482
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.6.4The system shall throw an error when
- the no optimization is selected while parameter tuning is required.
Specification(s): errors/optimization
Design: GaussianProcessTrainerGaussianProcess
Issue(s): #15482
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- stochastic_tools: LibtorchANNTrainer
- 3.6.5The system shall be able to train and evaluate a libtorch-based neural network in the same input file.
Specification(s): train_and_evaluate
Design: LibtorchANNTrainerLibtorchANNSurrogate
Issue(s): #19571
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.6.6The system shall be able to train a libtorch-based neural network.
Specification(s): train
Design: LibtorchANNTrainerLibtorchANNSurrogate
Issue(s): #19571
Collection(s): FUNCTIONAL
Type(s): CheckFiles
- 3.6.7The system shall be able to evaluate a previously trained, libtorch-based neural network.
Specification(s): evaluate
Design: LibtorchANNTrainerLibtorchANNSurrogate
Issue(s): #19571
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.6.8The system shall be able to retrain a pretrained and saved libtorch-based neural network.
Specification(s): retrain
Design: LibtorchANNTrainerLibtorchANNSurrogate
Issue(s): #19571
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.6.9The system shall be able to throw an error if the user requires libtorch-based objects without installing libtorch.
Specification(s): trainer-no-torch-error
Design: LibtorchANNTrainerLibtorchANNSurrogate
Issue(s): #19571
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.6.10The system shall be able to train a libtorch-based neural network using a relative tolerance instead of fixed epoch number.
Specification(s): train-with-rel-tol
Design: LibtorchANNTrainerLibtorchANNSurrogate
Issue(s): #19571
Collection(s): FUNCTIONAL
Type(s): CheckFiles
- stochastic_tools: LibtorchANNSurrogate
- 3.6.5The system shall be able to train and evaluate a libtorch-based neural network in the same input file.
Specification(s): train_and_evaluate
Design: LibtorchANNTrainerLibtorchANNSurrogate
Issue(s): #19571
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.6.6The system shall be able to train a libtorch-based neural network.
Specification(s): train
Design: LibtorchANNTrainerLibtorchANNSurrogate
Issue(s): #19571
Collection(s): FUNCTIONAL
Type(s): CheckFiles
- 3.6.7The system shall be able to evaluate a previously trained, libtorch-based neural network.
Specification(s): evaluate
Design: LibtorchANNTrainerLibtorchANNSurrogate
Issue(s): #19571
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.6.8The system shall be able to retrain a pretrained and saved libtorch-based neural network.
Specification(s): retrain
Design: LibtorchANNTrainerLibtorchANNSurrogate
Issue(s): #19571
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.6.9The system shall be able to throw an error if the user requires libtorch-based objects without installing libtorch.
Specification(s): trainer-no-torch-error
Design: LibtorchANNTrainerLibtorchANNSurrogate
Issue(s): #19571
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.6.10The system shall be able to train a libtorch-based neural network using a relative tolerance instead of fixed epoch number.
Specification(s): train-with-rel-tol
Design: LibtorchANNTrainerLibtorchANNSurrogate
Issue(s): #19571
Collection(s): FUNCTIONAL
Type(s): CheckFiles
- stochastic_tools: Surrogates System
- 3.6.11The system shall support the creation of surrogate models that can be
- trained with replicated stochastic data and
- evaluated separately (with replicated data);
- trained with distributed stochastic data and
- evaluated separately (with distributed data);
- trained with distributed stochastic data;
- evaluated separately with a different number of processors;
- and be trained and evaluated in memory with a single input file.
Specification(s): surrogate/train, surrogate/evaluate, surrogate/train_distributed, surrogate/evaluate_distributed, surrogate/train_three_ranks, surrogate/evaluate_two_ranks, surrogate/evaluate_and_train
Design: Surrogates System
Issue(s): #14875
Collection(s): FUNCTIONAL
Type(s): JSONDiffCheckFiles
- stochastic_tools: NearestPointTrainer
- 3.6.12The system shall create a surrogate that evaluates the closes point from training data by
- training then
- evaluating,
- training and loading, and
- using explictly specified predictors.
Specification(s): nearest_point/train, nearest_point/load, nearest_point/train_and_load, nearest_point/predictors
Design: NearestPointTrainerNearestPointSurrogate
Issue(s): #14933
Collection(s): FUNCTIONAL
Type(s): CSVDiffCheckFiles
- stochastic_tools: NearestPointSurrogate
- 3.6.12The system shall create a surrogate that evaluates the closes point from training data by
- training then
- evaluating,
- training and loading, and
- using explictly specified predictors.
Specification(s): nearest_point/train, nearest_point/load, nearest_point/train_and_load, nearest_point/predictors
Design: NearestPointTrainerNearestPointSurrogate
Issue(s): #14933
Collection(s): FUNCTIONAL
Type(s): CSVDiffCheckFiles
- stochastic_tools: PODReducedBasisTrainer
- 3.6.13The system shall demonstrate a POD-RB surrogate (with Dirichlet BC) by
- training using known 4D data
- and then evaluating new samples separately for new data.
Specification(s): pod_boundary/train, pod_boundary/load
Design: PODReducedBasisTrainerPODReducedBasisSurrogatePODFullSolveMultiAppPODSamplerSolutionTransferPODResidualTransfer
Issue(s): #15538
Collection(s): FUNCTIONAL
Type(s): CSVDiffCheckFiles
- 3.6.16PODReducedBasisTrainer shall throw an error when
- the variable names cannot be found on sub-applications,
- the number of energy limits and variable names do not match,
- the number of tag names and tag types do not match,
- the Dirichlet tag types do not exist,
- and the residual generation is called before having the basis vectors.
Specification(s): trainer/var_names, trainer/en_limits, trainer/tag_types, trainer/dir_tag_names, trainer/wrong_res_transfer
Design: PODReducedBasisTrainerPODResidualTransferPODSamplerSolutionTransfer
Issue(s): #15538
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.6.18The system shall demonstrate a POD-RB surrogate (without Dirichlet BC) by
- training using known 3D data,
- saving the eigenvalues,
- then evaluating new samples separately for new data,
- and doing both together in one input file.
Specification(s): pod_internal/train, pod_internal/save_ev, pod_internal/load, pod_internal/train_and_load
Design: PODReducedBasisTrainerPODReducedBasisSurrogatePODFullSolveMultiAppPODSamplerSolutionTransferPODResidualTransfer
Issue(s): #15538
Collection(s): FUNCTIONAL
Type(s): CSVDiffCheckFiles
- stochastic_tools: PODReducedBasisSurrogate
- 3.6.13The system shall demonstrate a POD-RB surrogate (with Dirichlet BC) by
- training using known 4D data
- and then evaluating new samples separately for new data.
Specification(s): pod_boundary/train, pod_boundary/load
Design: PODReducedBasisTrainerPODReducedBasisSurrogatePODFullSolveMultiAppPODSamplerSolutionTransferPODResidualTransfer
Issue(s): #15538
Collection(s): FUNCTIONAL
Type(s): CSVDiffCheckFiles
- 3.6.17PODReducedBasisSurrogate shall throw an error when
- the number of inputs in 'change_rank' and 'new_ranks' is not the same.
Specification(s): surrogate/var_name
Design: PODReducedBasisSurrogate
Issue(s): #15538
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.6.18The system shall demonstrate a POD-RB surrogate (without Dirichlet BC) by
- training using known 3D data,
- saving the eigenvalues,
- then evaluating new samples separately for new data,
- and doing both together in one input file.
Specification(s): pod_internal/train, pod_internal/save_ev, pod_internal/load, pod_internal/train_and_load
Design: PODReducedBasisTrainerPODReducedBasisSurrogatePODFullSolveMultiAppPODSamplerSolutionTransferPODResidualTransfer
Issue(s): #15538
Collection(s): FUNCTIONAL
Type(s): CSVDiffCheckFiles
- stochastic_tools: PODFullSolveMultiApp
- 3.6.13The system shall demonstrate a POD-RB surrogate (with Dirichlet BC) by
- training using known 4D data
- and then evaluating new samples separately for new data.
Specification(s): pod_boundary/train, pod_boundary/load
Design: PODReducedBasisTrainerPODReducedBasisSurrogatePODFullSolveMultiAppPODSamplerSolutionTransferPODResidualTransfer
Issue(s): #15538
Collection(s): FUNCTIONAL
Type(s): CSVDiffCheckFiles
- 3.6.14PODFullSolveMultiapp shall throw an error when
- the trainer object cannot be found.
Specification(s): multiapp/trainer_name
Design: PODFullSolveMultiApp
Issue(s): #15538
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.6.18The system shall demonstrate a POD-RB surrogate (without Dirichlet BC) by
- training using known 3D data,
- saving the eigenvalues,
- then evaluating new samples separately for new data,
- and doing both together in one input file.
Specification(s): pod_internal/train, pod_internal/save_ev, pod_internal/load, pod_internal/train_and_load
Design: PODReducedBasisTrainerPODReducedBasisSurrogatePODFullSolveMultiAppPODSamplerSolutionTransferPODResidualTransfer
Issue(s): #15538
Collection(s): FUNCTIONAL
Type(s): CSVDiffCheckFiles
- stochastic_tools: PODSamplerSolutionTransfer
- 3.6.13The system shall demonstrate a POD-RB surrogate (with Dirichlet BC) by
- training using known 4D data
- and then evaluating new samples separately for new data.
Specification(s): pod_boundary/train, pod_boundary/load
Design: PODReducedBasisTrainerPODReducedBasisSurrogatePODFullSolveMultiAppPODSamplerSolutionTransferPODResidualTransfer
Issue(s): #15538
Collection(s): FUNCTIONAL
Type(s): CSVDiffCheckFiles
- 3.6.15PODSamplerSolutionTransfer shall throw an error when
- the trainer object cannot be found.
Specification(s): solution_transfer/trainer_name
Design: PODSamplerSolutionTransfer
Issue(s): #15538
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.6.16PODReducedBasisTrainer shall throw an error when
- the variable names cannot be found on sub-applications,
- the number of energy limits and variable names do not match,
- the number of tag names and tag types do not match,
- the Dirichlet tag types do not exist,
- and the residual generation is called before having the basis vectors.
Specification(s): trainer/var_names, trainer/en_limits, trainer/tag_types, trainer/dir_tag_names, trainer/wrong_res_transfer
Design: PODReducedBasisTrainerPODResidualTransferPODSamplerSolutionTransfer
Issue(s): #15538
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.6.18The system shall demonstrate a POD-RB surrogate (without Dirichlet BC) by
- training using known 3D data,
- saving the eigenvalues,
- then evaluating new samples separately for new data,
- and doing both together in one input file.
Specification(s): pod_internal/train, pod_internal/save_ev, pod_internal/load, pod_internal/train_and_load
Design: PODReducedBasisTrainerPODReducedBasisSurrogatePODFullSolveMultiAppPODSamplerSolutionTransferPODResidualTransfer
Issue(s): #15538
Collection(s): FUNCTIONAL
Type(s): CSVDiffCheckFiles
- stochastic_tools: PODResidualTransfer
- 3.6.13The system shall demonstrate a POD-RB surrogate (with Dirichlet BC) by
- training using known 4D data
- and then evaluating new samples separately for new data.
Specification(s): pod_boundary/train, pod_boundary/load
Design: PODReducedBasisTrainerPODReducedBasisSurrogatePODFullSolveMultiAppPODSamplerSolutionTransferPODResidualTransfer
Issue(s): #15538
Collection(s): FUNCTIONAL
Type(s): CSVDiffCheckFiles
- 3.6.16PODReducedBasisTrainer shall throw an error when
- the variable names cannot be found on sub-applications,
- the number of energy limits and variable names do not match,
- the number of tag names and tag types do not match,
- the Dirichlet tag types do not exist,
- and the residual generation is called before having the basis vectors.
Specification(s): trainer/var_names, trainer/en_limits, trainer/tag_types, trainer/dir_tag_names, trainer/wrong_res_transfer
Design: PODReducedBasisTrainerPODResidualTransferPODSamplerSolutionTransfer
Issue(s): #15538
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.6.18The system shall demonstrate a POD-RB surrogate (without Dirichlet BC) by
- training using known 3D data,
- saving the eigenvalues,
- then evaluating new samples separately for new data,
- and doing both together in one input file.
Specification(s): pod_internal/train, pod_internal/save_ev, pod_internal/load, pod_internal/train_and_load
Design: PODReducedBasisTrainerPODReducedBasisSurrogatePODFullSolveMultiAppPODSamplerSolutionTransferPODResidualTransfer
Issue(s): #15538
Collection(s): FUNCTIONAL
Type(s): CSVDiffCheckFiles
- stochastic_tools: PolynomialChaos
- 3.6.19The system shall compute polynomial chaos coefficents using
- MonteCarlo sampler with Uniform distribution,
- Quadrature sampler with Uniform distribution, and
- Quadrature sampler with Normal distribution.
Specification(s): coefficients/monte_carlo_integration, coefficients/gauss_legendre_integration, coefficients/gauss_hermite
Design: PolynomialChaos
Issue(s): #14710
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- stochastic_tools: PolynomialChaosReporter
- 3.6.20The system shall compute relevant statistics with polynomial chaos expansion including
- statistical moments with Legendre polynomials,
- statistical moments with Hermite polynomials,
- sampler and user defined local sensitivities with Legendre polynomials,
- sampler and user defined local sensitivities with Hermite polynomials, and
- Sobol sensitivity indices.
Specification(s): statistics/legendre_moment_calculation, statistics/hermite_moment_calculation, statistics/legendre_local_sensitivity, statistics/hermite_local_sensitivity, statistics/sobol
Design: PolynomialChaosReporter
Issue(s): #14836
Collection(s): FUNCTIONAL
Type(s): JSONDiff
- stochastic_tools: QuadratureSampler
- 3.6.21The system shall include the ability to use sparse grid methods to evaluate polynomial chaos expansion coefficients including
- Smolyak and
- Clenshaw-Curtis methods.
Specification(s): sparse/smolyak_sobol, sparse/clenshaw_curtis_sobol
Design: QuadratureSampler
Issue(s): #14833
Collection(s): FUNCTIONAL
Type(s): JSONDiff
- stochastic_tools: PolynomialRegressionTrainer
- 3.6.22The system shall throw an error when
- the number of samples does not match the number of results.
Specification(s): errors/wrong_sampler
Design: PolynomialRegressionTrainer
Issue(s): #15361
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.6.23The system shall demonstrate a polnomial regression surrogate by
- training using known 3D data
- and then evaluating new samples separately for the same data
- and then doing both on another 1D case.
Specification(s): poly_reg/train, poly_reg/load, poly_reg/train_and_load
Design: PolynomialRegressionTrainerPolynomialRegressionSurrogate
Issue(s): #15361
Collection(s): FUNCTIONAL
Type(s): CSVDiffCheckFiles
- 3.6.24The sytem shall be able to create polynomial regression surrogate with vector-type response.
Specification(s): vector
Design: PolynomialRegressionTrainerPolynomialRegressionSurrogate
Issue(s): #15361
Collection(s): FUNCTIONAL
Type(s): CheckFiles
- stochastic_tools: PolynomialRegressionSurrogate
- 3.6.23The system shall demonstrate a polnomial regression surrogate by
- training using known 3D data
- and then evaluating new samples separately for the same data
- and then doing both on another 1D case.
Specification(s): poly_reg/train, poly_reg/load, poly_reg/train_and_load
Design: PolynomialRegressionTrainerPolynomialRegressionSurrogate
Issue(s): #15361
Collection(s): FUNCTIONAL
Type(s): CSVDiffCheckFiles
- 3.6.24The sytem shall be able to create polynomial regression surrogate with vector-type response.
Specification(s): vector
Design: PolynomialRegressionTrainerPolynomialRegressionSurrogate
Issue(s): #15361
Collection(s): FUNCTIONAL
Type(s): CheckFiles
- stochastic_tools: SamplerParameterTransfer
- 3.7.1The system shall include the ability to modify parameters for sub-applications using values from a distribution
- on a single processor,
- on multiple processors,
- and on more processors than samples.
Specification(s): normal/n1, normal/n2, normal/n3
Design: SamplerParameterTransfer
Issue(s): #8863
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.7.2The system shall include the ability to modify parameters for sub-applications executed in batches using values from a distribution
- on a single processor,
- on multiple processors, and
- on multiple processors using in-memory sub-application restore.
Specification(s): batch/n1, batch/n2, batch/n2_restore
Design: SamplerParameterTransfer
Issue(s): #8863
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.7.3The system shall include the ability to transfer stochastic results for two sub apps.
Specification(s): batch_two_subapps
Design: SamplerParameterTransfer
Issue(s): #17079
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.7.4The 'StochasticToolsTransfer object shall error if the 'execute_on' parameter is defined when the corresponding MultiApp object is running in batch mode.
Specification(s): StochasticToolsTransfer_execute_on_error
Design: SamplerParameterTransfer
Issue(s): #8863
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.7.5The 'StochasticToolsTransfer' object shall error if the 'execute_on' parameter does not match the corresponding MultiApp object is running in normal mode.
Specification(s): StochasticToolsTransfer_execute_on_check
Design: SamplerParameterTransfer
Issue(s): #8863
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.7.6The system shall report a reasonable error if parameters for a trasnfer between multiapps are provided to stochastics transfer, which do not support this currently
Specification(s): direction_error
Design: SamplerParameterTransfer
Issue(s): #8863
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.7.7The system shall support the creation of a sub-application for each row of the stochastic data.
Specification(s): monte_carlo
Design: MonteCarloSamplerParameterTransfer
Issue(s): #8863
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.7.14The system shall produce an error if neither a 'SamplerTransientMultiApp' nor
SamplerFullSolveMultiApp
is provided in SamplerParameterTransfer.Specification(s): multiapp_type
Design: SamplerParameterTransfer
Issue(s): #11363
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.7.17The system shall produce an error if supplied vector of real values is not sized correctly within the SamplerParameterTransfer object.
Specification(s): num_parameters_wrong
Design: SamplerParameterTransfer
Issue(s): #11363
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.7.18The system shall produce an error if sampling method differs between the sub-application and the associated sub-application data transfer.
Specification(s): sampler_mismatch
Design: SamplerParameterTransfer
Issue(s): #11363
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.7.19The system shall be capable of transferring scalar data to sub-applications for each row of the stochastic data
- using a Monte Carlo and
- Sobol sampling scheme.
Specification(s): transfer/monte_carlo, transfer/sobol
Design: SamplerParameterTransfer
Issue(s): #8065
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.7.20The system shall be capable of transferring vector data to sub-applications for each row of the stochastic data.
Specification(s): monte_carlo
Design: SamplerParameterTransfer
Issue(s): #8065
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.7.21The system shall error if the transferred vector to a sub-application
- is not sized correctly for stochastic data,
- is not sized uniformily across sub-applications,
- if the vector parameter does not exist, and
- if the sub-application does not consume all of the supplied data.
Specification(s): errors/not_enough_data, errors/size_mismatch, errors/invalid_name, errors/extra_data
Design: SamplerParameterTransfer
Issue(s): #8065
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.7.22The system shall support the creation of a sub-application for each row sampled data generated from a Sobol scheme.
Specification(s): sobol
Design: SobolSamplerParameterTransfer
Issue(s): #8863
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- stochastic_tools: StochasticResults
- 3.7.8The system shall produce an error if neither a 'SamplerTransientMultiApp' nor
SamplerFullSolveMultiApp
is provided in SamplerPostprocessorTransfer.Specification(s): wrong_multi_app
Design: StochasticResults
Issue(s): #9419
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.7.9The system shall produce an error if the 'result' object in 'SamplerPostprocessorTransfer' is not a 'StochasticResults object'.
Specification(s): require_stochastic_results
Design: StochasticResults
Issue(s): #9419
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
- 3.8.9The system shall support the collection of stochastic data from multiple sub-applications.
Specification(s): multiple
Design: StochasticResults
Issue(s): #14414
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.8.17The system shall support the collection of stochastic data that is
- replicated on all processors and
- distributed across many.
Specification(s): parallel_type/replicated, parallel_type/distributed
Design: StochasticResults
Issue(s): #14410
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.8.18The system shall support the labeling of collection of stochastic data
- with custom prefix and
- without a prefix.
Specification(s): prefix/custom, prefix/none
Design: StochasticResults
Issue(s): #14410
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.8.19The system shall support the collection of stochastic data that
- can be appended into a single data set or
- or contain a single file per timestep.
Specification(s): data/complete, data/time
Design: StochasticResults
Issue(s): #14412
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- stochastic_tools: SamplerReporterTransfer
- 3.7.13The system shall support the ability to transfer reporter data from each sub-application for a set of stochastic data
- in normal mode,
- in batch mode,
- with distributed output,
- with more processors than samples,
- and error if transferring unsupported type.
Specification(s): transfer/normal, transfer/batch, transfer/distributed, transfer/more_cpus, transfer/invalid_type
Design: SamplerReporterTransfer
Issue(s): #16166
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunExceptionJSONDiff
- stochastic_tools: SamplerData
- 3.8.10The system shall be able to ouptut samples from a sampler using the sampling method
- get global matrix;
- get local matrix;
- get next local row;
Specification(s): get_sample_types/get_global_samples, get_sample_types/get_local_samples, get_sample_types/get_next_local_row
Design: SamplerData
Issue(s): #9402
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.8.11The system shall be able to ouptut distributed samples from a sampler using the sampling method
- get local matrix;
- get next local row;
Specification(s): parallel/get_local_samples, parallel/get_next_local_row
Design: SamplerData
Issue(s): #13906
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.8.12The system shall be able to ouptut samples from a sampler with
- one column;
- multiple columns;
- large number of columns;
Specification(s): cols/one, cols/multi, cols/lots
Design: SamplerData
Issue(s): #20576
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- stochastic_tools: SobolStatistics
- 3.8.13The system shall support the ability to compute first, second, and total-effect Sobol sensitivity indices.
Specification(s): sobol
Design: SobolStatistics
Issue(s): #14784
Collection(s): FUNCTIONAL
Type(s): CSVDiff
- 3.8.14The system shall support the ability to compute confidence intervals on Sobol sensitivity indices.
Specification(s): sobol_bootstrap
Design: SobolStatistics
Issue(s): #14784
Collection(s): FUNCTIONAL
Type(s): CSVDiff