CASM  1.1.0
A Clusters Approach to Statistical Mechanics
CASM::xtal::LatticeIsEquivalent Class Reference

#include <LatticeIsEquivalent.hh>

Detailed Description

Lattice comparisons.

Does comparisons of the form: copy_apply(A, lat) ?= copy_apply(B, other)*U,

where lat and other are lattices, represented as column matrices A & B are symmetry operations U is a unimodular (3x3, integer, w/ abs(det(T))==1) transformation matrix

Definition at line 25 of file LatticeIsEquivalent.hh.

Public Member Functions

 LatticeIsEquivalent (const Lattice &_lat)
 
bool operator() (const Lattice &other, double tol=-1.) const
 Checks if lat = other*U, with unimodular U. More...
 
Eigen::Matrix3d U () const
 Returns U found for last check. More...
 

Private Attributes

Lattice m_lat
 
Eigen::Matrix3d m_U
 

Constructor & Destructor Documentation

◆ LatticeIsEquivalent()

CASM::xtal::LatticeIsEquivalent::LatticeIsEquivalent ( const Lattice _lat)

Definition at line 10 of file LatticeIsEquivalent.cc.

Member Function Documentation

◆ operator()()

bool CASM::xtal::LatticeIsEquivalent::operator() ( const Lattice other,
double  tol = -1. 
) const

Checks if lat = other*U, with unimodular U.

Checks if lat = other*U, with unimodular U, tolerance is relative, default tolerance is sentinal value to default to m_lat.tol()

Definition at line 13 of file LatticeIsEquivalent.cc.

◆ U()

Eigen::Matrix3d CASM::xtal::LatticeIsEquivalent::U ( ) const

Returns U found for last check.

Definition at line 20 of file LatticeIsEquivalent.cc.

Member Data Documentation

◆ m_lat

Lattice CASM::xtal::LatticeIsEquivalent::m_lat
private

Definition at line 37 of file LatticeIsEquivalent.hh.

◆ m_U

Eigen::Matrix3d CASM::xtal::LatticeIsEquivalent::m_U
mutableprivate

Definition at line 38 of file LatticeIsEquivalent.hh.


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