Stochastic Tools Requirements Traceability Matrix
This template follows INL template TEM-214, "IT System Requirements Traceability Matrix."
This document serves as an addendum to Framework Requirements Traceability Matrix and captures information for Requirement Traceability Matrix (RTM) specific to the Stochastic Tools application.
Introduction
Minimum System Requirements
In general, the following is required for MOOSE-based development:
GCC/Clang C++17 compliant compiler (GCC @ 7.5.0, Clang @ 5.0.2 or greater)
Note: Intel compilers are not supported.
Memory: 16 GBs (debug builds)
Processor: 64-bit x86
Disk: 30GB
System Purpose
The MOOSE is a tool for solving complex coupled Multiphysics equations using the finite element method. MOOSE uses an object-oriented design to abstract data structure management, parallelism, threading and compiling while providing an easy to use interface targeted at engineers that may not have a lot of software development experience. MOOSE will require extreme scalability and flexibility when compared to other FEM frameworks. For instance, MOOSE needs the ability to run extremely complex material models, or even third-party applications within a parallel simulation without sacrificing parallelism. This capability is in contrast to what is often seen in commercial packages, where custom material models can limit the parallel scalability, forcing serial runs in the most severe cases. When comparing high-end capabilities, many MOOSE competitors target modest-sized clusters with just a few thousand processing cores. MOOSE, however, will be required to routinely executed on much larger clusters with scalability to clusters available in the top 500 systems (top500.org). MOOSE will also be targeted at smaller systems such as high-end laptop computers.
The design goal of MOOSE is to give developers ultimate control over their physical models and applications. Designing new models or solving completely new classes of problems will be accomplished by writing standard C++ source code within the framework's class hierarchy. Scientists and engineers will be free to implement completely new algorithms using pieces of the framework where possible, and extending the framework's capabilities where it makes sense to do so. Commercial applications do not have this capability, and instead opt for either a more rigid parameter system or a limited application-specific metalanguage.
System Scope
MOOSE's scope is to provide a set of interfaces for building Finite Element Method (FEM) simulations. Abstractions to all underlying libraries are provided.
Solving coupled problems where competing physical phenomena impact one and other in a significant nonlinear fashion represents a serious challenge to several solution strategies. Small perturbations in strongly-coupled parameters often have very large adverse effects on convergence behavior. These adverse effects are compounded as additional physics are added to a model. To overcome these challenges, MOOSE employs three distinct yet compatible systems for solving these types of problems.
First, an advanced numerical technique called the Jacobian-Free Newton-Krylov (JFNK) method is employed to solve the most fully-coupled physics in an accurate, consistent way. An example of this would be the effect of temperature on the expansion or contraction of a material. While the JFNK numerical method is very effective at solving fully-coupled equations, it can also be computationally expensive. Plus, not all physical phenomena in a given model are truly coupled to one another. For instance, in a reactor, the speed of the coolant flow may not have any direct effect on the complex chemical reactions taking place inside the fuel rods. We call such models "loosely-coupled". A robust, scalable system must strike the proper balance between the various modeling strategies to avoid performing unnecessary computations or incorrectly predicting behavior in situations such as these.
MOOSE's Multiapp system will allow modelers to group physics into logical categories where MOOSE can solve some groups fully-coupled and others loosely-coupled. The Multiapp system goes even further by also supporting a "tightly-coupled" strategy, which falls somewhere between the "fully-coupled" and "loosely-coupled" approaches. Several sets of physics can then be linked together into logical hierarchies using any one of these coupling strategies, allowing for several potential solution strategies. For instance, a complex nuclear reactor model might consist of several tightly-coupled systems of fully-coupled equations.
Finally, MOOSE's Transfers system ties all of the physics groups contained within the Multiapp system together and allows for full control over the flow of information among the various groups. This capability bridges physical phenomena from several different complementary scales simultaneously. When these three MOOSE systems are combined, myriad coupling combinations are possible. In all cases, the MOOSE framework handles the parallel communication, input, output and execution of the underlying simulation. By handling these computer science tasks, the MOOSE framework keeps modelers focused on doing research.
MOOSE innovates by building advanced simulation capabilities on top of the very best available software technologies in a way that makes them widely accessible for innovative research. MOOSE is equally capable of solving small models on common laptops and the very biggest FEM models ever attempted—all without any major changes to configuration or source code. Since its inception, the MOOSE project has focused on both developer and computational efficiency. Improved developer efficiency is achieved by leveraging existing algorithms and technologies from several leading open-source packages. Additionally, MOOSE uses several complementary parallel technologies (both the distributed-memory message passing paradigm and shared-memory thread-based approaches are used) to lay an efficient computational foundation for development. Using existing open technologies in this manner helps the developers reduce the scope of the project and keeps the size of the MOOSE code base maintainable. This approach provides users with state-of-the-art finite element and solver technology as a basis for the advanced coupling and solution strategies mentioned previously.
MOOSE's developers work openly with other package developers to make sure that cutting-edge technologies are available through MOOSE, providing researchers with competitive research opportunities. MOOSE maintains a set of objects that hide parallel interfaces while exposing advanced spatial and temporal coupling algorithms in the framework. This accessible approach places developmental technology into the hands of scientists and engineers, which can speed the pace of scientific discovery.
Assumptions and Dependencies
The Stochastic Tools application is developed using MOOSE and is based on various modules, as such the RTM for Stochastic Tools is dependent upon the files listed at the beginning of this document.
Pre-test Instructions/Environment/Setup
Ideally all testing should be performed on a clean test machine following one of the supported configurations setup by the test system engineer. Testing may be performed on local workstations and cluster systems containing supported operating systems.
The repository should be clean prior to building and testing. When using "git" this can be done by doing a force clean in the main repository and each one of the submodules:
git clean -xfd
git submodule foreach 'git clean -xfd'
All tests must pass in accordance with the type of test being performed. This list can be found in the Software Test Plan.
System Requirements Traceability
Functional Requirements
- stochastic_tools: Distributions
- 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: Ics
- 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
Prerequisite(s): 3.2.1
- stochastic_tools: Multiapps
- 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
Prerequisite(s): 3.3.1
- 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
Prerequisite(s): 3.3.1
- 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
Prerequisite(s): 3.3.6
- 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
Prerequisite(s): 3.3.7
- 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.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
- 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.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.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.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.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.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
- stochastic_tools: Reporters
- 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.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
- 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
- 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: Samplers
- 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
- 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
- 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
- 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
- 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
- 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
- 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
- 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.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
- 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
- stochastic_tools: Surrogates
- 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
- 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
Prerequisite(s): 3.6.6
- 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
Prerequisite(s): 3.6.7
- 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
Prerequisite(s): 3.6.8
- 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
- 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
- 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.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.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
- 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
- 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
- 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
- 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: Transfers
- 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
Prerequisite(s): 3.7.1
- 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.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.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
- 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
- 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.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
- 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: Vectorpostprocessors
- 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.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
- 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
- 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