Scippy

UG

Ubiquity Generator framework

ParaLoadCoordinatorTerminationState Class Referenceabstract

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

#include <paraLoadCoordinatorTerminationState.h>

Inheritance diagram for ParaLoadCoordinatorTerminationState:
BbParaLoadCoordinatorTerminationState

Public Member Functions

 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

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 55 of file paraLoadCoordinatorTerminationState.h.

Constructor & Destructor Documentation

◆ ParaLoadCoordinatorTerminationState()

default constructor

Definition at line 77 of file paraLoadCoordinatorTerminationState.h.

◆ ~ParaLoadCoordinatorTerminationState()

destructor

Definition at line 92 of file paraLoadCoordinatorTerminationState.h.

Member Function Documentation

◆ read()

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

read from checkpoint file

Parameters
commcommunicator used
ingzstream for input

Implemented in BbParaLoadCoordinatorTerminationState.

◆ toString()

virtual std::string toString ( )
pure virtual

stringfy ParaCalculationState

Returns
string to show inside of this object

Implemented in BbParaLoadCoordinatorTerminationState.

◆ write()

virtual void write ( gzstream::ogzstream &  out)
pure virtual

write to checkpoint file

Parameters
outgzstream for output

Implemented in BbParaLoadCoordinatorTerminationState.

Member Data Documentation

◆ idleTime

double idleTime

idle time of this LoadCoordinator

Definition at line 71 of file paraLoadCoordinatorTerminationState.h.

◆ isCheckpointState

◆ nReceived

◆ nSent

◆ nWarmStart

◆ rank

int rank

rank of this ParaLoadCoordinator

Counters related to this ParaLoadCoordinator TODO: The numbers should be classified depending on solvers

Definition at line 60 of file paraLoadCoordinatorTerminationState.h.

Referenced by BbParaLoadCoordinatorTerminationState::read(), BbParaLoadCoordinatorTerminationState::toString(), and BbParaLoadCoordinatorTerminationState::write().

◆ runningTime

double runningTime

this ParaLoadCoordinator running time

Definition at line 72 of file paraLoadCoordinatorTerminationState.h.