CompuCell3D::CellVelocity Class Reference

#include <CellVelocity.h>

Inheritance diagram for CompuCell3D::CellVelocity:

[legend]

Collaboration diagram for CompuCell3D::CellVelocity:

[legend]

List of all members.

Public Member Functions
	CellVelocity ()
virtual	~CellVelocity ()
virtual void	init (Simulator *simulator)
virtual void	extraInit (Simulator *simulator)
virtual void	start ()
virtual void	step (const unsigned int currentStep)
virtual void	finish ()
virtual void	readXML (XMLPullParser &in)
virtual void	writeXML (XMLSerializer &out)
Protected Member Functions
void	resizeCellVelocityData ()
void	updateCOMList ()
void	zeroCellVelocities ()
Protected Attributes
Potts3D *	potts
CellInventory *	cellInventoryPtr
BasicClassAccessor < CellVelocityData > *	cellVelocityDataAccessorPtr
unsigned int	updateFrequency
Point3D	boundaryConditionIndicator
Dim3D	fieldDim

---

Detailed Description

Definition at line 21 of file CellVelocity.h.

---

Constructor & Destructor Documentation

CompuCell3D::CellVelocity::CellVelocity

(

)

Definition at line 23 of file CellVelocity.cpp.

References updateFrequency.

CompuCell3D::CellVelocity::~CellVelocity

(

)

[virtual]

Definition at line 30 of file CellVelocity.cpp.

---

Member Function Documentation

void CompuCell3D::CellVelocity::init

(

Simulator *

simulator

)

[virtual]

getting cell inventory

Definition at line 34 of file CellVelocity.cpp.

References cellInventoryPtr, CompuCell3D::Potts3D::getCellInventory(), CompuCell3D::Simulator::getPotts(), and potts.

void CompuCell3D::CellVelocity::extraInit

(

Simulator *

simulator

)

[virtual]

Reimplemented from CompuCell3D::SimObject.

Definition at line 46 of file CellVelocity.cpp.

References ASSERT_OR_THROW, boundaryConditionIndicator, cellVelocityDataAccessorPtr, fieldDim, CompuCell3D::Potts3D::getBoundaryXName(), CompuCell3D::Potts3D::getBoundaryYName(), CompuCell3D::Potts3D::getBoundaryZName(), CompuCell3D::Potts3D::getCellFieldG(), CompuCell3D::CellVelocityPlugin::getCellVelocityDataAccessorPtr(), CompuCell3D::Simulator::pluginManager, potts, CompuCell3D::Point3D::x, CompuCell3D::Point3D::y, and CompuCell3D::Point3D::z.

void CompuCell3D::CellVelocity::start

(

)

[virtual]

Implements CompuCell3D::Steppable.

Definition at line 67 of file CellVelocity.cpp.

References updateCOMList(), and zeroCellVelocities().

void CompuCell3D::CellVelocity::step

(

const unsigned int

currentStep

)

[virtual]

Implements CompuCell3D::Steppable.

Definition at line 158 of file CellVelocity.cpp.

References updateCOMList(), and updateFrequency.

virtual void CompuCell3D::CellVelocity::finish

(

)

[inline, virtual]

Implements CompuCell3D::Steppable.

Definition at line 36 of file CellVelocity.h.

void CompuCell3D::CellVelocity::readXML

(

XMLPullParser &

in

)

[virtual]

Definition at line 183 of file CellVelocity.cpp.

References BasicString::parseUInteger(), and updateFrequency.

virtual void CompuCell3D::CellVelocity::writeXML

(

XMLSerializer &

out

)

[inline, virtual]

Definition at line 41 of file CellVelocity.h.

void CompuCell3D::CellVelocity::resizeCellVelocityData

(

)

[protected]

Definition at line 166 of file CellVelocity.cpp.

void CompuCell3D::CellVelocity::updateCOMList

(

)

[protected]

loop over all the cells in the inventory

Definition at line 73 of file CellVelocity.cpp.

References boundaryConditionIndicator, CompuCell3D::CellInventory::cellInventoryBegin(), CompuCell3D::CellInventory::cellInventoryEnd(), cellInventoryPtr, cellVelocityDataAccessorPtr, CompuCell3D::CellG::extraAttribPtr, fieldDim, findMin(), updateFrequency, CompuCell3D::CellG::volume, CompuCell3D::Point3D::x, Coordinates3D< T >::X(), CompuCell3D::CellG::xCM, Coordinates3D< T >::XRef(), CompuCell3D::Point3D::y, Coordinates3D< T >::Y(), CompuCell3D::CellG::yCM, Coordinates3D< T >::YRef(), CompuCell3D::Point3D::z, Coordinates3D< T >::Z(), CompuCell3D::CellG::zCM, and Coordinates3D< T >::ZRef().

Referenced by start(), and step().

void CompuCell3D::CellVelocity::zeroCellVelocities

(

)

[protected]

loop over all the cells in the inventory

Definition at line 130 of file CellVelocity.cpp.

References CompuCell3D::CellInventory::cellInventoryBegin(), CompuCell3D::CellInventory::cellInventoryEnd(), cellInventoryPtr, and cellVelocityDataAccessorPtr.

Referenced by start().

---

Member Data Documentation

Potts3D* CompuCell3D::CellVelocity::potts [protected]

Definition at line 41 of file CellVelocity.h.

Referenced by extraInit(), and init().

CellInventory* CompuCell3D::CellVelocity::cellInventoryPtr [protected]

Definition at line 45 of file CellVelocity.h.

Referenced by init(), updateCOMList(), and zeroCellVelocities().

BasicClassAccessor<CellVelocityData>* CompuCell3D::CellVelocity::cellVelocityDataAccessorPtr [protected]

Definition at line 46 of file CellVelocity.h.

Referenced by extraInit(), updateCOMList(), and zeroCellVelocities().

unsigned int CompuCell3D::CellVelocity::updateFrequency [protected]

Definition at line 49 of file CellVelocity.h.

Referenced by CellVelocity(), readXML(), step(), and updateCOMList().

Point3D CompuCell3D::CellVelocity::boundaryConditionIndicator [protected]

Definition at line 54 of file CellVelocity.h.

Referenced by extraInit(), and updateCOMList().

Dim3D CompuCell3D::CellVelocity::fieldDim [protected]

Definition at line 55 of file CellVelocity.h.

Referenced by extraInit(), and updateCOMList().

---

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

• CompuCell/DOXYGEN/core/CompuCell3D/steppables/CellVelocity/CellVelocity.h
• CompuCell/DOXYGEN/core/CompuCell3D/steppables/CellVelocity/CellVelocity.cpp