CompuCell3D::CellInstantVelocityPlugin Class Reference

#include <CellInstantVelocityPlugin.h>

Inheritance diagram for CompuCell3D::CellInstantVelocityPlugin:

[legend]

Collaboration diagram for CompuCell3D::CellInstantVelocityPlugin:

[legend]

List of all members.

Public Member Functions
	CellInstantVelocityPlugin ()
virtual	~CellInstantVelocityPlugin ()
virtual void	init (Simulator *_simulator)
virtual void	extraInit (Simulator *_simulator)
virtual void	field3DChange (const Point3D &pt, CellG *newCell, CellG *oldCell)
virtual std::string	toString ()
InstantCellVelocityData &	getInstantVelocityData ()
void	calculateInstantVelocityData (const Point3D &pt, const CellG *newCell, const CellG *oldCell)
Private Attributes
Potts3D *	potts
Dim3D	fieldDim
Point3D	boundaryConditionIndicator
InstantCellVelocityData	ivd

---

Detailed Description

Definition at line 24 of file CellInstantVelocityPlugin.h.

---

Constructor & Destructor Documentation

CompuCell3D::CellInstantVelocityPlugin::CellInstantVelocityPlugin

(

)

Definition at line 18 of file CellInstantVelocityPlugin.cpp.

CompuCell3D::CellInstantVelocityPlugin::~CellInstantVelocityPlugin

(

)

[virtual]

Definition at line 24 of file CellInstantVelocityPlugin.cpp.

---

Member Function Documentation

void CompuCell3D::CellInstantVelocityPlugin::init

(

Simulator *

_simulator

)

[virtual]

Reimplemented from CompuCell3D::CellVelocityPlugin.

Definition at line 29 of file CellInstantVelocityPlugin.cpp.

References boundaryConditionIndicator, fieldDim, CompuCell3D::Potts3D::getBoundaryXName(), CompuCell3D::Potts3D::getBoundaryYName(), CompuCell3D::Potts3D::getBoundaryZName(), CompuCell3D::Potts3D::getCellFieldG(), CompuCell3D::Simulator::getPotts(), CompuCell3D::CellVelocityPlugin::init(), potts, CompuCell3D::Point3D::x, CompuCell3D::Point3D::y, and CompuCell3D::Point3D::z.

void CompuCell3D::CellInstantVelocityPlugin::extraInit

(

Simulator *

_simulator

)

[virtual]

Reimplemented from CompuCell3D::CellVelocityPlugin.

Definition at line 41 of file CellInstantVelocityPlugin.cpp.

References CompuCell3D::CellVelocityPlugin::extraInit(), potts, and CompuCell3D::Potts3D::registerCellGChangeWatcher().

void CompuCell3D::CellInstantVelocityPlugin::field3DChange	(	const Point3D &	pt,
		CellG *	newCell,
		CellG *	oldCell
	)			[virtual]

Definition at line 53 of file CellInstantVelocityPlugin.cpp.

References calculateInstantVelocityData(), CompuCell3D::CellVelocityPlugin::cellVelocityDataAccessorPtr, CompuCell3D::CellG::extraAttribPtr, ivd, CompuCell3D::InstantCellVelocityData::newCellCM, CompuCell3D::InstantCellVelocityData::newCellV, CompuCell3D::InstantCellVelocityData::oldCellCM, and CompuCell3D::InstantCellVelocityData::oldCellV.

virtual std::string CompuCell3D::CellInstantVelocityPlugin::toString

(

)

[inline, virtual]

Reimplemented from CompuCell3D::CellVelocityPlugin.

Definition at line 39 of file CellInstantVelocityPlugin.h.

InstantCellVelocityData& CompuCell3D::CellInstantVelocityPlugin::getInstantVelocityData

(

)

[inline]

Definition at line 42 of file CellInstantVelocityPlugin.h.

References ivd.

void CompuCell3D::CellInstantVelocityPlugin::calculateInstantVelocityData	(	const Point3D &	pt,
		const CellG *	newCell,
		const CellG *	oldCell
	)

Definition at line 93 of file CellInstantVelocityPlugin.cpp.

References boundaryConditionIndicator, CompuCell3D::CellVelocityPlugin::cellVelocityDataAccessorPtr, CompuCell3D::CellG::extraAttribPtr, fieldDim, findMin(), CompuCell3D::Simulator::getStep(), ivd, CompuCell3D::InstantCellVelocityData::newCellCM, CompuCell3D::InstantCellVelocityData::newCellV, CompuCell3D::InstantCellVelocityData::oldCellCM, CompuCell3D::InstantCellVelocityData::oldCellV, CompuCell3D::SimObject::simulator, 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, CompuCell3D::InstantCellVelocityData::zeroAll(), and Coordinates3D< T >::ZRef().

Referenced by field3DChange().

---

Member Data Documentation

Potts3D* CompuCell3D::CellInstantVelocityPlugin::potts [private]

Definition at line 49 of file CellInstantVelocityPlugin.h.

Referenced by extraInit(), and init().

Dim3D CompuCell3D::CellInstantVelocityPlugin::fieldDim [private]

Definition at line 50 of file CellInstantVelocityPlugin.h.

Referenced by calculateInstantVelocityData(), and init().

Point3D CompuCell3D::CellInstantVelocityPlugin::boundaryConditionIndicator [private]

Definition at line 51 of file CellInstantVelocityPlugin.h.

Referenced by calculateInstantVelocityData(), and init().

InstantCellVelocityData CompuCell3D::CellInstantVelocityPlugin::ivd [private]

Definition at line 52 of file CellInstantVelocityPlugin.h.

Referenced by calculateInstantVelocityData(), field3DChange(), and getInstantVelocityData().

---

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

• CompuCell/DOXYGEN/core/CompuCell3D/plugins/CellVelocity/CellInstantVelocityPlugin.h
• CompuCell/DOXYGEN/core/CompuCell3D/plugins/CellVelocity/CellInstantVelocityPlugin.cpp