https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
LibtorchNeuralNetControlTransfer Class Reference

#include <LibtorchNeuralNetControlTransfer.h>

Inheritance diagram for LibtorchNeuralNetControlTransfer:
[legend]

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
 
bool isKokkosObject (IsKokkosObjectKey &&) const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
const std::string & name () const
 
std::string typeAndName () const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
MooseObjectName uniqueName () const
 
const InputParameters & parameters () const
 
const hit::Node * getHitNode () const
 
bool hasBase () const
 
const std::string & getBase () 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 &name) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (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
 
std::string messagePrefix (const bool hit_prefix=true) const
 
std::string errorPrefix (const std::string &) const
 
void mooseError (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
void callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr) 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 callMooseError (MooseApp *const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node *node)
 
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
 
 usingCombinedWarningSolutionWarnings
 
const ConsoleStream _console
 

Static Public Attributes

static const libMesh::Number OutOfMeshValue
 
static const std::string type_param
 
static const std::string name_param
 
static const std::string unique_name_param
 
static const std::string app_param
 
static const std::string moose_base_param
 
static const std::string kokkos_object_param
 

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 checkParentAppUserObjectExecuteOn (const std::string &object_name) 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
 
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) 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 addUserObjectExecutionCheckParam (InputParameters &params)
 
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
 
Factory & _factory
 
ActionFactory & _action_factory
 
const std::string & _type
 
const std::string & _name
 
const InputParameters & _pars
 
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.

39  : MultiAppTransfer(parameters),
40  SurrogateModelInterface(this),
41  _control_name(getParam<std::string>("control_name")),
42  _trainer(getSurrogateTrainerByName<LibtorchDRLControlTrainer>(
43  getParam<UserObjectName>("trainer_name")))
44 {
45 }
LibtorchNeuralNetControlTransfer::_trainer
const LibtorchDRLControlTrainer & _trainer
The trainer object which will contains the control neural net.
Definition: LibtorchNeuralNetControlTransfer.h:34
MultiAppTransfer::parameters
const InputParameters & parameters() const
MultiAppTransfer::MultiAppTransfer
MultiAppTransfer(const InputParameters &parameters)
LibtorchNeuralNetControlTransfer::_control_name
const std::string _control_name
The name of the control object on the other app where we want to copy our neural net.
Definition: LibtorchNeuralNetControlTransfer.h:31
SurrogateModelInterface::SurrogateModelInterface
SurrogateModelInterface(const MooseObject *moose_object)
Definition: SurrogateModelInterface.C:22

Member Function Documentation

◆ execute()

void LibtorchNeuralNetControlTransfer::execute ( )
overridevirtual

Implements MultiAppTransfer.

Definition at line 48 of file LibtorchNeuralNetControlTransfer.C.

49 {
50  // Get the control neural net from the trainer
51  const Moose::LibtorchArtificialNeuralNet & trainer_nn = _trainer.controlNeuralNet();
52 
53  // Get the control object from the other app
54  FEProblemBase & app_problem = _multi_app->appProblemBase(0);
55  auto & control_warehouse = app_problem.getControlWarehouse();
56  std::shared_ptr<Control> control_ptr = control_warehouse.getActiveObject(_control_name);
57  LibtorchNeuralNetControl * control_object =
58  dynamic_cast<LibtorchNeuralNetControl *>(control_ptr.get());
59 
60  if (!control_object)
61  paramError("control_name", "The given gontrol is not a LibtorchNeuralNetrControl!");
62 
63  // Copy and the neural net and execute it to get the initial values
64  control_object->loadControlNeuralNet(trainer_nn);
65  control_object->execute();
66 }
LibtorchNeuralNetControlTransfer::_trainer
const LibtorchDRLControlTrainer & _trainer
The trainer object which will contains the control neural net.
Definition: LibtorchNeuralNetControlTransfer.h:34
MultiAppTransfer::paramError
void paramError(const std::string &param, Args... args) const
MultiAppTransfer::_multi_app
std::shared_ptr< MultiApp > _multi_app
ExecuteMooseObjectWarehouse< Control >::getActiveObject
std::shared_ptr< Control > getActiveObject(const std::string &name, THREAD_ID tid=0) const
LibtorchDRLControlTrainer::controlNeuralNet
const Moose::LibtorchArtificialNeuralNet & controlNeuralNet() const
Definition: LibtorchDRLControlTrainer.h:47
LibtorchNeuralNetControlTransfer::_control_name
const std::string _control_name
The name of the control object on the other app where we want to copy our neural net.
Definition: LibtorchNeuralNetControlTransfer.h:31
LibtorchNeuralNetControl::execute
virtual void execute() override
FEProblemBase::getControlWarehouse
ExecuteMooseObjectWarehouse< Control > & getControlWarehouse()
LibtorchNeuralNetControl::loadControlNeuralNet
void loadControlNeuralNet(const Moose::LibtorchArtificialNeuralNet &input_nn)

◆ getSurrogateModel() [1/2]

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

Definition at line 46 of file SurrogateModelInterface.C.

47 {
48  return getSurrogateModelByName<SurrogateModel>(_smi_params.get<UserObjectName>(name));
49 }
SurrogateModelInterface::_smi_params
const InputParameters & _smi_params
Parameters of the object with this interface.
Definition: SurrogateModelInterface.h:70
InputParameters::get
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
name
const std::string name
Definition: Setup.h:20

◆ getSurrogateModel() [2/2]

template<typename T >
T & SurrogateModelInterface::getSurrogateModel ( const std::string &  name) const
inherited

Get a SurrogateModel/Trainer with a given name.

Parameters
nameThe 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().

82 {
83  return getSurrogateModelByName<T>(_smi_params.get<UserObjectName>(name));
84 }
SurrogateModelInterface::_smi_params
const InputParameters & _smi_params
Parameters of the object with this interface.
Definition: SurrogateModelInterface.h:70
InputParameters::get
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
name
const std::string name
Definition: Setup.h:20

◆ getSurrogateModelByName() [1/2]

template<>
SurrogateModel& SurrogateModelInterface::getSurrogateModelByName ( const UserObjectName &  name) const
inherited

Definition at line 31 of file SurrogateModelInterface.C.

32 {
33  std::vector<SurrogateModel *> models;
34  _smi_feproblem.theWarehouse()
35  .query()
36  .condition<AttribName>(name)
37  .condition<AttribSystem>("SurrogateModel")
38  .queryInto(models);
39  if (models.empty())
40  mooseError("Unable to find a SurrogateModel object with the name '" + name + "'");
41  return *(models[0]);
42 }
mooseError
void mooseError(Args &&... args)
SurrogateModelInterface::_smi_feproblem
FEProblemBase & _smi_feproblem
Reference to FEProblemBase instance.
Definition: SurrogateModelInterface.h:73
FEProblemBase::theWarehouse
TheWarehouse & theWarehouse() const
name
const std::string name
Definition: Setup.h:20
TheWarehouse::query
Query query()

◆ getSurrogateModelByName() [2/2]

template<typename T >
T & SurrogateModelInterface::getSurrogateModelByName ( const UserObjectName &  name) const
inherited

Get a sampler with a given name.

Parameters
nameThe 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().

89 {
90  std::vector<T *> models;
91  _smi_feproblem.theWarehouse()
92  .query()
93  .condition<AttribName>(name)
94  .condition<AttribSystem>("SurrogateModel")
95  .queryInto(models);
96  if (models.empty())
97  mooseError("Unable to find a SurrogateModel object of type " + std::string(typeid(T).name()) +
98  " with the name '" + name + "'");
99  return *(models[0]);
100 }
mooseError
void mooseError(Args &&... args)
SurrogateModelInterface::_smi_feproblem
FEProblemBase & _smi_feproblem
Reference to FEProblemBase instance.
Definition: SurrogateModelInterface.h:73
FEProblemBase::theWarehouse
TheWarehouse & theWarehouse() const
name
const std::string name
Definition: Setup.h:20
TheWarehouse::query
Query query()

◆ getSurrogateTrainer() [1/2]

template<typename T >
T & SurrogateModelInterface::getSurrogateTrainer ( const std::string &  name) const
inherited

Definition at line 104 of file SurrogateModelInterface.h.

105 {
106  return getSurrogateTrainerByName<T>(_smi_params.get<UserObjectName>(name));
107 }
SurrogateModelInterface::_smi_params
const InputParameters & _smi_params
Parameters of the object with this interface.
Definition: SurrogateModelInterface.h:70
InputParameters::get
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
name
const std::string name
Definition: Setup.h:20

◆ getSurrogateTrainer() [2/2]

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

Definition at line 60 of file SurrogateModelInterface.C.

61 {
62  return getSurrogateTrainerByName<SurrogateTrainerBase>(_smi_params.get<UserObjectName>(name));
63 }
SurrogateModelInterface::_smi_params
const InputParameters & _smi_params
Parameters of the object with this interface.
Definition: SurrogateModelInterface.h:70
InputParameters::get
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
name
const std::string name
Definition: Setup.h:20

◆ getSurrogateTrainerByName() [1/2]

template<>
SurrogateTrainerBase& SurrogateModelInterface::getSurrogateTrainerByName ( const UserObjectName &  name) const
inherited

Definition at line 53 of file SurrogateModelInterface.C.

54 {
55  return _smi_feproblem.getUserObject<SurrogateTrainerBase>(name);
56 }
FEProblemBase::getUserObject
T & getUserObject(const std::string &name, unsigned int tid=0) const
SurrogateModelInterface::_smi_feproblem
FEProblemBase & _smi_feproblem
Reference to FEProblemBase instance.
Definition: SurrogateModelInterface.h:73
name
const std::string name
Definition: Setup.h:20
SurrogateTrainerBase
This is the base trainer class whose main functionality is the API for declaring model data...
Definition: SurrogateTrainer.h:32

◆ 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().

112 {
113  SurrogateTrainerBase * base_ptr =
114  &_smi_feproblem.getUserObject<SurrogateTrainerBase>(name, _smi_tid);
115  T * obj_ptr = dynamic_cast<T *>(base_ptr);
116  if (!obj_ptr)
117  mooseError("Failed to find a SurrogateTrainer object of type " + std::string(typeid(T).name()) +
118  " with the name '",
119  name,
120  "' for the desired type.");
121  return *obj_ptr;
122 }
FEProblemBase::getUserObject
T & getUserObject(const std::string &name, unsigned int tid=0) const
mooseError
void mooseError(Args &&... args)
SurrogateModelInterface::_smi_feproblem
FEProblemBase & _smi_feproblem
Reference to FEProblemBase instance.
Definition: SurrogateModelInterface.h:73
name
const std::string name
Definition: Setup.h:20
SurrogateModelInterface::_smi_tid
const THREAD_ID _smi_tid
Thread ID.
Definition: SurrogateModelInterface.h:76
SurrogateTrainerBase
This is the base trainer class whose main functionality is the API for declaring model data...
Definition: SurrogateTrainer.h:32

◆ validParams()

InputParameters LibtorchNeuralNetControlTransfer::validParams ( )
static

Definition at line 18 of file LibtorchNeuralNetControlTransfer.C.

19 {
20  InputParameters params = MultiAppTransfer::validParams();
21  params += SurrogateModelInterface::validParams();
22 
23  params.addClassDescription("Copies a neural network from a trainer object on the main app to a "
24  "LibtorchNeuralNetControl object on the subapp.");
25 
26  params.suppressParameter<MultiAppName>("from_multi_app");
27  params.suppressParameter<MultiAppName>("multi_app");
28  params.suppressParameter<MultiMooseEnum>("direction");
29 
30  params.addRequiredParam<UserObjectName>("trainer_name",
31  "Trainer object that contains the neural networks."
32  " for different samples.");
33  params.addRequiredParam<std::string>("control_name", "Controller object name.");
34  return params;
35 }
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters::suppressParameter
void suppressParameter(const std::string &name)
MultiAppTransfer::validParams
static InputParameters validParams()
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
SurrogateModelInterface::validParams
static InputParameters validParams()
Definition: SurrogateModelInterface.C:17

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:
Generated on Wed Nov 5 2025 20:28:35 for https://mooseframework.inl.gov by   doxygen 1.8.14