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

Concrete subclass of the xfer::RefineTransactionFactory<DIM> base class that allocates transaction outernode sum objects for a xfer::RefineSchedule<DIM> object. More...

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

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

[legend]List of all members.

Public Member Functions
	OuternodeSumTransactionFactory ()
	Default constructor.
virtual	~OuternodeSumTransactionFactory ()
	Virtual destructor for base class.
void	setRefineItems (const typename xfer::RefineClasses< DIM >::Data **refine_items, int num_refine_items)
	Set the array of xfer::RefineClass<DIM>::Data items used by the transactions.
void	unsetRefineItems ()
	Clear the array of xfer::RefineClass<DIM>::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 ritem_id, const hier::Box< DIM > &box=hier::Box< DIM >(), bool use_time_interpolation=false, tbox::Pointer< tbox::Arena > pool=(tbox::Arena *)(0)) const
	Allocate an OuternodeSumTransaction<DIM> object.
void	preprocessScratchSpace (tbox::Pointer< hier::PatchLevel< DIM > > level, double fill_time, const hier::ComponentSelector &preprocess_vector) const
	Function to initialize scratch space data for the sum transactions (patch data components indicated by the component selector) to zero.

---

Detailed Description

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

Concrete subclass of the xfer::RefineTransactionFactory<DIM> base class that allocates transaction outernode sum objects for a xfer::RefineSchedule<DIM> object.

See also:

xfer::RefineTransactionFactory

xfer::OuternodeSumTransaction

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::algs::OuternodeSumTransactionFactory< DIM >::OuternodeSumTransactionFactory

(

)

Default constructor.

template<int DIM>

SAMRAI::algs::OuternodeSumTransactionFactory< DIM >::~OuternodeSumTransactionFactory

(

)

[virtual]

Virtual destructor for base class.

---

Member Function Documentation

template<int DIM>

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

Set the array of xfer::RefineClass<DIM>::Data items used by the transactions.

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

template<int DIM>

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

(

)

[virtual]

Clear the array of xfer::RefineClass<DIM>::Data items used by the transactions.

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

template<int DIM>

tbox::Pointer< tbox::Transaction > SAMRAI::algs::OuternodeSumTransactionFactory< 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 *)(0)
	)			const [virtual]

Allocate an OuternodeSumTransaction<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.
	ritem_id	Integer index of xfer::RefineClass<DIM>::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 >.

template<int DIM>

void SAMRAI::algs::OuternodeSumTransactionFactory< DIM >::preprocessScratchSpace	(	tbox::Pointer< hier::PatchLevel< DIM > >	level,
		double	fill_time,
		const hier::ComponentSelector &	preprocess_vector
	)			const [virtual]

Function to initialize scratch space data for the sum transactions (patch data components indicated by the component selector) to zero.

Parameters:

	level	tbox::Pointer to patch level holding scratch data.
	fill_time	Double value of simulation time at which preprocess operation is called.
	preprocess_vector	Const reference to hier::ComponentSelector indicating patch data array indices of scratch patch data objects to preprocess.

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

---

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

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

---