CKNGeometricAtomFactory Class Reference

Factory class for create CKNGeometricAtom instance. More...

#include "KNGeometricAtomFactory.h"

Collaboration diagram for CKNGeometricAtomFactory:

Public Member Functions
	CKNGeometricAtomFactory ()
	~CKNGeometricAtomFactory ()

Static Public Member Functions
static void	SetAtomCoordination (CKNGeometricAtom::ATOM_TYPE type, double x, double y, double z)
	Setting atom coordination. More...
static void	SetNeighborCoordination (CKNGeometricAtom::NEIGHOR_RELATION type, double x, double y, double z)
	Setting neighbor coordination. More...
static void	SetRatio (double fRatio[3])
	Set ratio that applying to length, atom coordination and neighbor position. More...
static void	SetUnitCellSize (double fSize[3])
	Set unitcell size. More...
static void	FreeFactoryData ()
	Release all setting data. More...
static int	GetAtomCountInUnitcell ()
static MATERIAL_INDEX	GetMaterialNumber (char *pszMaterialName, CKNGeometricAtom::ATOM_TYPE type)
	Get total atom counts in unit cell. More...
static MATERIAL_INDEX	GetMaterialNumber (char *pszMaterialName)
	Get Atom number that mean material of atom number. More...
static void	InitAtomList ()
static void	InitNeighborList ()
static unsigned int	GetNeighborCount ()

Static Private Attributes
static std::vector < CKNGeometricAtom >	m_vectAtomList_1
	Get total Neighbor count in unit cell. More...
static std::vector < CKNGeometricAtom >	m_vectAtomList_2
	Atom array for cation. More...
static std::vector < CKNGeometricCoordination >	m_vectNeighborRelation1To2
	Neighbor relationship from anion to cation. More...
static std::vector < CKNGeometricCoordination >	m_vectNeighborRelation2To1
	Neighbor relationship from cation to anion. More...

Friends
class	CKNGeometricUnitCell

Detailed Description

Factory class for create CKNGeometricAtom instance.

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 KNGeometricAtomFactory.h.

Constructor & Destructor Documentation

CKNGeometricAtomFactory::CKNGeometricAtomFactory

(

)

Definition at line 18 of file KNGeometricAtomFactory.cpp.

{
}

CKNGeometricAtomFactory::~CKNGeometricAtomFactory

(

)

Definition at line 23 of file KNGeometricAtomFactory.cpp.

{
}

Member Function Documentation

void CKNGeometricAtomFactory::FreeFactoryData ( )

static

Release all setting data.

Definition at line 106 of file KNGeometricAtomFactory.cpp.

References m_vectAtomList_1, m_vectAtomList_2, m_vectNeighborRelation1To2, and m_vectNeighborRelation2To1.

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

static int CKNGeometricAtomFactory::GetAtomCountInUnitcell ( )

inlinestatic

Definition at line 30 of file KNGeometricAtomFactory.h.

References m_vectAtomList_1, and m_vectAtomList_2.

Referenced by CKNGeometricUnitCell::AddPeridoicDirection(), CKNGeometricUnitCell::Deserialize(), CKNGeometricShape::Deserialize(), CKNGeometricShape::ExchangeAtomInfoBetweenNode(), CKNGeometricShape::Serialize(), CKNGeometricUnitCell::SetPeriodic(), and CKNGeometricUnitCell::SetPeriodicDirection().

{ return m_vectAtomList_1.size() + m_vectAtomList_2.size();}; 

Here is the caller graph for this function:

MATERIAL_INDEX CKNGeometricAtomFactory::GetMaterialNumber ( char *  pszMaterialName, CKNGeometricAtom::ATOM_TYPE  type  )

static

Get total atom counts in unit cell.

Get Atom number that mean material of atom number

Parameters

pszMaterialName	Material name
type	Atom type

Returns

Material number

Definition at line 119 of file KNGeometricAtomFactory.cpp.

References CKNGeometricAtom::A, As, ATOM_NUM_BASE, CKNGeometricAtom::C, Ga, In, and Si.

Referenced by CKNGeometricUnitCell::ArrangeAtom(), CKNGeometricUnitCell::NumberingSubElement(), and CKNGeometricUnitCell::SetSubDomainMaterial().

{
    if (!strcmp(pszMaterialName, "Si"))
    {
        return Si;
    }
    else if (!strcmp(pszMaterialName, "GaAs"))
    {
        //return GaAs;
        switch (type)
        {
        case CKNGeometricAtom::A:
            return Ga;
            break;
        case CKNGeometricAtom::C:
            return As;
            break;
        }
    }
    else if (!strcmp(pszMaterialName, "InAs"))
    {
        //return InAs;
        switch (type)
        {
        case CKNGeometricAtom::A:
            return In;
            break;
        case CKNGeometricAtom::C:
            return As;
            break;
        }
    }

    return ATOM_NUM_BASE;
}

Here is the caller graph for this function:

MATERIAL_INDEX CKNGeometricAtomFactory::GetMaterialNumber ( char *  pszMaterialName )

static

Get Atom number that mean material of atom number.

Parameters

pszMaterialName

Material name

Returns

Material number

Definition at line 159 of file KNGeometricAtomFactory.cpp.

References ATOM_NUM_BASE, GaAs, InAs, and Si.

{
    if (!strcmp(pszMaterialName, "Si"))
    {
        return Si;
    }
    else if (!strcmp(pszMaterialName, "GaAs"))
    {
        return GaAs;
    }
    else if (!strcmp(pszMaterialName, "InAs"))
    {
        return InAs;
    }

    return ATOM_NUM_BASE;
}

static unsigned int CKNGeometricAtomFactory::GetNeighborCount ( )

inlinestatic

Definition at line 35 of file KNGeometricAtomFactory.h.

{ return m_vectNeighborRelation1To2.size() + m_vectNeighborRelation2To1.size(); }; 

void CKNGeometricAtomFactory::InitAtomList ( )

static

Definition at line 177 of file KNGeometricAtomFactory.cpp.

References m_vectAtomList_1, and m_vectAtomList_2.

Referenced by CKNGeometricShape::SetAtomAndNeighborInformation().

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

Here is the caller graph for this function:

void CKNGeometricAtomFactory::InitNeighborList ( )

static

Definition at line 183 of file KNGeometricAtomFactory.cpp.

References m_vectNeighborRelation1To2, and m_vectNeighborRelation2To1.

Referenced by CKNGeometricShape::SetAtomAndNeighborInformation().

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

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

static

Setting atom coordination.

Parameters

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

Definition at line 33 of file KNGeometricAtomFactory.cpp.

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

Referenced by CKNGeometricShape::SetAtomAndNeighborInformation(), and CKNGeometricConstructionLaunch::SetUnitCellInformation().

{
    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:

Here is the caller graph for this function:

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

static

Setting neighbor coordination.

Parameters

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

Definition at line 57 of file KNGeometricAtomFactory.cpp.

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

Referenced by CKNGeometricShape::SetAtomAndNeighborInformation(), and CKNGeometricConstructionLaunch::SetUnitCellInformation().

{
    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:

Here is the caller graph for this function:

void CKNGeometricAtomFactory::SetRatio ( double  fRatio[3] )

static

Set ratio that applying to length, atom coordination and neighbor position.

Parameters

fRatio

Ration for x, y, z direction

Definition at line 77 of file KNGeometricAtomFactory.cpp.

References m_vectAtomList_1, m_vectAtomList_2, m_vectNeighborRelation1To2, and m_vectNeighborRelation2To1.

Referenced by SetUnitCellSize().

{
    int             i, nSize;

    nSize = m_vectAtomList_1.size();
    for (i = 0; i < nSize; ++i)
        m_vectAtomList_1[i].SetRatio(fRatio);

    nSize = m_vectAtomList_2.size();
    for (i = 0; i < nSize; ++i)
        m_vectAtomList_2[i].SetRatio(fRatio);

    nSize = m_vectNeighborRelation1To2.size();
    for (i = 0; i < nSize; ++i)
        m_vectNeighborRelation1To2[i].SetRatio(fRatio);

    nSize = m_vectNeighborRelation2To1.size();
    for (i = 0; i < nSize; ++i)
        m_vectNeighborRelation2To1[i].SetRatio(fRatio);
}

Here is the caller graph for this function:

void CKNGeometricAtomFactory::SetUnitCellSize ( double  fSize[3] )

static

Set unitcell size.

Parameters

fSize

size for x, y, z direction

Definition at line 101 of file KNGeometricAtomFactory.cpp.

References SetRatio().

{
    SetRatio(fSize);
}

Here is the call graph for this function:

Friends And Related Function Documentation

friend class CKNGeometricUnitCell

friend

Definition at line 44 of file KNGeometricAtomFactory.h.

Member Data Documentation

std::vector< CKNGeometricAtom > CKNGeometricAtomFactory::m_vectAtomList_1

staticprivate

Get total Neighbor count in unit cell.

Atom array for anion

Definition at line 35 of file KNGeometricAtomFactory.h.

Referenced by CKNGeometricUnitCell::ArrangeAtom(), FreeFactoryData(), GetAtomCountInUnitcell(), InitAtomList(), SetAtomCoordination(), and SetRatio().

std::vector< CKNGeometricAtom > CKNGeometricAtomFactory::m_vectAtomList_2

staticprivate

Atom array for cation.

Definition at line 39 of file KNGeometricAtomFactory.h.

Referenced by CKNGeometricUnitCell::ArrangeAtom(), FreeFactoryData(), GetAtomCountInUnitcell(), InitAtomList(), SetAtomCoordination(), and SetRatio().

std::vector< CKNGeometricCoordination > CKNGeometricAtomFactory::m_vectNeighborRelation1To2

staticprivate

Neighbor relationship from anion to cation.

Definition at line 41 of file KNGeometricAtomFactory.h.

Referenced by CKNGeometricUnitCell::BuildNeighborInformation(), FreeFactoryData(), InitNeighborList(), SetNeighborCoordination(), and SetRatio().

std::vector< CKNGeometricCoordination > CKNGeometricAtomFactory::m_vectNeighborRelation2To1

staticprivate

Neighbor relationship from cation to anion.

Definition at line 42 of file KNGeometricAtomFactory.h.

Referenced by CKNGeometricUnitCell::BuildNeighborInformation(), FreeFactoryData(), InitNeighborList(), SetNeighborCoordination(), and SetRatio().

---

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

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