ReductionCopier Class Reference

#include <ReductionCopier.H>

Inheritance diagram for ReductionCopier:

[legend]

List of all members.

---

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.

Public Member Functions
	ReductionCopier ()
	null constructor, copy constructor and operator= can be compiler defined.
	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
	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 (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 (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
	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 (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.
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
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
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
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
void	reverse ()
	reverse the direction of copy for an already-defined ReductionCopier
bool	check (const DisjointBoxLayout &from, const BoxLayout &to) const
	check that this Copier object corresponds to these two BoxLayouts.
int	print () const
Private Attributes
Vector< int >	m_transverseDir
Friends
class	CopyIterator
void	dumpmemoryatexit ()

---

Constructor & Destructor Documentation

ReductionCopier::ReductionCopier

(

)

[inline]

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

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

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::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::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::ReductionCopier	(	const DisjointBoxLayout &	a_level,
		const BoxLayout &	a_dest,
		const Vector< int > &	a_transverseDir,
		bool	a_exchange = false
	)

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

virtual ReductionCopier::~ReductionCopier

(

)

[virtual]

---

Member Function Documentation

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

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

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

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

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

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

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]

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

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

Reimplemented from Copier.

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

check that this Copier object corresponds to these two BoxLayouts.

int ReductionCopier::print

(

)

const

Reimplemented from Copier.

---

Friends And Related Function Documentation

friend class CopyIterator [friend]

Reimplemented from Copier.

void dumpmemoryatexit

(

)

[friend]

Reimplemented from Copier.

---

Member Data Documentation

Vector<int> ReductionCopier::m_transverseDir [private]

---

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

• ReductionCopier.H