BinItem Class Reference

#include <BinItem.H>

Inheritance diagram for BinItem:

Inheritance graph
[legend]

List of all members.


Detailed Description

Virtual base class for particle data.

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) must appear in a derived class.

Public Member Functions

 BinItem ()
 Null constructor, copy constructor and operator= can be compiler defined.
 BinItem (const RealVect &a_position)
 Constructs a BinItem at a_position.
virtual ~BinItem ()
 Destructor.
virtual void define (const RealVect &a_position)
 Same as the constructor.
void setPosition (const RealVect &a_position)
 Change the position.
void setPosition (const Real a_position, const int a_dimension)
 Change one component of the position.
RealVectposition ()
 Return a reference to the position.
const RealVectposition () const
 Return a constant reference to the position.
Real position (const int a_dir) const
 Gets one component of the position.
virtual bool operator== (const BinItem &a_p) const
 Equality operator. Checks whether two BinItems have equal data.
virtual bool operator== (const BinItem *a_p) const
 Same as the above, but defined for a pointer.
virtual bool operator!= (const BinItem &a_p) const
 Inequality operator.
virtual int size () const
 Number of bytes used by linearIn()/linearOut().
virtual void linearOut (void *a_buf) const
 Write a serialized (packed) representation into a_buf.
virtual void linearIn (void *a_buf)
 Extract a serialized (packed) representation from a_buf.
int preAllocatable ()
virtual void print () const
 Write a human-readable version to stdout (for debugging).

Protected Attributes

RealVect m_position
 this is the position in space of this item

Friends

std::ostream & operator<< (std::ostream &ostr, const BinItem &a_item)


Constructor & Destructor Documentation

BinItem::BinItem (  ) 

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

BinItem::BinItem ( const RealVect a_position  ) 

Constructs a BinItem at a_position.

virtual BinItem::~BinItem (  )  [virtual]

Destructor.


Member Function Documentation

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

Same as the constructor.

void BinItem::setPosition ( const RealVect a_position  ) 

Change the position.

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

Change one component of the position.

RealVect& BinItem::position (  ) 

Return a reference to the position.

const RealVect& BinItem::position (  )  const

Return a constant reference to the position.

Real BinItem::position ( const int  a_dir  )  const

Gets one component of the position.

virtual bool BinItem::operator== ( const BinItem a_p  )  const [virtual]

Equality operator. Checks whether two BinItems have equal data.

virtual bool BinItem::operator== ( const BinItem a_p  )  const [virtual]

Same as the above, but defined for a pointer.

virtual bool BinItem::operator!= ( const BinItem a_p  )  const [virtual]

Inequality operator.

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

Number of bytes used by linearIn()/linearOut().

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

Reimplemented in Particle.

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

Write a serialized (packed) representation into a_buf.

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

Reimplemented in Particle.

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

Extract a serialized (packed) representation from a_buf.

Given a linear representation of the class data previously made using linearOut() in a_buf, set the data for this class.

Reimplemented in Particle.

int BinItem::preAllocatable (  )  [inline]

virtual void BinItem::print (  )  const [virtual]

Write a human-readable version to stdout (for debugging).


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  ostr,
const BinItem a_item 
) [friend]


Member Data Documentation

this is the position in space of this item


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

Generated on Fri Aug 18 03:27:13 2017 for Chombo + EB + MF by  doxygen 1.5.5