Stochastic Tools Software Design Description

Introduction

The SDD for Stochastic Tools is a description of the software product and serves as guideline that describes the architecture of the system and all of its parts.

Dependencies

The Stochastic Tools application is developed using MOOSE and is based on various modules, as such the SDD for Stochastic Tools is dependent upon the following documents.

Requirements Cross Reference

The following is a list of all design documents and the associated requirements for Stochastic Tools.

  • stochastic_tools: RandomIC
  • 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

  • stochastic_tools: Sampler
  • 3.5.6The 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.7The system shall support the ability to sample data using the Latin Hypercube method that can operate
    1. using global matrix,
    2. a local matrix,
    3. 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.8The 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: Sobol
  • 3.5.10The system shall include a SOBOL method for sampling distribution data:
    1. with the re-sampling matrix and
    2. 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.11The system shall error if the SOBOL sampling method is setup with input sampling matrices
    1. with differing number of rows;
    2. with differing number of columns; and
    3. 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.25The 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.11The 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.12The 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.13The system shall support the collection of stochastic data that is
    1. replicated on all processors and
    2. distributed across many.

    Specification(s): parallel_type/replicated, parallel_type/distributed

    Design: StochasticResults

    Issue(s): #14410

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 3.8.14The system shall support the labeling of collection of stochastic data
    1. with custom prefix and
    2. without a prefix.

    Specification(s): prefix/custom, prefix/none

    Design: StochasticResults

    Issue(s): #14410

    Collection(s): FUNCTIONAL

    Type(s): CSVDiff

  • 3.8.15The system shall support the collection of stochastic data that
    1. can be appended into a single data set or
    2. 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: SobolStatistics
  • 3.8.10The 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