Stochastic Tools Requirements Traceability Matrix

This template follows INL template TEM-214, "IT System Requirements Traceability Matrix."

commentnote

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: Ics
  • 3.2.1The system shall generate parallel agnostic random initial conditions using a distribution function.

    Specification(s): generate

    Design: RandomIC

    Issue(s): #5567#11901#9710

    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

    Issue(s): #5567#11901#9710

    Collection(s): FAILURE_ANALYSISFUNCTIONAL

    Type(s): RunException

    Prerequisite(s): 3.2.1

  • stochastic_tools: Transfers
  • 3.7.1The system shall include the ability to modify parameters for sub-applications using values from a distribution
    1. on a single processor,
    2. on multiple processors,
    3. 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
    1. on a single processor,
    2. on multiple processors, and
    3. 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
    1. abort run,
    2. transfer last computed postprocessor value,
    3. 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
    1. in normal mode,
    2. in batch mode,
    3. with distributed output,
    4. with more processors than samples,
    5. 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
    1. using a Monte Carlo and
    2. 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
    1. is not sized correctly for stochastic data,
    2. is not sized uniformily across sub-applications,
    3. if the vector parameter does not exist, and
    4. 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

Usability Requirements

Performance Requirements

System Interface Requirements

References

No citations exist within this document.