#include <SampleWorker.h>

Inheritance diagram for SampleWorker< Sim_t >:

Collaboration diagram for SampleWorker< Sim_t >:

Public Member Functions
	SampleWorker (Expressions::Named_t objectives, Expressions::Named_t constraints, std::string simName, Comm::Bundle_t comms, CmdArguments_t args, const std::vector< std::string > &storeobjstr, const std::vector< std::string > &filesToKeep, const std::map< std::string, std::string > &userVariables)

	~SampleWorker ()

Protected Member Functions
void	notifyCoWorkers (size_t job_id, int tag)
	notify coworkers of incoming broadcast More...

void	runSlave ()

bool	onMessage (MPI_Status status, size_t recv_value) override

Protected Member Functions inherited from Worker< Sim_t >
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...

	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, const std::map< std::string, std::string > &userVariables, bool isOptimizer=true)

	~Worker ()

Protected Member Functions inherited from Poller
virtual void	run ()

	Poller (MPI_Comm comm, double delay=0.1)

virtual	~Poller ()

Protected Attributes
const std::vector< std::string >	statVariablesToStore_m

Protected Attributes inherited from Worker< Sim_t >
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_

const std::map< std::string, std::string >	userVariables_

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 Attributes
const std::vector< std::string >	filesToKeep_m

Additional Inherited Members
Protected Types inherited from Worker< Sim_t >
typedef boost::scoped_ptr< Sim_t >	SimPtr_t

Detailed Description

template<class Sim_t>
class SampleWorker< Sim_t >

Definition at line 36 of file SampleWorker.h.

Constructor & Destructor Documentation

◆ SampleWorker()

template<class Sim_t >

SampleWorker< Sim_t >::SampleWorker	(	Expressions::Named_t	objectives,
		Expressions::Named_t	constraints,
		std::string	simName,
		Comm::Bundle_t	comms,
		CmdArguments_t	args,
		const std::vector< std::string > &	storeobjstr,
		const std::vector< std::string > &	filesToKeep,
		const std::map< std::string, std::string > &	userVariables
	)

inline

Definition at line 40 of file SampleWorker.h.

References Worker< Sim_t >::coworker_comm_, Worker< Sim_t >::leader_pid_, Poller::run(), and SampleWorker< Sim_t >::runSlave().

Here is the call graph for this function:

◆ ~SampleWorker()

template<class Sim_t >

SampleWorker< Sim_t >::~SampleWorker ( )

inline

Definition at line 63 of file SampleWorker.h.

Member Function Documentation

◆ notifyCoWorkers()

template<class Sim_t >

void SampleWorker< Sim_t >::notifyCoWorkers	(	size_t	job_id,
		int	tag
	)

inlineprotected

notify coworkers of incoming broadcast

Definition at line 71 of file SampleWorker.h.

References Worker< Sim_t >::coworker_comm_, Worker< Sim_t >::leader_pid_, and Worker< Sim_t >::num_coworkers_.

Referenced by SampleWorker< Sim_t >::onMessage().

◆ onMessage()

template<class Sim_t >

bool SampleWorker< Sim_t >::onMessage	(	MPI_Status	status,
		size_t	recv_value
	)

inlineoverrideprotectedvirtual

User specific behavior on receiving a message.

Returns: boolean indicating if Irecv has to be re-posted

Reimplemented from Worker< Sim_t >.

Definition at line 139 of file SampleWorker.h.

References Worker< Sim_t >::cmd_args_, Poller::comm_m, Worker< Sim_t >::constraints_, Worker< Sim_t >::coworker_comm_, endl(), SampleWorker< Sim_t >::filesToKeep_m, 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, SampleWorker< Sim_t >::notifyCoWorkers(), Worker< Sim_t >::num_coworkers_, Worker< Sim_t >::objectives_, Worker< Sim_t >::pilot_rank_, Poller::run(), Worker< Sim_t >::simulation_name_, Worker< Sim_t >::userVariables_, and OptPilotException::what().

Here is the call graph for this function:

◆ runSlave()

template<class Sim_t >

void SampleWorker< Sim_t >::runSlave ( )

inlineprotected

coworkers simply wait on a job broadcast from the leader and then start a simulation..

Definition at line 83 of file SampleWorker.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_, Poller::run(), Worker< Sim_t >::simulation_name_, Worker< Sim_t >::userVariables_, and OptPilotException::what().

Referenced by SampleWorker< Sim_t >::SampleWorker().

Here is the call graph for this function:

Member Data Documentation

◆ filesToKeep_m

template<class Sim_t >

const std::vector<std::string> SampleWorker< Sim_t >::filesToKeep_m

private

Definition at line 214 of file SampleWorker.h.

Referenced by SampleWorker< Sim_t >::onMessage().

◆ statVariablesToStore_m

template<class Sim_t >

const std::vector<std::string> SampleWorker< Sim_t >::statVariablesToStore_m

protected

Definition at line 68 of file SampleWorker.h.

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

/Users/gsell/src/OPAL/src/src/Sample/SampleWorker.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

template<class Sim_t> class SampleWorker< Sim_t >

Constructor & Destructor Documentation

◆ SampleWorker()

◆ ~SampleWorker()

Member Function Documentation

◆ notifyCoWorkers()

◆ onMessage()

◆ runSlave()

Member Data Documentation

◆ filesToKeep_m

◆ statVariablesToStore_m

template<class Sim_t>
class SampleWorker< Sim_t >