Skip to content

Commit ca628fa

Browse files
authored
Merge branch 'develop' into fix_getwf_sepk_doc
2 parents 28f74f0 + 6c460fd commit ca628fa

File tree

21 files changed

+395
-607
lines changed

21 files changed

+395
-607
lines changed

docs/advanced/input_files/input-main.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@
195195
- [bessel\_descriptor\_smooth](#bessel_descriptor_smooth)
196196
- [bessel\_descriptor\_sigma](#bessel_descriptor_sigma)
197197
- [deepks\_bandgap](#deepks_bandgap)
198-
- [deepks\_bandgap\_range](#deepks_bandgap_range)
198+
- [deepks\_band\_range](#deepks_band_range)
199199
- [deepks\_v\_delta](#deepks_v_delta)
200200
- [deepks\_out\_unittest](#deepks_out_unittest)
201201
- [OFDFT: orbital free density functional theory](#ofdft-orbital-free-density-functional-theory)
@@ -2149,20 +2149,19 @@ Warning: this function is not robust enough for the current version. Please try
21492149
- **Availability**: numerical atomic orbital basis and `deepks_scf` is true
21502150
- **Description**: include bandgap label for DeePKS training
21512151
- 0: Don't include bandgap label
2152-
- 1: Include HOMO and LOMO for bandgap label
2153-
- 2: Include multiple bandgap label (see [deepks\_bandgap\_range](#deepks_bandgap_range) for more details)
2154-
- 3: Include target bandgap label (see [deepks\_bandgap\_range](#deepks_bandgap_range) for more details)
2155-
- 4: For systems containing H atoms only, HOMO is defined as the max occupation expect H atoms and the bandgap label is the energy between (HOMO, HOMO + 1)
2152+
- 1: Include target bandgap label (see [deepks\_band\_range](#deepks_band_range) for more details)
2153+
- 2: Include multiple bandgap label (see [deepks\_band\_range](#deepks_band_range) for more details)
2154+
- 3: For systems containing H atoms only, HOMO is defined as the max occupation expect H atoms and the bandgap label is the energy between HOMO and (HOMO + 1)
21562155
- **Default**: 0
21572156

2158-
### deepks_bandgap_range
2157+
### deepks_band_range
21592158

21602159
- **Type**: Int*2
2161-
- **Availability**: numerical atomic orbital basis, `deepks_scf` is true, and `deepks_bandgap` is 2 or 3
2162-
- **Description**:
2163-
- `deepks_bandgap` is 2: Bandgap labels are energies between (LUMO + deepks_bandgap_range[0], HOMO), (LUMO + deepks_bandgap_range[0] + 1, HOMO), ..., (LUMO + deepks_bandgap_range[1], HOMO) except (HOMO, HOMO)
2164-
- `deepks_bandgap` is 3: Bandgap label is the energy between (LUMO + deepks_bandgap_range[0], LUMO + deepks_bandgap_range[1])
2165-
- **Default**: 0 0
2160+
- **Availability**: numerical atomic orbital basis, `deepks_scf` is true, and `deepks_bandgap` is 1 or 2
2161+
- **Description**: The first value should not be larger than the second one and the meaning differs in different cases below
2162+
- `deepks_bandgap` is 1: Bandgap label is the energy between `LUMO + deepks_band_range[0]` and `LUMO + deepks_band_range[1]`. If not set, it will calculate energy between HOMO and LUMO states.
2163+
- `deepks_bandgap` is 2: Bandgap labels are energies between HOMO and all states in range [`LUMO + deepks_band_range[0]`, `LUMO + deepks_band_range[1]`] (Thus there are `deepks_band_range[1] - deepks_band_range[0] + 1` bandgaps in total). If HOMO is included in the setting range, it will be ignored since it will always be zero and has no valuable messages (`deepks_band_range[1] - deepks_band_range[0]` bandgaps in this case). *NOTICE: The set range can be greater than, less than, or include the value of HOMO. In the bandgap label, we always calculate the energy of the state in the set range minus the energy of HOMO state, so the bandgap can be negative if the state is lower than HOMO.*
2164+
- **Default**: -1 0
21662165

21672166
### deepks_v_delta
21682167

0 commit comments

Comments
 (0)