Documentation of Phonon Lifetime Package

This is a Python package.

phonon_lifetime

• phonon_lifetime package
  • System
    • System.as_pristine()
    • System.get_mode()
    • System.get_modes()
    • System.masses
    • System.n_atoms
    • System.n_primitive_atoms
    • System.n_repeats
    • System.primitive_atom_fractions
    • System.primitive_cell
    • System.strain_tensor
    • System.symbols
  • Subpackages
    • phonon_lifetime.defect package
      • MassDefect
      • MassDefectMode
      • MassDefectModes
      • MassDefectSystem
      • VacancyDefect
      • VacancyMode
      • VacancyModes
      • VacancySystem
    • phonon_lifetime.modes package
      • CanonicalMode
      • NormalMode
      • NormalModes
      • animate_mode_1d_x()
      • animate_mode_xy()
      • animate_mode_xyz()
      • get_mode_displacement()
      • plot_mode_1d_x()
      • plot_mode_xy()
      • plot_mode_xyz()
      • repeat_mode()
      • repeat_modes()
    • phonon_lifetime.pristine package
      • PristineMode
      • PristineModes
      • PristineSystem
      • plot_dispersion_1d()
      • plot_dispersion_2d_xy()
      • with_ase_forces()
      • with_nearest_neighbor_forces()
    • phonon_lifetime.system package
      • RepeatSystem
      • System
      • as_ase_atoms()
      • as_primitive()
      • get_atom_centres()
      • get_atom_fractions()
      • get_atom_supercell_fractions()
      • get_supercell_cell()
      • plot_xy()
      • plot_xyz()
      • Submodules
      • phonon_lifetime.system.build module
  • Submodules
  • phonon_lifetime.forces module
    • PristineStrainTensor
      • PristineStrainTensor.calculate_full_tensor()
      • PristineStrainTensor.calculate_pristine_tensor()
      • PristineStrainTensor.data
      • PristineStrainTensor.n_primitive_atoms
      • PristineStrainTensor.n_repeats
    • zero_strain_tensor()
  • phonon_lifetime.lifetimes module
    • calculate_decay_rates()
    • calculate_finite_time_rates()
    • calculate_survival_probabilities()
    • calculate_survival_probability()
    • get_first_order_scatter()
    • get_state_overlap()
    • get_state_overlap_matrix()
    • plot_first_order_scatter()
    • plot_first_order_scatter_against_qx()
    • plot_overlap_weights()
    • plot_survival_probability()
  • phonon_lifetime.wannier module
    • plot_wannier_vector()