Scippy

UG

Ubiquity Generator framework

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

#include <paraRacingRampUpParamSet.h>

Inheritance diagram for ParaRacingRampUpParamSet:

Public Member Functions
	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	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 ParaRacingRampUpParamSet (parameter set for racing ramp-up)

Definition at line 55 of file paraRacingRampUpParamSet.h.

Constructor & Destructor Documentation

◆ ParaRacingRampUpParamSet() [1/2]

ParaRacingRampUpParamSet ( )

default constructor

Definition at line 68 of file paraRacingRampUpParamSet.h.

◆ ParaRacingRampUpParamSet() [2/2]

ParaRacingRampUpParamSet ( int inTerminationCriteria )

constructor

Parameters

inTerminationCriteria termination criteria of racing ramp-up

Definition at line 77 of file paraRacingRampUpParamSet.h.

◆ ~ParaRacingRampUpParamSet()

virtual ~ParaRacingRampUpParamSet ( )

virtual

destructor

Definition at line 87 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()

int getTerminationCriteria ( )

get termination criteria

Returns: an int value to show termination criteria

Definition at line 96 of file paraRacingRampUpParamSet.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

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 106 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().

Member Data Documentation

◆ terminationCriteria

int terminationCriteria

protected

termination criteria of racing ramp-up : 0: number of nodes left, 1: time limit meaning must be defined in a derived class

Definition at line 60 of file paraRacingRampUpParamSet.h.

Referenced by ScipParaRacingRampUpParamSetMpi::createDatatype(), ScipParaRacingRampUpParamSetTh::createDatatype(), ParaRacingRampUpParamSet::getTerminationCriteria(), BbParaRacingRampUpParamSet::getTerminationCriteria(), ScipParaRacingRampUpParamSetMpi::receive(), ScipParaRacingRampUpParamSetTh::receive(), and ScipParaRacingRampUpParamSetMpi::send().