ParameterStudyAction.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 "Action.h"
#include "hit/hit.h"

// Forward declarations
class ReporterName;

class ParameterStudyAction : public Action
{
public:
  static InputParameters validParams();

  ParameterStudyAction(const InputParameters & params);

  virtual void act() override;

  static MooseEnum samplingTypes();
  static MultiMooseEnum distributionTypes();

protected:
  DistributionName distributionName(unsigned int count) const;
  std::vector<DistributionName> distributionNames(unsigned int full_count) const;

  SamplerName samplerName() const { return "study_sampler"; }

  MultiAppName multiappName() const { return "study_app"; }

  std::string samplerReceiverName() const { return "study_receiver"; }

  std::string multiappControlName() const { return "study_multiapp_control"; }

  std::string parameterTransferName() const { return "study_parameter_transfer"; }

  std::string reporterTransferName() const { return "study_qoi_transfer"; }

  std::string stochasticReporterName() const { return "study_results"; }

  OutputName outputName(std::string type) const { return type; }

  ReporterName quantityOfInterestName(const ReporterName & qoi) const;

  std::string statisticsName() const { return "study_statistics"; }

  template <typename T>
  T getDistributionParam(std::string param, unsigned int count) const;

  void showObject(std::string type, std::string name, const InputParameters & params) const;

private:
  static std::vector<std::map<std::string, bool>> samplerParameters();

  static std::vector<std::vector<std::string>> distributionParameters();

  static std::set<std::string> statisticsParameters();

  unsigned int inferMultiAppMode();

  const std::vector<std::string> & _parameters;
  const unsigned int _sampling_type;
  const MultiMooseEnum _distributions;
  const unsigned int _multiapp_mode;
  const bool _compute_stats;
  const bool _show_objects;
};

template <typename T>
T
ParameterStudyAction::getDistributionParam(std::string param, unsigned int count) const
{
  const auto & val = getParam<std::vector<T>>(param);
  return val[count];
}

class AreParametersControllableWalker : public hit::Walker
{
public:
  AreParametersControllableWalker(const std::vector<std::string> & parameters, MooseApp & app);

  void walk(const std::string & fullpath, const std::string & nodename, hit::Node * n) override;
  bool areControllable() const;

private:
  MooseApp & _app;
  std::vector<bool> _is_controllable;
  std::vector<std::pair<std::string, std::string>> _pars;
};

class ExecutionTypeWalker : public hit::Walker
{
public:
  ExecutionTypeWalker() : _exec_type(0), _found_exec(false) {}

  void walk(const std::string & fullpath, const std::string & nodename, hit::Node * n) override;
  unsigned int getExecutionType() const { return _exec_type; }

private:
  unsigned int _exec_type;
  bool _found_exec;
};