Skip to content

Commit 7bf3ead

Browse files
committed
update input
1 parent d6b8a7e commit 7bf3ead

File tree

2 files changed

+18
-3
lines changed

2 files changed

+18
-3
lines changed

docs/advanced/input_files/input-main.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +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)
198199
- [deepks\_v\_delta](#deepks_v_delta)
199200
- [deepks\_out\_unittest](#deepks_out_unittest)
200201
- [OFDFT: orbital free density functional theory](#ofdft-orbital-free-density-functional-theory)
@@ -2144,10 +2145,24 @@ Warning: this function is not robust enough for the current version. Please try
21442145

21452146
### deepks_bandgap
21462147

2147-
- **Type**: Boolean
2148+
- **Type**: Int
21482149
- **Availability**: numerical atomic orbital basis and `deepks_scf` is true
21492150
- **Description**: include bandgap label for DeePKS training
2150-
- **Default**: False
2151+
- 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)
2156+
- **Default**: 0
2157+
2158+
### deepks_bandgap_range
2159+
2160+
- **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
21512166

21522167
### deepks_v_delta
21532168

source/module_parameter/input_parameter.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ struct Input_para
266266
bool deepks_scf = false; ///< (need libnpy and libtorch) if set to true, a trained model
267267
///< would be needed to calculate V_delta and F_delta
268268
int deepks_bandgap = 0; ///< for bandgap label. QO added 2021-12-15
269-
std::vector<int> deepks_band_range = {}; ///< the range of bands to calculate bandgap
269+
std::vector<int> deepks_band_range = {0, 0}; ///< the range of bands to calculate bandgap
270270
int deepks_v_delta = 0; ///< for v_delta label. xuan added
271271
bool deepks_equiv = false; ///< whether to use equivariant version of DeePKS
272272
bool deepks_out_unittest = false; ///< if set to true, prints intermediate quantities that shall

0 commit comments

Comments
 (0)