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

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

#include <LocallyActiveDataOuternodeSumTransactionFactory.h>

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

Public Member Functions
	LocallyActiveDataOuternodeSumTransactionFactory ()
	Default constructor. More...
virtual	~LocallyActiveDataOuternodeSumTransactionFactory ()
	Virtual destructor for base class. More...
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. More...
void	unsetRefineItems ()
	Clear the array of xfer::RefineClass<DIM>::Data items used by the transactions. More...
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 OuternodeSumTransaction<DIM> object. More...
void	preprocessScratchSpace (tbox::Pointer< hier::PatchLevel< DIM > > level, double fill_time, const hier::LocallyActiveDataPatchLevelManager< DIM > &preprocess_mgr) const
	Function to initialize scratch space data for the sum transactions (patch data components indicated by the patch level manager) to zero. More...
virtual void	setTransactionTime (double fill_time)
	Virtual function to set simulation time for transaction objects. This operation is called by the refine schedule during the execution of the LocallyActiveDataRefineSchedule<DIM>::fillData() routine before data communication operations begin. This function is optional for the concrete transaction factory object. The default implementation is a no-op. More...

Private Member Functions
	LocallyActiveDataOuternodeSumTransactionFactory (const LocallyActiveDataOuternodeSumTransactionFactory< DIM > &)
void	operator= (const LocallyActiveDataOuternodeSumTransactionFactory< DIM > &)

Private Attributes
const xfer::RefineClasses< DIM >::Data **	d_refine_items
int	d_number_refine_items

Detailed Description

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

See also

xfer::LocallyActiveDataRefineTransactionFactory

xfer::OuternodeSumTransaction

Constructor & Destructor Documentation

LocallyActiveDataOuternodeSumTransactionFactory() [1/2]

template<int DIM>

SAMRAI::algs::LocallyActiveDataOuternodeSumTransactionFactory< DIM >::LocallyActiveDataOuternodeSumTransactionFactory

(

)

~LocallyActiveDataOuternodeSumTransactionFactory()

template<int DIM>

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

virtual

LocallyActiveDataOuternodeSumTransactionFactory() [2/2]

template<int DIM>

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

private

Member Function Documentation

setRefineItems()

template<int DIM>

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

virtual

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

unsetRefineItems()

template<int DIM>

void SAMRAI::algs::LocallyActiveDataOuternodeSumTransactionFactory< DIM >::unsetRefineItems ( )

virtual

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

allocate()

template<int DIM>

tbox::Pointer<tbox::Transaction> SAMRAI::algs::LocallyActiveDataOuternodeSumTransactionFactory< 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

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::LocallyActiveDataRefineTransactionFactory< DIM >.

preprocessScratchSpace()

template<int DIM>

void SAMRAI::algs::LocallyActiveDataOuternodeSumTransactionFactory< DIM >::preprocessScratchSpace ( tbox::Pointer< hier::PatchLevel< DIM > >  level, double  fill_time, const hier::LocallyActiveDataPatchLevelManager< DIM > &  preprocess_mgr  ) const

virtual

Parameters

level	tbox::Pointer to patch level holding scratch data.
fill_time	Double value of simulation time at which preprocess operation is called.
preprocess_mgr	Const reference to hier::LocallyActiveDataPatchLevelManager<DIM> object that indicates patch data array indices of which scratch patch data objects on each patch to preprocess.

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

operator=()

template<int DIM>

void SAMRAI::algs::LocallyActiveDataOuternodeSumTransactionFactory< DIM >::operator= ( const LocallyActiveDataOuternodeSumTransactionFactory< DIM > &  )

private

setTransactionTime()

template<int DIM>

virtual void SAMRAI::xfer::LocallyActiveDataRefineTransactionFactory< DIM >::setTransactionTime ( double  fill_time )

virtualinherited

Reimplemented in SAMRAI::xfer::StandardLocallyActiveDataRefineTransactionFactory< DIM >.

Member Data Documentation

d_refine_items

template<int DIM>

const xfer::RefineClasses<DIM>::Data** SAMRAI::algs::LocallyActiveDataOuternodeSumTransactionFactory< DIM >::d_refine_items

private

d_number_refine_items

template<int DIM>

int SAMRAI::algs::LocallyActiveDataOuternodeSumTransactionFactory< DIM >::d_number_refine_items

private

---

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

• /samrai/include/LocallyActiveDataOuternodeSumTransactionFactory.h