CGeometricCoordination Class Reference

Class for coordination. More...

#include "GeometricCoordination.h"

Collaboration diagram for CGeometricCoordination:

Public Member Functions
	CGeometricCoordination ()
	~CGeometricCoordination ()
double *	GetCoordinationAll ()
void	SetCoordination (CGeometricCoordination coordination)
	Get coordination with double buffer. More...
void	SetCoordination (double *pfCoordination)
	Set coordination to instance. More...
void	SetCoordination (double fXCoordination, double fYCoordination, double fZCoordination)
	Set coordination to instance. More...
double	GetCoordination (AXIS_DEFINE coord)
	Get coordination specific axis. More...
void	Rotate (AXIS_DEFINE axis, double fDegree)
	Rotate coordination with specific degree. More...
void	SetOffset (CGeometricCoordination coord)
	To offset coordination. More...
void	SetOffset (double fXCoordination, double fYCoordination, double fZCoordination)
	To offset coordination. More...
void	SetRatio (double fRatio[3])
	Set ratio. More...
bool	IsSame (CGeometricCoordination compare)
	Comparing coordination is same or not within tolerance. More...
bool	operator== (const CGeometricCoordination &compare)
	Comparing coordination is same or not within tolerance. More...
bool	operator!= (const CGeometricCoordination &compare)
	Comparing coordination is same or not within tolerance. More...

Private Attributes
double	m_fCoordination [3]
	Cooridnation for x, y, z direction. More...

Detailed Description

Class for coordination.

Date

03/Oct/2014

Definition at line 14 of file GeometricCoordination.h.

Constructor & Destructor Documentation

CGeometricCoordination::CGeometricCoordination

(

)

Definition at line 10 of file GeometricCoordination.cpp.

References _X, _Y, _Z, and m_fCoordination.

{
    m_fCoordination[_X] = 0;
    m_fCoordination[_Y] = 0;
    m_fCoordination[_Z] = 0;
}

CGeometricCoordination::~CGeometricCoordination

(

)

Definition at line 17 of file GeometricCoordination.cpp.

{
}

Member Function Documentation

double CGeometricCoordination::GetCoordination

(

AXIS_DEFINE

coord

)

Get coordination specific axis.

Parameters

coord

Axis that want to get coordination

Returns

Coordination value

Definition at line 47 of file GeometricCoordination.cpp.

References m_fCoordination.

Referenced by CGeometricShape::ArrangeUnitCell(), CGeometricShape::CalculateUnitcellCount(), CGeometricShape::ConstructContactRegionOnPoissonGrid(), CGeometricShape::ConstructMapInfo(), CGeometricShape::MapElecAtomOnPoissonGrid(), CGeometricUnitCell::NumberingSubElement(), CGeometricShape::RefillPeriodicBinding(), CGeometricShape::SetAtomAndNeighborInformation(), SetOffset(), and CGeometricUnitCell::SetSubDomainMaterial().

{
    return m_fCoordination[coord];
}

Here is the caller graph for this function:

double* CGeometricCoordination::GetCoordinationAll ( )

inline

Definition at line 20 of file GeometricCoordination.h.

References m_fCoordination.

Referenced by CGeometricShape::ArrangeUnitCell(), IsSame(), SetCoordination(), CGeometricUnitCell::SetCoordination(), and CGeometricAtom::SetCoordination().

{ return m_fCoordination; }; 

Here is the caller graph for this function:

bool CGeometricCoordination::IsSame

(

CGeometricCoordination

compare

)

Comparing coordination is same or not within tolerance.

Parameters

compare

Coordination that want to compare

Returns

Compare coordinatin is same or not

Definition at line 109 of file GeometricCoordination.cpp.

References _X, _Y, _Z, GetCoordinationAll(), and m_fCoordination.

Referenced by operator!=(), and operator==().

{
    double          *fCompare = compare.GetCoordinationAll();
    double          fTolerance = 1e-8;

    if (fabs(m_fCoordination[_X] - fCompare[_X]) > fTolerance)
        return false;

    if (fabs(m_fCoordination[_Y] - fCompare[_Y]) > fTolerance)
        return false;

    if( fabs(m_fCoordination[_Z] - fCompare[_Z]) > fTolerance)
        return false;

    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool CGeometricCoordination::operator!=

(

const CGeometricCoordination &

compare

)

Comparing coordination is same or not within tolerance.

Parameters

compare

Coordination that want to compare

Returns

Compare coordinatin is same or not

Definition at line 139 of file GeometricCoordination.cpp.

References IsSame().

{
    return !IsSame(compare);
}

Here is the call graph for this function:

bool CGeometricCoordination::operator==

(

const CGeometricCoordination &

compare

)

Comparing coordination is same or not within tolerance.

Parameters

compare

Coordination that want to compare

Returns

Compare coordinatin is same or not

Definition at line 130 of file GeometricCoordination.cpp.

References IsSame().

{
    return IsSame(compare);
}

Here is the call graph for this function:

void CGeometricCoordination::Rotate	(	AXIS_DEFINE	axis,
		double	fDegree
	)

Rotate coordination with specific degree.

Parameters

axis	Rotate axis x, y, z
fDegree	Rotate degree

Definition at line 56 of file GeometricCoordination.cpp.

References _X, _Y, _Z, and m_fCoordination.

{
    switch (axis)
    {
    case _X:
        m_fCoordination[_Y] = m_fCoordination[_Y] * cos(fDegree) - m_fCoordination[_Z] * sin(fDegree);
        m_fCoordination[_Z] = m_fCoordination[_Y] * sin(fDegree) + m_fCoordination[_Z] * cos(fDegree);
        break;
    case _Y:
        m_fCoordination[_Z] = m_fCoordination[_Z] * cos(fDegree) - m_fCoordination[_X] * sin(fDegree);
        m_fCoordination[_X] = m_fCoordination[_Z] * sin(fDegree) + m_fCoordination[_X] * cos(fDegree);
        break;
    case _Z:
        m_fCoordination[_X] = m_fCoordination[_X] * cos(fDegree) - m_fCoordination[_Y] * sin(fDegree);
        m_fCoordination[_Y] = m_fCoordination[_X] * sin(fDegree) + m_fCoordination[_Y] * cos(fDegree);
        break;
    }
}

void CGeometricCoordination::SetCoordination ( CGeometricCoordination  coordination )

inline

Get coordination with double buffer.

Definition at line 21 of file GeometricCoordination.h.

References GetCoordinationAll(), and SetCoordination().

Referenced by CGeometricShape::ArrangeUnitCell(), CGeometricAtom::CGeometricAtom(), CGeometricShape::InitShape(), SetCoordination(), CGeometricUnitCell::SetCoordination(), CGeometricAtom::SetCoordination(), CGeometricAtomFactory::SetNeighborCoordination(), IGeometricUnitCellInfo::SetNeighborCoordination(), and CGeometricShape::SetOriginCoordination().

{ SetCoordination(coordination.GetCoordinationAll()); }; 

Here is the call graph for this function:

Here is the caller graph for this function:

void CGeometricCoordination::SetCoordination

(

double *

pfCoordination

)

Set coordination to instance.

Set coordination to instance

Parameters

pfCoordination

Array of coordination of x, y, z direction

Definition at line 24 of file GeometricCoordination.cpp.

References _X, _Y, _Z, and m_fCoordination.

{ 
    m_fCoordination[_X] = pfCoordination[0];
    m_fCoordination[_Y] = pfCoordination[1];
    m_fCoordination[_Z] = pfCoordination[2];
}

void CGeometricCoordination::SetCoordination	(	double	fXCoordination,
		double	fYCoordination,
		double	fZCoordination
	)

Set coordination to instance.

Parameters

fXCoordination	X axis coordination
fYCoordination	Y axis coordination
fZCoordination	Z axis coordination

Definition at line 36 of file GeometricCoordination.cpp.

References _X, _Y, _Z, and m_fCoordination.

{
    m_fCoordination[_X] = fXCoordination;
    m_fCoordination[_Y] = fYCoordination;
    m_fCoordination[_Z] = fZCoordination;
}

void CGeometricCoordination::SetOffset

(

CGeometricCoordination

coord

)

To offset coordination.

Parameters

coord

Offset value

Definition at line 78 of file GeometricCoordination.cpp.

References _X, _Y, _Z, and GetCoordination().

Referenced by CGeometricUnitCell::ArrangeAtom(), CGeometricShape::ArrangeUnitCell(), CGeometricShape::CalculateUnitcellCount(), and CGeometricUnitCell::IsMachedNeighborRule().

{
    SetOffset(coord.GetCoordination(_X), coord.GetCoordination(_Y), coord.GetCoordination(_Z));
}

Here is the call graph for this function:

Here is the caller graph for this function:

void CGeometricCoordination::SetOffset	(	double	fXCoordination,
		double	fYCoordination,
		double	fZCoordination
	)

To offset coordination.

Parameters

fXCoordination	Offset value of x axis
fYCoordination	Offset value of y axis
fZCoordination	Offset value of z axis

Definition at line 88 of file GeometricCoordination.cpp.

References _X, _Y, _Z, and m_fCoordination.

{
    m_fCoordination[_X] += fXCoordination;
    m_fCoordination[_Y] += fYCoordination;
    m_fCoordination[_Z] += fZCoordination;
}

void CGeometricCoordination::SetRatio

(

double

fRatio[3]

)

Set ratio.

Parameters

fRatio

Ratio value

Definition at line 98 of file GeometricCoordination.cpp.

References _X, _Y, _Z, and m_fCoordination.

Referenced by CGeometricAtom::SetRatio().

{
    m_fCoordination[_X] *= fRatio[_X];
    m_fCoordination[_Y] *= fRatio[_Y];
    m_fCoordination[_Z] *= fRatio[_Z];
}

Here is the caller graph for this function:

Member Data Documentation

double CGeometricCoordination::m_fCoordination[3]

private

Cooridnation for x, y, z direction.

Definition at line 35 of file GeometricCoordination.h.

Referenced by CGeometricCoordination(), GetCoordination(), GetCoordinationAll(), IsSame(), Rotate(), SetCoordination(), SetOffset(), and SetRatio().

---

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

• D:/For Doxygen/GeometricCoordination.h
• D:/For Doxygen/GeometricCoordination.cpp