https://mooseframework.inl.gov
Statistics.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 #include "BootstrapCalculators.h"
14 
22 {
23 public:
26 
27  virtual void initialSetup() override;
28  virtual void execute() override;
29 
31  void initialize() override final;
32  void finalize() override final {}
33 
34 protected:
37 
40 
42  const std::vector<Real> _ci_levels;
43 
45  const unsigned int _replicates;
46 
48  const unsigned int _seed;
49 
52 
53  // The following vectors are sized to the number of statistics to be computed
54 
56  std::vector<VectorPostprocessorValue *> _stat_vectors;
57 
59  std::vector<std::tuple<std::string, std::string, bool>> _compute_from_names;
60 
61 private:
68  std::vector<Real> computeLevels(const std::vector<Real> & levels_in) const;
69 };
const std::vector< Real > _ci_levels
Confidence levels to compute (see computeLevels)
Definition: Statistics.h:42
const unsigned int _seed
Confidence level seed.
Definition: Statistics.h:48
void finalize() override final
Definition: Statistics.h:32
Compute several metrics for supplied VPP vectors.
Definition: Statistics.h:21
virtual void initialSetup() override
Definition: Statistics.C:83
void initialize() override final
Not used; all parallel computation is wrapped in the Statistics objects.
Definition: Statistics.C:106
const MooseEnum & _ci_method
Bootstrap Confidence Level method.
Definition: Statistics.h:39
static InputParameters validParams()
Definition: Statistics.C:24
VectorPostprocessorValue & _stat_type_vector
The VPP vector that will hold the statistics identifiers.
Definition: Statistics.h:51
const unsigned int _replicates
Confidence level replicates.
Definition: Statistics.h:45
std::vector< std::tuple< std::string, std::string, bool > > _compute_from_names
VPPs names to be computed from (Vectorpostprocessor name, vector name, is_distribute) ...
Definition: Statistics.h:59
const MultiMooseEnum & _compute_stats
The selected statistics to compute.
Definition: Statistics.h:36
Statistics(const InputParameters &parameters)
Definition: Statistics.C:64
std::vector< Real > VectorPostprocessorValue
std::vector< VectorPostprocessorValue * > _stat_vectors
The VPP vectors being computed.
Definition: Statistics.h:56
const InputParameters & parameters() const
std::vector< Real > computeLevels(const std::vector< Real > &levels_in) const
Helper function for converting confidence levels given in (0, 0.5] into levels in (0...
Definition: Statistics.C:147
virtual void execute() override
Definition: Statistics.C:114