SAMRAI::algs::OuternodeSumTransaction< DIM > Class Template Reference

Class OuternodeSumTransaction<DIM> represents a single outernode data sum communication transaction between two processors or a local data sum for refine schedules. Note that to there is an implicit hand-shaking between objects of this class and the xfer::RefineSchedule<DIM> object that constructs them. Following the refine schedule implementation, the source patch data index for a transaction always refers to the source data and the destination patch data index for a transaction is always the scratch data, all as defined in the xfer::RefineClasses<DIM> class. More...

#include <source/algorithm/femutils/standard/OuternodeSumTransaction.h>

Inheritance diagram for SAMRAI::algs::OuternodeSumTransaction< DIM >:

[legend]List of all members.

Public Member Functions
	OuternodeSumTransaction (tbox::Pointer< hier::PatchLevel< DIM > > dst_level, tbox::Pointer< hier::PatchLevel< DIM > > src_level, tbox::Pointer< hier::BoxOverlap< DIM > > overlap, int dst_patch, int src_patch, int refine_item_id)
virtual	~OuternodeSumTransaction ()
virtual bool	canEstimateIncomingMessageSize ()
virtual int	computeIncomingMessageSize ()
virtual int	computeOutgoingMessageSize ()
virtual int	getSourceProcessor ()
virtual int	getDestinationProcessor ()
virtual void	packStream (tbox::AbstractStream &stream)
virtual void	unpackStream (tbox::AbstractStream &stream)
virtual void	copyLocalData ()
virtual void	printClassData (std::ostream &stream) const
Static Public Member Functions
static void	setRefineItems (const typename xfer::RefineClasses< DIM >::Data **refine_items, int num_refine_items)
static void	unsetRefineItems ()

---

Detailed Description

template<int DIM>
class SAMRAI::algs::OuternodeSumTransaction< DIM >

Class OuternodeSumTransaction<DIM> represents a single outernode data sum communication transaction between two processors or a local data sum for refine schedules. Note that to there is an implicit hand-shaking between objects of this class and the xfer::RefineSchedule<DIM> object that constructs them. Following the refine schedule implementation, the source patch data index for a transaction always refers to the source data and the destination patch data index for a transaction is always the scratch data, all as defined in the xfer::RefineClasses<DIM> class.

See also:

xfer::RefineSchedule

xfer::RefineClasses

tbox::Schedule

tbox::Transaction

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::algs::OuternodeSumTransaction< DIM >::OuternodeSumTransaction	(	tbox::Pointer< hier::PatchLevel< DIM > >	dst_level,
		tbox::Pointer< hier::PatchLevel< DIM > >	src_level,
		tbox::Pointer< hier::BoxOverlap< DIM > >	overlap,
		int	dst_patch,
		int	src_patch,
		int	refine_item_id
	)

Construct a transaction with the specified source and destination levels, patches, and patch data components found in the refine class item with the given id owned by the calling refine schedule. In general, this constructor is called by a xfer::RefineSchedule<DIM> object for each data transaction (specifically summing outernode data) that must occur. This transaction will be responsible for one of the following: (1) a local data copy and sum, or (2) packing a message stream with source patch data, or (3) unpacking and summing destination patch data from a message stream.

Parameters:

	dst_level	Pointer to destination patch level.
	src_level	Pointer to source patch level.
	overlap	Pointer to overlap region between patches.
	dst_patch	Integer index of destination patch in destination patch level.
	src_patch	Integer index of source patch in source patch level.
	refine_item_id	Integer id of refine data item owned by refine schedule.

When assertion checking is active, an assertion will result if any of the pointer arguments is null, or if any of the integer arguments is invalid (i.e., < 0).

template<int DIM>

SAMRAI::algs::OuternodeSumTransaction< DIM >::~OuternodeSumTransaction

(

)

[virtual]

The virtual destructor for the copy transaction releases all memory associated with the transaction.

---

Member Function Documentation

template<int DIM>

void SAMRAI::algs::OuternodeSumTransaction< DIM >::setRefineItems	(	const typename xfer::RefineClasses< DIM >::Data **	refine_items,
		int	num_refine_items
	)			[static]

Static member function to set the array of refine class data items that is shared by all object instances of this sum transaction class during data transfers. The array must be set before any transactions are executed. The array is set in the xfer::RefineSchedule<DIM> class.

template<int DIM>

void SAMRAI::algs::OuternodeSumTransaction< DIM >::unsetRefineItems

(

)

[static]

Static member function to unset the array of refine class data items that is shared by all object instances of this sum transaction class during data transfers. The unset function is used to prevent erroneous execution of different schedules. The array is unset in the RefineSchedule<DIM> class.

template<int DIM>

bool SAMRAI::algs::OuternodeSumTransaction< DIM >::canEstimateIncomingMessageSize

(

)

[virtual]

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

Implements SAMRAI::tbox::Transaction.

template<int DIM>

int SAMRAI::algs::OuternodeSumTransaction< DIM >::computeIncomingMessageSize

(

)

[virtual]

Return the integer buffer space (in bytes) needed for the incoming message. This routine is only called if the transaction can estimate the size of the incoming message. See canEstimateIncomingMessageSize().

Implements SAMRAI::tbox::Transaction.

template<int DIM>

int SAMRAI::algs::OuternodeSumTransaction< DIM >::computeOutgoingMessageSize

(

)

[virtual]

Return the integer buffer space (in bytes) needed for the outgoing message.

Implements SAMRAI::tbox::Transaction.

template<int DIM>

int SAMRAI::algs::OuternodeSumTransaction< DIM >::getSourceProcessor

(

)

[virtual]

Return the sending processor number for the communications transaction.

Implements SAMRAI::tbox::Transaction.

template<int DIM>

int SAMRAI::algs::OuternodeSumTransaction< DIM >::getDestinationProcessor

(

)

[virtual]

Return the receiving processor number for the communications transaction.

Implements SAMRAI::tbox::Transaction.

template<int DIM>

void SAMRAI::algs::OuternodeSumTransaction< DIM >::packStream

(

tbox::AbstractStream &

stream

)

[virtual]

Pack the transaction data into the message stream.

Implements SAMRAI::tbox::Transaction.

template<int DIM>

void SAMRAI::algs::OuternodeSumTransaction< DIM >::unpackStream

(

tbox::AbstractStream &

stream

)

[virtual]

Unpack the transaction data from the message stream.

Implements SAMRAI::tbox::Transaction.

template<int DIM>

void SAMRAI::algs::OuternodeSumTransaction< DIM >::copyLocalData

(

)

[virtual]

Perform the local data copy for the transaction.

Implements SAMRAI::tbox::Transaction.

template<int DIM>

void SAMRAI::algs::OuternodeSumTransaction< DIM >::printClassData

(

std::ostream &

stream

)

const [virtual]

Print out transaction information.

Implements SAMRAI::tbox::Transaction.

---

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

• source/algorithm/femutils/standard/OuternodeSumTransaction.h
• source/algorithm/femutils/standard/OuternodeSumTransaction.C

---