SAMRAI::tbox::Transaction Class Reference

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

Inheritance diagram for SAMRAI::tbox::Transaction:

[legend]List of all members.

Public Member Functions
	Transaction ()
virtual	~Transaction ()
virtual bool	canEstimateIncomingMessageSize ()=0
virtual int	computeIncomingMessageSize ()=0
virtual int	computeOutgoingMessageSize ()=0
virtual int	getSourceProcessor ()=0
virtual int	getDestinationProcessor ()=0
virtual void	packStream (AbstractStream &stream)=0
virtual void	unpackStream (AbstractStream &stream)=0
virtual void	copyLocalData ()=0
virtual void	printClassData (std::ostream &stream) const =0

---

Detailed Description

Class Transaction describes a single communication between two processors or a local data copy. It is an abstract base class for each data transaction in a communication schedule.

---

Constructor & Destructor Documentation

SAMRAI::tbox::Transaction::Transaction

(

)

The constructor for transaction does nothing interesting.

SAMRAI::tbox::Transaction::~Transaction

(

)

[virtual]

The virtual destructor for transaction does nothing interesting.

---

Member Function Documentation

virtual bool SAMRAI::tbox::Transaction::canEstimateIncomingMessageSize

(

)

[pure virtual]

Return a boolean indicating whether this transaction can estimate the size of an incoming message. If this is false, then a different communications protocol kicks in and the message size is transmitted between nodes.

Implemented in SAMRAI::tbox::StatTransaction, SAMRAI::xfer::CoarsenCopyTransaction< DIM >, SAMRAI::xfer::RefineCopyTransaction< DIM >, SAMRAI::xfer::RefineTimeTransaction< DIM >, SAMRAI::algs::OuteredgeSumTransaction< DIM >, and SAMRAI::algs::OuternodeSumTransaction< DIM >.

virtual int SAMRAI::tbox::Transaction::computeIncomingMessageSize

(

)

[pure virtual]

Return the amount of buffer space needed for the incoming message. This routine is only called if the transaction can estimate the size of the incoming message.

Implemented in SAMRAI::tbox::StatTransaction, SAMRAI::xfer::CoarsenCopyTransaction< DIM >, SAMRAI::xfer::RefineCopyTransaction< DIM >, SAMRAI::xfer::RefineTimeTransaction< DIM >, SAMRAI::algs::OuteredgeSumTransaction< DIM >, and SAMRAI::algs::OuternodeSumTransaction< DIM >.

virtual int SAMRAI::tbox::Transaction::computeOutgoingMessageSize

(

)

[pure virtual]

Return the buffer space needed for the outgoing message.

Implemented in SAMRAI::tbox::StatTransaction, SAMRAI::xfer::CoarsenCopyTransaction< DIM >, SAMRAI::xfer::RefineCopyTransaction< DIM >, SAMRAI::xfer::RefineTimeTransaction< DIM >, SAMRAI::algs::OuteredgeSumTransaction< DIM >, and SAMRAI::algs::OuternodeSumTransaction< DIM >.

virtual int SAMRAI::tbox::Transaction::getSourceProcessor

(

)

[pure virtual]

Return the sending processor for the communications transaction.

Implemented in SAMRAI::tbox::StatTransaction, SAMRAI::xfer::CoarsenCopyTransaction< DIM >, SAMRAI::xfer::RefineCopyTransaction< DIM >, SAMRAI::xfer::RefineTimeTransaction< DIM >, SAMRAI::algs::OuteredgeSumTransaction< DIM >, and SAMRAI::algs::OuternodeSumTransaction< DIM >.

virtual int SAMRAI::tbox::Transaction::getDestinationProcessor

(

)

[pure virtual]

Return the receiving processor for the communications transaction.

Implemented in SAMRAI::tbox::StatTransaction, SAMRAI::xfer::CoarsenCopyTransaction< DIM >, SAMRAI::xfer::RefineCopyTransaction< DIM >, SAMRAI::xfer::RefineTimeTransaction< DIM >, SAMRAI::algs::OuteredgeSumTransaction< DIM >, and SAMRAI::algs::OuternodeSumTransaction< DIM >.

virtual void SAMRAI::tbox::Transaction::packStream

(

AbstractStream &

stream

)

[pure virtual]

Pack the transaction data into the message stream.

Implemented in SAMRAI::tbox::StatTransaction, SAMRAI::xfer::CoarsenCopyTransaction< DIM >, SAMRAI::xfer::RefineCopyTransaction< DIM >, SAMRAI::xfer::RefineTimeTransaction< DIM >, SAMRAI::algs::OuteredgeSumTransaction< DIM >, and SAMRAI::algs::OuternodeSumTransaction< DIM >.

virtual void SAMRAI::tbox::Transaction::unpackStream

(

AbstractStream &

stream

)

[pure virtual]

Unpack the transaction data from the message stream.

Implemented in SAMRAI::tbox::StatTransaction, SAMRAI::xfer::CoarsenCopyTransaction< DIM >, SAMRAI::xfer::RefineCopyTransaction< DIM >, SAMRAI::xfer::RefineTimeTransaction< DIM >, SAMRAI::algs::OuteredgeSumTransaction< DIM >, and SAMRAI::algs::OuternodeSumTransaction< DIM >.

virtual void SAMRAI::tbox::Transaction::copyLocalData

(

)

[pure virtual]

Perform the local data copy for the transaction.

Implemented in SAMRAI::tbox::StatTransaction, SAMRAI::xfer::CoarsenCopyTransaction< DIM >, SAMRAI::xfer::RefineCopyTransaction< DIM >, SAMRAI::xfer::RefineTimeTransaction< DIM >, SAMRAI::algs::OuteredgeSumTransaction< DIM >, and SAMRAI::algs::OuternodeSumTransaction< DIM >.

virtual void SAMRAI::tbox::Transaction::printClassData

(

std::ostream &

stream

)

const [pure virtual]

Print out transaction information.

Implemented in SAMRAI::tbox::StatTransaction, SAMRAI::xfer::CoarsenCopyTransaction< DIM >, SAMRAI::xfer::RefineCopyTransaction< DIM >, SAMRAI::xfer::RefineTimeTransaction< DIM >, SAMRAI::algs::OuteredgeSumTransaction< DIM >, and SAMRAI::algs::OuternodeSumTransaction< DIM >.

---

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

• source/toolbox/parallel/Transaction.h
• source/toolbox/parallel/Transaction.C

---