CKNGeometricCoordination Class Reference

Class for coordination. More...

#include "KNGeometricCoordination.h"

Collaboration diagram for CKNGeometricCoordination:

Public Member Functions
	CKNGeometricCoordination ()
	~CKNGeometricCoordination ()
double *	GetCoordinationAll ()
void	SetCoordination (CKNGeometricCoordination 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 (CKNGeometricCoordination 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 (CKNGeometricCoordination compare)
	Comparing coordination is same or not within tolerance. More...
bool	operator== (const CKNGeometricCoordination &compare)
	Comparing coordination is same or not within tolerance. More...
bool	operator!= (const CKNGeometricCoordination &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

Author

Kyu Nam Cho(mysto.nosp@m.us@k.nosp@m.orea..nosp@m.ac.k.nosp@m.r), Hoon Ryu(elec1.nosp@m.020@.nosp@m.gmail.nosp@m..com)

Definition at line 16 of file KNGeometricCoordination.h.

Constructor & Destructor Documentation

CKNGeometricCoordination::CKNGeometricCoordination

(

)

Definition at line 11 of file KNGeometricCoordination.cpp.

References _X, _Y, _Z, and m_fCoordination.

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

CKNGeometricCoordination::~CKNGeometricCoordination

(

)

Definition at line 18 of file KNGeometricCoordination.cpp.

{
}

Member Function Documentation

double CKNGeometricCoordination::GetCoordination

(

AXIS_DEFINE

coord

)

Get coordination specific axis.

Parameters

coord

Axis that want to get coordination

Returns

Coordination value

Definition at line 48 of file KNGeometricCoordination.cpp.

References m_fCoordination.

Referenced by CKNGeometricShape::ArrangeUnitCell(), CKNGeometricShape::CalculateUnitcellCount(), CKNGeometricShape::ConstructMapInfo(), CKNGeometricUnitCell::NumberingSubElement(), CKNGeometricShape::RefillPeriodicBinding(), CKNGeometricShape::SetAtomAndNeighborInformation(), SetOffset(), and CKNGeometricUnitCell::SetSubDomainMaterial().

{
    return m_fCoordination[coord];
}

Here is the caller graph for this function:

double* CKNGeometricCoordination::GetCoordinationAll ( )

inline

Definition at line 22 of file KNGeometricCoordination.h.

References m_fCoordination.

Referenced by CKNGeometricShape::ArrangeUnitCell(), IsSame(), SetCoordination(), CKNGeometricUnitCell::SetCoordination(), and CKNGeometricAtom::SetCoordination().

{ return m_fCoordination; }; 

Here is the caller graph for this function:

bool CKNGeometricCoordination::IsSame

(

CKNGeometricCoordination

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 110 of file KNGeometricCoordination.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 CKNGeometricCoordination::operator!=

(

const CKNGeometricCoordination &

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 140 of file KNGeometricCoordination.cpp.

References IsSame().

{
    return !IsSame(compare);
}

bool CKNGeometricCoordination::operator==

(

const CKNGeometricCoordination &

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 131 of file KNGeometricCoordination.cpp.

References IsSame().

{
    return IsSame(compare);
}

Here is the call graph for this function:

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

Rotate coordination with specific degree.

Parameters

axis	Rotate axis x, y, z
fDegree	Rotate degree

Definition at line 57 of file KNGeometricCoordination.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 CKNGeometricCoordination::SetCoordination ( CKNGeometricCoordination  coordination )

inline

Get coordination with double buffer.

Definition at line 23 of file KNGeometricCoordination.h.

References GetCoordinationAll(), and SetCoordination().

Referenced by CKNGeometricShape::ArrangeUnitCell(), CKNGeometricAtom::CKNGeometricAtom(), CKNGeometricShape::InitShape(), SetCoordination(), CKNGeometricUnitCell::SetCoordination(), CKNGeometricAtom::SetCoordination(), CKNGeometricAtomFactory::SetNeighborCoordination(), IKNGeometricUnitCellInfo::SetNeighborCoordination(), and CKNGeometricShape::SetOriginCoordination().

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

Here is the call graph for this function:

Here is the caller graph for this function:

void CKNGeometricCoordination::SetCoordination

(

double *

pfCoordination

)

Set coordination to instance.

Set coordination to instance

Parameters

pfCoordination

Array of coordination of x, y, z direction

Definition at line 25 of file KNGeometricCoordination.cpp.

References _X, _Y, _Z, and m_fCoordination.

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

void CKNGeometricCoordination::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 37 of file KNGeometricCoordination.cpp.

References _X, _Y, _Z, and m_fCoordination.

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

void CKNGeometricCoordination::SetOffset

(

CKNGeometricCoordination

coord

)

To offset coordination.

Parameters

coord

Offset value

Definition at line 79 of file KNGeometricCoordination.cpp.

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

Referenced by CKNGeometricUnitCell::ArrangeAtom(), CKNGeometricShape::ArrangeUnitCell(), CKNGeometricShape::CalculateUnitcellCount(), and CKNGeometricUnitCell::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 CKNGeometricCoordination::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 89 of file KNGeometricCoordination.cpp.

References _X, _Y, _Z, and m_fCoordination.

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

void CKNGeometricCoordination::SetRatio

(

double

fRatio[3]

)

Set ratio.

Parameters

fRatio

Ratio value

Definition at line 99 of file KNGeometricCoordination.cpp.

References _X, _Y, _Z, and m_fCoordination.

Referenced by CKNGeometricAtom::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 CKNGeometricCoordination::m_fCoordination[3]

private

Cooridnation for x, y, z direction.

Definition at line 37 of file KNGeometricCoordination.h.

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

---

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

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