SAMRAI::tbox::RelaunchableJob Class Reference

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

#include <source/toolbox/parallel/RelaunchableJob.h>

Inheritance diagram for SAMRAI::tbox::RelaunchableJob:

[legend]List of all members.

Public Types
enum	JobState { COMMUNICATION_WAIT = 0, NONCOMMUNICATION_WAIT = 1, JOB_IS_COMPLETED = 2 }
Public Member Functions
	RelaunchableJob ()
	Default constructor.
virtual	~RelaunchableJob (void)
	Destructor.
virtual void	continueJob ()=0
virtual JobState	getJobState ()=0
	Get the current state of the job, as a JobState enumeration.
virtual AsyncCommGroup *	getCommunicationGroup ()=0
	Get the communication group object that the job uses for communications.

---

Detailed Description

Define interface for a relaunchable job managed by JobRelauncher.

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

enum SAMRAI::tbox::RelaunchableJob::JobState

Enumerator:

COMMUNICATION_WAIT
NONCOMMUNICATION_WAIT
JOB_IS_COMPLETED

---

Constructor & Destructor Documentation

SAMRAI::tbox::RelaunchableJob::RelaunchableJob

(

)

[inline]

Default constructor.

virtual SAMRAI::tbox::RelaunchableJob::~RelaunchableJob

(

void

)

[inline, virtual]

Destructor.

Deallocate internal data.

---

Member Function Documentation

virtual void SAMRAI::tbox::RelaunchableJob::continueJob

(

)

[pure virtual]

Continue the user-defined job.

virtual JobState SAMRAI::tbox::RelaunchableJob::getJobState

(

)

[pure virtual]

Get the current state of the job, as a JobState enumeration.

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

(

)

[pure virtual]

Get the communication group object that the job uses for communications.

---

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

• source/toolbox/parallel/RelaunchableJob.h

---