A worker MPI entity consists of a processor group that runs a simulation of type Sim_t. The main loop in run() accepts new jobs from the master process runs the simulation and reports back the results. More...
#include <Worker.h>
Public Member Functions | |
| Worker (Expressions::Named_t constraints, std::string simName, Comm::Bundle_t comms, CmdArguments_t args) | |
| Worker (Expressions::Named_t objectives, Expressions::Named_t constraints, std::string simName, Comm::Bundle_t comms, CmdArguments_t args, bool isOptimizer=true) | |
| ~Worker () | |
Protected Types | |
| typedef boost::scoped_ptr< Sim_t > | SimPtr_t |
Protected Member Functions | |
| void | runCoWorker () |
| void | notifyCoWorkers (int tag) |
| notify coworkers of incoming broadcast More... | |
| void | setupPoll () |
| executed before starting polling loop More... | |
| void | prePoll () |
| executed before checking for new request More... | |
| void | postPoll () |
| executed after handling (if any) new request More... | |
| void | onStop () |
| enable implementation to react to STOP tag More... | |
| virtual bool | onMessage (MPI_Status status, size_t recv_value) |
 Protected Member Functions inherited from Poller | |
| virtual void | run () |
| Poller (MPI_Comm comm, double delay=0.1) | |
| virtual | ~Poller () |
Protected Attributes | |
| bool | is_idle_ |
| MPI_Comm | coworker_comm_ |
| Expressions::Named_t | objectives_ |
| Expressions::Named_t | constraints_ |
| int | leader_pid_ |
| int | num_coworkers_ |
| int | pilot_rank_ |
| std::string | simulation_name_ |
| CmdArguments_t | cmd_args_ |
| 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... | |
Detailed Description
template<class Sim_t>
class Worker< Sim_t >
A worker MPI entity consists of a processor group that runs a simulation of type Sim_t. The main loop in run() accepts new jobs from the master process runs the simulation and reports back the results.
- See Also
- Pilot
- Poller
- MPIHelper.h
- Template Parameters
-
Sim_T type of simulation to run
Member Typedef Documentation
Constructor & Destructor Documentation
|
inline |
Definition at line 32 of file Worker.h.
References Worker< Sim_t >::constraints_, Worker< Sim_t >::coworker_comm_, Comm::Bundle_t::coworkers, Worker< Sim_t >::is_idle_, Worker< Sim_t >::leader_pid_, Comm::Bundle_t::master_local_pid, Worker< Sim_t >::num_coworkers_, Worker< Sim_t >::pilot_rank_, and Worker< Sim_t >::simulation_name_.
|
inline |
Definition at line 49 of file Worker.h.
References Worker< Sim_t >::constraints_, Worker< Sim_t >::coworker_comm_, Comm::Bundle_t::coworkers, Worker< Sim_t >::is_idle_, Worker< Sim_t >::leader_pid_, Comm::Bundle_t::master_local_pid, Worker< Sim_t >::num_coworkers_, Worker< Sim_t >::objectives_, Worker< Sim_t >::pilot_rank_, Poller::run(), Worker< Sim_t >::runCoWorker(), and Worker< Sim_t >::simulation_name_.
Member Function Documentation
|
inlineprotected |
notify coworkers of incoming broadcast
Definition at line 155 of file Worker.h.
References Worker< Sim_t >::coworker_comm_, Worker< Sim_t >::leader_pid_, and Worker< Sim_t >::num_coworkers_.
Referenced by Worker< Sim_t >::onMessage(), and Worker< Sim_t >::onStop().
|
inlineprotectedvirtual |
User specific behavior on receiving a message.
- Returns
- boolean indicating if Irecv has to be re-posted
Implements Poller.
Reimplemented in SampleWorker< Sim_t >.
Definition at line 182 of file Worker.h.
References Worker< Sim_t >::cmd_args_, Poller::comm_m, Worker< Sim_t >::constraints_, Worker< Sim_t >::coworker_comm_, endl(), Worker< Sim_t >::is_idle_, Worker< Sim_t >::leader_pid_, MPI_Bcast_params(), MPI_COWORKER_NEW_JOB_TAG, MPI_Recv_params(), MPI_Send_reqvars(), MPI_WORK_JOBID_TAG, MPI_WORKER_FINISHED_ACK_TAG, MPI_WORKER_FINISHED_TAG, Worker< Sim_t >::notifyCoWorkers(), Worker< Sim_t >::num_coworkers_, Worker< Sim_t >::objectives_, Worker< Sim_t >::pilot_rank_, Worker< Sim_t >::simulation_name_, and OptPilotException::what().
|
inlineprotectedvirtual |
enable implementation to react to STOP tag
Implements Poller.
Definition at line 177 of file Worker.h.
References MPI_STOP_TAG, Worker< Sim_t >::notifyCoWorkers(), and Worker< Sim_t >::num_coworkers_.
|
inlineprotectedvirtual |
|
inlineprotectedvirtual |
|
inlineprotected |
coworkers simply wait on a job broadcast from the leader and then start a simulation..
Definition at line 95 of file Worker.h.
References Worker< Sim_t >::cmd_args_, Worker< Sim_t >::constraints_, Worker< Sim_t >::coworker_comm_, endl(), Poller::is_running_, Worker< Sim_t >::leader_pid_, MPI_Bcast_params(), MPI_COWORKER_NEW_JOB_TAG, MPI_STOP_TAG, Worker< Sim_t >::objectives_, Worker< Sim_t >::simulation_name_, and OptPilotException::what().
Referenced by Worker< Sim_t >::Worker().
|
inlineprotectedvirtual |
executed before starting polling loop
Implements Poller.
Definition at line 165 of file Worker.h.
References Poller::comm_m, MPI_WORKER_STATUSUPDATE_TAG, and Worker< Sim_t >::pilot_rank_.
Member Data Documentation
|
protected |
Definition at line 152 of file Worker.h.
Referenced by SampleWorker< Sim_t >::onMessage(), Worker< Sim_t >::onMessage(), Worker< Sim_t >::runCoWorker(), and SampleWorker< Sim_t >::runSlave().
|
protected |
Definition at line 90 of file Worker.h.
Referenced by SampleWorker< Sim_t >::onMessage(), Worker< Sim_t >::onMessage(), Worker< Sim_t >::runCoWorker(), SampleWorker< Sim_t >::runSlave(), and Worker< Sim_t >::Worker().
|
protected |
Definition at line 87 of file Worker.h.
Referenced by SampleWorker< Sim_t >::notifyCoWorkers(), Worker< Sim_t >::notifyCoWorkers(), SampleWorker< Sim_t >::onMessage(), Worker< Sim_t >::onMessage(), Worker< Sim_t >::runCoWorker(), SampleWorker< Sim_t >::runSlave(), SampleWorker< Sim_t >::SampleWorker(), and Worker< Sim_t >::Worker().
|
protected |
Definition at line 86 of file Worker.h.
Referenced by SampleWorker< Sim_t >::onMessage(), Worker< Sim_t >::onMessage(), and Worker< Sim_t >::Worker().
|
protected |
Definition at line 148 of file Worker.h.
Referenced by SampleWorker< Sim_t >::notifyCoWorkers(), Worker< Sim_t >::notifyCoWorkers(), SampleWorker< Sim_t >::onMessage(), Worker< Sim_t >::onMessage(), Worker< Sim_t >::runCoWorker(), SampleWorker< Sim_t >::runSlave(), SampleWorker< Sim_t >::SampleWorker(), and Worker< Sim_t >::Worker().
|
protected |
Definition at line 149 of file Worker.h.
Referenced by SampleWorker< Sim_t >::notifyCoWorkers(), Worker< Sim_t >::notifyCoWorkers(), SampleWorker< Sim_t >::onMessage(), Worker< Sim_t >::onMessage(), Worker< Sim_t >::onStop(), and Worker< Sim_t >::Worker().
|
protected |
Definition at line 89 of file Worker.h.
Referenced by SampleWorker< Sim_t >::onMessage(), Worker< Sim_t >::onMessage(), Worker< Sim_t >::runCoWorker(), SampleWorker< Sim_t >::runSlave(), and Worker< Sim_t >::Worker().
|
protected |
Definition at line 150 of file Worker.h.
Referenced by SampleWorker< Sim_t >::onMessage(), Worker< Sim_t >::onMessage(), Worker< Sim_t >::setupPoll(), and Worker< Sim_t >::Worker().
|
protected |
Definition at line 151 of file Worker.h.
Referenced by SampleWorker< Sim_t >::onMessage(), Worker< Sim_t >::onMessage(), Worker< Sim_t >::runCoWorker(), SampleWorker< Sim_t >::runSlave(), and Worker< Sim_t >::Worker().
The documentation for this class was generated from the following file:
- optimizer/Pilot/Worker.h
