ThreeBodyTB.jl Documentation
A three-body tight binding program written in Julia
Primary Author: Kevin F. Garrity, NIST
ThreeBodyTB.jl is a package for tight-binding, written in Julia.
Package Features
- Run tight-binding calculations with near DFT level accuracy (PBEsol).
- Get results in seconds based on pre-fit parameters from across periodic table.
- Calculate band structures and total energies.
- Get forces, stresses, and relax structures.
- Parameters based on two- and three-body interactions.
- Includes self-consistent treatment of long-range Coulomb interaction.
- Plotting based on interface of Plots.jl
New features
- Larger and better tested set of coefficients
- Coefficients for three-atom interactions for thousands of common combinations
- Magnetism (set
nspin=2
inscf_energy
and similar functions) - Charged unit cells
- Sparse matrix implementation of many key functions
- Improved performance
User's guide
Index
ThreeBodyTB.Atomdata
ThreeBodyTB.AtomicMod
ThreeBodyTB.AtomicProj
ThreeBodyTB.BandTools
ThreeBodyTB.CalcTB
ThreeBodyTB.Classical
ThreeBodyTB.ClassicalFit
ThreeBodyTB.DFT
ThreeBodyTB.DFToutMod
ThreeBodyTB.Ewald
ThreeBodyTB.Force_Stress
ThreeBodyTB.ManageDatabase
ThreeBodyTB.QE
ThreeBodyTB.SCF
ThreeBodyTB.Utility
ThreeBodyTB.Atomdata.atom_prefered_oxidation
ThreeBodyTB.Atomdata.atom_radius
ThreeBodyTB.Atomdata.atoms
ThreeBodyTB.Atomdata.cutoff_dist
ThreeBodyTB.Atomdata.electronegativity
ThreeBodyTB.Atomdata.min_dimer_dist_dict
ThreeBodyTB.Atomdata.sub_list
ThreeBodyTB.AtomicMod.atom
ThreeBodyTB.AtomicProj.proj_dat
ThreeBodyTB.CalcTB.coefs
ThreeBodyTB.Classical.coefs_cl
ThreeBodyTB.CrystalMod.crystal
ThreeBodyTB.DFToutMod.bandstructure
ThreeBodyTB.DFToutMod.dftout
ThreeBodyTB.TB.tb
ThreeBodyTB.TB.tb_crys
ThreeBodyTB.TB.tb_crys_kspace
ThreeBodyTB.TB.tb_k
ThreeBodyTB.AtomicMod.makeatom
ThreeBodyTB.AtomicProj.create_tb
ThreeBodyTB.AtomicProj.get_ham_r
ThreeBodyTB.AtomicProj.get_ham_r_slow
ThreeBodyTB.AtomicProj.loadXML_proj
ThreeBodyTB.AtomicProj.makeOG
ThreeBodyTB.AtomicProj.make_commands
ThreeBodyTB.AtomicProj.make_proj
ThreeBodyTB.AtomicProj.make_projwfcx
ThreeBodyTB.AtomicProj.makedict_proj
ThreeBodyTB.AtomicProj.prepare_ham_k
ThreeBodyTB.AtomicProj.projwfc_workf
ThreeBodyTB.AtomicProj.run_og
ThreeBodyTB.AtomicProj.run_projwfcx
ThreeBodyTB.BandStruct.band_summary
ThreeBodyTB.BandStruct.band_summary
ThreeBodyTB.BandStruct.band_summary
ThreeBodyTB.BandStruct.band_summary
ThreeBodyTB.BandStruct.get_kpath
ThreeBodyTB.BandStruct.plot_bandstr
ThreeBodyTB.BandStruct.plot_bandstr
ThreeBodyTB.BandStruct.plot_bandstr
ThreeBodyTB.BandStruct.plot_bandstr_dos
ThreeBodyTB.BandStruct.plot_bandstr_dos
ThreeBodyTB.BandStruct.plot_bandstr_dos
ThreeBodyTB.BandStruct.plot_bandstr_sym
ThreeBodyTB.BandStruct.plot_bandstr_sym
ThreeBodyTB.BandStruct.plot_bandstr_sym
ThreeBodyTB.BandStruct.plot_compare_dft
ThreeBodyTB.BandStruct.plot_compare_dft
ThreeBodyTB.BandStruct.plot_compare_tb
ThreeBodyTB.BandStruct.plot_compare_tb
ThreeBodyTB.BandStruct.plot_compare_tb
ThreeBodyTB.BandStruct.run_dft_compare
ThreeBodyTB.BandStruct.setup_proj
ThreeBodyTB.BandTools.band_energy
ThreeBodyTB.BandTools.calc_fermi
ThreeBodyTB.BandTools.smearing_energy
ThreeBodyTB.CalcTB.calc_frontier
ThreeBodyTB.CalcTB.calc_onsite
ThreeBodyTB.CalcTB.calc_tb_LV_sparse
ThreeBodyTB.CalcTB.calc_tb_fast
ThreeBodyTB.CalcTB.calc_tb_prepare_fast
ThreeBodyTB.CalcTB.calc_threebody
ThreeBodyTB.CalcTB.calc_threebody_onsite
ThreeBodyTB.CalcTB.calc_twobody
ThreeBodyTB.CalcTB.calc_twobody_faster
ThreeBodyTB.CalcTB.calc_twobody_onsite
ThreeBodyTB.CalcTB.fit_threebody
ThreeBodyTB.CalcTB.fit_threebody_onsite
ThreeBodyTB.CalcTB.fit_twobody
ThreeBodyTB.CalcTB.fit_twobody_onsite
ThreeBodyTB.CalcTB.get_data_info_v1
ThreeBodyTB.CalcTB.get_data_info_v2
ThreeBodyTB.CalcTB.laguerre
ThreeBodyTB.CalcTB.make_coefs
ThreeBodyTB.CalcTB.plot_database
ThreeBodyTB.CalcTB.read_coefs
ThreeBodyTB.CalcTB.renormalize_S
ThreeBodyTB.CalcTB.symmetry_factor_fit
ThreeBodyTB.CalcTB.symmetry_factor_int
ThreeBodyTB.CalcTB.three_body_H
ThreeBodyTB.CalcTB.three_body_O
ThreeBodyTB.CalcTB.trim_dist
ThreeBodyTB.CalcTB.two_body_H
ThreeBodyTB.CalcTB.two_body_O
ThreeBodyTB.CalcTB.two_body_S
ThreeBodyTB.CalcTB.write_coefs
ThreeBodyTB.Classical.calc_energy_cl
ThreeBodyTB.Classical.core_4_cl_laguerre_fast_fourbdy_cl!
ThreeBodyTB.Classical.energy_force_stress_cl
ThreeBodyTB.Classical.make_coefs_cl
ThreeBodyTB.Classical.read_coefs_cl
ThreeBodyTB.Classical.write_coefs_cl
ThreeBodyTB.ClassicalFit.do_fit_cl
ThreeBodyTB.ClassicalFit.do_fit_cl
ThreeBodyTB.ClassicalFit.do_fit_cl_RECURSIVE
ThreeBodyTB.ClassicalFit.kfold
ThreeBodyTB.CrystalMod.generate_optimum_supercell
ThreeBodyTB.CrystalMod.generate_random_distortion
ThreeBodyTB.CrystalMod.generate_supercell
ThreeBodyTB.CrystalMod.get_grid
ThreeBodyTB.CrystalMod.makecrys
ThreeBodyTB.CrystalMod.orbital_index
ThreeBodyTB.CrystalMod.parsePOSCAR
ThreeBodyTB.CrystalMod.parseQEinput
ThreeBodyTB.CrystalMod.write_efs
ThreeBodyTB.CrystalMod.write_poscar
ThreeBodyTB.DFT.runSCF
ThreeBodyTB.DFToutMod.get_atomize_energy
ThreeBodyTB.DFToutMod.makebs
ThreeBodyTB.DFToutMod.makedftout
ThreeBodyTB.DFToutMod.makedftout
ThreeBodyTB.DOS.dos
ThreeBodyTB.DOS.dos
ThreeBodyTB.DOS.dos_realspace
ThreeBodyTB.DOS.dos_realspace
ThreeBodyTB.DOS.dos_tetra
ThreeBodyTB.DOS.gaussian_dos
ThreeBodyTB.DOS.plot_dos
ThreeBodyTB.DOS.plot_dos_flip
ThreeBodyTB.DOS.projection
ThreeBodyTB.DOS.setup_tetra
ThreeBodyTB.Ewald.electrostatics_getgamma
ThreeBodyTB.Ewald.estimate_best_kappa
ThreeBodyTB.Ewald.getU
ThreeBodyTB.Ewald.get_onsite
ThreeBodyTB.Ewald.k_space
ThreeBodyTB.Ewald.k_space_LV
ThreeBodyTB.Ewald.real_space
ThreeBodyTB.FitTB.do_fitting
ThreeBodyTB.FitTB.do_fitting_linear
ThreeBodyTB.FitTB.do_fitting_recursive
ThreeBodyTB.FitTB.extract_database
ThreeBodyTB.FitTB.fourierspace
ThreeBodyTB.FitTB.get_k
ThreeBodyTB.FitTB.hermetian_index
ThreeBodyTB.FitTB.make_database
ThreeBodyTB.FitTB.prepare_for_fitting
ThreeBodyTB.Force_Stress.finite_diff
ThreeBodyTB.Force_Stress.get_energy_force_stress
ThreeBodyTB.Force_Stress.get_energy_force_stress_NOFFT
ThreeBodyTB.Force_Stress.get_energy_force_stress_fft
ThreeBodyTB.Force_Stress.get_energy_force_stress_fft_LV
ThreeBodyTB.Force_Stress.get_energy_force_stress_fft_LV_sym
ThreeBodyTB.Force_Stress.get_energy_force_stress_fft_LV_sym_SINGLE
ThreeBodyTB.Force_Stress.safe_mode_energy
ThreeBodyTB.Force_Stress.sparsify_jac
ThreeBodyTB.ManageDatabase.add_to_database
ThreeBodyTB.ManageDatabase.clear_database
ThreeBodyTB.ManageDatabase.prepare_database
ThreeBodyTB.ManageDatabase.prepare_database
ThreeBodyTB.QE.doclean
ThreeBodyTB.QE.loadXML
ThreeBodyTB.QE.loadXML_bs
ThreeBodyTB.QE.loadXML_bs
ThreeBodyTB.QE.make_commands
ThreeBodyTB.QE.makedict
ThreeBodyTB.QE.runSCF
ThreeBodyTB.QE.run_pwscf
ThreeBodyTB.SCF.remove_scf_from_tbc
ThreeBodyTB.SCF.remove_scf_from_tbc
ThreeBodyTB.SCF.remove_scf_from_tbc
ThreeBodyTB.SCF.scf_energy
ThreeBodyTB.SCF.scf_energy
ThreeBodyTB.SCF.scf_energy
ThreeBodyTB.Symmetry.get_kpath_sym
ThreeBodyTB.Symmetry.get_standard_crys
ThreeBodyTB.Symmetry.get_standard_crys
ThreeBodyTB.Symmetry.get_symmetry
ThreeBodyTB.Symmetry.get_symmetry
ThreeBodyTB.Symmetry.kassemble
ThreeBodyTB.TB.Hk
ThreeBodyTB.TB.calc_bands
ThreeBodyTB.TB.calc_energy
ThreeBodyTB.TB.calc_energy_charge_fft
ThreeBodyTB.TB.calc_energy_fft
ThreeBodyTB.TB.ewald_energy
ThreeBodyTB.TB.find_vbm_cbm
ThreeBodyTB.TB.get_dq
ThreeBodyTB.TB.get_energy_electron_density_kspace
ThreeBodyTB.TB.get_sym_R
ThreeBodyTB.TB.load_hr_dat
ThreeBodyTB.TB.make_kgrid
ThreeBodyTB.TB.make_tb
ThreeBodyTB.TB.make_tb_crys
ThreeBodyTB.TB.make_tb_crys_kspace
ThreeBodyTB.TB.make_tb_k
ThreeBodyTB.TB.myfft
ThreeBodyTB.TB.myfft_R_to_K
ThreeBodyTB.TB.organizedata
ThreeBodyTB.TB.read_tb_crys
ThreeBodyTB.TB.read_tb_crys_kspace
ThreeBodyTB.TB.tb_indexes
ThreeBodyTB.TB.trim
ThreeBodyTB.TB.types_energy
ThreeBodyTB.TB.write_tb_crys
ThreeBodyTB.TB.write_tb_crys_kspace
ThreeBodyTB.Utility.inv_reshape_vec
ThreeBodyTB.Utility.reshape_vec
ThreeBodyTB.relax_structure
ThreeBodyTB.scf_energy
ThreeBodyTB.scf_energy_force_stress
ThreeBodyTB.set_bin_dirs
ThreeBodyTB.set_units