IBTK::CopyToRootTransaction Class Reference

Class CopyToRootTransaction is a concrete implementation of the abstract base class SAMRAI::tbox::Transaction. It is used to communicate distributed patch data to a unified patch data object on a root MPI process. More...

#include <ibtk/CopyToRootTransaction.h>

Inheritance diagram for IBTK::CopyToRootTransaction:

Public Member Functions
	CopyToRootTransaction (int src_proc, int dst_proc, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchLevel< NDIM > > patch_level, int src_patch_data_idx, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchData< NDIM > > dst_patch_data)
	Constructor. More...
	~CopyToRootTransaction ()=default
	Destructor. More...
SAMRAI::tbox::Pointer< SAMRAI::hier::PatchData< NDIM > >	getRootPatchData () const
bool	canEstimateIncomingMessageSize () override
int	computeIncomingMessageSize () override
int	computeOutgoingMessageSize () override
int	getSourceProcessor () override
int	getDestinationProcessor () override
void	packStream (SAMRAI::tbox::AbstractStream &stream) override
void	unpackStream (SAMRAI::tbox::AbstractStream &stream) override
void	copyLocalData () override
void	printClassData (std::ostream &stream) const override

Private Member Functions
	CopyToRootTransaction ()=delete
	Default constructor. More...
	CopyToRootTransaction (const CopyToRootTransaction &from)=delete
	Copy constructor. More...
CopyToRootTransaction &	operator= (const CopyToRootTransaction &that)=delete
	Assignment operator. More...

Private Attributes
const int	d_src_proc
const int	d_dst_proc
SAMRAI::tbox::Pointer< SAMRAI::hier::PatchLevel< NDIM > >	d_patch_level
const int	d_src_patch_data_idx
SAMRAI::tbox::Pointer< SAMRAI::hier::PatchData< NDIM > >	d_dst_patch_data

Detailed Description

Note

This class is designed to be used with uniform grid data only.

Constructor & Destructor Documentation

CopyToRootTransaction() [1/3]

IBTK::CopyToRootTransaction::CopyToRootTransaction	(	int	src_proc,
		int	dst_proc,
		SAMRAI::tbox::Pointer< SAMRAI::hier::PatchLevel< NDIM > >	patch_level,
		int	src_patch_data_idx,
		SAMRAI::tbox::Pointer< SAMRAI::hier::PatchData< NDIM > >	dst_patch_data
	)

~CopyToRootTransaction()

IBTK::CopyToRootTransaction::~CopyToRootTransaction ( )

default

CopyToRootTransaction() [2/3]

IBTK::CopyToRootTransaction::CopyToRootTransaction ( )

privatedelete

Note

This constructor is not implemented and should not be used.

CopyToRootTransaction() [3/3]

IBTK::CopyToRootTransaction::CopyToRootTransaction ( const CopyToRootTransaction &  from )

privatedelete

Note

This constructor is not implemented and should not be used.

Parameters

from	The value to copy to this object.

Member Function Documentation

getRootPatchData()

SAMRAI::tbox::Pointer<SAMRAI::hier::PatchData<NDIM> > IBTK::CopyToRootTransaction::getRootPatchData

(

)

const

Return a pointer to the data on the root process.

canEstimateIncomingMessageSize()

bool IBTK::CopyToRootTransaction::canEstimateIncomingMessageSize ( )

overridevirtual

Return a boolean indicating whether this transaction can estimate the size of an incoming message.

Implements SAMRAI::tbox::Transaction.

computeIncomingMessageSize()

int IBTK::CopyToRootTransaction::computeIncomingMessageSize ( )

overridevirtual

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.

Implements SAMRAI::tbox::Transaction.

computeOutgoingMessageSize()

int IBTK::CopyToRootTransaction::computeOutgoingMessageSize ( )

overridevirtual

Return the buffer space needed for the outgoing message.

Implements SAMRAI::tbox::Transaction.

getSourceProcessor()

int IBTK::CopyToRootTransaction::getSourceProcessor ( )

overridevirtual

Return the sending processor for the communications transaction.

Implements SAMRAI::tbox::Transaction.

getDestinationProcessor()

int IBTK::CopyToRootTransaction::getDestinationProcessor ( )

overridevirtual

Return the receiving processor for the communications transaction.

Implements SAMRAI::tbox::Transaction.

packStream()

void IBTK::CopyToRootTransaction::packStream ( SAMRAI::tbox::AbstractStream &  stream )

overridevirtual

Pack the transaction data into the message stream.

Implements SAMRAI::tbox::Transaction.

unpackStream()

void IBTK::CopyToRootTransaction::unpackStream ( SAMRAI::tbox::AbstractStream &  stream )

overridevirtual

Unpack the transaction data from the message stream.

Implements SAMRAI::tbox::Transaction.

copyLocalData()

void IBTK::CopyToRootTransaction::copyLocalData ( )

overridevirtual

Perform the local data copy for the transaction.

Implements SAMRAI::tbox::Transaction.

printClassData()

void IBTK::CopyToRootTransaction::printClassData ( std::ostream &  stream ) const

overridevirtual

Print out transaction information.

Implements SAMRAI::tbox::Transaction.

operator=()

CopyToRootTransaction& IBTK::CopyToRootTransaction::operator= ( const CopyToRootTransaction &  that )

privatedelete

Note

This operator is not implemented and should not be used.

Parameters

that	The value to assign to this object.

Returns

A reference to this object.

Member Data Documentation

d_src_proc

const int IBTK::CopyToRootTransaction::d_src_proc

private

d_dst_proc

const int IBTK::CopyToRootTransaction::d_dst_proc

private

d_patch_level

SAMRAI::tbox::Pointer<SAMRAI::hier::PatchLevel<NDIM> > IBTK::CopyToRootTransaction::d_patch_level

private

d_src_patch_data_idx

const int IBTK::CopyToRootTransaction::d_src_patch_data_idx

private

d_dst_patch_data

SAMRAI::tbox::Pointer<SAMRAI::hier::PatchData<NDIM> > IBTK::CopyToRootTransaction::d_dst_patch_data

private

---

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

• ibtk/include/ibtk/CopyToRootTransaction.h