SobolReporter.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "GeneralReporter.h"
#include "SobolCalculators.h"
#include "VectorOfVectorCalculators.h"

class SobolSampler;
template <typename InType, typename OutType>
class SobolReporterContext;

class SobolReporter : public GeneralReporter
{
public:
  static InputParameters validParams();
  SobolReporter(const InputParameters & parameters);

  virtual void initialSetup() override {}
  virtual void initialize() override;
  virtual void execute() override {}
  virtual void finalize() override {}

  virtual void store(nlohmann::json & json) const override;

private:
  template <typename InType>
  void declareValueHelper(const ReporterName & r_name);

  const SobolSampler & _sobol_sampler;

  const std::vector<Real> & _ci_levels;

  const unsigned int & _ci_replicates;

  const unsigned int & _ci_seed;

  bool _initialized;
};

template <typename OutType>
using SobolState = std::pair<std::vector<OutType>, std::vector<std::vector<OutType>>>;

template <typename InType, typename OutType>
class SobolReporterContext : public ReporterGeneralContext<SobolState<OutType>>
{
public:
  SobolReporterContext(const libMesh::ParallelObject & other,
                       const MooseObject & producer,
                       ReporterState<SobolState<OutType>> & state,
                       const InType & data,
                       const ReporterProducerEnum & mode,
                       const SobolSampler & sampler);

  SobolReporterContext(const libMesh::ParallelObject & other,
                       const MooseObject & producer,
                       ReporterState<SobolState<OutType>> & state,
                       const InType & data,
                       const ReporterProducerEnum & mode,
                       const SobolSampler & sampler,
                       const MooseEnum & ci_method,
                       const std::vector<Real> & ci_levels,
                       unsigned int ci_replicates,
                       unsigned int ci_seed);

  virtual void finalize() override;
  virtual std::string type() const override
  {
    return "SobolIndices<" + MooseUtils::prettyCppType<OutType>() + ">";
  }
  static void
  storeSobol(nlohmann::json & json, const SobolState<OutType> & val, unsigned int nparam);

protected:
  virtual void store(nlohmann::json & json) const override;

private:
  const InType & _data;

  const ReporterProducerEnum & _data_mode;

  const SobolSampler & _sampler;

  StochasticTools::SobolCalculator<InType, OutType> _calc;

  std::unique_ptr<StochasticTools::BootstrapCalculator<std::vector<InType>, std::vector<OutType>>>
      _ci_calc_ptr = nullptr;
};