CASM::CanonicalGenerator< _OrbitType > Struct Template Reference

#include <OrbitGeneration.hh>

Detailed Description

template<typename _OrbitType>
struct CASM::CanonicalGenerator< _OrbitType >

Functor to find the canonical generating element for an orbit.

• Uses generating SymGroup, SymCompareType::prepare, SymCompareType::compare

Definition at line 109 of file OrbitGeneration.hh.

Public Types
typedef _OrbitType	OrbitType
typedef OrbitType::Element	Element
typedef OrbitType::SymCompareType	SymCompareType

Public Member Functions
	CanonicalGenerator (const std::vector< SymOp > &_generating_group, const SymCompareType &_sym_compare)
Element	operator() (const Element &e) const
	Applies symmetry to return an equivalent Element in a canonical form. More...
const SymOp &	to_canonical () const
	After using call operator, this can be checked. More...
const SymOp &	from_canonical () const
	After using call operator, this can be checked. More...

Public Attributes
const std::vector< SymOp > &	generating_group
const SymCompareType &	sym_compare

Private Attributes
const SymOp *	m_to_canonical

Member Typedef Documentation

Element

template<typename _OrbitType >

typedef OrbitType::Element CASM::CanonicalGenerator< _OrbitType >::Element

Definition at line 111 of file OrbitGeneration.hh.

OrbitType

template<typename _OrbitType >

typedef _OrbitType CASM::CanonicalGenerator< _OrbitType >::OrbitType

Definition at line 110 of file OrbitGeneration.hh.

SymCompareType

template<typename _OrbitType >

typedef OrbitType::SymCompareType CASM::CanonicalGenerator< _OrbitType >::SymCompareType

Definition at line 112 of file OrbitGeneration.hh.

Constructor & Destructor Documentation

CanonicalGenerator()

template<typename _OrbitType >

CASM::CanonicalGenerator< _OrbitType >::CanonicalGenerator	(	const std::vector< SymOp > &	_generating_group,
		const SymCompareType &	_sym_compare
	)

Definition at line 88 of file OrbitGeneration_impl.hh.

Member Function Documentation

from_canonical()

template<typename _OrbitType >

const SymOp & CASM::CanonicalGenerator< _OrbitType >::from_canonical

After using call operator, this can be checked.

Definition at line 118 of file OrbitGeneration_impl.hh.

operator()()

template<typename _OrbitType >

CanonicalGenerator< _OrbitType >::Element CASM::CanonicalGenerator< _OrbitType >::operator()

(

const Element &

e

)

const

Applies symmetry to return an equivalent Element in a canonical form.

Definition at line 98 of file OrbitGeneration_impl.hh.

to_canonical()

template<typename _OrbitType >

const SymOp & CASM::CanonicalGenerator< _OrbitType >::to_canonical

After using call operator, this can be checked.

Definition at line 112 of file OrbitGeneration_impl.hh.

Member Data Documentation

generating_group

template<typename _OrbitType >

const std::vector<SymOp>& CASM::CanonicalGenerator< _OrbitType >::generating_group

Definition at line 114 of file OrbitGeneration.hh.

m_to_canonical

template<typename _OrbitType >

const SymOp* CASM::CanonicalGenerator< _OrbitType >::m_to_canonical

mutableprivate

Definition at line 131 of file OrbitGeneration.hh.

sym_compare

template<typename _OrbitType >

const SymCompareType& CASM::CanonicalGenerator< _OrbitType >::sym_compare

Definition at line 115 of file OrbitGeneration.hh.

---

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

• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/symmetry/OrbitGeneration.hh
• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/symmetry/OrbitGeneration_impl.hh