You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/CONTRIBUTING.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,30 +54,30 @@ For those who are interested in the source code, the following figure shows the
54
54
| |-- module_neighbor The module for finding the neighbors of each atom in the unit cell.
55
55
| |-- module_paw The module for performing PAW calculations.
56
56
| |-- module_symmetry The module for finding the symmetry operations of the unit cell.
57
-
|-- source_estate The module for defining the electronic state and its operations.
57
+
|-- source_estate The module for defining the electronic state and its operations.
58
58
| |-- module_charge The module for calculating the charge density, charge mixing
59
59
| |-- potentials The module for calculating the potentials, including Hartree, exchange-correlation, local pseudopotential, etc.
60
60
|-- source_esolver The module defining task-specific driver of corresponding workflow for evaluating energies, forces, etc., including lj, dp, ks, sdft, ofdft, etc.
61
61
| | TDDFT, Orbital-free DFT, etc.
62
-
|-- source_hamilt The module for defining general Hamiltonian that can be used both in PW and LCAO calculations.
62
+
|-- source_hamilt The module for defining general Hamiltonian that can be used both in PW and LCAO calculations.
63
63
| |-- module_ewald The module for calculating the Ewald summation.
64
64
| |-- module_surchem The module for calculating the surface charge correction.
65
65
| |-- module_vdw The module for calculating the van der Waals correction.
66
66
| |-- module_xc The module for calculating the exchange-correlation energy and potential.
67
-
|-- source_lcao The module for defining the Hamiltonian in LCAO calculations.
67
+
|-- source_lcao The module for defining the Hamiltonian in LCAO calculations.
68
68
| |-- hamilt_lcaodft The module for defining the Hamiltonian in LCAO-DFT calculations.
69
69
| | |-- operator_lcao The module for defining the operators in LCAO-DFT calculations.
70
70
| |-- module_deepks The module for defining the Hamiltonian in DeepKS calculations.
71
71
| |-- module_dftu The module for defining the Hamiltonian in DFT+U calculations.
72
72
| |-- module_gint The module for performing grid integral in LCAO calculations.
73
73
| |-- module_hcontainer The module for storing the Hamiltonian matrix in LCAO calculations.
74
-
| |-- module_tddft The module for defining the Hamiltonian in TDDFT calculations.
74
+
| |-- module_rt The module for defining the Hamiltonian in TDDFT calculations.
75
75
| `-- module_ri The module for performing RI calculations.
76
-
|-- source_pw The module for defining the Hamiltonian in PW calculations.
77
-
| |-- hamilt_ofdft The module for defining the Hamiltonian in OFDFT calculations.
78
-
| |-- hamilt_pwdft The module for defining the Hamiltonian in PW-DFT calculations.
76
+
|-- source_pw The module for defining the Hamiltonian in PW calculations.
77
+
| |-- module_ofdft The module for defining the Hamiltonian in OFDFT calculations.
78
+
| |-- module_pwdft The module for defining the Hamiltonian in PW-DFT calculations.
79
79
| | |-- operator_pw The module for defining the operators in PW-DFT calculations.
80
-
| `-- hamilt_stodft The module for defining the Hamiltonian in STODFT calculations.
80
+
| `-- module_stodft The module for defining the Hamiltonian in STODFT calculations.
81
81
|-- source_hsolver The module for solving the Hamiltonian with different diagonalization methods, including CG, Davidson in PW
82
82
| | calculations, and scalapack and genelpa in LCAO calculations.
83
83
|-- source_io The module for reading of INPUT files and output properties including band structure, density of states, charge density, etc.
Copy file name to clipboardExpand all lines: docs/advanced/input_files/input-main.md
+31-18Lines changed: 31 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2786,37 +2786,41 @@ Support for hybrid functionals in the *pw [basis_type](#basis_type)* is under ac
2786
2786
2787
2787
The following parameters apply to *[basis_type](#basis_type)==lcao/lcao_in_pw/pw*. For basis specific parameters, see the sections *[Exact Exchange (LCAO/LCAO in PW)](#exact-exchange-lcaolcao-in-pw)* and *[Exact Exchange (PW)](#exact-exchange-pw)*.
2788
2788
2789
-
**Availablity**: *[dft_functional](#dft_functional)==hse/hf/pbe0/scan0/opt_orb* or *[rpa](#rpa)==True*.
-**Description**: Fraction of Fock exchange 1/r in hybrid functionals, so that $E_{X} = \alpha E_{X} + (1-\alpha)E_{X,\text{LDA/GGA}}$
2795
-
-**Default**:
2796
-
- 1: if *[dft_functional](#dft_functional)==hf*
2797
-
- 0.25: if *[dft_functional](#dft_functional)==pbe0*
2798
-
- 0.2: if *[dft_functional](#dft_functional)==b3lyp*
2799
-
- 0.25: if *[dft_functional](#dft_functional)==scan0*
2800
-
- 1: if *[dft_functional](#dft_functional)==muller*
2801
-
- 1: if *[dft_functional](#dft_functional)==power*
2802
-
- 1: if *[dft_functional](#dft_functional)==wp22*
2803
-
- 0: else
2810
+
-**Description**: Fraction of full-ranged Fock exchange 1/r ($\alpha$) in range-separated hybrid funtionals, so that $E_{X} = \alpha E_{X}^\text{HF-LR}+(\alpha+\beta) E_{X}^\text{HF-SR}+(1-\alpha)E_{X}^\text{KS-LR}+[1-(\alpha+\beta)]E_{X}^\text{KS-SR}$.
2811
+
-**Default**: see [hybrid_func_params](#hybrid_func_params)
2804
2812
2805
2813
### exx_erfc_alpha
2806
2814
2807
2815
-**Type**: Real \[Real...\](optional)
2808
-
-**Description**: Fraction of exchange erfc(wr)/r in hybrid functionals, so that $E_{X} = \alpha E_{X}^{\text{SR}} + (1-\alpha)E_{X,\text{LDA/GGA}}^{\text{SR}} + E_{X,\text{LDA/GGA}}^{\text{LR}}$
2809
-
-**Default**:
2810
-
- 0.25: if *[dft_functional](#dft_functional)==hse*
2811
-
- 1: if *[dft_functional](#dft_functional)==cwp22*
2812
-
- -1: if *[dft_functional](#dft_functional)==wp22*
2813
-
- 0: else
2816
+
-**Description**: Fraction of short-ranged Fock exchange erfc(wr)/r ($\beta$) in range-separated hybrid funtionals, so that $E_{X} = \alpha E_{X}^\text{HF-LR}+(\alpha+\beta) E_{X}^\text{HF-SR}+(1-\alpha)E_{X}^\text{KS-LR}+[1-(\alpha+\beta)]E_{X}^\text{KS-SR}$.
2817
+
-**Default**: see [hybrid_func_params](#hybrid_func_params)
2814
2818
2815
2819
### exx_erfc_omega
2816
2820
2817
2821
-**Type**: Real \[Real...\](optional)
2818
2822
-**Description**: Range-separation parameter in exchange, such that $1/r=\text{erfc}(\omega r)/r+\text{erf}(\omega r)/r$
2819
-
-**Default**: 0.11
2823
+
-**Default**: see [hybrid_func_params](#hybrid_func_params)
2820
2824
2821
2825
### exx_separate_loop
2822
2826
@@ -2951,6 +2955,15 @@ These variables are relevant when using hybrid functionals with *[basis_type](#b
2951
2955
- True: if gamma_only
2952
2956
- False: else
2953
2957
2958
+
### exx_singularity_correction
2959
+
2960
+
-**Type**: String
2961
+
-**Description**:
2962
+
- spencer: see Phys. Rev. B 77, 193110 (2008).
2963
+
- revised_spencer: see Phys. Rev. Mater. 5, 013807 (2021).
0 commit comments