https://mooseframework.inl.gov
SobolStatistics.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
13 
14 class SobolSampler;
15 
20 {
21 public:
24  virtual void execute() override;
25  virtual void initialSetup() override;
26 
28  virtual void initialize() final{};
29  virtual void finalize() final{};
30 
31 protected:
34 
35  // CI levels to be computed
36  const std::vector<Real> & _ci_levels;
37 
38  // Number of CI replicates to use in Bootstrap methods
39  const unsigned int & _ci_replicates;
40 
41  // Random seed for producing CI replicates
42  const unsigned int & _ci_seed;
43 
45  std::vector<std::pair<const VectorPostprocessorValue *, bool>> _result_vectors;
46 
48  std::vector<VectorPostprocessorValue *> _sobol_stat_vectors;
49 
51  std::vector<std::vector<VectorPostprocessorValue *>> _sobol_ci_vectors;
52 };
A class used to perform Monte Carlo sampling for performing Sobol sensitivity analysis.
Definition: SobolSampler.h:23
std::vector< std::vector< VectorPostprocessorValue * > > _sobol_ci_vectors
Confidence interval vectors computed by this object.
std::vector< std::pair< const VectorPostprocessorValue *, bool > > _result_vectors
Result vectors from StocasticResults object.
virtual void finalize() final
const std::vector< Real > & _ci_levels
SobolStatistics(const InputParameters &parameters)
virtual void execute() override
virtual void initialSetup() override
std::vector< VectorPostprocessorValue * > _sobol_stat_vectors
Vectors computed by this object.
Computes Sobol sensitivity indices, see SobolCalculators.
const SobolSampler & _sobol_sampler
The sampler that generated the samples that produced results for the _results_vectors.
const unsigned int & _ci_seed
const InputParameters & parameters() const
static InputParameters validParams()
const unsigned int & _ci_replicates
virtual void initialize() final
Not used; all parallel computation is wrapped in the SobolCalculator objects.