StochasticTools System

The StochasticTools block is provides parameters that provide convenience for running stochastic simulations. For example, if the block is present it will automatically create the necessary objects for running a parameter study style stochastic analysis. This is where the main input file does not perform a solve, but simply spawns other simulations. Please refer to Parameter Study for an example.

[StochasticTools]
[]

Input Parameters

active__all__ If specified only the blocks named will be visited and made active
Default:__all__
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:If specified only the blocks named will be visited and made active
auto_create_executionerTrueAutomatically setup the Executioner block for a master application without a simulation.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Automatically setup the Executioner block for a master application without a simulation.
auto_create_meshTrueAutomatically setup the Mesh block for a master application without a simulation.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Automatically setup the Mesh block for a master application without a simulation.
auto_create_problemTrueAutomatically setup the Problem block for a master application without a simulation.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Automatically setup the Problem block for a master application without a simulation.
inactiveIf specified blocks matching these identifiers will be skipped.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:If specified blocks matching these identifiers will be skipped.

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.

Advanced Parameters

Available Actions

Stochastic Tools App
StochasticToolsActionAction for performing some common functions for running stochastic simulations.

(contrib/moose/modules/stochastic_tools/examples/parameter_study/main.i)

[StochasticTools]
[]

[Distributions]
  [gamma]
    type = Uniform
    lower_bound = 0.5
    upper_bound = 2.5
  []
  [q_0]
    type = Weibull
    location = -110
    scale = 20
    shape = 1
  []
  [T_0]
    type = Normal
    mean = 300
    standard_deviation = 45
  []
  [s]
    type = Normal
    mean = 100
    standard_deviation = 25
  []
[]

[Samplers]
  [hypercube]
    type = LatinHypercube
    num_rows = 5000
    distributions = 'gamma q_0 T_0 s'
  []
[]

[MultiApps]
  [runner]
    type = SamplerFullSolveMultiApp
    sampler = hypercube
    input_files = 'diffusion.i'
    mode = batch-restore
  []
[]

[Transfers]
  [parameters]
    type = SamplerParameterTransfer
    to_multi_app = runner
    sampler = hypercube
    parameters = 'Materials/constant/prop_values Kernels/source/value BCs/right/value BCs/left/value'
  []
  [results]
    type = SamplerReporterTransfer
    from_multi_app = runner
    sampler = hypercube
    stochastic_reporter = results
    from_reporter = 'T_avg/value q_left/value'
  []
[]

[Reporters]
  [results]
    type = StochasticReporter
  []
  [stats]
    type = StatisticsReporter
    reporters = 'results/results:T_avg:value results/results:q_left:value'
    compute = 'mean stddev'
    ci_method = 'percentile'
    ci_levels = '0.05 0.95'
  []
[]

[Outputs]
  execute_on = 'FINAL'
  [out]
    type = JSON
  []
[]

Input Parameters
Available Actions