#include <LibtorchNeuralNetControlTransfer.h>

Inheritance diagram for LibtorchNeuralNetControlTransfer:

Public Types
enum	DIRECTION

typedef DataFileName	DataFileParameterType

Public Member Functions
	LibtorchNeuralNetControlTransfer (const InputParameters &parameters)

virtual void	execute () override

void	variableIntegrityCheck (const AuxVariableName &var_name, bool is_from_multiapp) const

void	initialSetup () override

const std::shared_ptr< MultiApp >	getMultiApp () const

const std::shared_ptr< MultiApp >	getFromMultiApp () const

const std::shared_ptr< MultiApp >	getToMultiApp () const

std::string	getFromName () const

std::string	getToName () const

bool	hasFromMultiApp () const

bool	hasToMultiApp () const

virtual void	getAppInfo ()

const MultiMooseEnum &	directions ()

void	setCurrentDirection (const int direction)

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

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

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	subdomainSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

PerfGraph &	perfGraph ()

MooseEnum	direction ()

MooseEnum	direction ()

MooseEnum	currentDirection ()

MooseEnum	currentDirection ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

template<>
SurrogateModel &	getSurrogateModel (const std::string &name) const

template<>
SurrogateTrainerBase &	getSurrogateTrainer (const std::string &name) const

template<>
SurrogateModel &	getSurrogateModelByName (const UserObjectName &name) const

template<>
SurrogateTrainerBase &	getSurrogateTrainerByName (const UserObjectName &name) const


template<typename T = SurrogateModel>
T &	getSurrogateModel (const std::string &name) const
	Get a SurrogateModel/Trainer with a given name. More...

template<typename T = SurrogateTrainerBase>
T &	getSurrogateTrainer (const std::string &name) const


template<typename T = SurrogateModel>
T &	getSurrogateModelByName (const UserObjectName &name) const
	Get a sampler with a given name. More...

template<typename T = SurrogateTrainerBase>
T &	getSurrogateTrainerByName (const UserObjectName &name) const

Static Public Member Functions
static InputParameters	validParams ()

static void	addSkipCoordCollapsingParam (InputParameters &params)

static libMesh::System *	find_sys (libMesh::EquationSystems &es, const std::string &var_name)

static std::string	possibleDirections ()

Public Attributes
	TO_MULTIAPP

	FROM_MULTIAPP

	BETWEEN_MULTIAPP

const ConsoleStream	_console

Static Public Attributes
static const libMesh::Number	OutOfMeshValue

Protected Member Functions
std::vector< unsigned int >	getFromsPerProc ()

libMesh::NumericVector< Real > &	getTransferVector (unsigned int i_local, std::string var_name)

unsigned int	getGlobalSourceAppIndex (unsigned int i_from) const

unsigned int	getGlobalTargetAppIndex (unsigned int i_to) const

unsigned int	getLocalSourceAppIndex (unsigned int i_from) const

virtual void	checkSiblingsTransferSupported () const

void	errorIfObjectExecutesOnTransferInSourceApp (const std::string &object_name) const

Point	getPointInTargetAppFrame (const Point &p, unsigned int local_i_to, const std::string &phase) const

void	checkMultiAppExecuteOn ()

void	checkVariable (const FEProblemBase &fe_problem, const VariableName &var_name, const std::string &param_name="") const

void	extendBoundingBoxes (const Real factor, std::vector< libMesh::BoundingBox > &bboxes) const

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

ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

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

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

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

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

std::string	restartableName (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

std::vector< libMesh::BoundingBox >	getFromBoundingBoxes ()

std::vector< libMesh::BoundingBox >	getFromBoundingBoxes (BoundaryID boundary_id)

std::vector< libMesh::BoundingBox >	getFromBoundingBoxes ()

std::vector< libMesh::BoundingBox >	getFromBoundingBoxes (BoundaryID boundary_id)

Static Protected Member Functions
static void	addBBoxFactorParam (InputParameters &params)

static void	transformBoundingBox (libMesh::BoundingBox &box, const MultiAppCoordTransform &transform)

Protected Attributes
const std::string	_control_name
	The name of the control object on the other app where we want to copy our neural net. More...

const LibtorchDRLControlTrainer &	_trainer
	The trainer object which will contains the control neural net. More...

std::shared_ptr< MultiApp >	_multi_app

std::vector< FEProblemBase *>	_to_problems

std::vector< FEProblemBase *>	_from_problems

std::vector< libMesh::EquationSystems *>	_to_es

std::vector< libMesh::EquationSystems *>	_from_es

std::vector< MooseMesh *>	_to_meshes

std::vector< MooseMesh *>	_from_meshes

std::vector< Point >	_to_positions

std::vector< Point >	_from_positions

std::vector< std::unique_ptr< MultiAppCoordTransform > >	_to_transforms

std::vector< std::unique_ptr< MultiAppCoordTransform > >	_from_transforms

const bool	_skip_coordinate_collapsing

bool	_displaced_source_mesh

bool	_displaced_target_mesh

Real	_bbox_factor

std::vector< unsigned int >	_to_local2global_map

std::vector< unsigned int >	_from_local2global_map

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

THREAD_ID	_tid

MultiMooseEnum	_directions

const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

MooseApp &	_pg_moose_app

const std::string	_prefix

MooseEnum	_direction

MooseEnum	_current_direction

const Parallel::Communicator &	_communicator

Detailed Description

Definition at line 20 of file LibtorchNeuralNetControlTransfer.h.

Constructor & Destructor Documentation

◆ LibtorchNeuralNetControlTransfer()

LibtorchNeuralNetControlTransfer::LibtorchNeuralNetControlTransfer ( const InputParameters & parameters )

Definition at line 37 of file LibtorchNeuralNetControlTransfer.C.

   : MultiAppTransfer(parameters),
     SurrogateModelInterface(this),
     _control_name(getParam<std::string>("control_name")),
     _trainer(getSurrogateTrainerByName<LibtorchDRLControlTrainer>(
         getParam<UserObjectName>("trainer_name")))
 {
 }

Member Function Documentation

◆ execute()

void LibtorchNeuralNetControlTransfer::execute ( )

overridevirtual

Implements MultiAppTransfer.

Definition at line 48 of file LibtorchNeuralNetControlTransfer.C.

 {
   // Get the control neural net from the trainer
   const Moose::LibtorchArtificialNeuralNet & trainer_nn = _trainer.controlNeuralNet();
 
   // Get the control object from the other app
   FEProblemBase & app_problem = _multi_app->appProblemBase(0);
   auto & control_warehouse = app_problem.getControlWarehouse();
   std::shared_ptr<Control> control_ptr = control_warehouse.getActiveObject(_control_name);
   LibtorchNeuralNetControl * control_object =
       dynamic_cast<LibtorchNeuralNetControl *>(control_ptr.get());
 
   if (!control_object)
     paramError("control_name", "The given gontrol is not a LibtorchNeuralNetrControl!");
 
   // Copy and the neural net and execute it to get the initial values
   control_object->loadControlNeuralNet(trainer_nn);
   control_object->execute();
 }

◆ getSurrogateModel() [1/2]

template<>

SurrogateModel& SurrogateModelInterface::getSurrogateModel ( const std::string & name ) const

inherited

Definition at line 46 of file SurrogateModelInterface.C.

 {
   return getSurrogateModelByName<SurrogateModel>(_smi_params.get<UserObjectName>(name));
 }

◆ getSurrogateModel() [2/2]

template<typename T >

T & SurrogateModelInterface::getSurrogateModel ( const std::string & name ) const

inherited

Get a SurrogateModel/Trainer with a given name.

Parameters

name	The name of the parameter key of the sampler to retrieve

Returns: The sampler with name associated with the parameter 'name'

Definition at line 81 of file SurrogateModelInterface.h.

Referenced by SurrogateTrainer::initialize().

 {
   return getSurrogateModelByName<T>(_smi_params.get<UserObjectName>(name));
 }

◆ getSurrogateModelByName() [1/2]

template<>

SurrogateModel& SurrogateModelInterface::getSurrogateModelByName ( const UserObjectName & name ) const

inherited

Definition at line 31 of file SurrogateModelInterface.C.

 {
   std::vector<SurrogateModel *> models;
   _smi_feproblem.theWarehouse()
       .query()
       .condition<AttribName>(name)
       .condition<AttribSystem>("SurrogateModel")
       .queryInto(models);
   if (models.empty())
     mooseError("Unable to find a SurrogateModel object with the name '" + name + "'");
   return *(models[0]);
 }

◆ getSurrogateModelByName() [2/2]

template<typename T >

T & SurrogateModelInterface::getSurrogateModelByName ( const UserObjectName & name ) const

inherited

Get a sampler with a given name.

Parameters

name	The name of the sampler to retrieve

Returns: The sampler with name 'name'

Definition at line 88 of file SurrogateModelInterface.h.

Referenced by CrossValidationScores::CrossValidationScores(), EvaluateSurrogate::EvaluateSurrogate(), and InverseMapping::initialSetup().

 {
   std::vector<T *> models;
   _smi_feproblem.theWarehouse()
       .query()
       .condition<AttribName>(name)
       .condition<AttribSystem>("SurrogateModel")
       .queryInto(models);
   if (models.empty())
     mooseError("Unable to find a SurrogateModel object of type " + std::string(typeid(T).name()) +
                " with the name '" + name + "'");
   return *(models[0]);
 }

◆ getSurrogateTrainer() [1/2]

template<typename T >

T & SurrogateModelInterface::getSurrogateTrainer ( const std::string & name ) const

inherited

Definition at line 104 of file SurrogateModelInterface.h.

 {
   return getSurrogateTrainerByName<T>(_smi_params.get<UserObjectName>(name));
 }

◆ getSurrogateTrainer() [2/2]

template<>

SurrogateTrainerBase& SurrogateModelInterface::getSurrogateTrainer ( const std::string & name ) const

inherited

Definition at line 60 of file SurrogateModelInterface.C.

 {
   return getSurrogateTrainerByName<SurrogateTrainerBase>(_smi_params.get<UserObjectName>(name));
 }

◆ getSurrogateTrainerByName() [1/2]

template<>

SurrogateTrainerBase& SurrogateModelInterface::getSurrogateTrainerByName ( const UserObjectName & name ) const

inherited

Definition at line 53 of file SurrogateModelInterface.C.

 {
   return _smi_feproblem.getUserObject<SurrogateTrainerBase>(name);
 }

◆ getSurrogateTrainerByName() [2/2]

template<typename T >

T & SurrogateModelInterface::getSurrogateTrainerByName ( const UserObjectName & name ) const

inherited

Definition at line 111 of file SurrogateModelInterface.h.

Referenced by SurrogateTrainerOutput::output().

 {
   SurrogateTrainerBase * base_ptr =
       &_smi_feproblem.getUserObject<SurrogateTrainerBase>(name, _smi_tid);
   T * obj_ptr = dynamic_cast<T *>(base_ptr);
   if (!obj_ptr)
     mooseError("Failed to find a SurrogateTrainer object of type " + std::string(typeid(T).name()) +
                    " with the name '",
                name,
                "' for the desired type.");
   return *obj_ptr;
 }

◆ validParams()

InputParameters LibtorchNeuralNetControlTransfer::validParams ( )

static

Definition at line 18 of file LibtorchNeuralNetControlTransfer.C.

 {
   InputParameters params = MultiAppTransfer::validParams();
   params += SurrogateModelInterface::validParams();
 
   params.addClassDescription("Copies a neural network from a trainer object on the main app to a "
                              "LibtorchNeuralNetControl object on the subapp.");
 
   params.suppressParameter<MultiAppName>("from_multi_app");
   params.suppressParameter<MultiAppName>("multi_app");
   params.suppressParameter<MultiMooseEnum>("direction");
 
   params.addRequiredParam<UserObjectName>("trainer_name",
                                           "Trainer object that contains the neural networks."
                                           " for different samples.");
   params.addRequiredParam<std::string>("control_name", "Controller object name.");
   return params;
 }

Member Data Documentation

◆ _control_name

const std::string LibtorchNeuralNetControlTransfer::_control_name

protected

The name of the control object on the other app where we want to copy our neural net.

Definition at line 31 of file LibtorchNeuralNetControlTransfer.h.

Referenced by execute().

◆ _trainer

const LibtorchDRLControlTrainer& LibtorchNeuralNetControlTransfer::_trainer

protected

The trainer object which will contains the control neural net.

Definition at line 34 of file LibtorchNeuralNetControlTransfer.h.

Referenced by execute().

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

stochastic_tools/include/libtorch/transfers/LibtorchNeuralNetControlTransfer.h
stochastic_tools/src/libtorch/transfers/LibtorchNeuralNetControlTransfer.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LibtorchNeuralNetControlTransfer()

Member Function Documentation

◆ execute()

◆ getSurrogateModel() [1/2]

◆ getSurrogateModel() [2/2]

◆ getSurrogateModelByName() [1/2]

◆ getSurrogateModelByName() [2/2]

◆ getSurrogateTrainer() [1/2]

◆ getSurrogateTrainer() [2/2]

◆ getSurrogateTrainerByName() [1/2]

◆ getSurrogateTrainerByName() [2/2]

◆ validParams()

Member Data Documentation

◆ _control_name

◆ _trainer