SAMRAI::tbox::RelaunchableJob Class Reference

Define interface for a relaunchable job managed by JobRelauncher. More...

#include <tbox/RelaunchableJob.h>

Inheritance diagram for SAMRAI::tbox::RelaunchableJob:

Public Types
enum	JobState { COMMUNICATION_WAIT = 0, NONCOMMUNICATION_WAIT = 1, JOB_IS_COMPLETED = 2 }

Public Member Functions
	RelaunchableJob ()
	Default constructor. More...
virtual	~RelaunchableJob (void)
	Destructor. More...
virtual void	continueJob ()=0
virtual JobState	getJobState ()=0
	Get the current state of the job, as a JobState enumeration. More...
virtual AsyncCommGroup *	getCommunicationGroup ()=0
	Get the communication group object that the job uses for communications. More...

Detailed Description

This is a strategy class for use with JobRelauncher.

The implemented job should be written to be able to pause during a communication or non-communication wait.

Member Enumeration Documentation

JobState

enum SAMRAI::tbox::RelaunchableJob::JobState

Enumerator
COMMUNICATION_WAIT
NONCOMMUNICATION_WAIT
JOB_IS_COMPLETED

Constructor & Destructor Documentation

RelaunchableJob()

SAMRAI::tbox::RelaunchableJob::RelaunchableJob ( )

inline

~RelaunchableJob()

virtual SAMRAI::tbox::RelaunchableJob::~RelaunchableJob ( void  )

inlinevirtual

Deallocate internal data.

Member Function Documentation

continueJob()

virtual void SAMRAI::tbox::RelaunchableJob::continueJob ( )

pure virtual

Continue the user-defined job.

Implemented in SAMRAI::mesh::AsyncBergerRigoutsosNode< DIM >.

getJobState()

virtual JobState SAMRAI::tbox::RelaunchableJob::getJobState ( )

pure virtual

Implemented in SAMRAI::mesh::AsyncBergerRigoutsosNode< DIM >.

getCommunicationGroup()

virtual AsyncCommGroup* SAMRAI::tbox::RelaunchableJob::getCommunicationGroup ( )

pure virtual

Implemented in SAMRAI::mesh::AsyncBergerRigoutsosNode< DIM >.

---

The documentation for this class was generated from the following file:

• /samrai/include/tbox/RelaunchableJob.h