MillerIndexOrientation Class Reference

Inheritance diagram for MillerIndexOrientation:

Collaboration diagram for MillerIndexOrientation:

Public Types
enum	QComponent { QX , QY , QZ }

Public Member Functions
	MillerIndexOrientation (QComponent q1, MillerIndex index1, QComponent q2, MillerIndex index2)
	~MillerIndexOrientation () override
MillerIndexOrientation *	clone () const override
void	usePrimitiveLattice (const Lattice &lattice) override
Transform3D	transformationMatrix () const override

Private Member Functions
bool	checkAlignment () const

Private Attributes
Lattice	m_prim_lattice
QComponent	m_q1
QComponent	m_q2
MillerIndex	m_ind1
MillerIndex	m_ind2

Detailed Description

Specifies a rotation of a lattice through the Miller indices of two coordinate axes.

Definition at line 41 of file ILatticeOrientation.h.

Member Enumeration Documentation

QComponent

enum MillerIndexOrientation::QComponent

Enumerator
QX
QY
QZ

Definition at line 44 of file ILatticeOrientation.h.

{ QX, QY, QZ };

Constructor & Destructor Documentation

MillerIndexOrientation()

MillerIndexOrientation::MillerIndexOrientation	(	MillerIndexOrientation::QComponent	q1,
		MillerIndex	index1,
		MillerIndexOrientation::QComponent	q2,
		MillerIndex	index2
	)

This constructor is best explained by an example.

Arguments QX, (1,1,0), QY, (0,2,1) mean: Rotate the lattice such that the axis [110] points into x direction, and the axis [021], projected into the yz plane, points into z direction.

Definition at line 33 of file ILatticeOrientation.cpp.

    : m_prim_lattice(), m_q1(q1), m_q2(q2), m_ind1{index1}, m_ind2{index2}
{
    if (!checkAlignment())
        throw std::runtime_error("MillerIndexOrientation constructor: "
                                 "invalid alignment parameters");
}

References checkAlignment().

Referenced by clone().

Here is the call graph for this function:

~MillerIndexOrientation()

MillerIndexOrientation::~MillerIndexOrientation ( )

overridedefault

Member Function Documentation

clone()

MillerIndexOrientation * MillerIndexOrientation::clone ( ) const

overridevirtual

Implements ILatticeOrientation.

Definition at line 44 of file ILatticeOrientation.cpp.

{
    auto* result = new MillerIndexOrientation(m_q1, m_ind1, m_q2, m_ind2);
    result->usePrimitiveLattice(m_prim_lattice);
    return result;
}

References m_ind1, m_ind2, m_prim_lattice, m_q1, m_q2, and MillerIndexOrientation().

Here is the call graph for this function:

usePrimitiveLattice()

void MillerIndexOrientation::usePrimitiveLattice ( const Lattice &  lattice )

overridevirtual

Implements ILatticeOrientation.

Definition at line 53 of file ILatticeOrientation.cpp.

{
    m_prim_lattice.resetBasis(lattice.getBasisVectorA(), lattice.getBasisVectorB(),
                              lattice.getBasisVectorC());
}

References Lattice::getBasisVectorA(), Lattice::getBasisVectorB(), Lattice::getBasisVectorC(), m_prim_lattice, and Lattice::resetBasis().

Here is the call graph for this function:

transformationMatrix()

Transform3D MillerIndexOrientation::transformationMatrix ( ) const

overridevirtual

Implements ILatticeOrientation.

Definition at line 59 of file ILatticeOrientation.cpp.

{
    auto dir_1 = m_prim_lattice.getMillerDirection(m_ind1.h, m_ind1.k, m_ind1.l);
    auto dir_2 = m_prim_lattice.getMillerDirection(m_ind2.h, m_ind2.k, m_ind2.l);
    auto dir_2_parallel = dir_2.project(dir_1);
    dir_2 = (dir_2 - dir_2_parallel).unit();
    auto dir_3 = SignForCrossProduct(m_q1, m_q2) * dir_1.cross(dir_2);
    auto q3 = ThirdQComponent(m_q1, m_q2);
    Eigen::Matrix3d rot_matrix;
    FillVectorInRow(rot_matrix, dir_1, m_q1);
    FillVectorInRow(rot_matrix, dir_2, m_q2);
    FillVectorInRow(rot_matrix, dir_3, q3);
    return Transform3D(rot_matrix);
}

References anonymous_namespace{ILatticeOrientation.cpp}::FillVectorInRow(), Lattice::getMillerDirection(), MillerIndex::h, MillerIndex::k, MillerIndex::l, m_ind1, m_ind2, m_prim_lattice, m_q1, m_q2, BasicVector3D< T >::project(), anonymous_namespace{ILatticeOrientation.cpp}::SignForCrossProduct(), and anonymous_namespace{ILatticeOrientation.cpp}::ThirdQComponent().

Here is the call graph for this function:

checkAlignment()

bool MillerIndexOrientation::checkAlignment ( ) const

private

Definition at line 74 of file ILatticeOrientation.cpp.

{
    if (m_q1 == m_q2)
        return false;
    if (!ValidMillerIndex(m_ind1) || !ValidMillerIndex(m_ind2))
        return false;
    if (ParallelMillerIndices(m_ind1, m_ind2))
        return false;
    return true;
}

References m_ind1, m_ind2, m_q1, m_q2, anonymous_namespace{ILatticeOrientation.cpp}::ParallelMillerIndices(), and anonymous_namespace{ILatticeOrientation.cpp}::ValidMillerIndex().

Referenced by MillerIndexOrientation().

Here is the call graph for this function:

Member Data Documentation

m_prim_lattice

Lattice MillerIndexOrientation::m_prim_lattice

private

Definition at line 61 of file ILatticeOrientation.h.

Referenced by clone(), transformationMatrix(), and usePrimitiveLattice().

m_q1

QComponent MillerIndexOrientation::m_q1

private

Definition at line 62 of file ILatticeOrientation.h.

Referenced by checkAlignment(), clone(), and transformationMatrix().

m_q2

QComponent MillerIndexOrientation::m_q2

private

Definition at line 62 of file ILatticeOrientation.h.

Referenced by checkAlignment(), clone(), and transformationMatrix().

m_ind1

MillerIndex MillerIndexOrientation::m_ind1

private

Definition at line 63 of file ILatticeOrientation.h.

Referenced by checkAlignment(), clone(), and transformationMatrix().

m_ind2

MillerIndex MillerIndexOrientation::m_ind2

private

Definition at line 63 of file ILatticeOrientation.h.

Referenced by checkAlignment(), clone(), and transformationMatrix().

---

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

• /home/www/ba/Sample/Lattice/ILatticeOrientation.h
• /home/www/ba/Sample/Lattice/ILatticeOrientation.cpp