NOMAD Source
Version 4.0.0 Beta
|
Class for initialization (step 0) of an Algorithm. More...
#include <Initialization.hpp>
Public Member Functions | |
Initialization (const Step *parentStep) | |
Constructor. More... | |
virtual | ~Initialization () |
Destructor. More... | |
const std::shared_ptr< Barrier > & | getBarrier () const |
virtual void | startImp () override |
virtual bool | runImp () override=0 |
virtual void | endImp () override |
![]() | |
Step () | |
Constructor #1 for MainStep (no parent) More... | |
Step (const Step *parentStep, const std::shared_ptr< RunParameters > &runParams=nullptr, const std::shared_ptr< PbParameters > &pbParams=nullptr) | |
Constructor #2 for child step of a parent sharing the same stopReason. More... | |
Step (const Step *parentStep, std::shared_ptr< AllStopReasons > stopReasons, const std::shared_ptr< RunParameters > &runParams=nullptr, const std::shared_ptr< PbParameters > &pbParams=nullptr) | |
Constructor #3: for a child Step with a provided stopReason (such as an algorithm) More... | |
virtual | ~Step () |
Destructor. More... | |
const Step * | getParentStep () const |
Get the parent step. More... | |
virtual const std::string & | getName () const |
Get the name of this step. More... | |
void | setName (const std::string &name) |
Set the name of this step. More... | |
const std::shared_ptr< AllStopReasons > & | getAllStopReasons () const |
const std::shared_ptr< RunParameters > & | getRunParams () const |
const std::shared_ptr< PbParameters > & | getPbParams () const |
void | addCallback (const CallbackType &callbackType, const StepEndCbFunc &stepEndCbFunc) |
Set user callback. More... | |
void | addCallback (const CallbackType &callbackType, const HotRestartCbFunc &hotRestartCbFunc) |
void | AddOutputInfo (const std::string &s, bool isBlockStart, bool isBlockEnd) const |
display output More... | |
void | AddOutputInfo (const std::string &s, OutputLevel outputLevel=OutputLevel::LEVEL_INFO) const |
void | AddOutputError (const std::string &s) const |
void | AddOutputWarning (const std::string &s) const |
void | AddOutputVeryHigh (const std::string &s) const |
void | AddOutputHigh (const std::string &s) const |
void | AddOutputDebug (const std::string &s) const |
void | AddOutputInfo (OutputInfo outputInfo) const |
template<typename T > | |
T | getParentOfType (const bool stopAtAlgo=true) const |
Template function to get the parent of given type. More... | |
bool | isAnAlgorithm () const |
const Algorithm * | getRootAlgorithm () const |
Get Algorithm ancestor that has no Algorithm ancestor. More... | |
std::string | getAlgoName () const |
virtual std::string | getAlgoComment () const |
virtual void | setAlgoComment (const std::string &algoComment, const bool force=false) |
virtual void | resetPreviousAlgoComment (const bool force=false) |
const std::shared_ptr< MeshBase > | getIterationMesh () const |
const std::shared_ptr< EvalPoint > | getIterationFrameCenter () const |
const std::shared_ptr< Barrier > | getMegaIterationBarrier () const |
void | start () |
bool | run () |
void | end () |
virtual void | hotRestartOnUserInterrupt () |
Helper for hot restart functionalities. More... | |
void | debugShowCallStack () const |
For debugging purposes. Show the stack of Steps for this step. More... | |
Protected Attributes | |
std::shared_ptr< Barrier > | _barrier |
Barrier constructed from evaluated X0s. More... | |
![]() | |
const Step * | _parentStep |
The parent of this step. More... | |
std::string | _name |
The name of this step. More... | |
std::shared_ptr< AllStopReasons > | _stopReasons |
The stop reasons of an algorithm. More... | |
std::shared_ptr< RunParameters > | _runParams |
The run parameters that control a step. More... | |
std::shared_ptr< PbParameters > | _pbParams |
The problem parameters that control a step. More... | |
Private Member Functions | |
void | init () |
Helper for constructor. More... | |
Additional Inherited Members | |
![]() | |
static bool | getUserTerminate () |
Interruption call by user. More... | |
static void | setUserTerminate () |
Interruption requested. More... | |
static void | userInterrupt (int signalValue) |
Interruption call by user. More... | |
static void | debugSegFault (int signalValue) |
static bool | getUserInterrupt () |
static void | runCallback (CallbackType callbackType, const Step &step, bool &stop) |
Run user callback. More... | |
static void | runCallback (CallbackType callbackType, std::vector< std::string > ¶mLines) |
static void | disableWarnings () |
![]() | |
void | verifyParentNotNull () |
Helper for constructors. More... | |
void | verifyGenerateAllPointsBeforeEval (const std::string &method, const bool expected) const |
Helper for validating steps depending on parameter GENERATE_ALL_POINTS_BEFORE_EVAL. More... | |
void | hotRestartBeginHelper () |
Helpers for hot restart, to be called at the start and end of any override. More... | |
void | hotRestartEndHelper () |
Helpers for hot restart, to be called at the start and end of any override. More... | |
![]() | |
static bool | _userInterrupt |
Interrupt NOMAD if Ctrl-C is pressed. More... | |
static bool | _userTerminate |
Terminate NOMAD if Ctrl-C is pressed again. More... | |
static StepEndCbFunc | _cbIterationEnd |
static StepEndCbFunc | _cbMegaIterationEnd |
static HotRestartCbFunc | _cbHotRestart |
static bool | _showWarnings |
Class for initialization (step 0) of an Algorithm.
This an abstract class, each algorithm should probably implement an initialization.
Definition at line 57 of file Initialization.hpp.
|
inlineexplicit |
Constructor.
Definition at line 67 of file Initialization.hpp.
|
virtual |
Destructor.
Upon destruction, print all that is in the output queue.
|
inlineoverridevirtual |
Placeholder to be implemented by derived classes. Called by end.
Implements Step.
Reimplemented in NMInitialization, QuadModelInitialization, and SgtelibModelInitialization.
Definition at line 90 of file Initialization.hpp.
|
inline |
Definition at line 80 of file Initialization.hpp.
|
private |
Helper for constructor.
|
overridepure virtual |
Placeholder to be implemented in derived classes. Called by run.
Implements Step.
Implemented in NMInitialization, MadsInitialization, QuadModelInitialization, and SgtelibModelInitialization.
|
inlineoverridevirtual |
Placeholder to be implemented in derived classes. Called by start.
Implements Step.
Reimplemented in NMInitialization, QuadModelInitialization, and SgtelibModelInitialization.
Definition at line 88 of file Initialization.hpp.
|
protected |
Barrier constructed from evaluated X0s.
Definition at line 60 of file Initialization.hpp.