Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 26 additions & 6 deletions docs/advanced/input_files/input-main.md
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,8 @@
- [vdw\_cutoff\_type](#vdw_cutoff_type)
- [vdw\_cutoff\_radius](#vdw_cutoff_radius)
- [vdw\_radius\_unit](#vdw_radius_unit)
- [vdw\_cutoff\_smooth\_width\_2b](#vdw_cutoff_smooth_width_2b)
- [vdw\_cutoff\_smooth\_width\_3b](#vdw_cutoff_smooth_width_3b)
- [vdw\_cutoff\_period](#vdw_cutoff_period)
- [vdw\_cn\_thr](#vdw_cn_thr)
- [vdw\_cn\_thr\_unit](#vdw_cn_thr_unit)
Expand Down Expand Up @@ -3936,7 +3938,7 @@
- d4: Grimme's DFT-D4 dispersion correction method using the external DFT-D4 library
- none: no vdW correction

> Note: ABACUS supports automatic setting of DFT-D3 parameters for common functionals. To benefit from this feature, please specify the parameter dft_functional explicitly, otherwise the autoset procedure will crash. If not satisfied with the built-in parameters, any manual setting on vdw_s6, vdw_s8, vdw_a1 and vdw_a2 will overwrite the automatic values.
> 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.
- **Default**: none

### vdw_d4_xc
Expand All @@ -3962,25 +3964,25 @@

- **Type**: String
- **Availability**: *[`vdw_method`](#vdw_method) in [d2, d3_0, d3_bj]*
- **Description**: This scale factor 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. For DFT-D3, recommended values with different DFT functionals can be found on the here. If not set, will search in ABACUS built-in dataset based on the dft_functional keywords. User set value will overwrite the searched value.
- **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.

### vdw_s8

- **Type**: String
- **Availability**: *[`vdw_method`](#vdw_method) in [d3_0, d3_bj]*
- **Description**: This scale factor is relevant for D3(0) and D3(BJ) van der Waals (vdW) correction methods. The recommended values of this parameter with different DFT functionals can be found on the webpage. If not set, will search in ABACUS built-in dataset based on the dft_functional keywords. User set value will overwrite the searched value.
- **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.

### vdw_a1

- **Type**: String
- **Availability**: *[`vdw_method`](#vdw_method) in [d3_0, d3_bj]*
- **Description**: This damping function parameter is relevant for D3(0) and D3(BJ) van der Waals (vdW) correction methods. The recommended values of this parameter with different DFT functionals can be found on the webpage. If not set, will search in ABACUS built-in dataset based on the dft_functional keywords. User set value will overwrite the searched value.
- **Description**: Damping parameter rs6 for D3(0), or a1 for D3(BJ). If not set, ABACUS loads the s-dftd3 value for dft_functional. A user value overwrites the tabulated value.

### vdw_a2

- **Type**: String
- **Availability**: *[`vdw_method`](#vdw_method) in [d3_0, d3_bj]*
- **Description**: This damping function parameter is only relevant for D3(0) and D3(BJ) van der Waals (vdW) correction methods. The recommended values of this parameter with different DFT functionals can be found on the webpage. If not set, will search in ABACUS built-in dataset based on the dft_functional keywords. User set value will overwrite the searched value.
- **Description**: Damping parameter rs8 for D3(0), or a2 for D3(BJ). If not set, ABACUS loads the s-dftd3 value for dft_functional. A user value overwrites the tabulated value.

### vdw_d

Expand Down Expand Up @@ -4043,7 +4045,7 @@
- **Type**: String
- **Description**: Determines the method used for specifying the cutoff radius in periodic systems when applying Van der Waals correction. Available options are:
- radius: The supercell is selected within a sphere centered at the origin with a radius defined by vdw_cutoff_radius.
- period: The extent of the supercell is explicitly specified using the vdw_cutoff_period keyword.
- period: The extent of the D2 supercell is explicitly specified using the vdw_cutoff_period keyword. DFT-D3 and DFT-D4 require radius.
- **Default**: radius

### vdw_cutoff_radius
Expand All @@ -4062,6 +4064,24 @@
- Bohr
- **Default**: Bohr

### vdw_cutoff_smooth_width_2b

- **Type**: Real
- **Availability**: *[`vdw_method`](#vdw_method) in [d3_0, d3_bj, d4]*
- **Description**: Width of the smooth switching region for the two-body pairwise dispersion real-space cutoff.
A value of zero disables smoothing for the two-body contribution.
- **Default**: 0.05
- **Unit**: Bohr

### vdw_cutoff_smooth_width_3b

- **Type**: Real
- **Availability**: *[`vdw_method`](#vdw_method) in [d3_0, d3_bj, d4]*
- **Description**: Width of the smooth switching region for the three-body Axilrod-Teller-Muto (ATM) dispersion real-space cutoff.
A value of zero disables smoothing for the three-body contribution.
- **Default**: 0.05
- **Unit**: Bohr

### vdw_cutoff_period

- **Type**: Integer Integer Integer
Expand Down
30 changes: 24 additions & 6 deletions docs/parameters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4166,7 +4166,7 @@ parameters:
* d4: Grimme's DFT-D4 dispersion correction method using the external DFT-D4 library
* none: no vdW correction

[NOTE] ABACUS supports automatic setting of DFT-D3 parameters for common functionals. To benefit from this feature, please specify the parameter dft_functional explicitly, otherwise the autoset procedure will crash. If not satisfied with the built-in parameters, any manual setting on vdw_s6, vdw_s8, vdw_a1 and vdw_a2 will overwrite the automatic values.
[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.
default_value: none
unit: ""
availability: ""
Expand Down Expand Up @@ -4194,31 +4194,31 @@ parameters:
category: vdW correction
type: String
description: |
This scale factor 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. For DFT-D3, recommended values with different DFT functionals can be found on the here. If not set, will search in ABACUS built-in dataset based on the dft_functional keywords. User set value will overwrite the searched value.
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.
default_value: ""
unit: ""
availability: "vdw_method in [d2, d3_0, d3_bj]"
- name: vdw_s8
category: vdW correction
type: String
description: |
This scale factor is relevant for D3(0) and D3(BJ) van der Waals (vdW) correction methods. The recommended values of this parameter with different DFT functionals can be found on the webpage. If not set, will search in ABACUS built-in dataset based on the dft_functional keywords. User set value will overwrite the searched value.
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.
default_value: ""
unit: ""
availability: "vdw_method in [d3_0, d3_bj]"
- name: vdw_a1
category: vdW correction
type: String
description: |
This damping function parameter is relevant for D3(0) and D3(BJ) van der Waals (vdW) correction methods. The recommended values of this parameter with different DFT functionals can be found on the webpage. If not set, will search in ABACUS built-in dataset based on the dft_functional keywords. User set value will overwrite the searched value.
Damping parameter rs6 for D3(0), or a1 for D3(BJ). If not set, ABACUS loads the s-dftd3 value for dft_functional. A user value overwrites the tabulated value.
default_value: ""
unit: ""
availability: "vdw_method in [d3_0, d3_bj]"
- name: vdw_a2
category: vdW correction
type: String
description: |
This damping function parameter is only relevant for D3(0) and D3(BJ) van der Waals (vdW) correction methods. The recommended values of this parameter with different DFT functionals can be found on the webpage. If not set, will search in ABACUS built-in dataset based on the dft_functional keywords. User set value will overwrite the searched value.
Damping parameter rs8 for D3(0), or a2 for D3(BJ). If not set, ABACUS loads the s-dftd3 value for dft_functional. A user value overwrites the tabulated value.
default_value: ""
unit: ""
availability: "vdw_method in [d3_0, d3_bj]"
Expand Down Expand Up @@ -4290,7 +4290,7 @@ parameters:
description: |
Determines the method used for specifying the cutoff radius in periodic systems when applying Van der Waals correction. Available options are:
* radius: The supercell is selected within a sphere centered at the origin with a radius defined by vdw_cutoff_radius.
* period: The extent of the supercell is explicitly specified using the vdw_cutoff_period keyword.
* period: The extent of the D2 supercell is explicitly specified using the vdw_cutoff_period keyword. DFT-D3 and DFT-D4 require radius.
default_value: radius
unit: ""
availability: ""
Expand All @@ -4312,6 +4312,24 @@ parameters:
default_value: Bohr
unit: ""
availability: vdw_cutoff_type==radius
- name: vdw_cutoff_smooth_width_2b
category: vdW correction
type: Real
description: |
Width of the smooth switching region for the two-body pairwise dispersion real-space cutoff.
A value of zero disables smoothing for the two-body contribution.
default_value: "0.05"
unit: Bohr
availability: "vdw_method in [d3_0, d3_bj, d4]"
- name: vdw_cutoff_smooth_width_3b
category: vdW correction
type: Real
description: |
Width of the smooth switching region for the three-body Axilrod-Teller-Muto (ATM) dispersion real-space cutoff.
A value of zero disables smoothing for the three-body contribution.
default_value: "0.05"
unit: Bohr
availability: "vdw_method in [d3_0, d3_bj, d4]"
- name: vdw_cutoff_period
category: vdW correction
type: Integer Integer Integer
Expand Down
8 changes: 4 additions & 4 deletions source/source_hamilt/module_vdw/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
set(vdw_sources
vdw_xcname.cpp
vdwd2_parameters.cpp
vdwd3_parameters_tab.cpp
vdwd3_parameters.cpp
vdwd2.cpp
vdwd3_data.cpp
vdwd3_parameters.cpp
vdwd3_evaluator.cpp
vdwd3.cpp
vdwd3_autoset_xcname.cpp
vdwd3_auto_xcpar.cpp
vdw.cpp
)

Expand Down
Loading
Loading