tbplas.merge_prim_cell

tbplas.merge_prim_cell(*args: Union[PrimitiveCell, PCInterHopping]) → PrimitiveCell

Merge primitive cells and inter-hopping dictionaries to build a large primitive cell.

Parameters:

args – primitive cells and inter-hopping terms within the large primitive cell

Returns:

merged primitive cell

Raises:

• ValueError – if no arg is given, or any arg is not instance of PrimitiveCell or PCInterHopping, or any inter_hop_dict involves primitive cells not included in args, or lattice vectors of primitive cells do not match

• PCOrbIndexError – if any orbital index in any inter_hop_dict is out of range