An interface class which manages the model data save and load functionalities from moose objects (such as surrogates, mappings, etc.) in the stochastic tools module. More...

#include <RestartableModelInterface.h>

Inheritance diagram for RestartableModelInterface:

[legend]

Public Member Functions
	RestartableModelInterface (const MooseObject &object, const bool read_only, const std::string &meta_data_name)

const std::string &	modelMetaDataName () const
	Accessor for the name of the model meta data. More...

const FileName &	getModelDataFileName () const
	Get the associated filename. More...

bool	hasModelData () const
	Check if we need to load model data (if the filename parameter is used) More...


template<typename T , typename... Args>
T &	declareModelData (const std::string &data_name, Args &&... args)
	Declare model data for loading from file as well as restart. More...


template<typename T , typename... Args>
const T &	getModelData (const std::string &data_name, Args &&... args) const
	Retrieve model data from the interface. More...

Static Public Member Functions
static InputParameters	validParams ()

Private Attributes
const MooseObject &	_model_object
	Reference to the MooseObject that uses this interface. More...

const std::string	_model_meta_data_name
	The model meta data name. More...

PublicRestartable	_model_restartable
	Member for interfacing with the framework's restartable system. More...

Detailed Description

An interface class which manages the model data save and load functionalities from moose objects (such as surrogates, mappings, etc.) in the stochastic tools module.

Definition at line 19 of file RestartableModelInterface.h.

Constructor & Destructor Documentation

◆ RestartableModelInterface()

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

Definition at line 21 of file RestartableModelInterface.C.

   : _model_object(object),
     _model_meta_data_name(meta_data_name),
     _model_restartable(_model_object.getMooseApp(), "", "", 0, read_only, meta_data_name)
 {
   _model_object.getMooseApp().registerRestartableDataMapName(_model_meta_data_name,
                                                              _model_object.name());
 }

Member Function Documentation

◆ declareModelData()

template<typename T , typename... Args>

T & RestartableModelInterface::declareModelData	(	const std::string &	data_name,
		Args &&...	args
	)

Declare model data for loading from file as well as restart.

Definition at line 78 of file RestartableModelInterface.h.

 {
   return _model_restartable.declareRestartableData<T>(data_name, std::forward<Args>(args)...);
 }

◆ getModelData()

template<typename T , typename... Args>

const T & RestartableModelInterface::getModelData	(	const std::string &	data_name,
		Args &&...	args
	)		const

Retrieve model data from the interface.

Definition at line 85 of file RestartableModelInterface.h.

 {
   return _model_restartable.getRestartableData<T>(data_name, std::forward<Args>(args)...);
 }

◆ getModelDataFileName()

const FileName & RestartableModelInterface::getModelDataFileName ( ) const

Get the associated filename.

Definition at line 33 of file RestartableModelInterface.C.

 {
   return _model_object.getParam<FileName>("filename");
 }

◆ hasModelData()

bool RestartableModelInterface::hasModelData ( ) const

Check if we need to load model data (if the filename parameter is used)

Definition at line 39 of file RestartableModelInterface.C.

 {
   return _model_object.isParamValid("filename");
 }

◆ modelMetaDataName()

const std::string& RestartableModelInterface::modelMetaDataName ( ) const

inline

Accessor for the name of the model meta data.

Definition at line 47 of file RestartableModelInterface.h.

Referenced by SurrogateTrainerOutput::output(), and MappingOutput::output().

47 { return _model_meta_data_name; }

RestartableModelInterface::_model_meta_data_name

const std::string _model_meta_data_name

The model meta data name.

Definition: RestartableModelInterface.h:61

◆ validParams()

InputParameters RestartableModelInterface::validParams ( )

static

Definition at line 13 of file RestartableModelInterface.C.

Referenced by SurrogateModel::validParams(), VariableMappingBase::validParams(), and SurrogateTrainerBase::validParams().

 {
   InputParameters params = emptyInputParameters();
   params.addParam<FileName>(
       "filename", "The name of the file which will be associated with the saved/loaded data.");
   return params;
 }