PAOFLOW.spectrum.kpnts_interpolation_mesh#
Attributes#
Functions#
|
Build the k-point path for band structure interpolation. |
|
Compute Cartesian k-path points between high-symmetry points. |
Module Contents#
- PAOFLOW.spectrum.kpnts_interpolation_mesh.kpnts_interpolation_mesh(data_controller)[source]#
Build the k-point path for band structure interpolation.
- Parameters:
data_controller (DataController) – Object providing
data_arraysanddata_attributes. Required arrays:a_vectors,b_vectors,high_sym_points. Required attributes:nk,alat,ibrav,band_path.- Returns:
Modifies
data_arraysin place:kq: np.ndarray, shape(3, nkpath)— k-path points in crystal coordinates.
Also writes
kpath_points.txtviaDataController.write_kpnts_path().- Return type:
None
- PAOFLOW.spectrum.kpnts_interpolation_mesh.get_path(ibrav, alat, cell, dk, b_vectors, band_path, special_points)[source]#
Compute Cartesian k-path points between high-symmetry points.
- Parameters:
ibrav (int) – Quantum ESPRESSO Bravais lattice index.
alat (float) – Lattice constant (Bohr).
cell (np.ndarray, shape
(3, 3)) – Lattice vectors (rows) in units ofalat.dk (float) – Spacing between consecutive k-points along each segment (in crystal coordinates).
b_vectors (np.ndarray, shape
(3, 3)) – Reciprocal lattice vectors (rows) in units of2π/alat.band_path (str or None) – Hyphen/pipe-separated path string (e.g.
'G-X|M-R'). IfNone, the default path foribravis used.special_points (dict or None) – Mapping of point labels to crystal-coordinate arrays. If
None, the default points foribravare used.
- Returns:
points (np.ndarray, shape
(3, nkpath)) – k-path points in Cartesian coordinates (units of2π/alat).path_file (str) – Formatted string describing the k-path for file output.