SAMRAI::xfer::StandardCoarsenTransactionFactory< DIM > Class Template Reference

Concrete subclass of CoarsenTransactionFactory<DIM> base class that allocates CoarsenCopyTransaction<DIM> objects for a CoarsenSchedule<DIM> object. More...

#include <source/transfer/datamovers/standard/StandardCoarsenTransactionFactory.h>

Inheritance diagram for SAMRAI::xfer::StandardCoarsenTransactionFactory< DIM >:

[legend]List of all members.

Public Member Functions
	StandardCoarsenTransactionFactory ()
	Default constructor.
virtual	~StandardCoarsenTransactionFactory ()
	Virtual destructor.
void	setCoarsenItems (const typename CoarsenClasses< DIM >::Data **coarsen_items, int num_coarsen_items)
	Set the array of CoarsenClass::Data items used by the transactions.
void	unsetCoarsenItems ()
	Clear the array of CoarsenClass::Data items used by the transactions.
tbox::Pointer< tbox::Transaction >	allocate (tbox::Pointer< hier::PatchLevel< DIM > > dst_level, tbox::Pointer< hier::PatchLevel< DIM > > src_level, tbox::Pointer< hier::BoxOverlap< DIM > > overlap, int dst_patch_id, int src_patch_id, int citem_id, tbox::Pointer< tbox::Arena > pool=(tbox::Arena *)(0)) const
	Allocate a CoarsenCopyTransaction<DIM> object.

---

Detailed Description

template<int DIM>
class SAMRAI::xfer::StandardCoarsenTransactionFactory< DIM >

Concrete subclass of CoarsenTransactionFactory<DIM> base class that allocates CoarsenCopyTransaction<DIM> objects for a CoarsenSchedule<DIM> object.

See also:

xfer::CoarsenCopyTransaction

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::xfer::StandardCoarsenTransactionFactory< DIM >::StandardCoarsenTransactionFactory

(

)

Default constructor.

template<int DIM>

SAMRAI::xfer::StandardCoarsenTransactionFactory< DIM >::~StandardCoarsenTransactionFactory

(

)

[virtual]

Virtual destructor.

---

Member Function Documentation

template<int DIM>

void SAMRAI::xfer::StandardCoarsenTransactionFactory< DIM >::setCoarsenItems	(	const typename CoarsenClasses< DIM >::Data **	coarsen_items,
		int	num_coarsen_items
	)			[virtual]

Set the array of CoarsenClass::Data items used by the transactions.

Implements SAMRAI::xfer::CoarsenTransactionFactory< DIM >.

template<int DIM>

void SAMRAI::xfer::StandardCoarsenTransactionFactory< DIM >::unsetCoarsenItems

(

)

[virtual]

Clear the array of CoarsenClass::Data items used by the transactions.

Implements SAMRAI::xfer::CoarsenTransactionFactory< DIM >.

template<int DIM>

tbox::Pointer< tbox::Transaction > SAMRAI::xfer::StandardCoarsenTransactionFactory< DIM >::allocate	(	tbox::Pointer< hier::PatchLevel< DIM > >	dst_level,
		tbox::Pointer< hier::PatchLevel< DIM > >	src_level,
		tbox::Pointer< hier::BoxOverlap< DIM > >	overlap,
		int	dst_patch_id,
		int	src_patch_id,
		int	citem_id,
		tbox::Pointer< tbox::Arena >	pool = (tbox::Arena *)(0)
	)			const [virtual]

Allocate a CoarsenCopyTransaction<DIM> object.

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_id	Integer index of destination patch in destination patch level.
	src_patch_id	Integer index of source patch in source patch level.
	citem_id	Integer index of CoarsenClass::Data item associated with transaction.
	pool	Optional pointer to memory pool from which the coarsen transaction may be allocated. Default is null.

Implements SAMRAI::xfer::CoarsenTransactionFactory< DIM >.

---

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

• source/transfer/datamovers/standard/StandardCoarsenTransactionFactory.h
• source/transfer/datamovers/standard/StandardCoarsenTransactionFactory.C

---