CASM  1.1.0
A Clusters Approach to Statistical Mechanics
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
CASM::xtal::SymOp Struct Reference

#include <SymType.hh>

Detailed Description

Within the scope of crystallography, this struct will serve as the symmetry object, which holds a transformation matrix, translation vector, and time reversal boolean, whithout any other overhead.

Definition at line 22 of file SymType.hh.

Public Member Functions

 SymOp (const SymOpMatrixType &mat, const SymOpTranslationType &translation, SymOpTimeReversalType time_reversal)
 

Static Public Member Functions

static SymOp identity ()
 
static SymOp time_reversal ()
 
static SymOp translation_operation (const SymOpTranslationType &translation)
 
static SymOp point_operation (const SymOpMatrixType &mat)
 

Public Attributes

SymOpMatrixType matrix
 
SymOpTranslationType translation
 
SymOpTimeReversalType is_time_reversal_active
 

Constructor & Destructor Documentation

◆ SymOp()

CASM::xtal::SymOp::SymOp ( const SymOpMatrixType &  mat,
const SymOpTranslationType &  translation,
SymOpTimeReversalType  time_reversal 
)
inline

Definition at line 23 of file SymType.hh.

Member Function Documentation

◆ identity()

static SymOp CASM::xtal::SymOp::identity ( )
inlinestatic

Definition at line 29 of file SymType.hh.

◆ point_operation()

static SymOp CASM::xtal::SymOp::point_operation ( const SymOpMatrixType &  mat)
inlinestatic

Definition at line 43 of file SymType.hh.

◆ time_reversal()

static SymOp CASM::xtal::SymOp::time_reversal ( )
inlinestatic

Definition at line 34 of file SymType.hh.

◆ translation_operation()

static SymOp CASM::xtal::SymOp::translation_operation ( const SymOpTranslationType &  translation)
inlinestatic

Definition at line 39 of file SymType.hh.

Member Data Documentation

◆ is_time_reversal_active

SymOpTimeReversalType CASM::xtal::SymOp::is_time_reversal_active

Definition at line 49 of file SymType.hh.

◆ matrix

SymOpMatrixType CASM::xtal::SymOp::matrix

Definition at line 47 of file SymType.hh.

◆ translation

SymOpTranslationType CASM::xtal::SymOp::translation

Definition at line 48 of file SymType.hh.

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