SAMRAI::math::PatchSideDataOpsInteger< DIM > Class Template Reference

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

Inheritance diagram for SAMRAI::math::PatchSideDataOpsInteger< DIM >:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 PatchSideDataOpsInteger ()
virtual ~PatchSideDataOpsInteger ()
int numberOfEntries (const tbox::Pointer< pdat::SideData< DIM, int > > &data, const hier::Box< DIM > &box) const
void copyData (tbox::Pointer< pdat::SideData< DIM, int > > &dst, const tbox::Pointer< pdat::SideData< DIM, int > > &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, int > > &data, const hier::Box< DIM > &box, std::ostream &s=tbox::plog) const
void setToScalar (tbox::Pointer< pdat::SideData< DIM, int > > &dst, const int &alpha, const hier::Box< DIM > &box) const
void abs (tbox::Pointer< pdat::SideData< DIM, int > > &dst, const tbox::Pointer< pdat::SideData< DIM, int > > &src, const hier::Box< DIM > &box) const

Detailed Description

template<int DIM>
class SAMRAI::math::PatchSideDataOpsInteger< DIM >

Class PatchSideDataOpsInteger<DIM> provides a collection of operations that may be used to manipulate integer side-centered patch data. The operations include basic arithmetic, min, max, etc. With the exception of a few basic routines, this class inherits its interface (and thus its functionality) from the base class PatchSideDataBasicOps<DIM> from which it is derived.

A more extensive set of operations is implemented for real (double and float) and complex patch data in the classes PatchSideDataOpsReal<DIM> and PatchSideDataOpsComplex<DIM>, repsectively.

See also:
math::PatchSideDataBasicOps


Constructor & Destructor Documentation

template<int DIM>
SAMRAI::math::PatchSideDataOpsInteger< DIM >::PatchSideDataOpsInteger (  ) 

Empty constructor and destructor.

template<int DIM>
SAMRAI::math::PatchSideDataOpsInteger< DIM >::~PatchSideDataOpsInteger (  )  [virtual]


Member Function Documentation

template<int DIM>
int SAMRAI::math::PatchSideDataOpsInteger< DIM >::numberOfEntries ( const tbox::Pointer< pdat::SideData< DIM, int > > &  data,
const hier::Box< DIM > &  box 
) const

Return the number of data values for the side-centered data object in the given box. Note that it is assumed that the box refers to the cell-centered index space corresponding to the patch hierarchy.

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

Copy dst data to src data over given box.

template<int DIM>
void SAMRAI::math::PatchSideDataOpsInteger< DIM >::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>
void SAMRAI::math::PatchSideDataOpsInteger< DIM >::printData ( const tbox::Pointer< pdat::SideData< DIM, int > > &  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>
void SAMRAI::math::PatchSideDataOpsInteger< DIM >::setToScalar ( tbox::Pointer< pdat::SideData< DIM, int > > &  dst,
const int &  alpha,
const hier::Box< DIM > &  box 
) const

Initialize data to given scalar over given box.

template<int DIM>
void SAMRAI::math::PatchSideDataOpsInteger< DIM >::abs ( tbox::Pointer< pdat::SideData< DIM, int > > &  dst,
const tbox::Pointer< pdat::SideData< DIM, int > > &  src,
const hier::Box< DIM > &  box 
) const

Set destination component to absolute value of source component. That is, each destination entry is set to $d_i = \| s_i \|$.


The documentation for this class was generated from the following files:
Generated on Thu Jun 18 11:28:39 2009 for SAMRAI by  doxygen 1.5.1