Scippy

UG

Ubiquity Generator framework

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

#include <bbParaRacingRampUpParamSet.h>

Inheritance diagram for BbParaRacingRampUpParamSet:

Public Member Functions
	BbParaRacingRampUpParamSet ()
	default constructor More...

	BbParaRacingRampUpParamSet (int inTerminationCriteria, int inNNodesLeft, double inTimeLimit)
	constructor More...

virtual	~BbParaRacingRampUpParamSet ()
	destructor More...

int	getTerminationCriteria ()
	get termination criteria More...

int	getStopRacingNNodesLeft ()
	get stop racing number of nodes left More...

double	getStopRacingTimeLimit ()
	get stop racing time limimt 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 BbParaRacingRampUpParamSet More...

virtual int	receive (ParaComm *comm, int source)=0
	receive BbParaRacingRampUpParamSet 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 BbParaRacingRampUpParamSet More...

virtual int	getStrategy ()=0
	get strategy More...

Public Member Functions inherited from ParaRacingRampUpParamSet
	ParaRacingRampUpParamSet ()
	default constructor More...

	ParaRacingRampUpParamSet (int inTerminationCriteria)
	constructor More...

virtual	~ParaRacingRampUpParamSet ()
	destructor More...

int	getTerminationCriteria ()
	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...

Protected Attributes
int	nNodesLeft
	stop racing number of nodes left More...

double	timeLimit
	stop racing time limit More...

Protected Attributes inherited from ParaRacingRampUpParamSet
int	terminationCriteria
	termination criteria of racing ramp-up : 0: number of nodes left, 1: time limit meaning must be defined in a derived class More...

Detailed Description

class BbParaRacingRampUpParamSet (parameter set for racing ramp-up)

Definition at line 57 of file bbParaRacingRampUpParamSet.h.

Constructor & Destructor Documentation

◆ BbParaRacingRampUpParamSet() [1/2]

BbParaRacingRampUpParamSet ( )

default constructor

Definition at line 70 of file bbParaRacingRampUpParamSet.h.

◆ BbParaRacingRampUpParamSet() [2/2]

BbParaRacingRampUpParamSet	(	int	inTerminationCriteria,
		int	inNNodesLeft,
		double	inTimeLimit
	)

constructor

Parameters

inTerminationCriteria	termination criteria of racing ramp-up
inNNodesLeft	stop racing number of nodes left
inTimeLimit	stop racing time limit

Definition at line 81 of file bbParaRacingRampUpParamSet.h.

◆ ~BbParaRacingRampUpParamSet()

virtual ~BbParaRacingRampUpParamSet ( )

virtual

destructor

Definition at line 95 of file bbParaRacingRampUpParamSet.h.

Member Function Documentation

◆ getStopRacingNNodesLeft()

int getStopRacingNNodesLeft ( )

get stop racing number of nodes left

Returns: the number of nodes left

Definition at line 114 of file bbParaRacingRampUpParamSet.h.

References BbParaRacingRampUpParamSet::nNodesLeft.

◆ getStopRacingTimeLimit()

double getStopRacingTimeLimit ( )

get stop racing time limimt

Returns: time to stop racing

Definition at line 124 of file bbParaRacingRampUpParamSet.h.

References BbParaRacingRampUpParamSet::timeLimit.

◆ getStrategy()

virtual int getStrategy ( )

pure virtual

get strategy

Returns: an int value which shows strategy

Implements ParaRacingRampUpParamSet.

Implemented in ScipParaRacingRampUpParamSet.

◆ getTerminationCriteria()

int getTerminationCriteria ( )

get termination criteria

Returns: an int value to show termination criteria

Definition at line 104 of file bbParaRacingRampUpParamSet.h.

References ParaRacingRampUpParamSet::terminationCriteria.

◆ read()

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

pure virtual

read from checkpoint file

Parameters

comm	communicator used
in	gzstream for input

Implements ParaRacingRampUpParamSet.

Implemented in ScipParaRacingRampUpParamSet.

◆ receive()

virtual int receive	(	ParaComm *	comm,
		int	source
	)

pure virtual

receive BbParaRacingRampUpParamSet

Returns: always 0 (for future extensions)

Parameters

comm	communicator used
source	source rank

Implements ParaRacingRampUpParamSet.

Implemented in ScipParaRacingRampUpParamSetMpi, and ScipParaRacingRampUpParamSetTh.

Referenced by runSolverThread().

◆ send()

virtual int send	(	ParaComm *	comm,
		int	destination
	)

pure virtual

send BbParaRacingRampUpParamSet

Returns: always 0 (for future extensions)

Parameters

comm	communicator used
destination	destination rank

Implements ParaRacingRampUpParamSet.

Implemented in ScipParaRacingRampUpParamSetMpi, and ScipParaRacingRampUpParamSetTh.

◆ setWinnerRank()

virtual void setWinnerRank ( int rank )

virtual

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

Reimplemented from ParaRacingRampUpParamSet.

Definition at line 135 of file bbParaRacingRampUpParamSet.h.

◆ toString()

virtual const std::string toString ( )

pure virtual

stringfy BbParaRacingRampUpParamSet

Returns: string to show inside of this object

Implements ParaRacingRampUpParamSet.

Implemented in ScipParaRacingRampUpParamSet.

◆ write()

virtual void write ( gzstream::ogzstream & out )

pure virtual

write to checkpoint file

Parameters

out	gzstream for output

Implements ParaRacingRampUpParamSet.

Implemented in ScipParaRacingRampUpParamSet.

Member Data Documentation

◆ nNodesLeft

int nNodesLeft

protected

stop racing number of nodes left

Definition at line 62 of file bbParaRacingRampUpParamSet.h.

Referenced by ScipParaRacingRampUpParamSetMpi::createDatatype(), ScipParaRacingRampUpParamSetTh::createDatatype(), BbParaRacingRampUpParamSet::getStopRacingNNodesLeft(), and ScipParaRacingRampUpParamSetTh::receive().

◆ timeLimit

double timeLimit

protected

stop racing time limit

Definition at line 63 of file bbParaRacingRampUpParamSet.h.

Referenced by ScipParaRacingRampUpParamSetMpi::createDatatype(), ScipParaRacingRampUpParamSetTh::createDatatype(), BbParaRacingRampUpParamSet::getStopRacingTimeLimit(), and ScipParaRacingRampUpParamSetTh::receive().