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=2inscf_energyand similar functions) - Charged unit cells
- Sparse matrix implementation of many key functions
- Improved performance
User's guide
Index
ThreeBodyTB.AtomdataThreeBodyTB.AtomicModThreeBodyTB.AtomicProjThreeBodyTB.BandToolsThreeBodyTB.CalcTBThreeBodyTB.ClassicalThreeBodyTB.ClassicalFitThreeBodyTB.DFTThreeBodyTB.DFToutModThreeBodyTB.EwaldThreeBodyTB.Force_StressThreeBodyTB.ManageDatabaseThreeBodyTB.QEThreeBodyTB.SCFThreeBodyTB.UtilityThreeBodyTB.Atomdata.atom_prefered_oxidationThreeBodyTB.Atomdata.atom_radiusThreeBodyTB.Atomdata.atomsThreeBodyTB.Atomdata.cutoff_distThreeBodyTB.Atomdata.electronegativityThreeBodyTB.Atomdata.min_dimer_dist_dictThreeBodyTB.Atomdata.sub_listThreeBodyTB.AtomicMod.atomThreeBodyTB.AtomicProj.proj_datThreeBodyTB.CalcTB.coefsThreeBodyTB.Classical.coefs_clThreeBodyTB.CrystalMod.crystalThreeBodyTB.DFToutMod.bandstructureThreeBodyTB.DFToutMod.dftoutThreeBodyTB.TB.tbThreeBodyTB.TB.tb_crysThreeBodyTB.TB.tb_crys_kspaceThreeBodyTB.TB.tb_kThreeBodyTB.AtomicMod.makeatomThreeBodyTB.AtomicProj.create_tbThreeBodyTB.AtomicProj.get_ham_rThreeBodyTB.AtomicProj.get_ham_r_slowThreeBodyTB.AtomicProj.loadXML_projThreeBodyTB.AtomicProj.makeOGThreeBodyTB.AtomicProj.make_commandsThreeBodyTB.AtomicProj.make_projThreeBodyTB.AtomicProj.make_projwfcxThreeBodyTB.AtomicProj.makedict_projThreeBodyTB.AtomicProj.prepare_ham_kThreeBodyTB.AtomicProj.projwfc_workfThreeBodyTB.AtomicProj.run_ogThreeBodyTB.AtomicProj.run_projwfcxThreeBodyTB.BandStruct.band_summaryThreeBodyTB.BandStruct.band_summaryThreeBodyTB.BandStruct.band_summaryThreeBodyTB.BandStruct.band_summaryThreeBodyTB.BandStruct.get_kpathThreeBodyTB.BandStruct.plot_bandstrThreeBodyTB.BandStruct.plot_bandstrThreeBodyTB.BandStruct.plot_bandstrThreeBodyTB.BandStruct.plot_bandstr_dosThreeBodyTB.BandStruct.plot_bandstr_dosThreeBodyTB.BandStruct.plot_bandstr_dosThreeBodyTB.BandStruct.plot_bandstr_symThreeBodyTB.BandStruct.plot_bandstr_symThreeBodyTB.BandStruct.plot_bandstr_symThreeBodyTB.BandStruct.plot_compare_dftThreeBodyTB.BandStruct.plot_compare_dftThreeBodyTB.BandStruct.plot_compare_tbThreeBodyTB.BandStruct.plot_compare_tbThreeBodyTB.BandStruct.plot_compare_tbThreeBodyTB.BandStruct.run_dft_compareThreeBodyTB.BandStruct.setup_projThreeBodyTB.BandTools.band_energyThreeBodyTB.BandTools.calc_fermiThreeBodyTB.BandTools.smearing_energyThreeBodyTB.CalcTB.calc_frontierThreeBodyTB.CalcTB.calc_onsiteThreeBodyTB.CalcTB.calc_tb_LV_sparseThreeBodyTB.CalcTB.calc_tb_fastThreeBodyTB.CalcTB.calc_tb_prepare_fastThreeBodyTB.CalcTB.calc_threebodyThreeBodyTB.CalcTB.calc_threebody_onsiteThreeBodyTB.CalcTB.calc_twobodyThreeBodyTB.CalcTB.calc_twobody_fasterThreeBodyTB.CalcTB.calc_twobody_onsiteThreeBodyTB.CalcTB.fit_threebodyThreeBodyTB.CalcTB.fit_threebody_onsiteThreeBodyTB.CalcTB.fit_twobodyThreeBodyTB.CalcTB.fit_twobody_onsiteThreeBodyTB.CalcTB.get_data_info_v1ThreeBodyTB.CalcTB.get_data_info_v2ThreeBodyTB.CalcTB.laguerreThreeBodyTB.CalcTB.make_coefsThreeBodyTB.CalcTB.plot_databaseThreeBodyTB.CalcTB.read_coefsThreeBodyTB.CalcTB.renormalize_SThreeBodyTB.CalcTB.symmetry_factor_fitThreeBodyTB.CalcTB.symmetry_factor_intThreeBodyTB.CalcTB.three_body_HThreeBodyTB.CalcTB.three_body_OThreeBodyTB.CalcTB.trim_distThreeBodyTB.CalcTB.two_body_HThreeBodyTB.CalcTB.two_body_OThreeBodyTB.CalcTB.two_body_SThreeBodyTB.CalcTB.write_coefsThreeBodyTB.Classical.calc_energy_clThreeBodyTB.Classical.core_4_cl_laguerre_fast_fourbdy_cl!ThreeBodyTB.Classical.energy_force_stress_clThreeBodyTB.Classical.make_coefs_clThreeBodyTB.Classical.read_coefs_clThreeBodyTB.Classical.write_coefs_clThreeBodyTB.ClassicalFit.do_fit_clThreeBodyTB.ClassicalFit.do_fit_clThreeBodyTB.ClassicalFit.do_fit_cl_RECURSIVEThreeBodyTB.ClassicalFit.kfoldThreeBodyTB.CrystalMod.generate_optimum_supercellThreeBodyTB.CrystalMod.generate_random_distortionThreeBodyTB.CrystalMod.generate_supercellThreeBodyTB.CrystalMod.get_gridThreeBodyTB.CrystalMod.makecrysThreeBodyTB.CrystalMod.orbital_indexThreeBodyTB.CrystalMod.parsePOSCARThreeBodyTB.CrystalMod.parseQEinputThreeBodyTB.CrystalMod.write_efsThreeBodyTB.CrystalMod.write_poscarThreeBodyTB.DFT.runSCFThreeBodyTB.DFToutMod.get_atomize_energyThreeBodyTB.DFToutMod.makebsThreeBodyTB.DFToutMod.makedftoutThreeBodyTB.DFToutMod.makedftoutThreeBodyTB.DOS.dosThreeBodyTB.DOS.dosThreeBodyTB.DOS.dos_realspaceThreeBodyTB.DOS.dos_realspaceThreeBodyTB.DOS.dos_tetraThreeBodyTB.DOS.gaussian_dosThreeBodyTB.DOS.plot_dosThreeBodyTB.DOS.plot_dos_flipThreeBodyTB.DOS.projectionThreeBodyTB.DOS.setup_tetraThreeBodyTB.Ewald.electrostatics_getgammaThreeBodyTB.Ewald.estimate_best_kappaThreeBodyTB.Ewald.getUThreeBodyTB.Ewald.get_onsiteThreeBodyTB.Ewald.k_spaceThreeBodyTB.Ewald.k_space_LVThreeBodyTB.Ewald.real_spaceThreeBodyTB.FitTB.do_fittingThreeBodyTB.FitTB.do_fitting_linearThreeBodyTB.FitTB.do_fitting_recursiveThreeBodyTB.FitTB.extract_databaseThreeBodyTB.FitTB.fourierspaceThreeBodyTB.FitTB.get_kThreeBodyTB.FitTB.hermetian_indexThreeBodyTB.FitTB.make_databaseThreeBodyTB.FitTB.prepare_for_fittingThreeBodyTB.Force_Stress.finite_diffThreeBodyTB.Force_Stress.get_energy_force_stressThreeBodyTB.Force_Stress.get_energy_force_stress_NOFFTThreeBodyTB.Force_Stress.get_energy_force_stress_fftThreeBodyTB.Force_Stress.get_energy_force_stress_fft_LVThreeBodyTB.Force_Stress.get_energy_force_stress_fft_LV_symThreeBodyTB.Force_Stress.get_energy_force_stress_fft_LV_sym_SINGLEThreeBodyTB.Force_Stress.safe_mode_energyThreeBodyTB.Force_Stress.sparsify_jacThreeBodyTB.ManageDatabase.add_to_databaseThreeBodyTB.ManageDatabase.clear_databaseThreeBodyTB.ManageDatabase.prepare_databaseThreeBodyTB.ManageDatabase.prepare_databaseThreeBodyTB.QE.docleanThreeBodyTB.QE.loadXMLThreeBodyTB.QE.loadXML_bsThreeBodyTB.QE.loadXML_bsThreeBodyTB.QE.make_commandsThreeBodyTB.QE.makedictThreeBodyTB.QE.runSCFThreeBodyTB.QE.run_pwscfThreeBodyTB.SCF.remove_scf_from_tbcThreeBodyTB.SCF.remove_scf_from_tbcThreeBodyTB.SCF.remove_scf_from_tbcThreeBodyTB.SCF.scf_energyThreeBodyTB.SCF.scf_energyThreeBodyTB.SCF.scf_energyThreeBodyTB.Symmetry.get_kpath_symThreeBodyTB.Symmetry.get_standard_crysThreeBodyTB.Symmetry.get_standard_crysThreeBodyTB.Symmetry.get_symmetryThreeBodyTB.Symmetry.get_symmetryThreeBodyTB.Symmetry.kassembleThreeBodyTB.TB.HkThreeBodyTB.TB.calc_bandsThreeBodyTB.TB.calc_energyThreeBodyTB.TB.calc_energy_charge_fftThreeBodyTB.TB.calc_energy_fftThreeBodyTB.TB.ewald_energyThreeBodyTB.TB.find_vbm_cbmThreeBodyTB.TB.get_dqThreeBodyTB.TB.get_energy_electron_density_kspaceThreeBodyTB.TB.get_sym_RThreeBodyTB.TB.load_hr_datThreeBodyTB.TB.make_kgridThreeBodyTB.TB.make_tbThreeBodyTB.TB.make_tb_crysThreeBodyTB.TB.make_tb_crys_kspaceThreeBodyTB.TB.make_tb_kThreeBodyTB.TB.myfftThreeBodyTB.TB.myfft_R_to_KThreeBodyTB.TB.organizedataThreeBodyTB.TB.read_tb_crysThreeBodyTB.TB.read_tb_crys_kspaceThreeBodyTB.TB.tb_indexesThreeBodyTB.TB.trimThreeBodyTB.TB.types_energyThreeBodyTB.TB.write_tb_crysThreeBodyTB.TB.write_tb_crys_kspaceThreeBodyTB.Utility.inv_reshape_vecThreeBodyTB.Utility.reshape_vecThreeBodyTB.relax_structureThreeBodyTB.scf_energyThreeBodyTB.scf_energy_force_stressThreeBodyTB.set_bin_dirsThreeBodyTB.set_units