IKNGeometricUnitCellInfo Class Reference

Iterface for Unitcell information. More...

#include "IKNGeometricUnitCellInfo.h"

Inheritance diagram for IKNGeometricUnitCellInfo:

Collaboration diagram for IKNGeometricUnitCellInfo:

Public Member Functions
void	InitCoordination ()
	Initial Coordination information. More...
virtual void	SetAtomCoordination ()=0
	Atom coordination setting. More...
virtual void	SetNeighborCoordination ()=0
	Neighbor atom coordiantion setting. More...
virtual void	SetUnitCellSize (double fUnitcellSize[3])=0
	Unitcell size setting. More...
int	GetA2CNeighborCount ()
	Get neigbhor relation count. More...
int	GetC2ANeighborCount ()
	Get neigbhor relation count. More...
	IKNGeometricUnitCellInfo ()
	~IKNGeometricUnitCellInfo ()
unsigned int	GetAnionCount ()
unsigned int	GetCationCount ()
	Get anion count in Unitcell. More...
double *	GetUnitcCellSize ()
	Get cation count in Unitcell. More...
CKNGeometricCoordination	GetAtomCoordination (CKNGeometricAtom::ATOM_TYPE atomType, unsigned int nIndex)
	Get Unitcell size x, y, z direction axis. More...
CKNGeometricCoordination	GetNeighborCoordination (CKNGeometricAtom::NEIGHOR_RELATION neighborType, unsigned int nIndex)
	Get neigbhor atom coordination from Unitcell. More...
void	RotateNeighbor (CKNMatrixOperation::CKNDMatrix *pRotationMatrix)
	Rotating neighbor coordination. More...
void	RotateAxis (CKNMatrixOperation::CKNDMatrix *pRotationMatrix)
	Rotating axis. More...

Protected Member Functions
void	SetAtomCoordination (CKNGeometricAtom::ATOM_TYPE type, double x, double y, double z)
	Set single atom coordination. More...
void	SetNeighborCoordination (CKNGeometricAtom::NEIGHOR_RELATION type, double x, double y, double z)
	Set single neighbor coordination. More...

Protected Attributes
double	m_UnitCellSize [3]
	Unitcell size x, y, z direction axis. More...
double	m_NeigbhorOriginSize [3]
	For neighbor distance calculation. More...
std::vector< CKNGeometricAtom >	m_vectAtomList_1
	Atom list in Unitcell for anion. More...
std::vector< CKNGeometricAtom >	m_vectAtomList_2
	Atom list in Unitcell for cation. More...
std::vector < CKNGeometricCoordination >	m_vectNeighborRelation1To2
	Neighbor relation list in Unitcell for anion to cation. More...
std::vector < CKNGeometricCoordination >	m_vectNeighborRelation2To1
	Neighbor relation list in Unitcell for cation to anion. More...

Detailed Description

Iterface for Unitcell information.

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 19 of file IKNGeometricUnitCellInfo.h.

Constructor & Destructor Documentation

IKNGeometricUnitCellInfo::IKNGeometricUnitCellInfo

(

)

Definition at line 12 of file IKNGeometricUnitCellInfo.cpp.

References m_UnitCellSize, CKNGeometricAtom::X_DIRECTION, CKNGeometricAtom::Y_DIRECTION, and CKNGeometricAtom::Z_DIRECTION.

{
    m_UnitCellSize[CKNGeometricAtom::X_DIRECTION] = 0.0;
    m_UnitCellSize[CKNGeometricAtom::Y_DIRECTION] = 0.0;
    m_UnitCellSize[CKNGeometricAtom::Z_DIRECTION] = 0.0;
}

IKNGeometricUnitCellInfo::~IKNGeometricUnitCellInfo

(

)

Definition at line 19 of file IKNGeometricUnitCellInfo.cpp.

{
}

Member Function Documentation

int IKNGeometricUnitCellInfo::GetA2CNeighborCount ( )

inline

Get neigbhor relation count.

Definition at line 26 of file IKNGeometricUnitCellInfo.h.

References m_vectNeighborRelation1To2.

Referenced by CKNGeometricShape::SetAtomAndNeighborInformation().

Here is the caller graph for this function:

unsigned int IKNGeometricUnitCellInfo::GetAnionCount ( )

inline

Definition at line 44 of file IKNGeometricUnitCellInfo.h.

References m_vectAtomList_1.

Referenced by CKNGeometricShape::SetAtomAndNeighborInformation().

{ return m_vectAtomList_1.size(); }; 

Here is the caller graph for this function:

CKNGeometricCoordination IKNGeometricUnitCellInfo::GetAtomCoordination	(	CKNGeometricAtom::ATOM_TYPE	atomType,
		unsigned int	nIndex
	)

Get Unitcell size x, y, z direction axis.

Get atom coordination from Unitcell

Parameters

atomType	Atom type, anion or cation
nIndex	Atom Index

Returns

Atom coordination

Definition at line 28 of file IKNGeometricUnitCellInfo.cpp.

References CKNGeometricAtom::A, CKNGeometricAtom::C, m_vectAtomList_1, and m_vectAtomList_2.

Referenced by CKNGeometricShape::SetAtomAndNeighborInformation().

{
    CKNGeometricCoordination        dumy;

    switch (atomType)
    {
    case CKNGeometricAtom::A:
        if (nIndex < 0 || nIndex >= m_vectAtomList_1.size())
            return dumy;
        return m_vectAtomList_1[nIndex].GetCoordination();
        break;
    case CKNGeometricAtom::C:
        if (nIndex < 0 || nIndex >= m_vectAtomList_2.size())
            return dumy;
        return m_vectAtomList_2[nIndex].GetCoordination();
        break;
    }

    return dumy;
}

Here is the caller graph for this function:

int IKNGeometricUnitCellInfo::GetC2ANeighborCount ( )

inline

Get neigbhor relation count.

Definition at line 27 of file IKNGeometricUnitCellInfo.h.

References m_vectNeighborRelation2To1.

Referenced by CKNGeometricShape::SetAtomAndNeighborInformation().

Here is the caller graph for this function:

unsigned int IKNGeometricUnitCellInfo::GetCationCount ( )

inline

Get anion count in Unitcell.

Definition at line 45 of file IKNGeometricUnitCellInfo.h.

References m_vectAtomList_2.

Referenced by CKNGeometricShape::SetAtomAndNeighborInformation().

{ return m_vectAtomList_2.size(); }; 

Here is the caller graph for this function:

CKNGeometricCoordination IKNGeometricUnitCellInfo::GetNeighborCoordination	(	CKNGeometricAtom::NEIGHOR_RELATION	neighborType,
		unsigned int	nIndex
	)

Get neigbhor atom coordination from Unitcell.

Parameters

neighborType	Neighbor Atom type, anion or cation
nIndex	Atom Index

Returns

Atom coordination

Definition at line 54 of file IKNGeometricUnitCellInfo.cpp.

References CKNGeometricAtom::A2C, CKNGeometricAtom::C2A, m_vectNeighborRelation1To2, and m_vectNeighborRelation2To1.

Referenced by CKNGeometricShape::SetAtomAndNeighborInformation().

{
    CKNGeometricCoordination        dumy;

    switch (neighborType)
    {
    case CKNGeometricAtom::A2C:
        if (nIndex < 0 || nIndex >= m_vectNeighborRelation1To2.size())
            return dumy;
        return m_vectNeighborRelation1To2[nIndex];
        break;
    case CKNGeometricAtom::C2A:
        if (nIndex < 0 || nIndex >= m_vectNeighborRelation2To1.size())
            return dumy;
        return m_vectNeighborRelation2To1[nIndex];
        break;
    }

    return dumy;
}

Here is the caller graph for this function:

double* IKNGeometricUnitCellInfo::GetUnitcCellSize ( )

inline

Get cation count in Unitcell.

Definition at line 46 of file IKNGeometricUnitCellInfo.h.

References m_UnitCellSize.

Referenced by CKNGeometricShape::SetAtomAndNeighborInformation().

{ return m_UnitCellSize; }; 

Here is the caller graph for this function:

void IKNGeometricUnitCellInfo::InitCoordination

(

)

Initial Coordination information.

Definition at line 179 of file IKNGeometricUnitCellInfo.cpp.

References m_vectAtomList_1, m_vectAtomList_2, m_vectNeighborRelation1To2, and m_vectNeighborRelation2To1.

Referenced by CKNGeometricShape::SetAtomAndNeighborInformation().

{
    m_vectAtomList_1.clear();
    m_vectAtomList_2.clear();
    m_vectNeighborRelation1To2.clear();
    m_vectNeighborRelation2To1.clear();
}

void IKNGeometricUnitCellInfo::RotateAxis

(

CKNMatrixOperation::CKNDMatrix *

pRotationMatrix

)

Rotating axis.

Parameters

pRotationMatrix

Rotation matrix

Definition at line 125 of file IKNGeometricUnitCellInfo.cpp.

References CKNMatrixOperation::CKNVector::GetAt(), CKNComplex::GetRealNumber(), m_UnitCellSize, CKNMatrixOperation::MVMul(), CKNMatrixOperation::CKNVector::SetAt(), and CKNMatrixOperation::CKNVector::SetSize().

{
    CKNMatrixOperation::CKNVector       Vector, Result;
    int                                 i;
    double                              *fCoordination = NULL;

    Vector.SetSize(3);
    Result.SetSize(3);

    for (i = 0; i < 3; ++i)
        Vector.SetAt(i, m_UnitCellSize[i], 0);

    CKNMatrixOperation::MVMul(pRotationMatrix, &Vector, &Result);

    for (i = 0; i < 3; ++i)
        m_UnitCellSize[i] = Result.GetAt(i).GetRealNumber();
}

Here is the call graph for this function:

void IKNGeometricUnitCellInfo::RotateNeighbor

(

CKNMatrixOperation::CKNDMatrix *

pRotationMatrix

)

Rotating neighbor coordination.

Parameters

pRotationMatrix

Rotation matrix

Definition at line 146 of file IKNGeometricUnitCellInfo.cpp.

References CKNMatrixOperation::CKNVector::GetAt(), CKNComplex::GetRealNumber(), m_vectNeighborRelation1To2, m_vectNeighborRelation2To1, CKNMatrixOperation::MVMul(), CKNMatrixOperation::CKNVector::SetAt(), and CKNMatrixOperation::CKNVector::SetSize().

Referenced by CKNGeometricShape::SetAtomAndNeighborInformation().

{
    CKNMatrixOperation::CKNVector       Vector, Result;
    unsigned int                        i, j;
    double                              *fCoordination = NULL;

    Vector.SetSize(3);
    Result.SetSize(3);

    for (i = 0; i < m_vectNeighborRelation1To2.size() ; ++i)
    {
        fCoordination = m_vectNeighborRelation1To2[i].GetCoordinationAll();

        for (j = 0; j < 3; ++j)
            Vector.SetAt(j, fCoordination[j], 0);
        
        CKNMatrixOperation::MVMul(pRotationMatrix, &Vector, &Result);
        m_vectNeighborRelation1To2[i].SetCoordination(Result.GetAt(0).GetRealNumber(), Result.GetAt(1).GetRealNumber(), Result.GetAt(2).GetRealNumber());
    }

    for (i = 0; i < m_vectNeighborRelation2To1.size(); ++i)
    {
        fCoordination = m_vectNeighborRelation2To1[i].GetCoordinationAll();

        for (j = 0; j < 3; ++j)
            Vector.SetAt(j, fCoordination[j], 0);
        
        CKNMatrixOperation::MVMul(pRotationMatrix, &Vector, &Result);
        m_vectNeighborRelation2To1[i].SetCoordination(Result.GetAt(0).GetRealNumber(), Result.GetAt(1).GetRealNumber(), Result.GetAt(2).GetRealNumber());
    }

}

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void IKNGeometricUnitCellInfo::SetAtomCoordination ( )

pure virtual

Atom coordination setting.

Implemented in CKNGeometricUnitCellInfo_cubic, and CKNGeometricUnitCellInfo_zincblende.

Referenced by CKNGeometricShape::SetAtomAndNeighborInformation(), CKNGeometricUnitCellInfo_zincblende::SetAtomCoordination(), and CKNGeometricUnitCellInfo_cubic::SetAtomCoordination().

Here is the caller graph for this function:

void IKNGeometricUnitCellInfo::SetAtomCoordination ( CKNGeometricAtom::ATOM_TYPE  type, double  x, double  y, double  z  )

protected

Set single atom coordination.

Parameters

type	Atom type
x	x coordination
y	y coordination
z	z coordination

Definition at line 81 of file IKNGeometricUnitCellInfo.cpp.

References CKNGeometricAtom::A, ATOM_NUM_BASE, CKNGeometricAtom::C, m_vectAtomList_1, m_vectAtomList_2, CKNGeometricAtom::SetCoordination(), and CKNGeometricAtom::SetType().

{
    CKNGeometricAtom            atom;

    atom.SetType(type, ATOM_NUM_BASE);
    atom.SetCoordination(x, y, z);

    switch (type)
    {
    case CKNGeometricAtom::A:
        m_vectAtomList_1.push_back(atom);
        break;
    case CKNGeometricAtom::C:
        m_vectAtomList_2.push_back(atom);
        break;
    }
}

Here is the call graph for this function:

virtual void IKNGeometricUnitCellInfo::SetNeighborCoordination ( )

pure virtual

Neighbor atom coordiantion setting.

Implemented in CKNGeometricUnitCellInfo_cubic, and CKNGeometricUnitCellInfo_zincblende.

Referenced by CKNGeometricShape::SetAtomAndNeighborInformation(), CKNGeometricUnitCellInfo_zincblende::SetNeighborCoordination(), and CKNGeometricUnitCellInfo_cubic::SetNeighborCoordination().

Here is the caller graph for this function:

void IKNGeometricUnitCellInfo::SetNeighborCoordination ( CKNGeometricAtom::NEIGHOR_RELATION  type, double  x, double  y, double  z  )

protected

Set single neighbor coordination.

Parameters

type	Neighbor relationship type
x	x axis distance
y	y axis distance
z	z axis distance

Definition at line 105 of file IKNGeometricUnitCellInfo.cpp.

References CKNGeometricAtom::A2C, CKNGeometricAtom::C2A, m_vectNeighborRelation1To2, m_vectNeighborRelation2To1, and CKNGeometricCoordination::SetCoordination().

{
    CKNGeometricCoordination        relationCoordnation;

    relationCoordnation.SetCoordination(x, y, z);

    switch (type)
    {
    case CKNGeometricAtom::A2C:
        m_vectNeighborRelation1To2.push_back(relationCoordnation);
        break;
    case CKNGeometricAtom::C2A:
        m_vectNeighborRelation2To1.push_back(relationCoordnation);
        break;
    }
}

Here is the call graph for this function:

virtual void IKNGeometricUnitCellInfo::SetUnitCellSize ( double  fUnitcellSize[3] )

pure virtual

Unitcell size setting.

Implemented in CKNGeometricUnitCellInfo_cubic, and CKNGeometricUnitCellInfo_zincblende.

Referenced by CKNGeometricShape::SetAtomAndNeighborInformation().

Here is the caller graph for this function:

Member Data Documentation

double IKNGeometricUnitCellInfo::m_NeigbhorOriginSize[3]

protected

For neighbor distance calculation.

Definition at line 34 of file IKNGeometricUnitCellInfo.h.

Referenced by CKNGeometricUnitCellInfo_zincblende::SetNeighborCoordination(), and CKNGeometricUnitCellInfo_zincblende::SetUnitCellSize().

double IKNGeometricUnitCellInfo::m_UnitCellSize[3]

protected

Unitcell size x, y, z direction axis.

Definition at line 33 of file IKNGeometricUnitCellInfo.h.

Referenced by GetUnitcCellSize(), IKNGeometricUnitCellInfo(), RotateAxis(), CKNGeometricUnitCellInfo_cubic::SetAtomCoordination(), CKNGeometricUnitCellInfo_zincblende::SetAtomCoordination(), CKNGeometricUnitCellInfo_cubic::SetNeighborCoordination(), CKNGeometricUnitCellInfo_cubic::SetUnitCellSize(), and CKNGeometricUnitCellInfo_zincblende::SetUnitCellSize().

std::vector<CKNGeometricAtom> IKNGeometricUnitCellInfo::m_vectAtomList_1

protected

Atom list in Unitcell for anion.

Definition at line 35 of file IKNGeometricUnitCellInfo.h.

Referenced by GetAnionCount(), GetAtomCoordination(), InitCoordination(), and SetAtomCoordination().

std::vector<CKNGeometricAtom> IKNGeometricUnitCellInfo::m_vectAtomList_2

protected

Atom list in Unitcell for cation.

Definition at line 36 of file IKNGeometricUnitCellInfo.h.

Referenced by GetAtomCoordination(), GetCationCount(), InitCoordination(), and SetAtomCoordination().

std::vector<CKNGeometricCoordination> IKNGeometricUnitCellInfo::m_vectNeighborRelation1To2

protected

Neighbor relation list in Unitcell for anion to cation.

Definition at line 37 of file IKNGeometricUnitCellInfo.h.

Referenced by GetA2CNeighborCount(), GetNeighborCoordination(), InitCoordination(), RotateNeighbor(), and SetNeighborCoordination().

std::vector<CKNGeometricCoordination> IKNGeometricUnitCellInfo::m_vectNeighborRelation2To1

protected

Neighbor relation list in Unitcell for cation to anion.

Definition at line 38 of file IKNGeometricUnitCellInfo.h.

Referenced by GetC2ANeighborCount(), GetNeighborCoordination(), InitCoordination(), RotateNeighbor(), and SetNeighborCoordination().

---

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

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