pythtb.Mesh.is_k_torus#

property Mesh.is_k_torus#

Does the mesh wind around the BZ in all k-directions?

A torus mesh has an axis for each k-dimension and winds around the BZ in each k-direction.

Notes

  • This only considers the k-space axes/dimensions. Non-periodic lambda axes will not affect the periodicity of the k-axes.

  • If the mesh is not a grid, this will always return False.

  • If the number of k-axes is less than dim_k, this will return False.

  • If the number of k-axes is equal to dim_k but not all k-axes wind around the BZ, this will return False.