The sample Pilot (Master): Coordinates requests by sampler to workers. More...

#include <SamplePilot.h>

Inheritance diagram for SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >:

Collaboration diagram for SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >:

Public Member Functions
	SamplePilot (CmdArguments_t args, boost::shared_ptr< Comm_t > comm, functionDictionary_t known_expr_funcs, const DVarContainer_t &dvar, const Expressions::Named_t &obj, const std::map< std::string, std::shared_ptr< SamplingMethod > > &sampleMethods, const std::vector< std::string > &storeobjstr, const std::vector< std::string > &filesToKeep)

	sampleMethods_m (sampleMethods)

virtual	~SamplePilot ()

Public Attributes
	false

Protected Types
typedef std::map< size_t, Param_t >	Jobs_t
	keep track of requests and running jobs More...

typedef Jobs_t::iterator	JobIter_t

Protected Types inherited from Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >
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
virtual void	setup (functionDictionary_t known_expr_funcs, const std::vector< std::string > &storeobjstr, const std::vector< std::string > &filesToKeep)

virtual void	startSampler ()

void	startWorker (const std::vector< std::string > &storeobjstr, const std::vector< std::string > &filesToKeep)

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)

Protected Member Functions inherited from Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >
void	parseInputFile (functionDictionary_t known_expr_funcs, bool isOptimizationRun)

virtual void	startOptimizer ()

virtual void	startWorker ()

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...

bool	stop (bool isOpt=true)

void	run ()

	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)

virtual	~Pilot ()

	Poller (MPI_Comm comm, double delay=0.1)

virtual	~Poller ()

Protected Attributes
Jobs_t	running_job_list_

Jobs_t	request_queue_

Protected Attributes inherited from Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >
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_t >	master_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< Trace >	job_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 Attributes
std::map< std::string, std::shared_ptr < SamplingMethod > >	sampleMethods_m

Detailed Description

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

The sample Pilot (Master): Coordinates requests by sampler to workers.

Every worker thread notifies the master here if idle or not. When available the master dispatches one of the pending simulations to the worker who will run the specified simulation and report results back to the master.

See Also: SampleWorker; Sampler

Template Parameters

Opt_t	type of the sampler
Sim_t	type of the simulation
SolPropagationGraph_t	strategy to distribute solution between master islands
Comm_t	comm splitter strategy

Definition at line 33 of file SamplePilot.h.

Member Typedef Documentation

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

typedef Jobs_t::iterator SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::JobIter_t

protected

Definition at line 81 of file SamplePilot.h.

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

typedef std::map<size_t, Param_t > SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::Jobs_t

protected

keep track of requests and running jobs

Definition at line 80 of file SamplePilot.h.

Constructor & Destructor Documentation

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

SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::SamplePilot	(	CmdArguments_t	args,
		boost::shared_ptr< Comm_t >	comm,
		functionDictionary_t	known_expr_funcs,
		const DVarContainer_t &	dvar,
		const Expressions::Named_t &	obj,
		const std::map< std::string, std::shared_ptr< SamplingMethod > > &	sampleMethods,
		const std::vector< std::string > &	storeobjstr,
		const std::vector< std::string > &	filesToKeep
	)

inline

Definition at line 41 of file SamplePilot.h.

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

virtual SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::~SamplePilot ( )

inlinevirtual

Definition at line 73 of file SamplePilot.h.

Member Function Documentation

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

virtual bool SamplePilot< 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

Reimplemented from Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >.

Definition at line 203 of file SamplePilot.h.

Here is the call graph for this function:

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

virtual void SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::postPoll ( )

inlineprotectedvirtual

executed after handling (if any) new request

Reimplemented from Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >.

Definition at line 144 of file SamplePilot.h.

Here is the call graph for this function:

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

SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::sampleMethods_m ( sampleMethods )

inline

Definition at line 61 of file SamplePilot.h.

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

Here is the call graph for this function:

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

virtual void SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::sendNewJobToWorker ( int worker )

inlineprotectedvirtual

Reimplemented from Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >.

Definition at line 177 of file SamplePilot.h.

References endl(), 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_, MPI_Send_params(), MPI_WORK_JOBID_TAG, SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::request_queue_, SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::running_job_list_, and Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::worker_comm_.

Referenced by SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::onMessage(), and SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::postPoll().

Here is the call graph for this function:

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

virtual void SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::setup	(	functionDictionary_t	known_expr_funcs,
		const std::vector< std::string > &	storeobjstr,
		const std::vector< std::string > &	filesToKeep
	)

inlineprotectedvirtual

Definition at line 87 of file SamplePilot.h.

References Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::comm_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::global_rank_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::parseInputFile(), Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::startPilot(), SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::startSampler(), and Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::startWorker().

Referenced by SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::sampleMethods_m().

Here is the call graph for this function:

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

virtual void SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::startSampler ( )

inlineprotectedvirtual

Definition at line 104 of file SamplePilot.h.

References 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 >::dvars_, endl(), Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::global_rank_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::objectives_, and SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::sampleMethods_m.

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

Here is the call graph for this function:

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

void SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::startWorker	(	const std::vector< std::string > &	storeobjstr,
		const std::vector< std::string > &	filesToKeep
	)

inlineprotected

Definition at line 120 of file SamplePilot.h.

References 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_, endl(), Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::global_rank_, Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::input_file_, and Pilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::objectives_.

Here is the call graph for this function:

Member Data Documentation

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

SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::false

Definition at line 59 of file SamplePilot.h.

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

Jobs_t SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::request_queue_

protected

Definition at line 83 of file SamplePilot.h.

Referenced by SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::onMessage(), SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::postPoll(), and SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::sendNewJobToWorker().

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

Jobs_t SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::running_job_list_

protected

Definition at line 82 of file SamplePilot.h.

Referenced by SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::onMessage(), and SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::sendNewJobToWorker().

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

std::map< std::string, std::shared_ptr<SamplingMethod> > SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::sampleMethods_m

private

Definition at line 282 of file SamplePilot.h.

Referenced by SamplePilot< Opt_t, Sim_t, SolPropagationGraph_t, Comm_t >::startSampler().

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

src/Sample/SamplePilot.h

Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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