Specialized copier for doing reductions in dimensionality. More...

#include <ReductionCopier.H>

Inheritance diagram for ReductionCopier:

Public Member Functions
	ReductionCopier ()
	null constructor, copy constructor and operator= can be compiler defined. More...

	ReductionCopier (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, int a_transverseDir, bool a_exchange=false)

	ReductionCopier (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, const ProblemDomain &a_domain, int a_transverseDir, bool a_exchange=false)
	this constructor contains support for periodic BC's More...

	ReductionCopier (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, const IntVect &a_destGhost, int a_transverseDir, bool a_exchange=false)
	Copier to copy data into the valid and invalid regions of a_dest from a_level. More...

	ReductionCopier (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, const ProblemDomain &a_domain, const IntVect &a_destGhost, int a_transverseDir, bool a_exchange=false)
	Copier to copy data into the valid and invalid regions of a_dest from a_level with support for periodic BCs. More...

	ReductionCopier (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, const Vector< int > &a_transverseDir, bool a_exchange=false)

	ReductionCopier (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, const ProblemDomain &a_domain, const Vector< int > &a_transverseDir, bool a_exchange=false)
	this constructor contains support for periodic BC's More...

	ReductionCopier (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, const IntVect &a_destGhost, const Vector< int > &a_transverseDir, bool a_exchange=false)
	Copier to copy data into the valid and invalid regions of a_dest from a_level. More...

	ReductionCopier (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, const ProblemDomain &a_domain, const IntVect &a_destGhost, const Vector< int > &a_transverseDir, bool a_exchange=false)
	Copier to copy data into the valid and invalid regions of a_dest from a_level with support for periodic BCs. More...

virtual	~ReductionCopier ()

virtual void	define (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, int a_transverseDir, bool a_exchange=false)

virtual void	define (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, const ProblemDomain &a_domain, int a_transverseDir, bool a_exchange=false)
	contains support for periodic BCs More...

virtual void	define (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, const IntVect &a_destGhost, int a_transverseDir, bool a_exchange=false)

virtual void	define (const BoxLayout &a_level, const BoxLayout &a_dest, const ProblemDomain &a_domain, const IntVect &a_destGhost, int a_transverseDir, bool a_exchange=false)
	contains support for periodic BCs More...

virtual void	define (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, const Vector< int > &a_transverseDir, bool a_exchange=false)

virtual void	define (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, const ProblemDomain &a_domain, const Vector< int > &a_transverseDir, bool a_exchange=false)
	contains support for periodic BCs More...

virtual void	define (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, const IntVect &a_destGhost, const Vector< int > &a_transverseDir, bool a_exchange=false)

virtual void	define (const BoxLayout &a_level, const BoxLayout &a_dest, const ProblemDomain &a_domain, const IntVect &a_destGhost, const Vector< int > &a_transverseDir, bool a_exchange=false)
	contains support for periodic BCs More...

void	reverse ()
	reverse the direction of copy for an already-defined ReductionCopier More...

bool	check (const DisjointBoxLayout &from, const BoxLayout &to) const
	check that this Copier object corresponds to these two BoxLayouts. More...

int	print () const

Public Member Functions inherited from Copier
	Copier ()
	null constructor, copy constructor and operator= can be compiler defined. More...

	Copier (const Copier &a_rhs)

	Copier (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, bool a_exchange=false, IntVect a_shift=IntVect::Zero)

	Copier (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, const ProblemDomain &a_domain, bool a_exchange=false, IntVect a_shift=IntVect::Zero)
	this constructor contains support for periodic BC's More...

	Copier (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, const IntVect &a_destGhost, bool a_exchange=false, IntVect a_shift=IntVect::Zero)
	Copier to copy data into the valid and invalid regions of a_dest from a_level. More...

	Copier (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, const ProblemDomain &a_domain, const IntVect &a_destGhost, bool a_exchange=false, IntVect a_shift=IntVect::Zero)
	Copier to copy data into the valid and invalid regions of a_dest from a_level with support for periodic BCs. More...

virtual	~Copier ()

virtual void	define (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, bool a_exchange=false, IntVect a_shift=IntVect::Zero)

virtual void	define (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, const ProblemDomain &a_domain, bool a_exchange=false, IntVect a_shift=IntVect::Zero)
	contains support for periodic BCs More...

virtual void	define (const DisjointBoxLayout &a_level, const BoxLayout &a_dest, const IntVect &a_destGhost, bool a_exchange=false, IntVect a_shift=IntVect::Zero)

virtual void	define (const BoxLayout &a_level, const BoxLayout &a_dest, const ProblemDomain &a_domain, const IntVect &a_destGhost, bool a_exchange=false, IntVect a_shift=IntVect::Zero)
	contains support for periodic BCs More...

virtual void	exchangeDefine (const DisjointBoxLayout &a_grids, const IntVect &a_ghost)
	alternative version of define for exchange copiers that uses new optimized neighborIterator More...

void	ghostDefine (const DisjointBoxLayout &a_src, const DisjointBoxLayout &a_dest, const ProblemDomain &a_domain, const IntVect &a_srcGhost)
	performs the computation necessary for moving from ghost+valid cells to valid. More...

virtual void	clear ()

Copier &	operator= (const Copier &b)

void	reverse ()

void	trimEdges (const DisjointBoxLayout &a_exchangedLayout, const IntVect &ghost)

void	coarsen (int a_refRatio)

int	print () const

bool	bufferAllocated () const

void	setBufferAllocated (bool arg) const

int	numLocalCellsToCopy () const

int	numFromCellsToCopy () const

int	numToCellsToCopy () const

bool	isDefined () const

Private Attributes
Vector< int >	m_transverseDir

Friends
class	CopyIterator

void	dumpmemoryatexit ()

Additional Inherited Members
Public Attributes inherited from Copier
CopierBuffer	m_buffers

Protected Member Functions inherited from Copier
void	trimMotion (const DisjointBoxLayout &a_exchangedLayout, const IntVect &a_ghost, const Vector< MotionItem > &a_oldItems, Vector< MotionItem > &a_newItems)

void	sort ()

const ProblemDomain &	getPhysDomain (const DisjointBoxLayout &a_level) const

Protected Attributes inherited from Copier
Vector< MotionItem * >	m_localMotionPlan

Vector< MotionItem * >	m_fromMotionPlan

Vector< MotionItem * >	m_toMotionPlan

bool	buffersAllocated

DisjointBoxLayout	m_originPlan

BoxLayout	m_dest

bool	m_isDefined

Static Protected Attributes inherited from Copier
static Pool	s_motionItemPool

Detailed Description

Specialized copier for doing reductions in dimensionality.

This is a specialized Copier designed to copy from a multi-dimensional DisjointBoxLayout to a smaller-dimensional one by copying all of the data in the transverse direction to the destination boxLayout. It is assumed that this will be used with a different sort of operator (like a summation operator, for example), since a straight copy operation wouldn't make much sense. Anyway, this just defines the intersection regions; what you do with them is your problem.

Note also that both the Spreading and Reduction Copiers ignore periodicity, since it can lead to unintended side-effects and multiple-counting of data. The way to handle periodicity is to do an exchange on the source data before calling the copyTo which does the reduction.

Constructor & Destructor Documentation

◆ ReductionCopier() [1/9]

ReductionCopier::ReductionCopier ( )

inline

null constructor, copy constructor and operator= can be compiler defined.

References check(), define(), print(), reverse(), and ~ReductionCopier().

◆ ReductionCopier() [2/9]

ReductionCopier::ReductionCopier	(	const DisjointBoxLayout &	a_level,
		const BoxLayout &	a_dest,
		int	a_transverseDir,
		bool	a_exchange = `false`
	)

◆ ReductionCopier() [3/9]

ReductionCopier::ReductionCopier	(	const DisjointBoxLayout &	a_level,
		const BoxLayout &	a_dest,
		const ProblemDomain &	a_domain,
		int	a_transverseDir,
		bool	a_exchange = `false`
	)

this constructor contains support for periodic BC's

◆ ReductionCopier() [4/9]

ReductionCopier::ReductionCopier	(	const DisjointBoxLayout &	a_level,
		const BoxLayout &	a_dest,
		const IntVect &	a_destGhost,
		int	a_transverseDir,
		bool	a_exchange = `false`
	)

Copier to copy data into the valid and invalid regions of a_dest from a_level.

◆ ReductionCopier() [5/9]

ReductionCopier::ReductionCopier	(	const DisjointBoxLayout &	a_level,
		const BoxLayout &	a_dest,
		const ProblemDomain &	a_domain,
		const IntVect &	a_destGhost,
		int	a_transverseDir,
		bool	a_exchange = `false`
	)

Copier to copy data into the valid and invalid regions of a_dest from a_level with support for periodic BCs.

◆ ReductionCopier() [6/9]

ReductionCopier::ReductionCopier	(	const DisjointBoxLayout &	a_level,
		const BoxLayout &	a_dest,
		const Vector< int > &	a_transverseDir,
		bool	a_exchange = `false`
	)

◆ ReductionCopier() [7/9]

ReductionCopier::ReductionCopier	(	const DisjointBoxLayout &	a_level,
		const BoxLayout &	a_dest,
		const ProblemDomain &	a_domain,
		const Vector< int > &	a_transverseDir,
		bool	a_exchange = `false`
	)

this constructor contains support for periodic BC's

◆ ReductionCopier() [8/9]

ReductionCopier::ReductionCopier	(	const DisjointBoxLayout &	a_level,
		const BoxLayout &	a_dest,
		const IntVect &	a_destGhost,
		const Vector< int > &	a_transverseDir,
		bool	a_exchange = `false`
	)

Copier to copy data into the valid and invalid regions of a_dest from a_level.

◆ ReductionCopier() [9/9]

ReductionCopier::ReductionCopier	(	const DisjointBoxLayout &	a_level,
		const BoxLayout &	a_dest,
		const ProblemDomain &	a_domain,
		const IntVect &	a_destGhost,
		const Vector< int > &	a_transverseDir,
		bool	a_exchange = `false`
	)

Copier to copy data into the valid and invalid regions of a_dest from a_level with support for periodic BCs.

◆ ~ReductionCopier()

virtual ReductionCopier::~ReductionCopier ( )

virtual

Referenced by ReductionCopier().

Member Function Documentation

◆ define() [1/8]

virtual void ReductionCopier::define	(	const DisjointBoxLayout &	a_level,
		const BoxLayout &	a_dest,
		int	a_transverseDir,
		bool	a_exchange = `false`
	)

virtual

Referenced by ReductionCopier().

◆ define() [2/8]

virtual void ReductionCopier::define	(	const DisjointBoxLayout &	a_level,
		const BoxLayout &	a_dest,
		const ProblemDomain &	a_domain,
		int	a_transverseDir,
		bool	a_exchange = `false`
	)

virtual

contains support for periodic BCs

◆ define() [3/8]

virtual void ReductionCopier::define	(	const DisjointBoxLayout &	a_level,
		const BoxLayout &	a_dest,
		const IntVect &	a_destGhost,
		int	a_transverseDir,
		bool	a_exchange = `false`
	)

virtual

◆ define() [4/8]

virtual void ReductionCopier::define	(	const BoxLayout &	a_level,
		const BoxLayout &	a_dest,
		const ProblemDomain &	a_domain,
		const IntVect &	a_destGhost,
		int	a_transverseDir,
		bool	a_exchange = `false`
	)

virtual

contains support for periodic BCs

◆ define() [5/8]

virtual void ReductionCopier::define	(	const DisjointBoxLayout &	a_level,
		const BoxLayout &	a_dest,
		const Vector< int > &	a_transverseDir,
		bool	a_exchange = `false`
	)

virtual

◆ define() [6/8]

virtual void ReductionCopier::define	(	const DisjointBoxLayout &	a_level,
		const BoxLayout &	a_dest,
		const ProblemDomain &	a_domain,
		const Vector< int > &	a_transverseDir,
		bool	a_exchange = `false`
	)

virtual

contains support for periodic BCs

◆ define() [7/8]

virtual void ReductionCopier::define	(	const DisjointBoxLayout &	a_level,
		const BoxLayout &	a_dest,
		const IntVect &	a_destGhost,
		const Vector< int > &	a_transverseDir,
		bool	a_exchange = `false`
	)

virtual

◆ define() [8/8]

virtual void ReductionCopier::define	(	const BoxLayout &	a_level,
		const BoxLayout &	a_dest,
		const ProblemDomain &	a_domain,
		const IntVect &	a_destGhost,
		const Vector< int > &	a_transverseDir,
		bool	a_exchange = `false`
	)

virtual

contains support for periodic BCs

◆ reverse()

void ReductionCopier::reverse ( )

reverse the direction of copy for an already-defined ReductionCopier

This function simply replaces the from data with the to-data for the already-defined copy operation. For now, this function heads right into a MayDay::Error, since what you probably want is to use a SpreadingCopier rather than a reversed ReductionCopier

Referenced by ReductionCopier().

◆ check()

bool ReductionCopier::check	(	const DisjointBoxLayout &	from,
		const BoxLayout &	to
	)		const

check that this Copier object corresponds to these two BoxLayouts.

Referenced by ReductionCopier().

◆ print()

int ReductionCopier::print ( ) const

Referenced by ReductionCopier().

Friends And Related Function Documentation

◆ CopyIterator

friend class CopyIterator

friend

◆ dumpmemoryatexit

void dumpmemoryatexit ( )

friend

Member Data Documentation

◆ m_transverseDir

Vector<int> ReductionCopier::m_transverseDir

private

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

ReductionCopier.H

Public Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ReductionCopier() [1/9]

◆ ReductionCopier() [2/9]

◆ ReductionCopier() [3/9]

◆ ReductionCopier() [4/9]

◆ ReductionCopier() [5/9]

◆ ReductionCopier() [6/9]

◆ ReductionCopier() [7/9]

◆ ReductionCopier() [8/9]

◆ ReductionCopier() [9/9]

◆ ~ReductionCopier()

Member Function Documentation

◆ define() [1/8]

◆ define() [2/8]

◆ define() [3/8]

◆ define() [4/8]

◆ define() [5/8]

◆ define() [6/8]

◆ define() [7/8]

◆ define() [8/8]

◆ reverse()

◆ check()

◆ print()

Friends And Related Function Documentation

◆ CopyIterator

◆ dumpmemoryatexit

Member Data Documentation

◆ m_transverseDir