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

#include <StandardRefineTransactionFactory.h>

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

[legend]

Public Member Functions
	StandardRefineTransactionFactory ()
	Default constructor. More...

virtual	~StandardRefineTransactionFactory ()
	Virtual destructor. More...

void	setRefineItems (const typename RefineClasses< DIM >::Data **refine_items, int num_refine_items)
	Set the array of RefineClass::Data items used by the transactions. More...

void	unsetRefineItems ()
	Clear the array of RefineClass::Data items used by the transactions. More...

void	setTransactionTime (double fill_time)
	Set simulation time used by the refine time transaction objects. 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 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. More...

virtual void	preprocessScratchSpace (tbox::Pointer< hier::PatchLevel< DIM > > level, double fill_time, const hier::ComponentSelector &preprocess_vector) const
	Virtual function allowing transaction factory to preprocess scratch space data before transactactions use it if they need to. This function is optional for the concrete transaction factory object. The default implementation is a no-op. More...

Private Member Functions
	StandardRefineTransactionFactory (const StandardRefineTransactionFactory< DIM > &)

void	operator= (const StandardRefineTransactionFactory< DIM > &)

Private Attributes
const RefineClasses< DIM >::Data **	d_refine_items

int	d_num_refine_items

Detailed Description

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

See also: xfer::RefineCopyTransaction; xfer::RefineTimeTransaction; xfer::RefineTransactionFactory

Constructor & Destructor Documentation

◆ StandardRefineTransactionFactory() [1/2]

template<int DIM>

SAMRAI::xfer::StandardRefineTransactionFactory< DIM >::StandardRefineTransactionFactory ( )

◆ ~StandardRefineTransactionFactory()

template<int DIM>

virtual SAMRAI::xfer::StandardRefineTransactionFactory< DIM >::~StandardRefineTransactionFactory ( )

virtual

◆ StandardRefineTransactionFactory() [2/2]

template<int DIM>

SAMRAI::xfer::StandardRefineTransactionFactory< DIM >::StandardRefineTransactionFactory ( const StandardRefineTransactionFactory< DIM > & )

private

Member Function Documentation

◆ setRefineItems()

template<int DIM>

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

virtual

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

◆ unsetRefineItems()

template<int DIM>

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

virtual

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

◆ setTransactionTime()

template<int DIM>

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

virtual

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

◆ allocate()

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

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 >.

◆ operator=()

template<int DIM>

void SAMRAI::xfer::StandardRefineTransactionFactory< DIM >::operator= ( const StandardRefineTransactionFactory< DIM > & )

private

◆ preprocessScratchSpace()

template<int DIM>

virtual void SAMRAI::xfer::RefineTransactionFactory< DIM >::preprocessScratchSpace	(	tbox::Pointer< hier::PatchLevel< DIM > >	level,
		double	fill_time,
		const hier::ComponentSelector &	preprocess_vector
	)		const

virtualinherited

Parameters

level	tbox::Pointer to patch level holding scratch data.
fill_time	Double value of simulation time corresponding to RefineSchedule<DIM> operations.
preprocess_vector	Const reference to ComponentSelector that indicates patch data array indices of scratch patch data objects to preprocess.

Reimplemented in SAMRAI::algs::OuternodeSumTransactionFactory< DIM >, and SAMRAI::algs::OuteredgeSumTransactionFactory< DIM >.