CASM::LatticeEnumEquivalents Class Reference

#include <LatticeEnumEquivalents.hh>

Inheritance diagram for CASM::LatticeEnumEquivalents:

Detailed Description

Enumerate equivalent Lattics, given a SymGroup.

• The 'begin' Lattice is always the canonical form, with respect to the specified SymGroup

Definition at line 20 of file LatticeEnumEquivalents.hh.

Public Types
typedef InputEnumIterator < Lattice, IsConst >	iterator
typedef Lattice	value_type
typedef CASM_TMP::ConstSwitch < IsConst, Lattice > &	reference
typedef long	step_type

Public Member Functions
	LatticeEnumEquivalents (const Lattice &lat, const SymGroup &super_g, double tol)
	Constructor. More...
std::string	name () const override
	Derived enumerators must implement name, via ENUM_MEMBERS. More...
const Lattice &	generator () const
const SymOp &	sym_op () const
const std::vector< SymOp > &	invariant_subgroup () const
iterator	begin ()
iterator	end ()
reference	current () const
	Access the current ObjectType by reference. More...
step_type	step () const
	Increments with each enumerated object. More...
bool	valid () const
	Returns false if enumeration is complete. More...
virtual jsonParser	source (step_type step) const

Static Public Attributes
static const std::string	enumerator_name = "LatticeEnumEquivalents"

Protected Member Functions
void	_initialize (value_type *_initial)
void	_initialize ()
void	_set_current_ptr (value_type *_new)
	Change the pointer. More...
value_type &	_current ()
	Access the current ObjectType by reference. More...
void	_set_step (step_type val)
	Set current step value. More...
void	_increment_step ()
	Increment current step value. More...
void	_decrement_step ()
	Decrement current step value. More...
void	_invalidate ()
	Call if enumeration complete. More...
void	_validate ()
	Used if random access enumerator step is moved into valid range. More...

Member Typedef Documentation

typedef InputEnumIterator<Lattice , IsConst> CASM::InputEnumeratorBase< Lattice , IsConst >::iterator

inherited

Definition at line 231 of file InputEnumerator.hh.

typedef CASM_TMP::ConstSwitch<IsConst, Lattice >& CASM::ValEnumerator< Lattice , IsConst >::reference

inherited

Definition at line 192 of file Enumerator.hh.

typedef long CASM::EnumeratorBase::step_type

inherited

Definition at line 103 of file Enumerator.hh.

typedef Lattice CASM::ValEnumerator< Lattice , IsConst >::value_type

inherited

Definition at line 191 of file Enumerator.hh.

Constructor & Destructor Documentation

CASM::LatticeEnumEquivalents::LatticeEnumEquivalents	(	const Lattice &	lat,
		const SymGroup &	super_g,
		double	tol
	)

Constructor.

Parameters

lat	Lattice to generate equivalents of
super_g	The super group to use to generate equivalents. Must have a valid MasterSymGroup.
tol	Tolerance used for checking equivalence

Exceptions

std::runtime_error

if super_g does not have a MasterSymGroup

Definition at line 36 of file LatticeEnumEquivalents.cc.

Member Function Documentation

value_type& CASM::ValEnumerator< Lattice , IsConst >::_current ( )

inlineprotectedinherited

Access the current ObjectType by reference.

Definition at line 244 of file Enumerator.hh.

void CASM::EnumeratorBase::_decrement_step ( )

inlineprotectedinherited

Decrement current step value.

Definition at line 164 of file Enumerator.hh.

void CASM::EnumeratorBase::_increment_step ( )

inlineprotectedinherited

Increment current step value.

Definition at line 159 of file Enumerator.hh.

void CASM::EnumeratorBase::_initialize ( )

inlineprotectedinherited

Initialize

• Sets step to 0
• Sets valid to true

Definition at line 148 of file Enumerator.hh.

void CASM::ValEnumerator< Lattice , IsConst >::_initialize ( value_type *  _initial )

inlineprotectedinherited

Initialize

• Sets current to point at _initial
• Sets step to 0
• Sets valid to true

Definition at line 216 of file Enumerator.hh.

void CASM::EnumeratorBase::_invalidate ( )

inlineprotectedinherited

Call if enumeration complete.

Definition at line 169 of file Enumerator.hh.

void CASM::ValEnumerator< Lattice , IsConst >::_set_current_ptr ( value_type *  _new )

inlineprotectedinherited

Change the pointer.

Definition at line 239 of file Enumerator.hh.

void CASM::EnumeratorBase::_set_step ( step_type  val )

inlineprotectedinherited

Set current step value.

Definition at line 154 of file Enumerator.hh.

void CASM::EnumeratorBase::_validate ( )

inlineprotectedinherited

Used if random access enumerator step is moved into valid range.

Definition at line 174 of file Enumerator.hh.

iterator CASM::InputEnumeratorBase< Lattice , IsConst >::begin ( )

inlineinherited

Definition at line 245 of file InputEnumerator.hh.

reference CASM::ValEnumerator< Lattice , IsConst >::current ( ) const

inlineinherited

Access the current ObjectType by reference.

Definition at line 232 of file Enumerator.hh.

iterator CASM::InputEnumeratorBase< Lattice , IsConst >::end ( )

inlineinherited

Definition at line 249 of file InputEnumerator.hh.

const Lattice & CASM::EnumEquivalents< Lattice , Array< SymOp >::const_iterator , SymOp , SymRepIndexCompare >::generator ( ) const

inlineinherited

Definition at line 107 of file EnumEquivalents.hh.

const std::vector<SymOp >& CASM::EnumEquivalents< Lattice , Array< SymOp >::const_iterator , SymOp , SymRepIndexCompare >::invariant_subgroup ( ) const

inlineinherited

Definition at line 115 of file EnumEquivalents.hh.

std::string CASM::LatticeEnumEquivalents::name ( ) const

inlineoverridevirtual

Derived enumerators must implement name, via ENUM_MEMBERS.

Implements CASM::EnumeratorBase.

Definition at line 26 of file LatticeEnumEquivalents.hh.

virtual jsonParser CASM::EnumeratorBase::source ( step_type  step ) const

inlinevirtualinherited

Default Object source just uses step#

Returns:

{
  "enumerated_by": "<enumerator_type>",
  "step": <step #>
}

Definition at line 131 of file Enumerator.hh.

step_type CASM::EnumeratorBase::step ( ) const

inlineinherited

Increments with each enumerated object.

Definition at line 113 of file Enumerator.hh.

const SymOp & CASM::EnumEquivalents< Lattice , Array< SymOp >::const_iterator , SymOp , SymRepIndexCompare >::sym_op ( ) const

inlineinherited

Definition at line 111 of file EnumEquivalents.hh.

bool CASM::EnumeratorBase::valid ( ) const

inlineinherited

Returns false if enumeration is complete.

Definition at line 118 of file Enumerator.hh.

Member Data Documentation

const std::string CASM::LatticeEnumEquivalents::enumerator_name = "LatticeEnumEquivalents"

static

Definition at line 30 of file LatticeEnumEquivalents.hh.

---

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

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