ParaRacingRampUpParamSet Class Reference

class ParaRacingRampUpParamSet (parameter set for racing ramp-up) More...

#include <paraRacingRampUpParamSet.h>

Inheritance diagram for ParaRacingRampUpParamSet:

Public Member Functions
	ParaRacingRampUpParamSet ()
virtual	~ParaRacingRampUpParamSet ()
virtual int	getTerminationCriteria ()=0
	get termination criteria More...
virtual void	setWinnerRank (int rank)
	set winner rank TODO: this function and also getWinnerRank should be removed More...
virtual int	send (ParaComm *comm, int destination)=0
	send ParaRacingRampUpParamSet More...
virtual int	receive (ParaComm *comm, int source)=0
	receive ParaRacingRampUpParamSet More...
virtual void	write (gzstream::ogzstream &out)=0
	write to checkpoint file More...
virtual bool	read (ParaComm *comm, gzstream::igzstream &in)=0
	read from checkpoint file More...
virtual const std::string	toString ()=0
	stringfy ParaRacingRampUpParamSet More...
virtual int	getStrategy ()=0
	get strategy More...

Detailed Description

class ParaRacingRampUpParamSet (parameter set for racing ramp-up)

Definition at line 55 of file paraRacingRampUpParamSet.h.

Constructor & Destructor Documentation

ParaRacingRampUpParamSet()

ParaRacingRampUpParamSet

(

)

Definition at line 59 of file paraRacingRampUpParamSet.h.

~ParaRacingRampUpParamSet()

virtual ~ParaRacingRampUpParamSet ( )

virtual

Definition at line 64 of file paraRacingRampUpParamSet.h.

Member Function Documentation

getStrategy()

virtual int getStrategy ( )

pure virtual

get strategy

Returns

an int value which shows strategy

Implemented in ScipParaRacingRampUpParamSet, and BbParaRacingRampUpParamSet.

Referenced by BbParaLoadCoordinator::run().

getTerminationCriteria()

virtual int getTerminationCriteria ( )

pure virtual

get termination criteria

Returns

an int value to show termination criteria

Implemented in BbParaRacingRampUpParamSet.

read()

virtual bool read ( ParaComm *  comm, gzstream::igzstream &  in  )

pure virtual

read from checkpoint file

Parameters

comm	communicator used
in	gzstream for input

Implemented in BbParaRacingRampUpParamSet, and ScipParaRacingRampUpParamSet.

Referenced by BbParaLoadCoordinator::warmStart().

receive()

virtual int receive ( ParaComm *  comm, int  source  )

pure virtual

receive ParaRacingRampUpParamSet

Returns

always 0 (for future extensions)

Parameters

comm	communicator used
source	source rank

Implemented in BbParaRacingRampUpParamSet, ScipParaRacingRampUpParamSetMpi, and ScipParaRacingRampUpParamSetTh.

Referenced by main(), and BbParaSolver::processTagWinnerRacingRampUpParamSet().

send()

virtual int send ( ParaComm *  comm, int  destination  )

pure virtual

send ParaRacingRampUpParamSet

Returns

always 0 (for future extensions)

Parameters

comm	communicator used
destination	destination rank

Implemented in BbParaRacingRampUpParamSet, ScipParaRacingRampUpParamSetMpi, and ScipParaRacingRampUpParamSetTh.

Referenced by BbParaLoadCoordinator::run(), and BbParaLoadCoordinator::warmStart().

setWinnerRank()

virtual void setWinnerRank ( int  rank )

virtual

set winner rank TODO: this function and also getWinnerRank should be removed

Reimplemented in BbParaRacingRampUpParamSet.

Definition at line 80 of file paraRacingRampUpParamSet.h.

toString()

virtual const std::string toString ( )

pure virtual

stringfy ParaRacingRampUpParamSet

Returns

string to show inside of this object

Implemented in ScipParaRacingRampUpParamSet, and BbParaRacingRampUpParamSet.

write()

virtual void write ( gzstream::ogzstream &  out )

pure virtual

write to checkpoint file

Parameters

out	gzstream for output

Implemented in ScipParaRacingRampUpParamSet, and BbParaRacingRampUpParamSet.

Referenced by BbParaLoadCoordinator::updateCheckpointFiles().