UG

Ubiquity Generator framework

Abstract interface for calculation state in a ParaSolver. Holds no data; derived classes own the fields. More...

#include <paraCalculationState.h>

Inheritance diagram for ParaCalculationState:

Public Member Functions
	ParaCalculationState ()

virtual	~ParaCalculationState ()

virtual double	getCompTime ()=0
	getter of computing time of a subproblem More...

virtual int	getNSolved ()=0
	getter of the number of tasks solved in a subproblem More...

virtual int	getTerminationState ()=0
	getter of the termination state for solving the subproblem More...

virtual std::string	toString ()=0
	stringfy ParaCalculationState More...

virtual std::string	toSimpleString ()=0
	stringfy ParaCalculationState (simple string version) More...

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

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

Detailed Description

Abstract interface for calculation state in a ParaSolver. Holds no data; derived classes own the fields.

Definition at line 52 of file paraCalculationState.h.

Constructor & Destructor Documentation

◆ ParaCalculationState()

ParaCalculationState ( )

Definition at line 56 of file paraCalculationState.h.

◆ ~ParaCalculationState()

virtual ~ParaCalculationState ( )

virtual

Definition at line 62 of file paraCalculationState.h.

Member Function Documentation

◆ getCompTime()

virtual double getCompTime ( )

pure virtual

getter of computing time of a subproblem

Returns: subroblem computing time

Implemented in BbParaCalculationState.

◆ getNSolved()

virtual int getNSolved ( )

pure virtual

getter of the number of tasks solved in a subproblem

Returns: the number of tasks

Implemented in BbParaCalculationState.

◆ getTerminationState()

virtual int getTerminationState ( )

pure virtual

getter of the termination state for solving the subproblem

Returns: the termination state

Implemented in BbParaCalculationState.

◆ receive()

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

pure virtual

send this object to destination

Parameters

comm	communicator used to receive this object
source	source rank to receive this object
tag	tag to show this object

Implemented in BbParaCalculationStateMpi, and BbParaCalculationStateTh.

Referenced by BbParaLoadCoordinator::processRacingRampUpTagCompletionOfCalculation(), BbParaLoadCoordinator::processTagCompletionOfCalculation(), and BbParaLoadCoordinator::processTagSelfSlpitNodeCalcuationState().

◆ send()

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

pure virtual

send this object to destination

Parameters

comm	communicator used to send this object
destination	destination rank to send
tag	tag to show this object

Implemented in BbParaCalculationStateMpi, and BbParaCalculationStateTh.

Referenced by BbParaSolver::sendCompletionOfCalculation(), and BbParaSolver::sendCompletionOfCalculationWithoutSolving().

◆ toSimpleString()

virtual std::string toSimpleString ( )

pure virtual

stringfy ParaCalculationState (simple string version)

Returns: simple string to show this object

Implemented in BbParaCalculationState.

Referenced by BbParaLoadCoordinator::writeSubtreeInfo().

◆ toString()

virtual std::string toString ( )

pure virtual

stringfy ParaCalculationState

Returns: string to show this object

Implemented in BbParaCalculationState.

Referenced by ParaLoadCoordinator::writeTransferLog(), and ParaLoadCoordinator::writeTransferLogInRacing().