CompuCell3D::LengthConstraintLocalFlexPlugin Class Reference

#include <LengthConstraintLocalFlexPlugin.h>

Inheritance diagram for CompuCell3D::LengthConstraintLocalFlexPlugin:

[legend]

Collaboration diagram for CompuCell3D::LengthConstraintLocalFlexPlugin:

[legend]

List of all members.

Public Types
typedef void(LengthConstraintLocalFlexPlugin::*	field3DChangeFcnPtr_t )(const Point3D &pt, CellG *newCell, CellG *oldCell)
typedef double(LengthConstraintLocalFlexPlugin::*	changeEnergyFcnPtr_t )(const Point3D &pt, const CellG *newCell, const CellG *oldCell)
Public Member Functions
	LengthConstraintLocalFlexPlugin ()
virtual	~LengthConstraintLocalFlexPlugin ()
virtual void	init (Simulator *simulator, CC3DXMLElement *_xmlData=0)
virtual std::string	toString ()
BasicClassAccessor < LengthConstraintLocalFlexData > *	getLengthConstraintLocalFlexDataPtr ()
void	setLengthConstraintData (CellG *_cell, double _lambdaLength, double _targetLength)
virtual void	field3DChange (const Point3D &pt, CellG *newCell, CellG *oldCell)
	CellChangeWatcher interface.
void	field3DChange_xy (const Point3D &pt, CellG *newCell, CellG *oldCell)
void	field3DChange_xz (const Point3D &pt, CellG *newCell, CellG *oldCell)
void	field3DChange_yz (const Point3D &pt, CellG *newCell, CellG *oldCell)
virtual double	changeEnergy (const Point3D &pt, const CellG *newCell, const CellG *oldCell)
virtual double	changeEnergy_xy (const Point3D &pt, const CellG *newCell, const CellG *oldCell)
virtual double	changeEnergy_xz (const Point3D &pt, const CellG *newCell, const CellG *oldCell)
virtual double	changeEnergy_yz (const Point3D &pt, const CellG *newCell, const CellG *oldCell)
Public Attributes
field3DChangeFcnPtr_t	field3DChangeFcnPtr
changeEnergyFcnPtr_t	changeEnergyFcnPtr
Private Attributes
Potts3D *	potts
BasicClassAccessor < LengthConstraintLocalFlexData >	lengthConstraintLocalFlexDataAccessor

---

Detailed Description

Definition at line 51 of file LengthConstraintLocalFlexPlugin.h.

---

Member Typedef Documentation

typedef void(LengthConstraintLocalFlexPlugin::* CompuCell3D::LengthConstraintLocalFlexPlugin::field3DChangeFcnPtr_t)(const Point3D &pt, CellG *newCell, CellG *oldCell)

typedef double(LengthConstraintLocalFlexPlugin::* CompuCell3D::LengthConstraintLocalFlexPlugin::changeEnergyFcnPtr_t)(const Point3D &pt, const CellG *newCell, const CellG *oldCell)

---

Constructor & Destructor Documentation

LengthConstraintLocalFlexPlugin::LengthConstraintLocalFlexPlugin

(

)

Definition at line 47 of file LengthConstraintLocalFlexPlugin.cpp.

LengthConstraintLocalFlexPlugin::~LengthConstraintLocalFlexPlugin

(

)

[virtual]

Definition at line 49 of file LengthConstraintLocalFlexPlugin.cpp.

---

Member Function Documentation

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

Reimplemented from CompuCell3D::SimObject.

Definition at line 52 of file LengthConstraintLocalFlexPlugin.cpp.

References ASSERT_OR_THROW, changeEnergy_xy(), changeEnergy_xz(), changeEnergy_yz(), changeEnergyFcnPtr, field3DChange_xy(), field3DChange_xz(), field3DChange_yz(), field3DChangeFcnPtr, CompuCell3D::Potts3D::getCellFactoryGroupPtr(), CompuCell3D::Potts3D::getCellFieldG(), CompuCell3D::Simulator::getPotts(), lengthConstraintLocalFlexDataAccessor, potts, CompuCell3D::Potts3D::registerCellGChangeWatcher(), BasicClassGroupFactory::registerClass(), CompuCell3D::Potts3D::registerEnergyFunctionWithName(), CompuCell3D::Point3D::x, CompuCell3D::Point3D::y, and CompuCell3D::Point3D::z.

std::string LengthConstraintLocalFlexPlugin::toString

(

)

[virtual]

Reimplemented from CompuCell3D::Plugin.

Definition at line 465 of file LengthConstraintLocalFlexPlugin.cpp.

BasicClassAccessor<LengthConstraintLocalFlexData>* CompuCell3D::LengthConstraintLocalFlexPlugin::getLengthConstraintLocalFlexDataPtr

(

)

[inline]

Definition at line 76 of file LengthConstraintLocalFlexPlugin.h.

void LengthConstraintLocalFlexPlugin::setLengthConstraintData	(	CellG *	_cell,
		double	_lambdaLength,
		double	_targetLength
	)

Definition at line 83 of file LengthConstraintLocalFlexPlugin.cpp.

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

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

CellChangeWatcher interface.

Definition at line 91 of file LengthConstraintLocalFlexPlugin.cpp.

References field3DChangeFcnPtr.

void LengthConstraintLocalFlexPlugin::field3DChange_xy	(	const Point3D &	pt,
		CellG *	newCell,
		CellG *	oldCell
	)

Definition at line 148 of file LengthConstraintLocalFlexPlugin.cpp.

References CompuCell3D::CellG::iXX, CompuCell3D::CellG::iXY, CompuCell3D::CellG::iYY, CompuCell3D::CellG::volume, CompuCell3D::Point3D::x, CompuCell3D::CellG::xCM, CompuCell3D::Point3D::y, and CompuCell3D::CellG::yCM.

Referenced by init().

void LengthConstraintLocalFlexPlugin::field3DChange_xz	(	const Point3D &	pt,
		CellG *	newCell,
		CellG *	oldCell
	)

Definition at line 98 of file LengthConstraintLocalFlexPlugin.cpp.

References CompuCell3D::CellG::iXX, CompuCell3D::CellG::iXZ, CompuCell3D::CellG::iZZ, CompuCell3D::CellG::volume, CompuCell3D::Point3D::x, CompuCell3D::CellG::xCM, CompuCell3D::Point3D::z, and CompuCell3D::CellG::zCM.

Referenced by init().

void LengthConstraintLocalFlexPlugin::field3DChange_yz	(	const Point3D &	pt,
		CellG *	newCell,
		CellG *	oldCell
	)

Definition at line 197 of file LengthConstraintLocalFlexPlugin.cpp.

References CompuCell3D::CellG::iYY, CompuCell3D::CellG::iYZ, CompuCell3D::CellG::iZZ, CompuCell3D::CellG::volume, CompuCell3D::Point3D::y, CompuCell3D::CellG::yCM, CompuCell3D::Point3D::z, and CompuCell3D::CellG::zCM.

Referenced by init().

double LengthConstraintLocalFlexPlugin::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 247 of file LengthConstraintLocalFlexPlugin.cpp.

References changeEnergyFcnPtr.

double LengthConstraintLocalFlexPlugin::changeEnergy_xy	(	const Point3D &	pt,
		const CellG *	newCell,
		const CellG *	oldCell
	)			[virtual]

E = lambda * (length - targetLength) ^ 2

Definition at line 326 of file LengthConstraintLocalFlexPlugin.cpp.

References CompuCell3D::CellG::extraAttribPtr, CompuCell3D::CellG::iXX, CompuCell3D::CellG::iXY, CompuCell3D::CellG::iYY, lengthConstraintLocalFlexDataAccessor, CompuCell3D::CellG::volume, CompuCell3D::Point3D::x, CompuCell3D::CellG::xCM, CompuCell3D::Point3D::y, and CompuCell3D::CellG::yCM.

Referenced by init().

double LengthConstraintLocalFlexPlugin::changeEnergy_xz	(	const Point3D &	pt,
		const CellG *	newCell,
		const CellG *	oldCell
	)			[virtual]

E = lambda * (length - targetLength) ^ 2

Definition at line 256 of file LengthConstraintLocalFlexPlugin.cpp.

References CompuCell3D::CellG::extraAttribPtr, CompuCell3D::CellG::iXX, CompuCell3D::CellG::iXZ, CompuCell3D::CellG::iZZ, lengthConstraintLocalFlexDataAccessor, CompuCell3D::CellG::volume, CompuCell3D::Point3D::x, CompuCell3D::CellG::xCM, CompuCell3D::Point3D::z, and CompuCell3D::CellG::zCM.

Referenced by init().

double LengthConstraintLocalFlexPlugin::changeEnergy_yz	(	const Point3D &	pt,
		const CellG *	newCell,
		const CellG *	oldCell
	)			[virtual]

E = lambda * (length - targetLength) ^ 2

Definition at line 395 of file LengthConstraintLocalFlexPlugin.cpp.

References CompuCell3D::CellG::extraAttribPtr, CompuCell3D::CellG::iYY, CompuCell3D::CellG::iYZ, CompuCell3D::CellG::iZZ, lengthConstraintLocalFlexDataAccessor, CompuCell3D::CellG::volume, CompuCell3D::Point3D::y, CompuCell3D::CellG::yCM, CompuCell3D::Point3D::z, and CompuCell3D::CellG::zCM.

Referenced by init().

---

Member Data Documentation

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

Definition at line 55 of file LengthConstraintLocalFlexPlugin.h.

Referenced by init().

BasicClassAccessor<LengthConstraintLocalFlexData> CompuCell3D::LengthConstraintLocalFlexPlugin::lengthConstraintLocalFlexDataAccessor [private]

Definition at line 56 of file LengthConstraintLocalFlexPlugin.h.

Referenced by changeEnergy_xy(), changeEnergy_xz(), changeEnergy_yz(), init(), and setLengthConstraintData().

field3DChangeFcnPtr_t CompuCell3D::LengthConstraintLocalFlexPlugin::field3DChangeFcnPtr

Definition at line 94 of file LengthConstraintLocalFlexPlugin.h.

Referenced by field3DChange(), and init().

changeEnergyFcnPtr_t CompuCell3D::LengthConstraintLocalFlexPlugin::changeEnergyFcnPtr

Definition at line 109 of file LengthConstraintLocalFlexPlugin.h.

Referenced by changeEnergy(), and init().

---

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

• CompuCell/DOXYGEN/core/CompuCell3D/plugins/LengthConstraintLocalFlex/LengthConstraintLocalFlexPlugin.h
• CompuCell/DOXYGEN/core/CompuCell3D/plugins/LengthConstraintLocalFlex/LengthConstraintLocalFlexPlugin.cpp