Superlattice.hh

Go to the documentation of this file.

#ifndef XTAL_SUPERLATTICE_HH
#define XTAL_SUPERLATTICE_HH
 
#include <casm/crystallography/Lattice.hh>
 
namespace CASM {
namespace xtal {
class Superlattice {
 private:
  Lattice m_primitive_lattice;
  Lattice m_superlattice;
  Eigen::Matrix3l m_transformation_matrix_to_super;
 
  Index m_size;
 
 public:
  const Lattice &superlattice() const { return m_superlattice; }
 
  const Lattice &prim_lattice() const { return m_primitive_lattice; }
 
  const Eigen::Matrix3l &transformation_matrix_to_super() const {
    return m_transformation_matrix_to_super;
  }
 
  Index size() const { return m_size; }
 
  Superlattice(const Lattice &tiling_unit, const Lattice &superlattice);
  Superlattice(const Lattice &tiling_unit,
               const Eigen::Matrix3l &transformation_matrix);
 
  static Superlattice smooth_prim(const Lattice &tiling_unit,
                                  const Lattice &superlattice);
 
  // TODO: Implement the day you need it.
  /* static Superlattice smooth_superlattice(const Lattice &tiling_unit, const
   * Lattice &superlattice); */
};
 
}  // namespace xtal
}  // namespace CASM
 
#endif