Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

BinItem Class Reference

Virtual base class for particle problems. More...

#include <BinItem.H>

Collaboration diagram for BinItem:

Collaboration graph
[legend]
List of all members.

Public Methods

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

 BinItem (const RealVect &a_position)
virtual ~BinItem ()
virtual void define (const RealVect &a_position)
void setPosition (const RealVect &a_position)
void setPosition (const Real a_position, const int a_dimension)
RealVect & position ()
const RealVect & position () const
Real position (const int a_dir) const
virtual int size () const
virtual void linearOut (void *buf) const
virtual void linearIn (void *buf)
int preAllocatable ()

Protected Attributes

RealVect m_position
 this is the position of this item


Detailed Description

Virtual base class for particle problems.

BinItem is a base class to provide the necessary interface with BinFab for particle-in-bin/cell problems. Since the only attribute of a particle needed by the BinFab is position, it is the only attribute present in this class. All other attributes (charge, velocity, etc) will appear in a derived class


Constructor & Destructor Documentation

BinItem::BinItem (    ) 
 

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

BinItem::BinItem (  const RealVect &    a_position ) 
 

virtual BinItem::~BinItem (    )  [virtual]
 


Member Function Documentation

virtual void BinItem::define (  const RealVect &    a_position )  [virtual]
 

virtual void BinItem::linearIn (  void *    buf )  [virtual]
 

virtual void BinItem::linearOut (  void *    buf )  const [virtual]
 

Write a linear representation of the internal data. Assumes that sufficient memory for the buffer has already been allocated by the caller.

Real BinItem::position (  const int    a_dir )  const
 

const RealVect& BinItem::position (    )  const
 

RealVect& BinItem::position (    ) 
 

int BinItem::preAllocatable (    )  [inline]
 

void BinItem::setPosition (  const Real    a_position,
const int    a_dimension
) 
 

void BinItem::setPosition (  const RealVect &    a_position ) 
 

virtual int BinItem::size (    )  const [virtual]
 

Returns the size, in number of bytes, of a flat linear representation of the data in this object.


Member Data Documentation

RealVect BinItem::m_position [protected]
 

this is the position of this item


The documentation for this class was generated from the following file:
Generated on Tue Jul 2 10:44:02 2002 for Chombo by doxygen1.2.16