CASM
AClustersApproachtoStatisticalMechanics
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules
Public Member Functions | Private Attributes | List of all members
CASM::UnitCellCoord Class Reference

#include <UnitCellCoord.hh>

Detailed Description

Unit Cell Coordinates.

  • Represent a crystal site using UnitCell indices and sublattice index

Definition at line 51 of file UnitCellCoord.hh.

Public Member Functions

 UnitCellCoord ()
 
 UnitCellCoord (Index _sublat, const UnitCell &_unitcell)
 
 UnitCellCoord (Index _sublat, Index i, Index j, Index k)
 
template<typename CoordType , typename StrucType >
 UnitCellCoord (CoordType coord, const StrucType &struc, double tol)
 Construct from a Coordinate and StrucType with a StrucType::basis. More...
 
UnitCell & unitcell ()
 
const UnitCell & unitcell () const
 
Index & unitcell (Index i)
 
const Index & unitcell (Index i) const
 
Index & sublat ()
 
const Index & sublat () const
 
Index & operator[] (Index i)
 
const Index & operator[] (Index i) const
 
UnitCellCoord & operator+= (UnitCell frac)
 
UnitCellCoord & operator-= (UnitCell frac)
 

Private Attributes

UnitCell m_unitcell
 
Index m_sublat
 

Constructor & Destructor Documentation

CASM::UnitCellCoord::UnitCellCoord ( )
inline

Definition at line 55 of file UnitCellCoord.hh.

CASM::UnitCellCoord::UnitCellCoord ( Index  _sublat,
const UnitCell &  _unitcell 
)
inline

Definition at line 129 of file UnitCellCoord.hh.

CASM::UnitCellCoord::UnitCellCoord ( Index  _sublat,
Index  i,
Index  j,
Index  k 
)
inline

Definition at line 133 of file UnitCellCoord.hh.

template<typename CoordType , typename StrucType >
CASM::UnitCellCoord::UnitCellCoord ( CoordType  coord,
const StrucType &  struc,
double  tol 
)

Construct from a Coordinate and StrucType with a StrucType::basis.

Construct from a CoordType and StrucType.

Definition at line 139 of file UnitCellCoord.hh.

Member Function Documentation

UnitCellCoord & CASM::UnitCellCoord::operator+= ( UnitCell  frac)
inline

Definition at line 192 of file UnitCellCoord.hh.

UnitCellCoord & CASM::UnitCellCoord::operator-= ( UnitCell  frac)
inline

Definition at line 197 of file UnitCellCoord.hh.

Index & CASM::UnitCellCoord::operator[] ( Index  i)
inline

Definition at line 178 of file UnitCellCoord.hh.

const Index & CASM::UnitCellCoord::operator[] ( Index  i) const
inline

Definition at line 185 of file UnitCellCoord.hh.

Index & CASM::UnitCellCoord::sublat ( )
inline

Definition at line 170 of file UnitCellCoord.hh.

const Index & CASM::UnitCellCoord::sublat ( ) const
inline

Definition at line 174 of file UnitCellCoord.hh.

UnitCell & CASM::UnitCellCoord::unitcell ( )
inline

Definition at line 154 of file UnitCellCoord.hh.

const UnitCell & CASM::UnitCellCoord::unitcell ( ) const
inline

Definition at line 158 of file UnitCellCoord.hh.

Index & CASM::UnitCellCoord::unitcell ( Index  i)
inline

Definition at line 162 of file UnitCellCoord.hh.

const Index & CASM::UnitCellCoord::unitcell ( Index  i) const
inline

Definition at line 166 of file UnitCellCoord.hh.

Member Data Documentation

Index CASM::UnitCellCoord::m_sublat
private

Definition at line 85 of file UnitCellCoord.hh.

UnitCell CASM::UnitCellCoord::m_unitcell
private

Definition at line 84 of file UnitCellCoord.hh.

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