DirectPerturbationReporter.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"

// Forward declaration
class DirectPerturbationSampler;

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

  virtual void initialize() override final;

  virtual void execute() override final {}
  virtual void finalize() override final {}

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

  DirectPerturbationSampler & _sampler;

  const bool _relative_sensitivity;

  bool _initialized;
};

template <typename DataType>
class DirectPerturbationReporterContext : public ReporterGeneralContext<std::vector<DataType>>
{
public:
  DirectPerturbationReporterContext(const libMesh::ParallelObject & other,
                                    const MooseObject & producer,
                                    ReporterState<std::vector<DataType>> & state,
                                    DirectPerturbationSampler & sampler,
                                    const std::vector<DataType> & data,
                                    const bool relative_sensitivity);

  virtual void finalize() override;
  virtual std::string type() const override
  {
    return "DirectPerturbationSensitivity<" + MooseUtils::prettyCppType<DataType>() + ">";
  }

private:
  void addSensitivityContribution(DataType & add_to,
                                  const DataType & to_add,
                                  const DataType & reference_value,
                                  const Real interval) const;

  DataType initializeDataType(const DataType & example_output) const;

  DirectPerturbationSampler & _sampler;

  const std::vector<DataType> & _data;

  const bool _relative_sensitivity;
};