MorrisReporter.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 "VectorCalculators.h"

#include "nlohmann/json.h"

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

  virtual void initialize() override final;

  virtual void execute() override final {}
  virtual void finalize() override final {}
  virtual void store(nlohmann::json & json) const override;

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

  Sampler & _sampler;

  const std::vector<Real> & _ci_levels;

  const unsigned int & _ci_replicates;

  const unsigned int & _ci_seed;

  bool _initialized;
};

template <typename DataType>
using MorrisState =
    std::map<std::string, std::pair<std::vector<DataType>, std::vector<std::vector<DataType>>>>;

template <typename DataType>
class MorrisReporterContext : public ReporterGeneralContext<MorrisState<DataType>>
{
public:
  MorrisReporterContext(const libMesh::ParallelObject & other,
                        const MooseObject & producer,
                        ReporterState<MorrisState<DataType>> & state,
                        Sampler & sampler,
                        const std::vector<DataType> & data);

  MorrisReporterContext(const libMesh::ParallelObject & other,
                        const MooseObject & producer,
                        ReporterState<MorrisState<DataType>> & state,
                        Sampler & sampler,
                        const std::vector<DataType> & data,
                        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 "MorrisSensitivity<" + MooseUtils::prettyCppType<DataType>() + ">";
  }

private:
  std::vector<DataType> computeElementaryEffects(const RealEigenMatrix & x,
                                                 const std::vector<DataType> & y) const;

  Sampler & _sampler;

  const std::vector<DataType> & _data;

  std::unique_ptr<StochasticTools::Calculator<std::vector<DataType>, DataType>> _mu_calc;
  std::unique_ptr<StochasticTools::Calculator<std::vector<DataType>, DataType>> _mustar_calc;
  std::unique_ptr<StochasticTools::Calculator<std::vector<DataType>, DataType>> _sig_calc;

  std::unique_ptr<StochasticTools::BootstrapCalculator<std::vector<DataType>, DataType>>
      _ci_mu_calc;
  std::unique_ptr<StochasticTools::BootstrapCalculator<std::vector<DataType>, DataType>>
      _ci_mustar_calc;
  std::unique_ptr<StochasticTools::BootstrapCalculator<std::vector<DataType>, DataType>>
      _ci_sig_calc;
};