Skip to content

Commit d61cccc

Browse files
authored
Merge branch 'develop' into develop
2 parents f9b330c + 6c460fd commit d61cccc

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
@@ -196,7 +196,7 @@
196196
- [bessel\_descriptor\_smooth](#bessel_descriptor_smooth)
197197
- [bessel\_descriptor\_sigma](#bessel_descriptor_sigma)
198198
- [deepks\_bandgap](#deepks_bandgap)
199-
- [deepks\_bandgap\_range](#deepks_bandgap_range)
199+
- [deepks\_band\_range](#deepks_band_range)
200200
- [deepks\_v\_delta](#deepks_v_delta)
201201
- [deepks\_out\_unittest](#deepks_out_unittest)
202202
- [OFDFT: orbital free density functional theory](#ofdft-orbital-free-density-functional-theory)
@@ -2162,20 +2162,19 @@ Warning: this function is not robust enough for the current version. Please try
21622162
- **Availability**: numerical atomic orbital basis and `deepks_scf` is true
21632163
- **Description**: include bandgap label for DeePKS training
21642164
- 0: Don't include bandgap label
2165-
- 1: Include HOMO and LOMO for bandgap label
2166-
- 2: Include multiple bandgap label (see [deepks\_bandgap\_range](#deepks_bandgap_range) for more details)
2167-
- 3: Include target bandgap label (see [deepks\_bandgap\_range](#deepks_bandgap_range) for more details)
2168-
- 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)
2165+
- 1: Include target bandgap label (see [deepks\_band\_range](#deepks_band_range) for more details)
2166+
- 2: Include multiple bandgap label (see [deepks\_band\_range](#deepks_band_range) for more details)
2167+
- 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)
21692168
- **Default**: 0
21702169

2171-
### deepks_bandgap_range
2170+
### deepks_band_range
21722171

21732172
- **Type**: Int*2
2174-
- **Availability**: numerical atomic orbital basis, `deepks_scf` is true, and `deepks_bandgap` is 2 or 3
2175-
- **Description**:
2176-
- `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)
2177-
- `deepks_bandgap` is 3: Bandgap label is the energy between (LUMO + deepks_bandgap_range[0], LUMO + deepks_bandgap_range[1])
2178-
- **Default**: 0 0
2173+
- **Availability**: numerical atomic orbital basis, `deepks_scf` is true, and `deepks_bandgap` is 1 or 2
2174+
- **Description**: The first value should not be larger than the second one and the meaning differs in different cases below
2175+
- `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.
2176+
- `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.*
2177+
- **Default**: -1 0
21792178

21802179
### deepks_v_delta
21812180

0 commit comments

Comments
 (0)