OPAL (Object Oriented Parallel Accelerator Library) 2022.1
OPAL
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t > Class Template Reference

#include <Pilot.h>

Inheritance diagram for Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >:
Inheritance graph
[legend]
Collaboration diagram for Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >:
Collaboration graph
[legend]

Public Member Functions

 Pilot (CmdArguments_t args, boost::shared_ptr< Comm_t > comm, const DVarContainer_t &dvar)
 
 Pilot (CmdArguments_t args, boost::shared_ptr< Comm_t > comm, functionDictionary_t known_expr_funcs)
 
 Pilot (CmdArguments_t args, boost::shared_ptr< Comm_t > comm, functionDictionary_t known_expr_funcs, const DVarContainer_t &dvar, const Expressions::Named_t &obj, const Expressions::Named_t &cons, std::vector< double > hypervolRef={}, bool isOptimizerRun=true, const std::map< std::string, std::string > &userVariables={})
 
virtual ~Pilot ()
 

Protected Types

typedef MasterNode< typename Opt_t::SolutionState_t, SolPropagationGraph_t > MasterNode_t
 
typedef std::map< size_t, std::pair< Param_t, reqVarContainer_t > > Jobs_t
 keep track of requests and running jobs More...
 
typedef Jobs_t::iterator JobIter_t
 

Protected Member Functions

void parseInputFile (functionDictionary_t, bool isOptimizationRun)
 
virtual void startOptimizer ()
 
virtual void startWorker (const std::map< std::string, std::string > &userVariables)
 
virtual void startPilot ()
 
virtual void setupPoll ()
 executed before starting polling loop More...
 
virtual void prePoll ()
 executed before checking for new request More...
 
virtual void onStop ()
 enable implementation to react to STOP tag More...
 
virtual void postPoll ()
 executed after handling (if any) new request More...
 
virtual void sendNewJobToWorker (int worker)
 
virtual bool onMessage (MPI_Status status, size_t recv_value)
 
bool stop (bool isOpt=true)
 
void run ()
 
virtual bool onMessage (MPI_Status status, size_t recv_value)=0
 
virtual void onStop ()=0
 enable implementation to react to STOP tag More...
 
virtual void setupPoll ()=0
 executed before starting polling loop More...
 
virtual void prePoll ()=0
 executed before checking for new request More...
 
virtual void postPoll ()=0
 executed after handling (if any) new request More...
 
virtual void run ()
 
 Poller (MPI_Comm comm, double delay=0.1)
 
virtual ~Poller ()
 

Protected Attributes

MPI_Comm worker_comm_
 MPI communicator used for messages to/from worker. More...
 
MPI_Comm opt_comm_
 MPI communicator used for messages to/from optimizer. More...
 
MPI_Comm coworker_comm_
 MPI communicator used for messages between all pilots. More...
 
boost::shared_ptr< Comm_t > comm_
 
CmdArguments_t cmd_args_
 
int global_rank_
 
int my_rank_in_worker_comm_
 
int my_rank_in_opt_comm_
 
int num_coworkers_
 
boost::scoped_ptr< MasterNode_tmaster_node_
 
std::string input_file_
 input file for simulation with embedded optimization problem More...
 
int total_available_workers_
 
bool has_opt_converged_
 
bool continue_polling_
 
Expressions::Named_t objectives_
 objectives More...
 
Expressions::Named_t constraints_
 constraints More...
 
DVarContainer_t dvars_
 design variables More...
 
std::vector< double > hypervolRef_
 hypervolume reference point More...
 
std::vector< bool > is_worker_idle_
 
Jobs_t running_job_list_
 
Jobs_t request_queue_
 
boost::scoped_ptr< Tracejob_trace_
 
- Protected Attributes inherited from Poller
MPI_Comm comm_m
 communicator the poller listens to requests More...
 
bool is_running_
 
double last_polled_
 time of last MPI_Test More...
 
double poll_delay_
 delay in seconds between polls More...
 

Private Member Functions

void setup (functionDictionary_t known_expr_funcs, const std::map< std::string, std::string > &userVariables)
 

Detailed Description

template<class Opt_t, class Sim_t, class SolPropagationGraph_t, class Comm_t>
class Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >

Definition at line 102 of file Pilot.h.

Member Typedef Documentation

◆ JobIter_t

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
typedef Jobs_t::iterator Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::JobIter_t
protected

Definition at line 198 of file Pilot.h.

◆ Jobs_t

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
typedef std::map<size_t, std::pair<Param_t, reqVarContainer_t> > Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::Jobs_t
protected

keep track of requests and running jobs

Definition at line 197 of file Pilot.h.

◆ MasterNode_t

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
typedef MasterNode< typename Opt_t::SolutionState_t, SolPropagationGraph_t > Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::MasterNode_t
protected

Definition at line 176 of file Pilot.h.

Constructor & Destructor Documentation

◆ Pilot() [1/3]

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::Pilot ( CmdArguments_t  args,
boost::shared_ptr< Comm_t >  comm,
const DVarContainer_t dvar 
)
inline

Definition at line 108 of file Pilot.h.

◆ Pilot() [2/3]

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::Pilot ( CmdArguments_t  args,
boost::shared_ptr< Comm_t >  comm,
functionDictionary_t  known_expr_funcs 
)
inline

Definition at line 118 of file Pilot.h.

References Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::setup().

Here is the call graph for this function:

◆ Pilot() [3/3]

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::Pilot ( CmdArguments_t  args,
boost::shared_ptr< Comm_t >  comm,
functionDictionary_t  known_expr_funcs,
const DVarContainer_t dvar,
const Expressions::Named_t obj,
const Expressions::Named_t cons,
std::vector< double >  hypervolRef = {},
bool  isOptimizerRun = true,
const std::map< std::string, std::string > &  userVariables = {} 
)
inline

Definition at line 127 of file Pilot.h.

◆ ~Pilot()

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
virtual Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::~Pilot ( )
inlinevirtual

Member Function Documentation

◆ onMessage()

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
virtual bool Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::onMessage ( MPI_Status  status,
size_t  recv_value 
)
inlineprotectedvirtual

User specific behavior on receiving a message.

Returns
boolean indicating if Irecv has to be re-posted

Implements Poller.

Reimplemented in SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >.

Definition at line 438 of file Pilot.h.

References Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::comm_, endl(), EXCHANGE_SOL_STATE_TAG, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::has_opt_converged_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::is_worker_idle_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::job_trace_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::master_node_, MPI_EXCHANGE_SOL_STATE_DATA_TAG, MPI_EXCHANGE_SOL_STATE_RES_SIZE_TAG, MPI_EXCHANGE_SOL_STATE_RES_TAG, MPI_OPT_JOB_FINISHED_TAG, MPI_Recv_params(), MPI_Recv_reqvars(), MPI_Send_reqvars(), MPI_WORKER_FINISHED_ACK_TAG, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::num_coworkers_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::opt_comm_, OPT_CONVERGED_TAG, OPT_NEW_JOB_TAG, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::request_queue_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::running_job_list_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::sendNewJobToWorker(), Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::stop(), Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::worker_comm_, WORKER_FINISHED_TAG, and WORKER_STATUSUPDATE_TAG.

Referenced by Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::run().

Here is the call graph for this function:

◆ onStop()

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
virtual void Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::onStop ( )
inlineprotectedvirtual

enable implementation to react to STOP tag

Implements Poller.

Definition at line 373 of file Pilot.h.

◆ parseInputFile()

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
void Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::parseInputFile ( functionDictionary_t  ,
bool  isOptimizationRun 
)
inlineprotected

◆ postPoll()

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
virtual void Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::postPoll ( )
inlineprotectedvirtual

◆ prePoll()

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
virtual void Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::prePoll ( )
inlineprotectedvirtual

executed before checking for new request

Implements Poller.

Definition at line 369 of file Pilot.h.

Referenced by Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::run().

◆ run()

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
void Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::run ( )
inlineprotectedvirtual

◆ sendNewJobToWorker()

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
virtual void Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::sendNewJobToWorker ( int  worker)
inlineprotectedvirtual

◆ setup()

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
void Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::setup ( functionDictionary_t  known_expr_funcs,
const std::map< std::string, std::string > &  userVariables 
)
inlineprivate

◆ setupPoll()

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
virtual void Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::setupPoll ( )
inlineprotectedvirtual

executed before starting polling loop

Implements Poller.

Definition at line 365 of file Pilot.h.

Referenced by Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::run().

◆ startOptimizer()

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
virtual void Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::startOptimizer ( )
inlineprotectedvirtual

◆ startPilot()

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
virtual void Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::startPilot ( )
inlineprotectedvirtual

Definition at line 311 of file Pilot.h.

References Physics::alpha, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::cmd_args_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::comm_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::constraints_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::continue_polling_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::coworker_comm_, endl(), Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::global_rank_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::has_opt_converged_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::is_worker_idle_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::job_trace_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::master_node_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::my_rank_in_opt_comm_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::my_rank_in_worker_comm_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::num_coworkers_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::objectives_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::opt_comm_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::run(), Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::total_available_workers_, and Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::worker_comm_.

Referenced by Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::setup(), and SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::setup().

Here is the call graph for this function:

◆ startWorker()

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
virtual void Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::startWorker ( const std::map< std::string, std::string > &  userVariables)
inlineprotectedvirtual

◆ stop()

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
bool Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::stop ( bool  isOpt = true)
inlineprotected

Member Data Documentation

◆ cmd_args_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
CmdArguments_t Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::cmd_args_
protected

◆ comm_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
boost::shared_ptr<Comm_t> Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::comm_
protected

◆ constraints_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
Expressions::Named_t Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::constraints_
protected

◆ continue_polling_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
bool Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::continue_polling_
protected

◆ coworker_comm_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
MPI_Comm Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::coworker_comm_
protected

◆ dvars_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
DVarContainer_t Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::dvars_
protected

◆ global_rank_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
int Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::global_rank_
protected

◆ has_opt_converged_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
bool Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::has_opt_converged_
protected

◆ hypervolRef_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
std::vector<double> Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::hypervolRef_
protected

hypervolume reference point

Definition at line 189 of file Pilot.h.

Referenced by Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::startOptimizer().

◆ input_file_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
std::string Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::input_file_
protected

◆ is_worker_idle_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
std::vector<bool> Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::is_worker_idle_
protected

◆ job_trace_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
boost::scoped_ptr<Trace> Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::job_trace_
protected

◆ master_node_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
boost::scoped_ptr< MasterNode_t > Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::master_node_
protected

◆ my_rank_in_opt_comm_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
int Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::my_rank_in_opt_comm_
protected

◆ my_rank_in_worker_comm_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
int Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::my_rank_in_worker_comm_
protected

◆ num_coworkers_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
int Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::num_coworkers_
protected

◆ objectives_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
Expressions::Named_t Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::objectives_
protected

◆ opt_comm_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
MPI_Comm Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::opt_comm_
protected

◆ request_queue_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
Jobs_t Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::request_queue_
protected

◆ running_job_list_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
Jobs_t Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::running_job_list_
protected

◆ total_available_workers_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
int Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::total_available_workers_
protected

◆ worker_comm_

template<class Opt_t , class Sim_t , class SolPropagationGraph_t , class Comm_t >
MPI_Comm Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::worker_comm_
protected

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