ChainControlData.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 "Restartable.h"
#include "MooseUtils.h"

class ChainControl;

class ChainControlDataBase : public Restartable
{
public:
  ChainControlDataBase(MooseApp & moose_app, const std::string & name)
    : Restartable(moose_app, name, "chain_control", 0),
      _name(name),
      _declared(false),
      _chain_control(nullptr)
  {
  }

  virtual ~ChainControlDataBase() = default;

  virtual std::string type() = 0;

  const std::string & name() const { return _name; }

  const ChainControl & getChainControl() const;

  void setChainControl(ChainControl & ctrl) { _chain_control = &ctrl; }

  void setDeclared() { _declared = true; }

  bool getDeclared() { return _declared; }

  virtual void copyValuesBack() = 0;

protected:
  const std::string _name;
  bool _declared;
  ChainControl * _chain_control;
};

template <typename T>
class ChainControlData : public ChainControlDataBase
{
public:
  ChainControlData(MooseApp & moose_app, std::string name)
    : ChainControlDataBase(moose_app, name),
      _value(declareRestartableData<T>(name)),
      _value_old(declareRestartableData<T>(name + "_old"))
  {
  }

  const T & get() const { return _value; }

  const T & getOld() const { return _value_old; }

  T & set() { return _value; }

  virtual std::string type() override;

  virtual void copyValuesBack() override;

private:
  T & _value;
  T & _value_old;
};

template <typename T>
inline std::string
ChainControlData<T>::type()
{
  return MooseUtils::prettyCppType<T>();
}

template <typename T>
inline void
ChainControlData<T>::copyValuesBack()
{
  _value_old = _value;
}