Edit on GitHub

Volumetric data files

Contents

Index

Read/write

WannierIO.read_xsf — Method
read_xsf(filename::AbstractString)

Read xsf file.

Return

  • primvec: 3 * 3, Å, each column is a primitive lattice vector
  • convvec: 3 * 3, Å, each column is a conventional lattice vector
  • atoms: n_atoms String, atomic symbols or numbers
  • atom_positions: 3 * n_atoms, Å, cartesian coordinates
  • origin: 3, Å, origin of the grid
  • span_vectors: 3 * 3, Å, each column is a spanning vector
  • X: nx, fractional coordinate of grid points along the first spanning vector
  • Y: ny, fractional coordinate of grid points along the second spanning vector
  • Z: nz, fractional coordinate of grid points along the third spanning vector
  • W: nx * ny * nz, volumetric data
Note

Only support reading 1 datagrid in BLOCK_DATAGRID_3D.

source
WannierIO.write_xsf — Method
write_xsf(filename, lattice, atom_positions, atom_numbers, origin, span_vectors, W)

Write xsf file.

Arguments

  • lattice: 3 * 3, Å, each column is a lattice vector
  • atom_positions: 3 * n_atoms, fractional coordinates
  • atom_numbers: n_atoms, atomic numbers
  • origin: 3, Å, origin of the grid
  • span_vectors: 3 * 3, Å, each column is a spanning vector
  • W: nx * ny * nz, volumetric data
source
WannierIO.read_bxsf — Method
read_bxsf(filename::AbstractString)

Read bxsf file.

Return

  • fermi_energy: Fermi energy in eV
  • origin: 3, Å⁻¹, origin of the grid
  • span_vectors: 3 * 3, Å⁻¹, each column is a spanning vector
  • X: nx, fractional coordinate of grid points along the first spanning vector
  • Y: ny, fractional coordinate of grid points along the second spanning vector
  • Z: nz, fractional coordinate of grid points along the third spanning vector
  • E: n_bands * nx * ny * nz, eigenvalues at each grid point
source
WannierIO.write_bxsf — Method
write_bxsf(
    filename::AbstractString,
    fermi_energy::T,
    origin::AbstractVector{T},
    span_vectors::AbstractMatrix{T},
    E::AbstractArray{T,4},
) where {T<:Real}

Write bxsf file.

Arguments

  • fermi_energy: Fermi energy in eV
  • origin: 3, Å⁻¹, origin of the grid
  • span_vectors: 3 * 3, Å⁻¹, each column is a spanning vector
  • E: n_bands * nx * ny * nz, eigenvalues at each grid point
source
WannierIO.read_cube — Method
read_cube(filename::AbstractString)

Read cube file.

Note

By default, cube use Bohr unit, here all returns are in Cartesian coordinates, Å unit.

source
WannierIO.write_cube — Method
write_cube(filename, filename, atom_positions, atom_numbers, origin, span_vectors, W)

Write cube file.

Arguments

  • atom_positions: 3 * n_atoms, Å, cartesian coordinates
  • atom_numbers: n_atoms, atomic numbers
  • origin: 3, Å, origin of the grid
  • span_vectors: 3 * 3, Å, each column is a spanning vector
  • W: nx * ny * nz, volumetric data
source