RestartableModelInterface.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 "PublicRestartable.h"
#include "StochasticToolsApp.h"

class RestartableModelInterface
{
public:
  static InputParameters validParams();

  RestartableModelInterface(const MooseObject & object,
                            const bool read_only,
                            const std::string & meta_data_name);


  // MOOSEDOCS_BEGIN
  template <typename T, typename... Args>
  T & declareModelData(const std::string & data_name, Args &&... args);
  // MOOSEDOCS_END


  template <typename T, typename... Args>
  const T & getModelData(const std::string & data_name, Args &&... args) const;

  const std::string & modelMetaDataName() const { return _model_meta_data_name; }

  const FileName & getModelDataFileName() const;

  bool hasModelData() const;

private:
  const MooseObject & _model_object;

  const std::string _model_meta_data_name;

  PublicRestartable _model_restartable;
};

template <>
void dataStore(std::ostream & stream, Eigen::LLT<RealEigenMatrix> & decomp, void * context);
template <>
void dataLoad(std::istream & stream, Eigen::LLT<RealEigenMatrix> & decomp, void * context);

template <typename T, typename... Args>
T &
RestartableModelInterface::declareModelData(const std::string & data_name, Args &&... args)
{
  return _model_restartable.declareRestartableData<T>(data_name, std::forward<Args>(args)...);
}

template <typename T, typename... Args>
const T &
RestartableModelInterface::getModelData(const std::string & data_name, Args &&... args) const
{
  return _model_restartable.getRestartableData<T>(data_name, std::forward<Args>(args)...);
}