Scippy

UG

Ubiquity Generator framework

BbParaLoadCoordinatorTerminationState Class Reference

Class for LoadCoordinator termination state which contains calculation state in a ParaLoadCoordinator. More...

#include <bbParaLoadCoordinatorTerminationState.h>

Inheritance diagram for BbParaLoadCoordinatorTerminationState:
ParaLoadCoordinatorTerminationState

Public Member Functions

 BbParaLoadCoordinatorTerminationState ()
 default constructor More...
 
virtual ~BbParaLoadCoordinatorTerminationState ()
 destructor More...
 
std::string toString ()
 stringfy ParaCalculationState More...
 
void write (gzstream::ogzstream &out)
 write to checkpoint file More...
 
bool read (ParaComm *comm, gzstream::igzstream &in)
 read from checkpoint file More...
 
- Public Member Functions inherited from ParaLoadCoordinatorTerminationState
 ParaLoadCoordinatorTerminationState ()
 default constructor More...
 
virtual ~ParaLoadCoordinatorTerminationState ()
 destructor More...
 
virtual std::string toString ()=0
 stringfy ParaCalculationState 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...
 

Public Attributes

unsigned long long nSentBackImmediately
 Counters related to this ParaLoadCoordinator TODO: The numbers should be classified depending on solvers. More...
 
unsigned long long nSentBackImmediatelyAnotherNode
 number of ParaNodes sent back immediately after AnotherNode request from LC More...
 
unsigned long long nDeletedInLc
 number of ParaNodes deleted in LC More...
 
unsigned long long nDeletedByMerging
 number of ParaNodes deleted by merging More...
 
unsigned long long nFailedToSendBack
 number of ParaNodes failed to send back More...
 
unsigned long long nFailedToSendBackAnotherNode
 number of ParaNodes failed to send back after AnotherNode request More...
 
unsigned long long nMaxUsageOfNodePool
 maximum number of ParaNodes in ParaNodePool More...
 
unsigned long long nInitialP
 initial p value, which indicates the number of good ParaNodes try to keep in LC More...
 
unsigned long long mMaxCollectingNodes
 maximum multiplier for the number of collecting nodes More...
 
unsigned long long nNodesInNodePool
 number of nodes in ParaNodePool More...
 
unsigned long long nNodesLeftInAllSolvers
 number of nodes left in all Solvers More...
 
unsigned long long nNodesOutputLog
 count for next logging of the number of transferred ParaNodes More...
 
double tNodesOutputLog
 keep time for next logging of the number of transferred ParaNodes More...
 
double globalBestDualBoundValue
 global best dual bound value (internal value) More...
 
double externalGlobalBestDualBoundValue
 global best dual bound value (external value) More...
 
double idleTime
 idle time of this LoadCoordinator More...
 
double runningTime
 this ParaLoadCoordinator running time More...
 
double addingNodeToMergeStructTime
 time when a ParaNode is added to merge struct More...
 
double generateMergeNodesCandidatesTime
 time when merge ParaNode candidates are generated More...
 
double regenerateMergeNodesCandidatesTime
 time when merge ParaNode candidates are regenerated More...
 
double mergeNodeTime
 time when ParaNode is merged More...
 
- Public Attributes inherited from ParaLoadCoordinatorTerminationState
bool isCheckpointState
 indicate if this state is at checkpoint or not More...
 
int rank
 rank of this ParaLoadCoordinator More...
 
unsigned long long nWarmStart
 number of warm starts (restarts) More...
 
unsigned long long nSent
 number of ParaTasks sent from LC More...
 
unsigned long long nReceived
 number of ParaTasks received from Solvers More...
 
double idleTime
 idle time of this LoadCoordinator More...
 
double runningTime
 this ParaLoadCoordinator running time More...
 

Detailed Description

Class for LoadCoordinator termination state which contains calculation state in a ParaLoadCoordinator.

Definition at line 56 of file bbParaLoadCoordinatorTerminationState.h.

Constructor & Destructor Documentation

◆ BbParaLoadCoordinatorTerminationState()

default constructor

Definition at line 101 of file bbParaLoadCoordinatorTerminationState.h.

◆ ~BbParaLoadCoordinatorTerminationState()

destructor

Definition at line 131 of file bbParaLoadCoordinatorTerminationState.h.

Member Function Documentation

◆ read()

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

read from checkpoint file

Parameters
commcommunicator used
ingzstream for input

Implements ParaLoadCoordinatorTerminationState.

Definition at line 124 of file bbParaLoadCoordinatorTerminationState.cpp.

References BbParaLoadCoordinatorTerminationState::addingNodeToMergeStructTime, BbParaLoadCoordinatorTerminationState::externalGlobalBestDualBoundValue, BbParaLoadCoordinatorTerminationState::generateMergeNodesCandidatesTime, BbParaLoadCoordinatorTerminationState::globalBestDualBoundValue, BbParaLoadCoordinatorTerminationState::idleTime, ParaLoadCoordinatorTerminationState::isCheckpointState, BbParaLoadCoordinatorTerminationState::mergeNodeTime, BbParaLoadCoordinatorTerminationState::nDeletedInLc, BbParaLoadCoordinatorTerminationState::nFailedToSendBack, BbParaLoadCoordinatorTerminationState::nFailedToSendBackAnotherNode, BbParaLoadCoordinatorTerminationState::nMaxUsageOfNodePool, BbParaLoadCoordinatorTerminationState::nNodesInNodePool, BbParaLoadCoordinatorTerminationState::nNodesLeftInAllSolvers, ParaLoadCoordinatorTerminationState::nReceived, ParaLoadCoordinatorTerminationState::nSent, BbParaLoadCoordinatorTerminationState::nSentBackImmediately, BbParaLoadCoordinatorTerminationState::nSentBackImmediatelyAnotherNode, ParaLoadCoordinatorTerminationState::nWarmStart, ParaLoadCoordinatorTerminationState::rank, BbParaLoadCoordinatorTerminationState::regenerateMergeNodesCandidatesTime, and BbParaLoadCoordinatorTerminationState::runningTime.

Referenced by BbParaLoadCoordinator::writePreviousStatisticsInformation().

◆ toString()

std::string toString ( )
virtual

stringfy ParaCalculationState

Returns
string to show inside of this object

stringfy ParaCalculationState

Implements ParaLoadCoordinatorTerminationState.

Definition at line 44 of file bbParaLoadCoordinatorTerminationState.cpp.

References BbParaLoadCoordinatorTerminationState::addingNodeToMergeStructTime, BbParaLoadCoordinatorTerminationState::externalGlobalBestDualBoundValue, BbParaLoadCoordinatorTerminationState::generateMergeNodesCandidatesTime, BbParaLoadCoordinatorTerminationState::globalBestDualBoundValue, BbParaLoadCoordinatorTerminationState::idleTime, ParaLoadCoordinatorTerminationState::isCheckpointState, BbParaLoadCoordinatorTerminationState::mergeNodeTime, BbParaLoadCoordinatorTerminationState::mMaxCollectingNodes, BbParaLoadCoordinatorTerminationState::nDeletedByMerging, BbParaLoadCoordinatorTerminationState::nDeletedInLc, BbParaLoadCoordinatorTerminationState::nFailedToSendBack, BbParaLoadCoordinatorTerminationState::nFailedToSendBackAnotherNode, BbParaLoadCoordinatorTerminationState::nInitialP, BbParaLoadCoordinatorTerminationState::nMaxUsageOfNodePool, BbParaLoadCoordinatorTerminationState::nNodesInNodePool, BbParaLoadCoordinatorTerminationState::nNodesLeftInAllSolvers, ParaLoadCoordinatorTerminationState::nReceived, ParaLoadCoordinatorTerminationState::nSent, BbParaLoadCoordinatorTerminationState::nSentBackImmediately, BbParaLoadCoordinatorTerminationState::nSentBackImmediatelyAnotherNode, ParaLoadCoordinatorTerminationState::rank, BbParaLoadCoordinatorTerminationState::regenerateMergeNodesCandidatesTime, and BbParaLoadCoordinatorTerminationState::runningTime.

Referenced by BbParaLoadCoordinator::writePreviousStatisticsInformation(), and BbParaLoadCoordinator::~BbParaLoadCoordinator().

◆ write()

void write ( gzstream::ogzstream &  out)
virtual

write to checkpoint file

Parameters
outgzstream for output

Implements ParaLoadCoordinatorTerminationState.

Definition at line 96 of file bbParaLoadCoordinatorTerminationState.cpp.

References BbParaLoadCoordinatorTerminationState::addingNodeToMergeStructTime, BbParaLoadCoordinatorTerminationState::externalGlobalBestDualBoundValue, BbParaLoadCoordinatorTerminationState::generateMergeNodesCandidatesTime, BbParaLoadCoordinatorTerminationState::globalBestDualBoundValue, BbParaLoadCoordinatorTerminationState::idleTime, ParaLoadCoordinatorTerminationState::isCheckpointState, BbParaLoadCoordinatorTerminationState::mergeNodeTime, BbParaLoadCoordinatorTerminationState::nDeletedInLc, BbParaLoadCoordinatorTerminationState::nFailedToSendBack, BbParaLoadCoordinatorTerminationState::nFailedToSendBackAnotherNode, BbParaLoadCoordinatorTerminationState::nMaxUsageOfNodePool, BbParaLoadCoordinatorTerminationState::nNodesInNodePool, BbParaLoadCoordinatorTerminationState::nNodesLeftInAllSolvers, ParaLoadCoordinatorTerminationState::nReceived, ParaLoadCoordinatorTerminationState::nSent, BbParaLoadCoordinatorTerminationState::nSentBackImmediately, BbParaLoadCoordinatorTerminationState::nSentBackImmediatelyAnotherNode, ParaLoadCoordinatorTerminationState::nWarmStart, ParaLoadCoordinatorTerminationState::rank, BbParaLoadCoordinatorTerminationState::regenerateMergeNodesCandidatesTime, and BbParaLoadCoordinatorTerminationState::runningTime.

Referenced by BbParaLoadCoordinator::writeLoadCoordinatorStatisticsToCheckpointFile().

Member Data Documentation

◆ addingNodeToMergeStructTime

◆ externalGlobalBestDualBoundValue

◆ generateMergeNodesCandidatesTime

◆ globalBestDualBoundValue

◆ idleTime

◆ mergeNodeTime

◆ mMaxCollectingNodes

unsigned long long mMaxCollectingNodes

maximum multiplier for the number of collecting nodes

Definition at line 74 of file bbParaLoadCoordinatorTerminationState.h.

Referenced by BbParaLoadCoordinatorTerminationState::toString(), and BbParaLoadCoordinator::~BbParaLoadCoordinator().

◆ nDeletedByMerging

unsigned long long nDeletedByMerging

number of ParaNodes deleted by merging

Definition at line 69 of file bbParaLoadCoordinatorTerminationState.h.

Referenced by BbParaLoadCoordinatorTerminationState::toString().

◆ nDeletedInLc

◆ nFailedToSendBack

◆ nFailedToSendBackAnotherNode

◆ nInitialP

unsigned long long nInitialP

initial p value, which indicates the number of good ParaNodes try to keep in LC

Definition at line 73 of file bbParaLoadCoordinatorTerminationState.h.

Referenced by BbParaLoadCoordinatorTerminationState::toString(), and BbParaLoadCoordinator::~BbParaLoadCoordinator().

◆ nMaxUsageOfNodePool

◆ nNodesInNodePool

◆ nNodesLeftInAllSolvers

◆ nNodesOutputLog

unsigned long long nNodesOutputLog

count for next logging of the number of transferred ParaNodes

Definition at line 77 of file bbParaLoadCoordinatorTerminationState.h.

Referenced by BbParaLoadCoordinator::processTagSolverState().

◆ nSentBackImmediately

◆ nSentBackImmediatelyAnotherNode

◆ regenerateMergeNodesCandidatesTime

◆ runningTime

◆ tNodesOutputLog

double tNodesOutputLog

keep time for next logging of the number of transferred ParaNodes

current dual bound value

Definition at line 78 of file bbParaLoadCoordinatorTerminationState.h.

Referenced by BbParaLoadCoordinator::processTagSolverState().