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

Concrete subclass of RefineTransactionFactory<DIM> base class that allocates RefineCopyTransaction<DIM> and RefineTimeTransaction<DIM> objects for a RefineSchedule<DIM> object. More...

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

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

[legend]List of all members.

Public Member Functions
	StandardRefineTransactionFactory ()
	Default constructor.
virtual	~StandardRefineTransactionFactory ()
	Virtual destructor.
void	setRefineItems (const typename RefineClasses< DIM >::Data **refine_items, int num_refine_items)
	Set the array of RefineClass::Data items used by the transactions.
void	unsetRefineItems ()
	Clear the array of RefineClass::Data items used by the transactions.
void	setTransactionTime (double fill_time)
	Set simulation time used by the refine time transaction objects.
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 ritem_id, const hier::Box< DIM > &box=hier::Box< DIM >(), bool use_time_interpolation=false, tbox::Pointer< tbox::Arena > pool=(tbox::Arena *) NULL) const
	Allocate an appropriate refine copy or time transaction object. When time interpolation flag is passed as true a RefineTimeTransaction<DIM> object will be created. Otherwise, a RefineCopyTransaction<DIM> aill be created.

---

Detailed Description

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

Concrete subclass of RefineTransactionFactory<DIM> base class that allocates RefineCopyTransaction<DIM> and RefineTimeTransaction<DIM> objects for a RefineSchedule<DIM> object.

See also:

xfer::RefineCopyTransaction

xfer::RefineTimeTransaction

xfer::RefineTransactionFactory

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::xfer::StandardRefineTransactionFactory< DIM >::StandardRefineTransactionFactory

(

)

Default constructor.

template<int DIM>

SAMRAI::xfer::StandardRefineTransactionFactory< DIM >::~StandardRefineTransactionFactory

(

)

[virtual]

Virtual destructor.

---

Member Function Documentation

template<int DIM>

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

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

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

template<int DIM>

void SAMRAI::xfer::StandardRefineTransactionFactory< DIM >::unsetRefineItems

(

)

[virtual]

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

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

template<int DIM>

void SAMRAI::xfer::StandardRefineTransactionFactory< DIM >::setTransactionTime

(

double

fill_time

)

[virtual]

Set simulation time used by the refine time transaction objects.

Reimplemented from SAMRAI::xfer::RefineTransactionFactory< DIM >.

template<int DIM>

tbox::Pointer< tbox::Transaction > SAMRAI::xfer::StandardRefineTransactionFactory< 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	ritem_id,
		const hier::Box< DIM > &	box = hier::Box< DIM >(),
		bool	use_time_interpolation = false,
		tbox::Pointer< tbox::Arena >	pool = (tbox::Arena *) NULL
	)			const [virtual]

Allocate an appropriate refine copy or time transaction object. When time interpolation flag is passed as true a RefineTimeTransaction<DIM> object will be created. Otherwise, a RefineCopyTransaction<DIM> aill be created.

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.
	ritem_id	Integer index of RefineClass::Data item associated with transaction.
	box	Optional const reference to box defining region of refine transaction. Default is an empty box.
	use_time_interpolation	Optional boolean flag indicating whether the refine transaction involves time interpolation. Default is false.
	pool	Optional pointer to memory pool from which the refine transaction may be allocated. Default is null.

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

---

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

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

---