Action for loading the model data for the mapping objects. More...

#include <LoadModelDataAction.h>

Inheritance diagram for LoadModelDataAction< T >:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	LoadModelDataAction (const InputParameters &params)

virtual void	act () override

void	timedAct ()

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)

MooseObjectName	uniqueActionName () const

const std::string &	specificTaskName () const

const std::set< std::string > &	getAllTasks () const

void	appendTask (const std::string &task)

MooseApp &	getMooseApp () const

const std::string &	type () const

virtual const std::string &	name () const

std::string	typeAndName () const

std::string	errorPrefix (const std::string &error_type) const

void	callMooseError (std::string msg, const bool with_prefix) const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

const InputParameters &	parameters () const

MooseObjectName	uniqueName () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &nm) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	mooseError (Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseInfo (Args &&... args) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

PerfGraph &	perfGraph ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

Public Attributes
const ConsoleStream	_console

Static Public Attributes
static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)

void	associateWithParameter (const std::string &param_name, InputParameters &params) const

void	associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) const

const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)

const T &	getMeshProperty (const std::string &data_name)

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

bool	hasMeshProperty (const std::string &data_name) const

std::string	meshPropertyName (const std::string &data_name) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
std::string	_registered_identifier

std::string	_specific_task_name

std::set< std::string >	_all_tasks

ActionWarehouse &	_awh

const std::string &	_current_task

std::shared_ptr< MooseMesh > &	_mesh

std::shared_ptr< MooseMesh > &	_displaced_mesh

std::shared_ptr< FEProblemBase > &	_problem

PerfID	_act_timer

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Private Member Functions
void	load (const T &object)
	Load the necessary information for the given model. More...

Detailed Description

template<typename T>
class LoadModelDataAction< T >

Action for loading the model data for the mapping objects.

Template Parameters

The	type of the object which needs to be loaded. This needs to be a derived class of `RestartableModelInterface` at the moment.

Definition at line 23 of file LoadModelDataAction.h.

Constructor & Destructor Documentation

◆ LoadModelDataAction()

template<typename T>

LoadModelDataAction< T >::LoadModelDataAction ( const InputParameters & params )

inline

Definition at line 28 of file LoadModelDataAction.h.

28 : Action(params) {}

Action::Action

Action(const InputParameters &parameters)

Member Function Documentation

◆ act()

template<typename T >

void LoadModelDataAction< T >::act ( )

overridevirtual

Implements Action.

Definition at line 49 of file LoadModelDataAction.h.

 {
   static_assert(std::is_base_of<RestartableModelInterface, T>::value,
                 "You must derive from RestartableModelInterface to use this action");
 
   // We fetch the mapping objects and then load the necessary data
   std::vector<T *> objects;
   static const auto attribute_name = T::validParams().getSystemAttributeName();
 
   _app.theWarehouse().query().template condition<AttribSystem>(attribute_name).queryInto(objects);
   for (auto object_ptr : objects)
     if (object_ptr->hasModelData())
       load(*object_ptr);
 }

◆ load()

template<typename T>

void LoadModelDataAction< T >::load ( const T & object )

private

Load the necessary information for the given model.

Parameters

object Reference to the object whose data shall be loaded

Definition at line 66 of file LoadModelDataAction.h.

 {
   // Create the object that will load in data
   RestartableDataReader reader(
       _app, _app.getRestartableDataMap(object.modelMetaDataName()), _app.forceRestart());
   reader.setErrorOnLoadWithDifferentNumberOfProcessors(false);
 
   // Read the supplied file
   const std::string filename = object.getModelDataFileName();
   try
   {
     reader.setInput(filename);
     reader.restore();
   }
   catch (...)
   {
     paramError("filename", "The supplied file '", filename, "' failed to load.");
   }
 }

◆ validParams()

template<typename T >

InputParameters LoadModelDataAction< T >::validParams ( )

static

Definition at line 42 of file LoadModelDataAction.h.

Referenced by LoadMappingDataAction::validParams(), and LoadSurrogateDataAction::validParams().

 {
   return Action::validParams();
 }

The documentation for this class was generated from the following file:

stochastic_tools/include/actions/LoadModelDataAction.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions