CASM::xtal::Superlattice Class Reference

#include <Superlattice.hh>

Detailed Description

Definition at line 8 of file Superlattice.hh.

Public Member Functions
const Lattice &	superlattice () const
const Lattice &	prim_lattice () const
const Eigen::Matrix3l &	transformation_matrix_to_super () const
Index	size () const
	Superlattice (const Lattice &tiling_unit, const Lattice &superlattice)
	Superlattice (const Lattice &tiling_unit, const Eigen::Matrix3l &transformation_matrix)

Static Public Member Functions
static Superlattice	smooth_prim (const Lattice &tiling_unit, const Lattice &superlattice)

Private Attributes
Lattice	m_primitive_lattice
Lattice	m_superlattice
Eigen::Matrix3l	m_transformation_matrix_to_super
	Integer matrix that convers the primitive lattice into the superlattice. More...
Index	m_size

Constructor & Destructor Documentation

Superlattice() [1/2]

CASM::xtal::Superlattice::Superlattice	(	const Lattice &	tiling_unit,
		const Lattice &	superlattice
	)

Definition at line 5 of file Superlattice.cc.

Superlattice() [2/2]

CASM::xtal::Superlattice::Superlattice	(	const Lattice &	tiling_unit,
		const Eigen::Matrix3l &	transformation_matrix
	)

Definition at line 14 of file Superlattice.cc.

Member Function Documentation

prim_lattice()

const Lattice& CASM::xtal::Superlattice::prim_lattice ( ) const

inline

Definition at line 20 of file Superlattice.hh.

size()

Index CASM::xtal::Superlattice::size ( ) const

inline

Returns the number of tiling units (primitive lattices) that fit inside the superlattice

Definition at line 30 of file Superlattice.hh.

smooth_prim()

Superlattice CASM::xtal::Superlattice::smooth_prim ( const Lattice &  tiling_unit, const Lattice &  superlattice  )

static

Constructs by taking the superlattice vectors to be the correct values, and then uses the rounded integer transformation matrix to slightly modify the primitive lattice so that it exactly transforms under the transformation matrix

Definition at line 22 of file Superlattice.cc.

superlattice()

const Lattice& CASM::xtal::Superlattice::superlattice ( ) const

inline

Definition at line 18 of file Superlattice.hh.

transformation_matrix_to_super()

const Eigen::Matrix3l& CASM::xtal::Superlattice::transformation_matrix_to_super ( ) const

inline

The integer transformation matrix that converts the tiling unit (primitive lattice) into the superlattice

Definition at line 24 of file Superlattice.hh.

Member Data Documentation

m_primitive_lattice

Lattice CASM::xtal::Superlattice::m_primitive_lattice

private

Definition at line 10 of file Superlattice.hh.

m_size

Index CASM::xtal::Superlattice::m_size

private

Definition at line 15 of file Superlattice.hh.

m_superlattice

Lattice CASM::xtal::Superlattice::m_superlattice

private

Definition at line 11 of file Superlattice.hh.

m_transformation_matrix_to_super

Eigen::Matrix3l CASM::xtal::Superlattice::m_transformation_matrix_to_super

private

Integer matrix that convers the primitive lattice into the superlattice.

Definition at line 13 of file Superlattice.hh.

---

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

• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/crystallography/Superlattice.hh
• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/src/casm/crystallography/Superlattice.cc