---

BinFab< T > Class Template Reference

Base class for particle problems. More...

#include <BinFab.H>

Inheritance diagram for BinFab< T >:

[legend]Collaboration diagram for BinFab< T >:

[legend]List of all members.

Public Methods
	BinFab ()
	null constructor, copy constructor and operator= can be compiler defined.
	BinFab (const Box &a_domain, const RealVect &a_mesh_spacing, const RealVect &a_origin, const ProblemDomain &a_probdomain)
	constructs empty binFab on domain
	BinFab (const BinFab &a_binfab)
	copy constructor
virtual	~BinFab ()
virtual void	define (const Box &a_domain, const RealVect &a_mesh_spacing, const RealVect &a_origin, const ProblemDomain &a_probdomain)
virtual void	reBin ()
	sort all the BinItems into the appropriate bins
virtual void	addItem (const T &a_item)
	copy one item into the appropriate bin
virtual void	addItems (const List< T > &a_list)
	copy a list of items into the appropriate bins
virtual void	addItemsDestructive (List< T > &a_list)
	move items off the argument list and into the appropriate bins
virtual void	clear ()
virtual int	size (const Box &box, const Interval &comps) const
	{\bf linearization functions}
virtual void	linearOut (void *buf, const Box &R, const Interval &comps) const
virtual void	linearIn (void *buf, const Box &R, const Interval &comps)
Static Public Methods
int	preAllocatable ()
Protected Methods
IntVect	locateBin (const T &) const
Protected Attributes
RealVect	m_origin
RealVect	m_mesh_spacing
ProblemDomain	m_probdomain

---

Detailed Description

template<class T>
class BinFab< T >

Base class for particle problems.

This is a class for holding and sorting particle-type items. Class <T> must have a RealVect <T>position() const function which is used to place the item in an appropriate bin.

---

Constructor & Destructor Documentation

template<class T> BinFab< T >::BinFab (    )

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

template<class T> BinFab< T >::BinFab (  const Box &    a_domain, const RealVect &    a_mesh_spacing, const RealVect &    a_origin, const ProblemDomain &    a_probdomain )

constructs empty binFab on domain

template<class T> BinFab< T >::BinFab (  const BinFab< T > &    a_binfab )

copy constructor

template<class T> BinFab< T >::~BinFab (    )  [virtual]

---

Member Function Documentation

template<class T> void BinFab< T >::addItem (  const T &    a_item )  [virtual]

copy one item into the appropriate bin

template<class T> void BinFab< T >::addItems (  const List< T > &    a_list )  [virtual]

copy a list of items into the appropriate bins

template<class T> void BinFab< T >::addItemsDestructive (  List< T > &    a_list )  [virtual]

move items off the argument list and into the appropriate bins

template<class T> void BinFab< T >::clear (    )  [virtual]

Reimplemented from BaseFab< List< T > >.

template<class T> void BinFab< T >::define (  const Box &    a_domain, const RealVect &    a_mesh_spacing, const RealVect &    a_origin, const ProblemDomain &    a_probdomain )  [virtual]

template<class T> void BinFab< T >::linearIn (  void *    buf, const Box &    R, const Interval &    comps )  [virtual]

Reimplemented from BaseFab< List< T > >.

template<class T> void BinFab< T >::linearOut (  void *    buf, const Box &    R, const Interval &    comps )  const [virtual]

Write a linear representation of the internal data. Assumes that sufficient memory for the buffer has already been allocated by the caller. Reimplemented from BaseFab< List< T > >.

template<class T> IntVect BinFab< T >::locateBin (  const T &    )  const [protected]

template<class T> int BinFab< T >::preAllocatable (    )  [inline, static]

Reimplemented from BaseFab< List< T > >.

template<class T> void BinFab< T >::reBin (    )  [virtual]

sort all the BinItems into the appropriate bins

template<class T> int BinFab< T >::size (  const Box &    box, const Interval &    comps )  const [virtual]

{\bf linearization functions} Returns the size, in number of bytes, of a flat linear representation of the data in this object in the area defined by the input Box R and the component Interval comps. The size does not include the size of R and comps. Reimplemented from BaseFab< List< T > >.

---

Member Data Documentation

template<class T> RealVect BinFab< T >::m_mesh_spacing [protected]

template<class T> RealVect BinFab< T >::m_origin [protected]

template<class T> ProblemDomain BinFab< T >::m_probdomain [protected]

---

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

• BinFab.H
• BinFabImplem.H

---