https://mooseframework.inl.gov
RestartableModelInterface.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
11 
14 {
16  params.addParam<FileName>(
17  "filename", "The name of the file which will be associated with the saved/loaded data.");
18  return params;
19 }
20 
22  const bool read_only,
23  const std::string & meta_data_name)
24  : _model_object(object),
25  _model_meta_data_name(meta_data_name),
26  _model_restartable(_model_object.getMooseApp(), "", "", 0, read_only, meta_data_name)
27 {
30 }
31 
32 const FileName &
34 {
35  return _model_object.getParam<FileName>("filename");
36 }
37 
38 bool
40 {
41  return _model_object.isParamValid("filename");
42 }
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
const FileName & getModelDataFileName() const
Get the associated filename.
virtual const std::string & name() const
MooseApp & getMooseApp() const
InputParameters emptyInputParameters()
bool isParamValid(const std::string &name) const
const std::string _model_meta_data_name
The model meta data name.
bool hasModelData() const
Check if we need to load model data (if the filename parameter is used)
static InputParameters validParams()
const T & getParam(const std::string &name) const
const MooseObject & _model_object
Reference to the MooseObject that uses this interface.
void registerRestartableDataMapName(const RestartableDataMapName &name, std::string suffix="")
RestartableModelInterface(const MooseObject &object, const bool read_only, const std::string &meta_data_name)