pythtb.Mesh.loop#

Mesh.loop(axis_idx, component_idx, winds_bz=False, closed=False)[source]#

Declare an axis loops a specified component of the mesh vector.

Calling this function will mark an axis as looping a given component of the vector in \((\mathbf{k}, \lambda)\)-space. This means that the two ends of the axis are identified, and sampling along axis_idx loops component_idx around a cycle.

Parameters:

axis_idxint: The index of the axis to mark as looping.
component_idxint: The component of the vector to mark as looping.
winds_bzbool, optional: If True, also mark the axis as winding the BZ for this component. This requires that the axis is a k-axis and the component is a k-component. Default is False.
closedbool, optional: If True, also mark the axis as closed for this component. This means the two ends of the axis correspond to the same Hamiltonian. Default is False.

Notes

Setting winds_bz and closed allows WFArray to decide whether phases apply to k-components at the edge of the mesh (loop is closed) or just beyond the edge of the mesh (loop is open).