CompuCell3D::VelocityPlugin Class Reference

#include <VelocityPlugin.h>

Inheritance diagram for CompuCell3D::VelocityPlugin:

[legend]

Collaboration diagram for CompuCell3D::VelocityPlugin:

[legend]

List of all members.

Public Member Functions
	VelocityPlugin ()
virtual	~VelocityPlugin ()
virtual void	init (Simulator *_simulator)
virtual void	extraInit (Simulator *_simulator)
virtual void	field3DChange (const Point3D &pt, CellG *newCell, CellG *oldCell)
virtual double	changeEnergy (const Point3D &pt, const CellG *newCell, const CellG *oldCell)
virtual double	localEnergy (const Point3D &pt)
virtual std::string	toString ()
BasicClassAccessor < VelocityData > *	getVelocityDataAccessorPtr ()
void	calculateVelocityData (const Point3D &pt, const CellG *newCell, const CellG *oldCell)
virtual void	readXML (XMLPullParser &in)
virtual void	writeXML (XMLSerializer &out)
Private Attributes
BasicClassAccessor< VelocityData >	velocityDataAccessor
Simulator *	sim
Potts3D *	potts
Dim3D	fieldDim
Point3D	boundaryConditionIndicator

---

Detailed Description

Definition at line 25 of file VelocityPlugin.h.

---

Constructor & Destructor Documentation

CompuCell3D::VelocityPlugin::VelocityPlugin

(

)

Definition at line 20 of file VelocityPlugin.cpp.

CompuCell3D::VelocityPlugin::~VelocityPlugin

(

)

[virtual]

Definition at line 25 of file VelocityPlugin.cpp.

---

Member Function Documentation

void CompuCell3D::VelocityPlugin::init

(

Simulator *

_simulator

)

[virtual]

Definition at line 30 of file VelocityPlugin.cpp.

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

void CompuCell3D::VelocityPlugin::extraInit

(

Simulator *

_simulator

)

[virtual]

Reimplemented from CompuCell3D::SimObject.

Definition at line 45 of file VelocityPlugin.cpp.

References CompuCell3D::Potts3D::getCellFactoryGroupPtr(), potts, CompuCell3D::Potts3D::registerCellGChangeWatcher(), BasicClassGroupFactory::registerClass(), CompuCell3D::Potts3D::registerEnergyFunctionWithName(), and velocityDataAccessor.

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

Definition at line 104 of file VelocityPlugin.cpp.

References calculateVelocityData().

double CompuCell3D::VelocityPlugin::changeEnergy	(	const Point3D &	pt,
		const CellG *	newCell,
		const CellG *	oldCell
	)			[virtual]

Parameters:

	pt	The point of change.
	newCell	The new spin.

Returns:

The energy change of changing point pt to newCell.

Reimplemented from CompuCell3D::EnergyFunction.

Definition at line 53 of file VelocityPlugin.cpp.

References boundaryConditionIndicator, CompuCell3D::CellG::extraAttribPtr, fieldDim, findMin(), CompuCell3D::Simulator::getStep(), CompuCell3D::precalculateAfterFlipCM(), sim, velocityDataAccessor, CompuCell3D::CellG::volume, CompuCell3D::Point3D::x, Coordinates3D< T >::X(), Coordinates3D< T >::XRef(), CompuCell3D::Point3D::y, Coordinates3D< T >::Y(), Coordinates3D< T >::YRef(), CompuCell3D::Point3D::z, Coordinates3D< T >::Z(), and Coordinates3D< T >::ZRef().

double CompuCell3D::VelocityPlugin::localEnergy

(

const Point3D &

pt

)

[virtual]

Called by Potts3D when this function is registered.

Returns:

The energy change for this function at point pt.

Reimplemented from CompuCell3D::EnergyFunction.

Definition at line 16 of file VelocityPlugin.cpp.

virtual std::string CompuCell3D::VelocityPlugin::toString

(

)

[inline, virtual]

Reimplemented from CompuCell3D::Plugin.

Definition at line 45 of file VelocityPlugin.h.

BasicClassAccessor<VelocityData>* CompuCell3D::VelocityPlugin::getVelocityDataAccessorPtr

(

)

[inline]

Definition at line 47 of file VelocityPlugin.h.

References velocityDataAccessor.

void CompuCell3D::VelocityPlugin::calculateVelocityData	(	const Point3D &	pt,
		const CellG *	newCell,
		const CellG *	oldCell
	)

Definition at line 111 of file VelocityPlugin.cpp.

References boundaryConditionIndicator, CompuCell3D::CellG::extraAttribPtr, fieldDim, findMin(), CompuCell3D::Simulator::getStep(), sim, velocityDataAccessor, 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 field3DChange().

void CompuCell3D::VelocityPlugin::readXML

(

XMLPullParser &

in

)

[virtual]

Definition at line 188 of file VelocityPlugin.cpp.

void CompuCell3D::VelocityPlugin::writeXML

(

XMLSerializer &

out

)

[virtual]

Definition at line 192 of file VelocityPlugin.cpp.

---

Member Data Documentation

BasicClassAccessor<VelocityData> CompuCell3D::VelocityPlugin::velocityDataAccessor [private]

Definition at line 28 of file VelocityPlugin.h.

Referenced by calculateVelocityData(), changeEnergy(), extraInit(), and getVelocityDataAccessorPtr().

Simulator* CompuCell3D::VelocityPlugin::sim [private]

Definition at line 58 of file VelocityPlugin.h.

Referenced by calculateVelocityData(), changeEnergy(), and init().

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

Definition at line 59 of file VelocityPlugin.h.

Referenced by extraInit(), and init().

Dim3D CompuCell3D::VelocityPlugin::fieldDim [private]

Definition at line 60 of file VelocityPlugin.h.

Referenced by calculateVelocityData(), changeEnergy(), and init().

Point3D CompuCell3D::VelocityPlugin::boundaryConditionIndicator [private]

Definition at line 61 of file VelocityPlugin.h.

Referenced by calculateVelocityData(), changeEnergy(), and init().

---

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

• CompuCell/DOXYGEN/core/CompuCell3D/plugins/Velocity/VelocityPlugin.h
• CompuCell/DOXYGEN/core/CompuCell3D/plugins/Velocity/VelocityPlugin.cpp