UG

Ubiquity Generator framework

class ParaSolverTerminationState (Solver termination state in a ParaSolver) More...

#include <paraSolverTerminationState.h>

Inheritance diagram for ParaSolverTerminationState:

Public Member Functions
	ParaSolverTerminationState ()

virtual	~ParaSolverTerminationState ()

virtual std::string	toString (ParaInitiator *initiator)=0
	stringfy ParaSolverTerminationState object More...

virtual int	getInterruptedMode ()=0
	getter of interrupted flag More...

virtual double	getDeterministicTime ()=0
	getter of deterministic time More...

virtual void	write (gzstream::ogzstream &out)=0
	write ParaSolverTerminationState to checkpoint file More...

virtual bool	read (ParaComm *comm, gzstream::igzstream &in)=0
	read ParaSolverTerminationState from checkpoint file More...

virtual void	send (ParaComm *comm, int destination, int tag)=0
	send this object More...

virtual void	receive (ParaComm *comm, int source, int tag)=0
	receive this object More...

Detailed Description

class ParaSolverTerminationState (Solver termination state in a ParaSolver)

Definition at line 53 of file paraSolverTerminationState.h.

Constructor & Destructor Documentation

◆ ParaSolverTerminationState()

ParaSolverTerminationState ( )

Definition at line 57 of file paraSolverTerminationState.h.

◆ ~ParaSolverTerminationState()

virtual ~ParaSolverTerminationState ( )

virtual

Definition at line 62 of file paraSolverTerminationState.h.

Member Function Documentation

◆ getDeterministicTime()

virtual double getDeterministicTime ( )

pure virtual

getter of deterministic time

Returns: deterministic time

Implemented in BbParaSolverTerminationState.

Referenced by BbParaLoadCoordinator::processRacingRampUpTagCompletionOfCalculation(), BbParaLoadCoordinator::processTagSelfSplitTermStateForInterruption(), ParaLoadCoordinator::processTagTerminated(), and BbParaLoadCoordinator::processTagTermStateForInterruption().

◆ getInterruptedMode()

virtual int getInterruptedMode ( )

pure virtual

getter of interrupted flag

Returns: true if it is interrupted, false otherwise

Implemented in BbParaSolverTerminationState.

Referenced by BbParaLoadCoordinator::processTagSelfSplitTermStateForInterruption(), ParaLoadCoordinator::processTagTerminated(), and BbParaLoadCoordinator::processTagTermStateForInterruption().

◆ read()

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

pure virtual

read ParaSolverTerminationState from checkpoint file

Parameters

comm	communicator used
in	gzstream to input

Implemented in BbParaSolverTerminationState.

Referenced by BbParaLoadCoordinator::writePreviousStatisticsInformation().

◆ receive()

virtual void receive	(	ParaComm *	comm,
		int	source,
		int	tag
	)

pure virtual

receive this object

Parameters

comm	communicator used
source	source rank
tag	TagTerminated

Implemented in BbParaSolverTerminationStateMpi, and BbParaSolverTerminationStateTh.

Referenced by BbParaLoadCoordinator::processRacingRampUpTagCompletionOfCalculation(), BbParaLoadCoordinator::processTagSelfSplitTermStateForInterruption(), ParaLoadCoordinator::processTagTerminated(), and BbParaLoadCoordinator::processTagTermStateForInterruption().

◆ send()

virtual void send	(	ParaComm *	comm,
		int	destination,
		int	tag
	)

pure virtual

send this object

Parameters

comm	communicator used
destination	destination rank
tag	TagTerminated

Implemented in BbParaSolverTerminationStateMpi, and BbParaSolverTerminationStateTh.

Referenced by BbParaSolver::sendCompletionOfCalculation(), BbParaSolver::sendCompletionOfCalculationWithoutSolving(), BbParaSolver::sendSolverTerminationState(), and ScipParaSolver::~ScipParaSolver().

◆ toString()

virtual std::string toString ( ParaInitiator * initiator )

pure virtual

stringfy ParaSolverTerminationState object

Returns: string to show inside of ParaSolverTerminationState object

Parameters

initiator pointer to ParaInitiator object

Implemented in BbParaSolverTerminationState.

Referenced by BbParaLoadCoordinator::processRacingRampUpTagCompletionOfCalculation(), ParaLoadCoordinator::processTagTerminated(), BbParaLoadCoordinator::processTagTermStateForInterruption(), and BbParaLoadCoordinator::writePreviousStatisticsInformation().

◆ write()

virtual void write ( gzstream::ogzstream & out )

pure virtual

write ParaSolverTerminationState to checkpoint file

Parameters

out	gzstream to output

Implemented in BbParaSolverTerminationState.

Referenced by BbParaSolverPool::writeSolverStatisticsToCheckpointFile().