SAMRAI::math::PatchSideDataOpsReal< DIM, TYPE > Class Template Reference

#include <source/mathops/side/PatchSideDataOpsReal.h>

Inheritance diagram for SAMRAI::math::PatchSideDataOpsReal< DIM, TYPE >:

[legend]List of all members.

Public Member Functions
	PatchSideDataOpsReal ()
virtual	~PatchSideDataOpsReal ()
void	copyData (tbox::Pointer< pdat::SideData< DIM, TYPE > > &dst, const tbox::Pointer< pdat::SideData< DIM, TYPE > > &src, const hier::Box< DIM > &box) const
void	swapData (tbox::Pointer< hier::Patch< DIM > > patch, const int data1_id, const int data2_id) const
void	printData (const tbox::Pointer< pdat::SideData< DIM, TYPE > > &data, const hier::Box< DIM > &box, std::ostream &s=tbox::plog) const
void	setToScalar (tbox::Pointer< pdat::SideData< DIM, TYPE > > &dst, const TYPE &alpha, const hier::Box< DIM > &box) const

---

Detailed Description

template<int DIM, class TYPE>
class SAMRAI::math::PatchSideDataOpsReal< DIM, TYPE >

Class PatchSideDataOpsReal<DIM> provides a collection of operations to manipulate float and double numerical side-centered patch data. The operations include basic arithmetic, norms and ordering, and assorted miscellaneous operations. With the exception of a few basic routines, this class inherits its interface (and thus its functionality) from the base classes PatchSideDataBasicOps<DIM>, PatchSideDataNormOpsReal<DIM>, and PatchSideDataMiscellaneousOpsReal<DIM> from which it is derived. The name of each of these base classes is indicative of the set of side-centered patch data operations that it provides.

Note that this templated class should only be used to instantiate objects with double or float as the template parameter. A similar set of operations is implemented for complex and integer patch data in the classes PatchSideDataOpsComplex<DIM> and PatchSideDataOpsInteger<DIM>, repsectively.

See also:

math::PatchSideDataBasicOps

math::PatchSideDataMiscellaneousOpsReal

math::PatchSideDataNormOpsReal

---

Constructor & Destructor Documentation

template<int DIM, class TYPE>

SAMRAI::math::PatchSideDataOpsReal< DIM, TYPE >::PatchSideDataOpsReal

(

)

Empty constructor and destructor.

template<int DIM, class TYPE>

SAMRAI::math::PatchSideDataOpsReal< DIM, TYPE >::~PatchSideDataOpsReal

(

)

[virtual]

---

Member Function Documentation

template<int DIM, class TYPE>

void SAMRAI::math::PatchSideDataOpsReal< DIM, TYPE >::copyData	(	tbox::Pointer< pdat::SideData< DIM, TYPE > > &	dst,
		const tbox::Pointer< pdat::SideData< DIM, TYPE > > &	src,
		const hier::Box< DIM > &	box
	)			const

Copy dst data to src data over given box.

template<int DIM, class TYPE>

void SAMRAI::math::PatchSideDataOpsReal< DIM, TYPE >::swapData	(	tbox::Pointer< hier::Patch< DIM > >	patch,
		const int	data1_id,
		const int	data2_id
	)			const

Swap pointers for patch data objects. Objects are checked for consistency of depth, box, and ghost box.

template<int DIM, class TYPE>

void SAMRAI::math::PatchSideDataOpsReal< DIM, TYPE >::printData	(	const tbox::Pointer< pdat::SideData< DIM, TYPE > > &	data,
		const hier::Box< DIM > &	box,
		std::ostream &	s = tbox::plog
	)			const

Print data entries over given box to given output stream.

template<int DIM, class TYPE>

void SAMRAI::math::PatchSideDataOpsReal< DIM, TYPE >::setToScalar	(	tbox::Pointer< pdat::SideData< DIM, TYPE > > &	dst,
		const TYPE &	alpha,
		const hier::Box< DIM > &	box
	)			const

Initialize data to given scalar over given box.

---

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

• source/mathops/side/PatchSideDataOpsReal.h
• source/mathops/side/PatchSideDataOpsReal.C

---