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

class ConstantReporter : public GeneralReporter
{
public:
  static InputParameters validParams();
  ConstantReporter(const InputParameters & parameters);
  virtual void initialize() override {}
  virtual void finalize() override {}
  virtual void execute() override {}

protected:
  template <typename T>
  static InputParameters addReporterTypeParams(const std::string & prefix,
                                               bool add_vector = true,
                                               bool multiple_entries = true);

  template <typename T>
  T * declareConstantReporterValue(const std::string & prefix);
  template <typename T>
  std::vector<T *> declareConstantReporterValues(const std::string & prefix);
  template <typename T>
  std::vector<std::vector<T> *> declareConstantVectorReporterValues(const std::string & prefix);
  template <typename T>
  std::vector<std::vector<std::vector<T>> *>
  declareConstantVectorVectorReporterValues(const std::string & prefix);
};

template <typename T>
InputParameters
ConstantReporter::addReporterTypeParams(const std::string & prefix,
                                        bool add_vector,
                                        bool multiple_entries)
{
  InputParameters params = emptyInputParameters();

  if (!multiple_entries)
  {
    mooseAssert(!add_vector, "Should be creating vector of singular entry.");
    params.addParam<ReporterValueName>(prefix + "_name", "Name of " + prefix + " value.");
    params.addParam<T>(prefix + "_value", "Value of " + prefix + ".");
    return params;
  }

  params.addParam<std::vector<ReporterValueName>>(prefix + "_names",
                                                  "Names for each " + prefix + " value.");
  params.addParam<std::vector<T>>(prefix + "_values", "Values for " + prefix + "s.");
  if (add_vector)
  {
    params.addParam<std::vector<ReporterValueName>>(
        prefix + "_vector_names", "Names for each vector of " + prefix + "s value.");
    params.addParam<std::vector<std::vector<T>>>(prefix + "_vector_values",
                                                 "Values for vectors of " + prefix + "s.");

    params.addParam<std::vector<ReporterValueName>>(prefix + "_vector_vector_names",
                                                    "Names for each vector of vectors of " +
                                                        prefix + "s value.");
    params.addParam<std::vector<std::vector<std::vector<T>>>>(
        prefix + "_vector_vector_values", "Values for vectors of vectors of " + prefix + "s.");
  }

  return params;
}

template <typename T>
T *
ConstantReporter::declareConstantReporterValue(const std::string & prefix)
{
  std::string names_param(prefix + "_name");
  std::string values_param(prefix + "_value");
  if (isParamValid(names_param) != isParamValid(values_param))
    paramError((isParamValid(names_param) ? names_param : values_param),
               "'",
               names_param,
               "' and '",
               values_param,
               "' must be set together.");
  else if (isParamValid(names_param))
    return &declareValue<T>(names_param, getParam<T>(values_param));

  return nullptr;
}

template <typename T>
std::vector<T *>
ConstantReporter::declareConstantReporterValues(const std::string & prefix)
{
  std::string names_param(prefix + "_names");
  std::string values_param(prefix + "_values");
  std::vector<T *> data;

  if (isParamValid(names_param) && !isParamValid(values_param))
    paramError(names_param, "Must specify values using ", values_param);
  else if (!isParamValid(names_param) && isParamValid(values_param))
    paramError(values_param, "Use ", names_param, " to specify reporter names.");
  else if (!isParamValid(names_param) && !isParamValid(values_param))
    return data;

  auto & names = getParam<std::vector<ReporterValueName>>(names_param);
  auto & values = this->getParam<std::vector<T>>(values_param);
  if (names.size() != values.size())
    paramError(values_param,
               "Number of names specified in ",
               names_param,
               " must match number of values specified in ",
               values_param);

  for (unsigned int i = 0; i < names.size(); ++i)
    data.push_back(&this->declareValueByName<T>(names[i], values[i]));

  return data;
}

template <typename T>
std::vector<std::vector<T> *>
ConstantReporter::declareConstantVectorReporterValues(const std::string & prefix)
{
  return this->declareConstantReporterValues<std::vector<T>>(prefix + "_vector");
}

template <typename T>
std::vector<std::vector<std::vector<T>> *>
ConstantReporter::declareConstantVectorVectorReporterValues(const std::string & prefix)
{
  return this->declareConstantReporterValues<std::vector<std::vector<T>>>(prefix +
                                                                          "_vector_vector");
}