Class OuteredgeSumTransaction<DIM> represents a single outeredge 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 <OuteredgeSumTransaction.h>

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

[legend]

Public Member Functions
	OuteredgeSumTransaction (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	~OuteredgeSumTransaction ()

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 ()

Private Member Functions
	OuteredgeSumTransaction (const OuteredgeSumTransaction< DIM > &)

void	operator= (const OuteredgeSumTransaction< DIM > &)

Private Attributes
tbox::Pointer< hier::PatchLevel< DIM > >	d_dst_level

tbox::Pointer< hier::PatchLevel< DIM > >	d_src_level

tbox::Pointer< hier::BoxOverlap< DIM > >	d_overlap

int	d_dst_patch

int	d_src_patch

int	d_refine_item_id

int	d_incoming_bytes

int	d_outgoing_bytes

Static Private Attributes
static const xfer::RefineClasses< DIM >::Data **	s_refine_items

static int	s_num_refine_items

Detailed Description

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

See also: xfer::RefineSchedule; xfer::RefineClasses; tbox::Schedule; tbox::Transaction

Constructor & Destructor Documentation

◆ OuteredgeSumTransaction() [1/2]

template<int DIM>

SAMRAI::algs::OuteredgeSumTransaction< DIM >::OuteredgeSumTransaction	(	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 outeredge 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	tbox::Pointer to destination patch level.
src_level	tbox::Pointer to source patch level.
overlap	tbox::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).

◆ ~OuteredgeSumTransaction()

template<int DIM>

virtual SAMRAI::algs::OuteredgeSumTransaction< DIM >::~OuteredgeSumTransaction ( )

virtual

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

◆ OuteredgeSumTransaction() [2/2]

template<int DIM>

SAMRAI::algs::OuteredgeSumTransaction< DIM >::OuteredgeSumTransaction ( const OuteredgeSumTransaction< DIM > & )

private

Member Function Documentation

◆ setRefineItems()

template<int DIM>

static void SAMRAI::algs::OuteredgeSumTransaction< 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 RefineSchedule<DIM> class.

◆ unsetRefineItems()

template<int DIM>

static void SAMRAI::algs::OuteredgeSumTransaction< 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.

◆ canEstimateIncomingMessageSize()

template<int DIM>

virtual bool SAMRAI::algs::OuteredgeSumTransaction< 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 edges.

Implements SAMRAI::tbox::Transaction.

◆ computeIncomingMessageSize()

template<int DIM>

virtual int SAMRAI::algs::OuteredgeSumTransaction< 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.