InputParameterWarehouse.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 <gtest/gtest.h>
#include "MooseObjectName.h"
#include "MooseTypes.h"
#include "ControllableItem.h"
#include "ControllableParameter.h"
#include "ControlOutput.h"

// Forward declarations
class InputParameters;
class Factory;
class ActionFactory;

class InputParameterWarehouse
{
public:
  InputParameterWarehouse();

  virtual ~InputParameterWarehouse() = default;

  class AddRemoveParamsKey
  {
    friend class Factory;
    friend class ActionFactory;
    FRIEND_TEST(InputParameterWarehouseTest, getControllableItems);
    FRIEND_TEST(InputParameterWarehouseTest, getControllableParameter);
    FRIEND_TEST(InputParameterWarehouseTest, getControllableParameterValues);
    FRIEND_TEST(InputParameterWarehouseTest, emptyControllableParameterValues);
    FRIEND_TEST(InputParameterWarehouseTest, addControllableParameterConnection);
    FRIEND_TEST(InputParameterWarehouseTest, addControllableParameterAlias);
    AddRemoveParamsKey() {}
    AddRemoveParamsKey(const AddRemoveParamsKey &) {}
  };


  const InputParameters & getInputParametersObject(const std::string & name,
                                                   THREAD_ID tid = 0) const;
  const InputParameters & getInputParametersObject(const std::string & tag,
                                                   const std::string & name,
                                                   THREAD_ID tid = 0) const;
  const InputParameters & getInputParametersObject(const MooseObjectName & object_name,
                                                   THREAD_ID tid = 0) const;

  const std::multimap<MooseObjectName, std::shared_ptr<InputParameters>> &
  getInputParameters(THREAD_ID tid = 0) const;

  void addControllableParameterConnection(const MooseObjectParameterName & primary,
                                          const MooseObjectParameterName & secondary,
                                          bool error_on_empty = true);

  void addControllableParameterAlias(const MooseObjectParameterName & alias,
                                     const MooseObjectParameterName & secondary);

  void addControllableObjectAlias(const MooseObjectName & alias, const MooseObjectName & secondary);

  /***
   * Helper method for printing controllable items.
   */
  std::string dumpChangedControls(bool reset_changed) const;

  template <typename T>
  std::vector<T> getControllableParameterValues(const MooseObjectParameterName & input) const;

  std::vector<MooseObjectParameterName>
  getControllableParameterNames(const MooseObjectParameterName & input) const;

  InputParameters & addInputParameters(const std::string & name,
                                       const InputParameters & parameters,
                                       THREAD_ID tid,
                                       const AddRemoveParamsKey);

  void
  removeInputParameters(const MooseObject & moose_object, THREAD_ID tid, const AddRemoveParamsKey);

private:
  std::vector<std::multimap<MooseObjectName, std::shared_ptr<InputParameters>>> _input_parameters;

  std::vector<std::vector<std::shared_ptr<ControllableItem>>> _controllable_items;

  ControllableParameter getControllableParameter(const MooseObjectParameterName & input) const;

  std::vector<ControllableItem *> getControllableItems(const MooseObjectParameterName & desired,
                                                       THREAD_ID tid = 0) const;


  InputParameters & getInputParameters(const std::string & name, THREAD_ID tid = 0) const;
  InputParameters &
  getInputParameters(const std::string & tag, const std::string & name, THREAD_ID tid = 0) const;
  InputParameters & getInputParameters(const MooseObjectName & object_name,
                                       THREAD_ID tid = 0) const;

  friend class Control;

  // Allow unit test to call methods
  FRIEND_TEST(InputParameterWarehouseTest, getControllableItems);
  FRIEND_TEST(InputParameterWarehouseTest, getControllableParameter);
  FRIEND_TEST(InputParameterWarehouseTest, getControllableParameterValues);
  FRIEND_TEST(InputParameterWarehouseTest, emptyControllableParameterValues);
  FRIEND_TEST(InputParameterWarehouseTest, addControllableParameterConnection);
  FRIEND_TEST(InputParameterWarehouseTest, addControllableParameterAlias);
};

template <typename T>
std::vector<T>
InputParameterWarehouse::getControllableParameterValues(
    const MooseObjectParameterName & input) const
{
  ControllableParameter param = getControllableParameter(input);
  return param.get<T>();
}