Scippy

UG

Ubiquity Generator framework

Base class of Calculation state in a ParaSolver. More...

#include <paraCalculationState.h>

Inheritance diagram for ParaCalculationState:

Public Member Functions
	ParaCalculationState ()
	Default Constructor. More...

	ParaCalculationState (double inCompTime, int inNSolved, int inTerminationState)
	Constructor. More...

virtual	~ParaCalculationState ()
	Destructor. More...

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

int	getNSolved ()
	geeter of the number of tasks solved in a subproblem More...

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

Protected Attributes
double	compTime
	computation time of this ParaTask More...

int	nSolved
	the number of tasks solved More...

int	terminationState
	indicate whether if this computation is terminationState or not. 0: no, 1: terminationState meaning can be defined in derived class More...

Detailed Description

Base class of Calculation state in a ParaSolver.

Definition at line 51 of file paraCalculationState.h.

Constructor & Destructor Documentation

◆ ParaCalculationState() [1/2]

ParaCalculationState ( )

Default Constructor.

Definition at line 63 of file paraCalculationState.h.

◆ ParaCalculationState() [2/2]

ParaCalculationState	(	double	inCompTime,
		int	inNSolved,
		int	inTerminationState
	)

Constructor.

Parameters

inCompTime	computation time of this ParaTask
inNSolved	the number of tasks solved
inTerminationState	indicate whether if this computation is terminationState or not. 0: no, 1: terminationState

Definition at line 74 of file paraCalculationState.h.

◆ ~ParaCalculationState()

virtual ~ParaCalculationState ( )

virtual

Destructor.

Definition at line 89 of file paraCalculationState.h.

Member Function Documentation

◆ getCompTime()

double getCompTime ( )

getter of computing time of a subproblem

Returns: subroblem computing time

Definition at line 99 of file paraCalculationState.h.

References ParaCalculationState::compTime.

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

◆ getNSolved()

int getNSolved ( )

geeter of the number of tasks solved in a subproblem

Returns: the number of tasks

Definition at line 109 of file paraCalculationState.h.

References ParaCalculationState::nSolved.

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

◆ getTerminationState()

int getTerminationState ( )

getter of the termination state for solving the subproblem

Returns: the termination state

Definition at line 118 of file paraCalculationState.h.

References ParaCalculationState::terminationState.

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

Member Data Documentation

◆ compTime

double compTime

protected

computation time of this ParaTask

Definition at line 54 of file paraCalculationState.h.

Referenced by BbParaCalculationStateMpi::createDatatype(), BbParaCalculationStateTh::createDatatype(), BbParaCalculationState::getAverageNodeCompTimeExcpetRoot(), ParaCalculationState::getCompTime(), BbParaCalculationStateMpi::receive(), BbParaCalculationStateTh::receive(), BbParaCalculationStateMpi::send(), BbParaCalculationState::toSimpleString(), and BbParaCalculationState::toString().

◆ nSolved

int nSolved

protected

the number of tasks solved

Definition at line 55 of file paraCalculationState.h.

Referenced by BbParaCalculationStateMpi::createDatatype(), BbParaCalculationStateTh::createDatatype(), BbParaCalculationState::getAverageNodeCompTimeExcpetRoot(), ParaCalculationState::getNSolved(), BbParaCalculationStateTh::receive(), BbParaCalculationState::toSimpleString(), and BbParaCalculationState::toString().

◆ terminationState

int terminationState

protected

indicate whether if this computation is terminationState or not. 0: no, 1: terminationState meaning can be defined in derived class

Definition at line 56 of file paraCalculationState.h.

Referenced by BbParaCalculationStateMpi::createDatatype(), BbParaCalculationStateTh::createDatatype(), ParaCalculationState::getTerminationState(), BbParaCalculationState::getTerminationState(), BbParaCalculationStateTh::receive(), and BbParaCalculationState::toString().