Class for initiator. More...
#include <paraInitiator.h>
Public Member Functions | |
ParaInitiator (ParaComm *inComm, ParaTimer *inTimer) | |
constructor More... | |
virtual | ~ParaInitiator () |
destructor More... | |
bool | isWarmStarted () |
check if the execution is warm started (restarted) or not More... | |
const char * | getPrefixWarm () |
get prefix of warm start (restart) files More... | |
ParaComm * | getParaComm () |
get communicator being used More... | |
virtual int | init (ParaParamSet *params, int argc, char **argv)=0 |
initialize initiator More... | |
virtual int | reInit (int nRestartedRacing)=0 |
reinitizalie initiator TODO: this function should be in inherited class More... | |
virtual ParaInstance * | getParaInstance ()=0 |
get instance object More... | |
virtual void | sendSolverInitializationMessage ()=0 |
send solver initialization message More... | |
virtual void | generateRacingRampUpParameterSets (int nParamSets, ParaRacingRampUpParamSet **racingRampUpParamSets)=0 |
generate racing ramp-up parameter sets TODO: this function may be in inherited class More... | |
virtual double | getEpsilon ()=0 |
get epsilon specified More... | |
virtual void | writeSolution (const std::string &message)=0 |
write solution More... | |
virtual void | writeParaInstance (const std::string &filename)=0 |
write ParaInstance More... | |
virtual void | writeSolverParameters (std::ostream *os)=0 |
write solver runtime parameters More... | |
virtual void | outputFinalSolverStatistics (std::ostream *os, double time)=0 |
output final solver statistics More... | |
virtual std::string | getStatus ()=0 |
get solving status string More... | |
virtual void | printSolverVersion (std::ostream *os)=0 |
print solver version More... | |
Protected Attributes | |
ParaComm * | paraComm |
communicator used More... | |
ParaTimer * | timer |
timer used More... | |
char * | prefixWarm |
prefix of warm start files More... | |
Class for initiator.
Definition at line 62 of file paraInitiator.h.
ParaInitiator | ( | ParaComm * | inComm, |
ParaTimer * | inTimer | ||
) |
constructor
inComm | communicator used |
inTimer | timer used |
Definition at line 75 of file paraInitiator.h.
References UG::getGitHash(), and UG_VERSION.
|
virtual |
destructor
Definition at line 91 of file paraInitiator.h.
|
pure virtual |
generate racing ramp-up parameter sets TODO: this function may be in inherited class
nParamSets | number of parameter sets to be generated |
racingRampUpParamSets | array of the racing parameter sets |
Implemented in ScipParaInitiator.
Referenced by ParaInitiator::getParaComm(), main(), and BbParaLoadCoordinator::sendParaTasksToIdleSolvers().
|
pure virtual |
get epsilon specified
Implemented in ScipParaInitiator.
Referenced by ParaInitiator::getParaComm(), BbParaLoadCoordinator::outputTabularSolvingStatus(), ParaLoadCoordinator::ParaLoadCoordinator(), BbParaLoadCoordinator::processRacingRampUpTagCompletionOfCalculation(), BbParaLoadCoordinator::processTagCompletionOfCalculation(), and BbParaLoadCoordinator::processTagSelfSlpitNodeCalcuationState().
ParaComm* getParaComm | ( | ) |
get communicator being used
Definition at line 120 of file paraInitiator.h.
References ParaInitiator::generateRacingRampUpParameterSets(), ParaInitiator::getEpsilon(), ParaInitiator::getParaInstance(), ParaInitiator::getStatus(), ParaInitiator::init(), ParaInitiator::outputFinalSolverStatistics(), ParaInitiator::paraComm, ParaInitiator::printSolverVersion(), ParaInitiator::reInit(), ParaInitiator::sendSolverInitializationMessage(), ParaInitiator::writeParaInstance(), ParaInitiator::writeSolution(), and ParaInitiator::writeSolverParameters().
|
pure virtual |
get instance object
Implemented in ScipParaInitiator.
Referenced by BbParaLoadCoordinator::BbParaLoadCoordinator(), BbParaLoadCoordinator::changeSearchStrategyOfAllSolversToOriginalSearch(), ParaInitiator::getParaComm(), main(), outputParaParamSet(), outputSolverParams(), ParaLoadCoordinator::ParaLoadCoordinator(), BbParaLoadCoordinator::processTagSolution(), BbParaLoadCoordinator::restartRacing(), BbParaLoadCoordinator::run(), and BbParaLoadCoordinator::sendParaTasksToIdleSolvers().
const char* getPrefixWarm | ( | ) |
get prefix of warm start (restart) files
Definition at line 110 of file paraInitiator.h.
References ParaInitiator::prefixWarm.
Referenced by BbParaLoadCoordinator::BbParaLoadCoordinator(), outputParaParamSet(), outputSolverParams(), and BbParaLoadCoordinator::sendParaTasksToIdleSolvers().
|
pure virtual |
get solving status string
Implemented in ScipParaInitiator.
Referenced by ParaInitiator::getParaComm().
|
pure virtual |
initialize initiator
params | UG parameter used |
argc | the number of command line arguments |
argv | array of the arguments |
Implemented in ScipParaInitiator.
Referenced by ParaInitiator::getParaComm(), and main().
bool isWarmStarted | ( | ) |
check if the execution is warm started (restarted) or not
Definition at line 100 of file paraInitiator.h.
Referenced by main().
|
pure virtual |
output final solver statistics
os | output stream to write final solver statistics |
time | computing time |
Implemented in ScipParaInitiator.
Referenced by ParaInitiator::getParaComm(), main(), and BbParaLoadCoordinator::~BbParaLoadCoordinator().
|
pure virtual |
print solver version
os | output file (or NULL for standard output) |
Implemented in ScipParaInitiator.
Referenced by ParaInitiator::getParaComm().
|
pure virtual |
reinitizalie initiator TODO: this function should be in inherited class
nRestartedRacing | the number of restarted racing |
Implemented in ScipParaInitiator.
Referenced by ParaInitiator::getParaComm(), and BbParaLoadCoordinator::restartRacing().
|
pure virtual |
send solver initialization message
Implemented in ScipParaInitiator.
Referenced by ParaInitiator::getParaComm(), and main().
|
pure virtual |
write ParaInstance
filename | output file name |
Implemented in ScipParaInitiator.
Referenced by ParaInitiator::getParaComm().
|
pure virtual |
write solution
message | message head string |
Implemented in ScipParaInitiator.
Referenced by ParaInitiator::getParaComm(), BbParaLoadCoordinator::sendParaTasksToIdleSolvers(), and BbParaLoadCoordinator::~BbParaLoadCoordinator().
|
pure virtual |
write solver runtime parameters
os | output stream to write solver parameters |
Implemented in ScipParaInitiator.
Referenced by ParaInitiator::getParaComm(), and outputSolverParams().
|
protected |
communicator used
Definition at line 66 of file paraInitiator.h.
Referenced by ParaInitiator::getParaComm(), and BbParaInitiator::~BbParaInitiator().
|
protected |
prefix of warm start files
Definition at line 68 of file paraInitiator.h.
Referenced by ParaInitiator::getPrefixWarm().
|
protected |
timer used
Definition at line 67 of file paraInitiator.h.