THMControl.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 "Control.h"
#include "ControlData.h"
#include "THMProblem.h"

class THMControl : public Control
{
public:
  THMControl(const InputParameters & parameters);

  virtual void init() {}

  const std::vector<std::string> & getControlDataDependencies() const
  {
    return _control_data_depends_on;
  }

protected:
  template <typename T>
  T & declareComponentControlData(const std::string & data_name);

  template <typename T>
  T & declareControlData(const std::string & data_name);

  template <typename T>
  const T & getControlData(const std::string & param_name);

  template <typename T>
  const T & getControlDataOld(const std::string & param_name);

  template <typename T>
  const T & getControlDataByName(const std::string & data_name);

  template <typename T>
  const T & getControlDataOldByName(const std::string & data_name);

  template <typename T>
  const T & getComponentControlDataOld(const std::string & data_name);

  THMProblem * _sim;

  std::vector<std::string> _control_data_depends_on;

public:
  static InputParameters validParams();
};

template <typename T>
T &
THMControl::declareComponentControlData(const std::string & data_name)
{
  std::string full_name = name() + ":" + data_name;
  ControlData<T> * data_ptr = _sim->declareControlData<T>(full_name, this);
  return data_ptr->set();
}

template <typename T>
T &
THMControl::declareControlData(const std::string & data_name)
{
  ControlData<T> * data_ptr = _sim->declareControlData<T>(data_name, this);
  return data_ptr->set();
}

template <typename T>
const T &
THMControl::getControlData(const std::string & param_name)
{
  std::string data_name = getParam<std::string>(param_name);
  return getControlDataByName<T>(data_name);
}

template <typename T>
const T &
THMControl::getControlDataOld(const std::string & param_name)
{
  std::string data_name = getParam<std::string>(param_name);
  return getControlDataOldByName<T>(data_name);
}

template <typename T>
const T &
THMControl::getControlDataByName(const std::string & data_name)
{
  ControlData<T> * data_ptr = _sim->getControlData<T>(data_name);
  if (data_ptr == nullptr)
    mooseError("Trying to get control data '",
               data_name,
               "', but it does not exist in the system. Check your spelling.");

  // set up dependencies for this control object
  auto it = std::find(_control_data_depends_on.begin(), _control_data_depends_on.end(), data_name);
  if (it == _control_data_depends_on.end())
    _control_data_depends_on.push_back(data_name);

  return data_ptr->get();
}

template <typename T>
const T &
THMControl::getControlDataOldByName(const std::string & data_name)
{
  ControlData<T> * data_ptr = _sim->getControlData<T>(data_name);
  if (data_ptr == nullptr)
    mooseError("Trying to get control data '",
               data_name,
               "', but it does not exist in the system. Check your spelling.");

  return data_ptr->getOld();
}

template <typename T>
const T &
THMControl::getComponentControlDataOld(const std::string & data_name)
{
  std::string full_name = name() + ":" + data_name;
  return getControlDataOldByName<T>(full_name);
}