SAMRAI::tbox::Transaction Class Reference

#include <tbox/Transaction.h>

Inheritance diagram for SAMRAI::tbox::Transaction:

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

Private Member Functions
	Transaction (const Transaction &)
void	operator= (const Transaction &)

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

Transaction() [1/2]

SAMRAI::tbox::Transaction::Transaction

(

)

The constructor for transaction does nothing interesting.

~Transaction()

virtual SAMRAI::tbox::Transaction::~Transaction ( )

virtual

The virtual destructor for transaction does nothing interesting.

Transaction() [2/2]

SAMRAI::tbox::Transaction::Transaction ( const Transaction &  )

private

Member Function Documentation

canEstimateIncomingMessageSize()

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 IBTK::LTransaction< T >, IBTK::CopyToRootTransaction, SAMRAI::xfer::RefineTimeTransaction< DIM >, SAMRAI::algs::OuteredgeSumTransaction< DIM >, SAMRAI::algs::OuternodeSumTransaction< DIM >, SAMRAI::xfer::CoarsenCopyTransaction< DIM >, SAMRAI::xfer::RefineCopyTransaction< DIM >, and SAMRAI::tbox::StatTransaction.

computeIncomingMessageSize()

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 IBTK::LTransaction< T >, IBTK::CopyToRootTransaction, SAMRAI::xfer::RefineTimeTransaction< DIM >, SAMRAI::algs::OuteredgeSumTransaction< DIM >, SAMRAI::algs::OuternodeSumTransaction< DIM >, SAMRAI::xfer::CoarsenCopyTransaction< DIM >, SAMRAI::xfer::RefineCopyTransaction< DIM >, and SAMRAI::tbox::StatTransaction.

computeOutgoingMessageSize()

virtual int SAMRAI::tbox::Transaction::computeOutgoingMessageSize ( )

pure virtual

Return the buffer space needed for the outgoing message.

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

getSourceProcessor()

virtual int SAMRAI::tbox::Transaction::getSourceProcessor ( )

pure virtual

Return the sending processor for the communications transaction.

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

getDestinationProcessor()

virtual int SAMRAI::tbox::Transaction::getDestinationProcessor ( )

pure virtual

Return the receiving processor for the communications transaction.

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

packStream()

virtual void SAMRAI::tbox::Transaction::packStream ( AbstractStream &  stream )

pure virtual

Pack the transaction data into the message stream.

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

unpackStream()

virtual void SAMRAI::tbox::Transaction::unpackStream ( AbstractStream &  stream )

pure virtual

Unpack the transaction data from the message stream.

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

copyLocalData()

virtual void SAMRAI::tbox::Transaction::copyLocalData ( )

pure virtual

Perform the local data copy for the transaction.

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

printClassData()

virtual void SAMRAI::tbox::Transaction::printClassData ( std::ostream &  stream ) const

pure virtual

Print out transaction information.

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

operator=()

void SAMRAI::tbox::Transaction::operator= ( const Transaction &  )

private

---

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

• /samrai/include/tbox/Transaction.h