CompuCell3D::AdjacentNeighbor Class Reference

#include <AdjacentNeighbor.h>

Collaboration diagram for CompuCell3D::AdjacentNeighbor:

[legend]

List of all members.

Public Member Functions
	AdjacentNeighbor ()
	AdjacentNeighbor (const Dim3D &_dim)
	~AdjacentNeighbor ()
void	initialize (const Dim3D &_dim)
std::vector< long > const &	getAdjNeighborOffsetVec () const
std::vector< long > const &	getAdjFace2FaceNeighborOffsetVec () const
std::vector< Point3D > const &	getAdjNeighborOffsetVec (const Point3D &_pt) const
std::vector< Point3D > const &	getAdjFace2FaceNeighborOffsetVec (const Point3D &_pt) const
Dim3D	getFieldDim () const
Field3DIndex const &	getField3DIndex () const
double	distance (double, double, double)
void	setPeriodicX ()
void	setPeriodicY ()
void	setPeriodicZ ()
bool	isInner (const Point3D &_pt) const
Protected Attributes
std::vector< long >	adjNeighborOffsets
std::vector< long >	adjFace2FaceNeighborOffsets
std::vector< Point3D >	adjNeighborOffsetsInner
std::vector< Point3D >	adjNeighborOffsetsBoundary
std::vector< Point3D >	adjFace2FaceNeighborOffsetsInner
std::vector< Point3D >	adjFace2FaceNeighborOffsetsBoundary
bool	periodicX
bool	periodicY
bool	periodicZ
Field3DIndex	field3DIndex
int	depth
Dim3D	fieldDim

---

Detailed Description

Definition at line 22 of file AdjacentNeighbor.h.

---

Constructor & Destructor Documentation

CompuCell3D::AdjacentNeighbor::AdjacentNeighbor

(

)

[inline, explicit]

Definition at line 24 of file AdjacentNeighbor.h.

AdjacentNeighbor::AdjacentNeighbor

(

const Dim3D &

_dim

)

[explicit]

here I will initialize vector of offsets

Definition at line 10 of file AdjacentNeighbor.cpp.

References initialize().

Here is the call graph for this function:

AdjacentNeighbor::~AdjacentNeighbor

(

)

Definition at line 199 of file AdjacentNeighbor.cpp.

---

Member Function Documentation

void AdjacentNeighbor::initialize

(

const Dim3D &

_dim

)

initializing face2face offsets

Definition at line 23 of file AdjacentNeighbor.cpp.

References adjFace2FaceNeighborOffsets, adjFace2FaceNeighborOffsetsBoundary, adjFace2FaceNeighborOffsetsInner, adjNeighborOffsets, adjNeighborOffsetsBoundary, adjNeighborOffsetsInner, depth, distance(), field3DIndex, fieldDim, and CompuCell3D::Field3DIndex::index().

Referenced by AdjacentNeighbor(), and CompuCell3D::ExternalPotentialPlugin::init().

Here is the call graph for this function:

std::vector<long> const& CompuCell3D::AdjacentNeighbor::getAdjNeighborOffsetVec

(

)

const [inline]

Definition at line 33 of file AdjacentNeighbor.h.

References adjNeighborOffsets.

std::vector<long> const& CompuCell3D::AdjacentNeighbor::getAdjFace2FaceNeighborOffsetVec

(

)

const [inline]

Definition at line 34 of file AdjacentNeighbor.h.

References adjFace2FaceNeighborOffsets.

Referenced by CompuCell3D::ExternalPotentialEnergy::changeEnergy(), CompuCell3D::CellBoundaryTrackerPlugin::field3DChange(), CompuCell3D::CellBoundaryTrackerPlugin::isBoundaryPixel(), CompuCell3D::CellBoundaryTrackerPlugin::testLatticeSanity(), and CompuCell3D::CellBoundaryTrackerPlugin::testLatticeSanityFull().

std::vector<Point3D> const& CompuCell3D::AdjacentNeighbor::getAdjNeighborOffsetVec

(

const Point3D &

_pt

)

const [inline]

Definition at line 36 of file AdjacentNeighbor.h.

References adjNeighborOffsetsBoundary, adjNeighborOffsetsInner, and isInner().

Here is the call graph for this function:

std::vector<Point3D> const& CompuCell3D::AdjacentNeighbor::getAdjFace2FaceNeighborOffsetVec

(

const Point3D &

_pt

)

const [inline]

Definition at line 46 of file AdjacentNeighbor.h.

References adjFace2FaceNeighborOffsetsBoundary, adjFace2FaceNeighborOffsetsInner, and isInner().

Here is the call graph for this function:

Dim3D CompuCell3D::AdjacentNeighbor::getFieldDim

(

)

const [inline]

Definition at line 57 of file AdjacentNeighbor.h.

References fieldDim.

Field3DIndex const& CompuCell3D::AdjacentNeighbor::getField3DIndex

(

)

const [inline]

Definition at line 58 of file AdjacentNeighbor.h.

References field3DIndex.

Referenced by CompuCell3D::NeighborTrackerPlugin::field3DChange(), CompuCell3D::CellBoundaryTrackerPlugin::field3DChange(), CompuCell3D::CellBoundaryTrackerPlugin::init(), CompuCell3D::CellBoundaryTrackerPlugin::testLatticeSanity(), and CompuCell3D::CellBoundaryTrackerPlugin::testLatticeSanityFull().

double AdjacentNeighbor::distance	(	double	x,
		double	y,
		double	z
	)

Definition at line 96 of file AdjacentNeighbor.cpp.

Referenced by initialize().

void AdjacentNeighbor::setPeriodicX

(

)

do nothing if someone has already called this function

adding Face2FaceNeighborOffsets

Definition at line 101 of file AdjacentNeighbor.cpp.

References adjFace2FaceNeighborOffsetsBoundary, adjNeighborOffsetsBoundary, fieldDim, periodicX, and CompuCell3D::Point3D::x.

Referenced by CompuCell3D::NeighborTrackerPlugin::init(), CompuCell3D::ExternalPotentialPlugin::init(), and CompuCell3D::CellBoundaryTrackerPlugin::init().

void AdjacentNeighbor::setPeriodicY

(

)

do nothing if someone has already called this function

Definition at line 133 of file AdjacentNeighbor.cpp.

References adjFace2FaceNeighborOffsetsBoundary, adjNeighborOffsetsBoundary, fieldDim, periodicY, and CompuCell3D::Point3D::y.

Referenced by CompuCell3D::NeighborTrackerPlugin::init(), CompuCell3D::ExternalPotentialPlugin::init(), and CompuCell3D::CellBoundaryTrackerPlugin::init().

void AdjacentNeighbor::setPeriodicZ

(

)

do nothing if someone has already called this function

Definition at line 166 of file AdjacentNeighbor.cpp.

References adjFace2FaceNeighborOffsetsBoundary, adjNeighborOffsetsBoundary, fieldDim, periodicZ, and CompuCell3D::Point3D::z.

Referenced by CompuCell3D::NeighborTrackerPlugin::init(), CompuCell3D::ExternalPotentialPlugin::init(), and CompuCell3D::CellBoundaryTrackerPlugin::init().

bool CompuCell3D::AdjacentNeighbor::isInner

(

const Point3D &

_pt

)

const [inline]

Definition at line 63 of file AdjacentNeighbor.h.

References fieldDim, CompuCell3D::Point3D::x, CompuCell3D::Point3D::y, and CompuCell3D::Point3D::z.

Referenced by getAdjFace2FaceNeighborOffsetVec(), and getAdjNeighborOffsetVec().

---

Member Data Documentation

std::vector<long> CompuCell3D::AdjacentNeighbor::adjNeighborOffsets [protected]

Definition at line 72 of file AdjacentNeighbor.h.

Referenced by getAdjNeighborOffsetVec(), and initialize().

std::vector<long> CompuCell3D::AdjacentNeighbor::adjFace2FaceNeighborOffsets [protected]

Definition at line 73 of file AdjacentNeighbor.h.

Referenced by getAdjFace2FaceNeighborOffsetVec(), and initialize().

std::vector<Point3D> CompuCell3D::AdjacentNeighbor::adjNeighborOffsetsInner [protected]

Definition at line 74 of file AdjacentNeighbor.h.

Referenced by getAdjNeighborOffsetVec(), and initialize().

std::vector<Point3D> CompuCell3D::AdjacentNeighbor::adjNeighborOffsetsBoundary [protected]

Definition at line 75 of file AdjacentNeighbor.h.

Referenced by getAdjNeighborOffsetVec(), initialize(), setPeriodicX(), setPeriodicY(), and setPeriodicZ().

std::vector<Point3D> CompuCell3D::AdjacentNeighbor::adjFace2FaceNeighborOffsetsInner [protected]

Definition at line 76 of file AdjacentNeighbor.h.

Referenced by getAdjFace2FaceNeighborOffsetVec(), and initialize().

std::vector<Point3D> CompuCell3D::AdjacentNeighbor::adjFace2FaceNeighborOffsetsBoundary [protected]

Definition at line 77 of file AdjacentNeighbor.h.

Referenced by getAdjFace2FaceNeighborOffsetVec(), initialize(), setPeriodicX(), setPeriodicY(), and setPeriodicZ().

bool CompuCell3D::AdjacentNeighbor::periodicX [protected]

Definition at line 78 of file AdjacentNeighbor.h.

Referenced by setPeriodicX().

bool CompuCell3D::AdjacentNeighbor::periodicY [protected]

Definition at line 79 of file AdjacentNeighbor.h.

Referenced by setPeriodicY().

bool CompuCell3D::AdjacentNeighbor::periodicZ [protected]

Definition at line 80 of file AdjacentNeighbor.h.

Referenced by setPeriodicZ().

Field3DIndex CompuCell3D::AdjacentNeighbor::field3DIndex [protected]

Definition at line 81 of file AdjacentNeighbor.h.

Referenced by getField3DIndex(), and initialize().

int CompuCell3D::AdjacentNeighbor::depth [protected]

Definition at line 82 of file AdjacentNeighbor.h.

Referenced by initialize().

Dim3D CompuCell3D::AdjacentNeighbor::fieldDim [protected]

Definition at line 83 of file AdjacentNeighbor.h.

Referenced by getFieldDim(), initialize(), isInner(), setPeriodicX(), setPeriodicY(), and setPeriodicZ().

---

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

• CompuCell3D/src-3.2.0-hex/CompuCell3D/Field3D/AdjacentNeighbor.h
• CompuCell3D/src-3.2.0-hex/CompuCell3D/Field3D/AdjacentNeighbor.cpp

---