CompuCell3D::CellOrientationPlugin Class Reference

#include <CellOrientationPlugin.h>

Inheritance diagram for CompuCell3D::CellOrientationPlugin:

[legend]

Collaboration diagram for CompuCell3D::CellOrientationPlugin:

[legend]

List of all members.

Public Member Functions
	CellOrientationPlugin ()
virtual	~CellOrientationPlugin ()
virtual void	init (Simulator *simulator, CC3DXMLElement *_xmlData=0)
virtual void	extraInit (Simulator *simulator)
virtual double	changeEnergy (const Point3D &pt, const CellG *newCell, const CellG *oldCell)
BasicClassAccessor < PolarizationVector > *	getPolarizationVectorAccessorPtr ()
BasicClassAccessor < LambdaCellOrientation > *	getLambdaCellOrientationAccessorPtr ()
void	setLambdaCellOrientation (CellG *_cell, double _lambda)
double	getLambdaCellOrientation (CellG *_cell)
virtual void	update (CC3DXMLElement *_xmlData, bool _fullInitFlag=false)
virtual std::string	steerableName ()
virtual std::string	toString ()
Private Attributes
Field3D< CellG * > *	cellFieldG
BasicClassAccessor < LambdaCellOrientation >	lambdaCellOrientationAccessor
Potts3D *	potts
double	lambdaCellOrientation
Simulator *	simulator
Dim3D	fieldDim
BasicClassAccessor < PolarizationVector > *	polarizationVectorAccessorPtr
bool	lambdaFlexFlag

---

Detailed Description

Definition at line 59 of file CellOrientationPlugin.h.

---

Constructor & Destructor Documentation

CellOrientationPlugin::CellOrientationPlugin

(

)

Definition at line 43 of file CellOrientationPlugin.cpp.

CellOrientationPlugin::~CellOrientationPlugin

(

)

[virtual]

Definition at line 53 of file CellOrientationPlugin.cpp.

---

Member Function Documentation

void CellOrientationPlugin::init	(	Simulator *	simulator,
		CC3DXMLElement *	_xmlData = 0
	)			[virtual]

Reimplemented from CompuCell3D::SimObject.

Definition at line 57 of file CellOrientationPlugin.cpp.

References cellFieldG, fieldDim, CompuCell3D::Potts3D::getCellFactoryGroupPtr(), CompuCell3D::Potts3D::getCellFieldG(), CompuCell3D::PolarizationVectorPlugin::getPolarizationVectorAccessorPtr(), CompuCell3D::Simulator::getPotts(), CompuCell3D::PolarizationVectorPlugin::init(), lambdaCellOrientationAccessor, CompuCell3D::Simulator::pluginManager, polarizationVectorAccessorPtr, potts, BasicClassGroupFactory::registerClass(), CompuCell3D::Potts3D::registerEnergyFunctionWithName(), CompuCell3D::Simulator::registerSteerableObject(), and update().

void CellOrientationPlugin::extraInit

(

Simulator *

simulator

)

[virtual]

Reimplemented from CompuCell3D::SimObject.

Definition at line 84 of file CellOrientationPlugin.cpp.

References cellFieldG, CompuCell3D::Potts3D::getCellFieldG(), CompuCell3D::Simulator::getPotts(), and potts.

double CellOrientationPlugin::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 105 of file CellOrientationPlugin.cpp.

References CompuCell3D::distanceVectorInvariant(), CompuCell3D::CellG::extraAttribPtr, fieldDim, CompuCell3D::Potts3D::getFlipNeighbor(), lambdaCellOrientation, lambdaCellOrientationAccessor, lambdaFlexFlag, polarizationVectorAccessorPtr, potts, CompuCell3D::Point3D::x, CompuCell3D::PolarizationVector::x, CompuCell3D::Point3D::y, CompuCell3D::PolarizationVector::y, CompuCell3D::Point3D::z, and CompuCell3D::PolarizationVector::z.

BasicClassAccessor<PolarizationVector>* CompuCell3D::CellOrientationPlugin::getPolarizationVectorAccessorPtr

(

)

[inline]

Definition at line 93 of file CellOrientationPlugin.h.

BasicClassAccessor<LambdaCellOrientation>* CompuCell3D::CellOrientationPlugin::getLambdaCellOrientationAccessorPtr

(

)

[inline]

Definition at line 94 of file CellOrientationPlugin.h.

void CellOrientationPlugin::setLambdaCellOrientation	(	CellG *	_cell,
		double	_lambda
	)

Definition at line 45 of file CellOrientationPlugin.cpp.

References CompuCell3D::CellG::extraAttribPtr, and lambdaCellOrientationAccessor.

double CellOrientationPlugin::getLambdaCellOrientation

(

CellG *

_cell

)

Definition at line 48 of file CellOrientationPlugin.cpp.

References CompuCell3D::CellG::extraAttribPtr, and lambdaCellOrientationAccessor.

void CellOrientationPlugin::update	(	CC3DXMLElement *	_xmlData,
		bool	_fullInitFlag = false
	)			[virtual]

Reimplemented from CompuCell3D::SteerableObject.

Definition at line 93 of file CellOrientationPlugin.cpp.

References CC3DXMLElement::findElement(), CC3DXMLElement::getDouble(), CC3DXMLElement::getFirstElement(), lambdaCellOrientation, and lambdaFlexFlag.

Referenced by init().

std::string CellOrientationPlugin::steerableName

(

)

[virtual]

Reimplemented from CompuCell3D::SteerableObject.

Definition at line 154 of file CellOrientationPlugin.cpp.

References toString().

std::string CellOrientationPlugin::toString

(

)

[virtual]

Reimplemented from CompuCell3D::Plugin.

Definition at line 149 of file CellOrientationPlugin.cpp.

Referenced by steerableName().

---

Member Data Documentation

Field3D<CellG *>* CompuCell3D::CellOrientationPlugin::cellFieldG [private]

Definition at line 63 of file CellOrientationPlugin.h.

Referenced by extraInit(), and init().

BasicClassAccessor<LambdaCellOrientation> CompuCell3D::CellOrientationPlugin::lambdaCellOrientationAccessor [private]

Definition at line 67 of file CellOrientationPlugin.h.

Referenced by changeEnergy(), getLambdaCellOrientation(), init(), and setLambdaCellOrientation().

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

Definition at line 71 of file CellOrientationPlugin.h.

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

double CompuCell3D::CellOrientationPlugin::lambdaCellOrientation [private]

Definition at line 72 of file CellOrientationPlugin.h.

Referenced by changeEnergy(), and update().

Simulator* CompuCell3D::CellOrientationPlugin::simulator [private]

Reimplemented from CompuCell3D::SimObject.

Definition at line 73 of file CellOrientationPlugin.h.

Dim3D CompuCell3D::CellOrientationPlugin::fieldDim [private]

Definition at line 74 of file CellOrientationPlugin.h.

Referenced by changeEnergy(), and init().

BasicClassAccessor<PolarizationVector>* CompuCell3D::CellOrientationPlugin::polarizationVectorAccessorPtr [private]

Definition at line 75 of file CellOrientationPlugin.h.

Referenced by changeEnergy(), and init().

bool CompuCell3D::CellOrientationPlugin::lambdaFlexFlag [private]

Definition at line 77 of file CellOrientationPlugin.h.

Referenced by changeEnergy(), and update().

---

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

• CompuCell/DOXYGEN/core/CompuCell3D/plugins/CellOrientation/CellOrientationPlugin.h
• CompuCell/DOXYGEN/core/CompuCell3D/plugins/CellOrientation/CellOrientationPlugin.cpp