Skip to content

Commit e39a910

Browse files
committed
Update input keywords description
1 parent 149b0a7 commit e39a910

3 files changed

Lines changed: 9 additions & 9 deletions

File tree

docs/advanced/input_files/input-main.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3988,7 +3988,7 @@
39883988
- d4: Grimme's DFT-D4 dispersion correction method using the external DFT-D4 library
39893989
- none: no vdW correction
39903990

3991-
> Note: DFT-D3 damping parameters are loaded from the bundled s-dftd3 v1.5.0 dataset. Individual user values overwrite the corresponding tabulated values. Setting all four of vdw_s6, vdw_s8, vdw_a1 and vdw_a2 defines a fully custom set and bypasses functional lookup.
3991+
> Note: ABACUS automatically loads DFT-D3 parameters for supported functionals according to dft_functional setting. Individual user values overwrite the corresponding tabulated values. Setting all four of vdw_s6, vdw_s8, vdw_a1 and vdw_a2 defines a fully custom set and bypasses functional lookup.
39923992
- **Default**: none
39933993

39943994
### vdw_d4_xc
@@ -4014,13 +4014,13 @@
40144014

40154015
- **Type**: String
40164016
- **Availability**: *[`vdw_method`](#vdw_method) in [d2, d3_0, d3_bj]*
4017-
- **Description**: Scale factor s6. DFT-D2 keeps its established defaults; for DFT-D3, ABACUS loads the s-dftd3 value for dft_functional. A user value overwrites the selected default.
4017+
- **Description**: Scale factor s6, which is used to optimize the interaction energy deviations in van der Waals (vdW) corrected calculations. The recommended values of this parameter are dependent on the chosen vdW correction method and the DFT functional being used. For DFT-D2, the recommended values are 0.75 (PBE), 1.2 (BLYP), 1.05 (B-P86), 1.0 (TPSS), and 1.05 (B3LYP); if not set, will use values of PBE functional by default. For DFT-D3, ABACUS will search in built-in dataset based on the dft_functional setting by default; user set value will overwrite the searched value.
40184018

40194019
### vdw_s8
40204020

40214021
- **Type**: String
40224022
- **Availability**: *[`vdw_method`](#vdw_method) in [d3_0, d3_bj]*
4023-
- **Description**: Scale factor s8 for D3(0) and D3(BJ). If not set, ABACUS loads the s-dftd3 value for dft_functional. A user value overwrites the tabulated value.
4023+
- **Description**: Scale factor s8 for D3(0) and D3(BJ). By default, ABACUS will search in built-in dataset based on the dft_functional setting. User set value will overwrite the searched value.
40244024

40254025
### vdw_a1
40264026

docs/parameters.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4263,7 +4263,7 @@ parameters:
42634263
* d4: Grimme's DFT-D4 dispersion correction method using the external DFT-D4 library
42644264
* none: no vdW correction
42654265
4266-
[NOTE] DFT-D3 damping parameters are loaded from the bundled s-dftd3 v1.5.0 dataset. Individual user values overwrite the corresponding tabulated values. Setting all four of vdw_s6, vdw_s8, vdw_a1 and vdw_a2 defines a fully custom set and bypasses functional lookup.
4266+
[NOTE] ABACUS automatically loads DFT-D3 parameters for supported functionals according to dft_functional setting. Individual user values overwrite the corresponding tabulated values. Setting all four of vdw_s6, vdw_s8, vdw_a1 and vdw_a2 defines a fully custom set and bypasses functional lookup.
42674267
default_value: none
42684268
unit: ""
42694269
availability: ""
@@ -4291,15 +4291,15 @@ parameters:
42914291
category: vdW correction
42924292
type: String
42934293
description: |
4294-
Scale factor s6. DFT-D2 keeps its established defaults; for DFT-D3, ABACUS loads the s-dftd3 value for dft_functional. A user value overwrites the selected default.
4294+
Scale factor s6, which is used to optimize the interaction energy deviations in van der Waals (vdW) corrected calculations. The recommended values of this parameter are dependent on the chosen vdW correction method and the DFT functional being used. For DFT-D2, the recommended values are 0.75 (PBE), 1.2 (BLYP), 1.05 (B-P86), 1.0 (TPSS), and 1.05 (B3LYP); if not set, will use values of PBE functional by default. For DFT-D3, ABACUS will search in built-in dataset based on the dft_functional setting by default; user set value will overwrite the searched value.
42954295
default_value: ""
42964296
unit: ""
42974297
availability: "vdw_method in [d2, d3_0, d3_bj]"
42984298
- name: vdw_s8
42994299
category: vdW correction
43004300
type: String
43014301
description: |
4302-
Scale factor s8 for D3(0) and D3(BJ). If not set, ABACUS loads the s-dftd3 value for dft_functional. A user value overwrites the tabulated value.
4302+
Scale factor s8 for D3(0) and D3(BJ). By default, ABACUS will search in built-in dataset based on the dft_functional setting. User set value will overwrite the searched value.
43034303
default_value: ""
43044304
unit: ""
43054305
availability: "vdw_method in [d3_0, d3_bj]"

source/source_io/module_parameter/read_inp_model.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ void ReadInput::item_model()
252252
* d4: Grimme's DFT-D4 dispersion correction method using the external DFT-D4 library
253253
* none: no vdW correction
254254
255-
[NOTE] DFT-D3 damping parameters are loaded from the bundled s-dftd3 v1.5.0 dataset. Individual user values overwrite the corresponding tabulated values. Setting all four of vdw_s6, vdw_s8, vdw_a1 and vdw_a2 defines a fully custom set and bypasses functional lookup.)";
255+
[NOTE] ABACUS automatically loads DFT-D3 parameters for supported functionals according to dft_functional setting. Individual user values overwrite the corresponding tabulated values. Setting all four of vdw_s6, vdw_s8, vdw_a1 and vdw_a2 defines a fully custom set and bypasses functional lookup.)";
256256
item.default_value = "none";
257257
item.unit = "";
258258
read_sync_string(input.vdw_method);
@@ -298,7 +298,7 @@ Available options are:
298298
item.annotation = "scale parameter of d2/d3_0/d3_bj";
299299
item.category = "vdW correction";
300300
item.type = "String";
301-
item.description = "Scale factor s6. DFT-D2 keeps its established defaults; for DFT-D3, ABACUS loads the s-dftd3 value for dft_functional. A user value overwrites the selected default.";
301+
item.description = "Scale factor s6, which is used to optimize the interaction energy deviations in van der Waals (vdW) corrected calculations. The recommended values of this parameter are dependent on the chosen vdW correction method and the DFT functional being used. For DFT-D2, the recommended values are 0.75 (PBE), 1.2 (BLYP), 1.05 (B-P86), 1.0 (TPSS), and 1.05 (B3LYP); if not set, will use values of PBE functional by default. For DFT-D3, ABACUS will search in built-in dataset based on the dft_functional setting by default; user set value will overwrite the searched value.";
302302
item.default_value = "";
303303
item.unit = "";
304304
item.set_availability("vdw_method in [d2, d3_0, d3_bj]");
@@ -323,7 +323,7 @@ Available options are:
323323
item.annotation = "scale parameter of d3_0/d3_bj";
324324
item.category = "vdW correction";
325325
item.type = "String";
326-
item.description = "Scale factor s8 for D3(0) and D3(BJ). If not set, ABACUS loads the s-dftd3 value for dft_functional. A user value overwrites the tabulated value.";
326+
item.description = "Scale factor s8 for D3(0) and D3(BJ). By default, ABACUS will search in built-in dataset based on the dft_functional setting. User set value will overwrite the searched value.";
327327
item.default_value = "";
328328
item.unit = "";
329329
item.set_availability("vdw_method in [d3_0, d3_bj]");

0 commit comments

Comments
 (0)