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/advanced/input_files/input-main.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
@@ -2142,7 +2142,7 @@ Warning: this function is not robust enough for the current version. Please try
2142
2142
### deepks_out_labels
2143
2143
2144
2144
-**Type**: Integer
2145
-
-**Availability**: numerical atomic orbital basis
2145
+
-**Availability**: Numerical atomic orbital basis
2146
2146
-**Description**: Print labels and descriptors for DeePKS in OUT.${suffix}. The names of these files start with "deepks".
2147
2147
- 0 : No output.
2148
2148
- 1 : Output intermediate files needed during DeePKS training.
@@ -2163,30 +2163,30 @@ Warning: this function is not robust enough for the current version. Please try
2163
2163
### deepks_out_freq_elec
2164
2164
2165
2165
-**Type**: Integer
2166
-
-**Availability**: numerical atomic orbital basis
2166
+
-**Availability**: Numerical atomic orbital basis
2167
2167
-**Description**: When `deepks_out_freq_elec` is greater than 0, print labels and descriptors for DeePKS in OUT.${suffix}/DeePKS_Labels_Elec per `deepks_out_freq_elec` electronic iterations, with suffix `_e*` to distinguish different steps. Often used with `deepks_out_labels` equals 1.
2168
2168
-**Default**: 0
2169
2169
2170
2170
### deepks_scf
2171
2171
2172
2172
-**Type**: Boolean
2173
-
-**Availability**: numerical atomic orbital basis
2173
+
-**Availability**: Numerical atomic orbital basis
2174
2174
-**Description**: perform self-consistent field iteration in DeePKS method
2175
2175
-**Note**: A trained, traced model file is needed.
2176
2176
-**Default**: False
2177
2177
2178
2178
### deepks_equiv
2179
2179
2180
2180
-**Type**: Boolean
2181
-
-**Availability**: numerical atomic orbital basis
2181
+
-**Availability**: Numerical atomic orbital basis
2182
2182
-**Description**: whether to use equivariant version of DeePKS
2183
2183
-**Note**: the equivariant version of DeePKS-kit is still under development, so this feature is currently only intended for internal usage.
2184
2184
-**Default**: False
2185
2185
2186
2186
### deepks_model
2187
2187
2188
2188
-**Type**: String
2189
-
-**Availability**: numerical atomic orbital basis and `deepks_scf` is true
2189
+
-**Availability**: Numerical atomic orbital basis and `deepks_scf` is true
2190
2190
-**Description**: the path of the trained, traced neural network model file generated by [deepks-kit](https://github.com/deepmodeling/deepks-kit)
2191
2191
-**Default**: None
2192
2192
@@ -2239,7 +2239,7 @@ Warning: this function is not robust enough for the current version. Please try
2239
2239
### deepks_bandgap
2240
2240
2241
2241
-**Type**: Int
2242
-
-**Availability**: numerical atomic orbital basis and `deepks_scf` is true
2242
+
-**Availability**: Numerical atomic orbital basis and `deepks_scf` is true
2243
2243
-**Description**: include bandgap label for DeePKS training
2244
2244
- 0: Don't include bandgap label
2245
2245
- 1: Include target bandgap label (see [deepks\_band\_range](#deepks_band_range) for more details)
@@ -2250,7 +2250,7 @@ Warning: this function is not robust enough for the current version. Please try
2250
2250
### deepks_band_range
2251
2251
2252
2252
-**Type**: Int*2
2253
-
-**Availability**: numerical atomic orbital basis, `deepks_scf` is true, and `deepks_bandgap` is 1 or 2
2253
+
-**Availability**: Numerical atomic orbital basis, `deepks_scf` is true, and `deepks_bandgap` is 1 or 2
2254
2254
-**Description**: The first value should not be larger than the second one and the meaning differs in different cases below
2255
2255
-`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.
2256
2256
-`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.*
@@ -2259,7 +2259,7 @@ Warning: this function is not robust enough for the current version. Please try
2259
2259
### deepks_v_delta
2260
2260
2261
2261
-**Type**: int
2262
-
-**Availability**: numerical atomic orbital basis
2262
+
-**Availability**: Numerical atomic orbital basis
2263
2263
-**Description**: Include V_delta/V_delta_R (Hamiltonian in k/real space) label for DeePKS training. When `deepks_out_labels` is true and `deepks_v_delta` > 0 (k space), ABACUS will output `deepks_hbase.npy`, `deepks_vdelta.npy` and `deepks_htot.npy`(htot=hbase+vdelta). When `deepks_out_labels` is true and `deepks_v_delta` < 0 (real space), ABACUS will output `deepks_hrtot.csr`, `deepks_hrdelta.csr`. Some more files output for different settings.
2264
2264
-`deepks_v_delta` = 1: `deepks_vdpre.npy`, which is used to calculate V_delta during DeePKS training.
2265
2265
-`deepks_v_delta` = 2: `deepks_phialpha.npy` and `deepks_gevdm.npy`, which can be used to calculate `deepks_vdpre.npy`. A recommanded method for memory saving.
0 commit comments