(git:27c966b)
Loading...
Searching...
No Matches
qs_dispersion_s_dftd3.F
Go to the documentation of this file.
1!--------------------------------------------------------------------------------------------------!
2! CP2K: A general program to perform molecular dynamics simulations !
3! Copyright 2000-2026 CP2K developers group <https://cp2k.org> !
4! !
5! SPDX-License-Identifier: GPL-2.0-or-later !
6!--------------------------------------------------------------------------------------------------!
7
9
12 USE kinds, ONLY: default_string_length, &
13 dp
16
17#if defined(__S_DFTD3)
18 USE dftd3_data_r4r2, ONLY: get_r4r2_val
19 USE dftd3_data_vdwrad, ONLY: get_vdw_rad
20 USE dftd3_param, ONLY: d3_param, &
21 get_rational_damping, &
22 get_zero_damping
23 USE dftd3_reference, ONLY: init_reference_c6, &
24 get_c6, &
25 reference_cn, &
26 number_of_references
27 USE mctc_data, ONLY: get_covalent_rad
28 USE mctc_env, ONLY: error_type
29#endif
30
31#include "./base/base_uses.f90"
32
33 IMPLICIT NONE
34
35 PRIVATE
36
37 CHARACTER(len=*), PARAMETER, PRIVATE :: moduleN = 'qs_dispersion_s_dftd3'
38
40
41CONTAINS
42
43! **************************************************************************************************
44!> \brief Check if a functional is supported by the s-dftd3 library
45!> \param pp_type ...
46!> \param ref_functional ...
47!> \param found ...
48! **************************************************************************************************
49 SUBROUTINE dftd3_functional_supported(pp_type, ref_functional, found)
50 INTEGER, INTENT(IN) :: pp_type
51 CHARACTER(LEN=*), INTENT(IN) :: ref_functional
52 LOGICAL, INTENT(OUT) :: found
53
54#if defined(__S_DFTD3)
55
56 CHARACTER(LEN=default_string_length) :: func_name
57 TYPE(d3_param) :: d3params
58 TYPE(error_type), ALLOCATABLE :: lib_error
59
60 ALLOCATE (lib_error)
61 func_name = ref_functional
62 d3params = d3_param()
63 found = .true.
64
65 SELECT CASE (pp_type)
67 CALL get_zero_damping(d3params, func_name, lib_error)
69 CALL get_rational_damping(d3params, func_name, lib_error)
70 CASE DEFAULT
71 d3params = d3_param()
72 END SELECT
73
74 found = .NOT. ALLOCATED(lib_error)
75
76#else
77 mark_used(pp_type)
78 mark_used(ref_functional)
79 found = .false.
80#endif
81
82 END SUBROUTINE dftd3_functional_supported
83
84! **************************************************************************************************
85!> \brief ...
86!> \param c6ab ...
87!> \param maxci ...
88!> \param r0ab ...
89!> \param rcov ...
90!> \param r2r4 ...
91!> \param pp_type ...
92!> \param ref_functional ...
93!> \param s6 ...
94!> \param s8 ...
95!> \param a1 ...
96!> \param a2 ...
97!> \param sr6 ...
98!> \param sr8 ...
99!> \param para_env ...
100!> \param error ...
101!> \param calc_scaling ...
102! **************************************************************************************************
103 SUBROUTINE dftd3_param_from_library(c6ab, maxci, r0ab, rcov, r2r4, &
104 pp_type, ref_functional, &
105 s6, s8, a1, a2, sr6, sr8, &
106 para_env, error, calc_scaling)
107
108 REAL(kind=dp), DIMENSION(:, :, :, :, :), &
109 INTENT(INOUT) :: c6ab
110 INTEGER, DIMENSION(:), INTENT(INOUT) :: maxci
111 REAL(kind=dp), DIMENSION(:, :), INTENT(INOUT) :: r0ab
112 REAL(kind=dp), DIMENSION(:), INTENT(INOUT) :: rcov, r2r4
113 INTEGER, INTENT(IN) :: pp_type
114 CHARACTER(LEN=*), INTENT(IN) :: ref_functional
115 REAL(kind=dp), INTENT(INOUT) :: s6, s8, a1, a2, sr6, sr8
116 TYPE(mp_para_env_type), INTENT(IN), POINTER :: para_env
117 CHARACTER(LEN=*), INTENT(OUT), OPTIONAL :: error
118 LOGICAL, INTENT(IN), OPTIONAL :: calc_scaling
119
120#if defined(__S_DFTD3)
121
122 CHARACTER(LEN=*), PARAMETER :: routinen = 'dftd3_param_from_library'
123
124 CHARACTER(LEN=default_string_length) :: func_name
125 INTEGER :: handle, i, iz, jref, jz, nelem, nref
126 LOGICAL :: do_calc_scaling
127 REAL(kind=dp) :: c6_val, r4r2, rcov_val
128 REAL(kind=dp), DIMENSION(94) :: r2r4_tmp, rcov_tmp
129 TYPE(d3_param) :: d3params
130 TYPE(error_type), ALLOCATABLE :: lib_error
131
132 CALL timeset(routinen, handle)
133
134 CALL init_reference_c6()
135
136 nref = 7
137 nelem = min(94, SIZE(maxci))
138
139 maxci(:) = 0
140 DO iz = 1, nelem
141 maxci(iz) = number_of_references(iz)
142 END DO
143
144 IF (para_env%is_source()) THEN
145 DO iz = 1, nelem
146 rcov_val = get_covalent_rad(iz)
147 rcov_tmp(iz) = rcov_val
148
149 r4r2 = get_r4r2_val(iz)
150 r2r4_tmp(iz) = r4r2
151 END DO
152
153 r0ab = 0.0_dp
154 DO iz = 1, nelem
155 DO jz = 1, nelem
156 IF (r2r4_tmp(iz) > 0.0_dp .AND. r2r4_tmp(jz) > 0.0_dp) THEN
157 r0ab(iz, jz) = get_vdw_rad(iz, jz)
158 END IF
159 END DO
160 END DO
161
162 c6ab = 0.0_dp
163 DO jref = 1, nref
164 DO jz = 1, nelem
165 DO i = 1, nref
166 DO iz = 1, nelem
167 c6_val = get_c6(i, jref, iz, jz)
168 c6ab(iz, jz, i, jref, 1) = c6_val
169 c6ab(iz, jz, i, jref, 2) = reference_cn(i, iz)
170 c6ab(iz, jz, i, jref, 3) = reference_cn(jref, jz)
171 END DO
172 END DO
173 END DO
174 END DO
175 END IF
176
177 CALL para_env%bcast(r2r4_tmp)
178 CALL para_env%bcast(r0ab)
179 CALL para_env%bcast(rcov_tmp)
180
181 IF (.NOT. para_env%is_source()) THEN
182 c6ab = 0.0_dp
183 DO jref = 1, nref
184 DO jz = 1, nelem
185 DO i = 1, nref
186 DO iz = 1, nelem
187 c6_val = get_c6(i, jref, iz, jz)
188 c6ab(iz, jz, i, jref, 1) = c6_val
189 c6ab(iz, jz, i, jref, 2) = reference_cn(i, iz)
190 c6ab(iz, jz, i, jref, 3) = reference_cn(jref, jz)
191 END DO
192 END DO
193 END DO
194 END DO
195 END IF
196
197 r2r4(:nelem) = r2r4_tmp(:nelem)
198 rcov(:nelem) = rcov_tmp(:nelem)
199
200 func_name = ref_functional
201 d3params = d3_param()
202
203 IF (para_env%is_source()) THEN
204 SELECT CASE (pp_type)
205 CASE (vdw_pairpot_dftd3)
206 CALL get_zero_damping(d3params, func_name, lib_error)
208 CALL get_rational_damping(d3params, func_name, lib_error)
209 CASE DEFAULT
210 d3params = d3_param()
211 END SELECT
212 IF (ALLOCATED(lib_error)) THEN
213 IF (PRESENT(error)) THEN
214 error = "Functional '"//trim(ref_functional)//"' not found in s-dftd3 library"
215 END IF
216 RETURN
217 END IF
218 END IF
219
220 CALL para_env%bcast(func_name)
221 CALL para_env%bcast(d3params%s6)
222 CALL para_env%bcast(d3params%s8)
223 CALL para_env%bcast(d3params%a1)
224 CALL para_env%bcast(d3params%a2)
225 CALL para_env%bcast(d3params%rs6)
226 CALL para_env%bcast(d3params%rs8)
227
228 IF (PRESENT(error)) error = ""
229
230 do_calc_scaling = .true.
231 IF (PRESENT(calc_scaling)) do_calc_scaling = calc_scaling
232
233 sr8 = d3params%rs8
234 IF (do_calc_scaling) THEN
235 s6 = d3params%s6
236 s8 = d3params%s8
237 a1 = d3params%a1
238 a2 = d3params%a2
239 sr6 = d3params%rs6
240 END IF
241
242 CALL timestop(handle)
243
244#else
245 mark_used(c6ab)
246 mark_used(maxci)
247 mark_used(r0ab)
248 mark_used(rcov)
249 mark_used(r2r4)
250 mark_used(pp_type)
251 mark_used(ref_functional)
252 mark_used(s6)
253 mark_used(s8)
254 mark_used(a1)
255 mark_used(a2)
256 mark_used(sr6)
257 mark_used(sr8)
258 mark_used(para_env)
259 mark_used(error)
260 mark_used(calc_scaling)
261 cpabort("s-dftd3 library not compiled in")
262#endif
263
264 END SUBROUTINE dftd3_param_from_library
265
266END MODULE qs_dispersion_s_dftd3
collects all constants needed in input so that they can be used without circular dependencies
integer, parameter, public vdw_pairpot_dftd3
integer, parameter, public vdw_pairpot_dftd3bj
Defines the basic variable types.
Definition kinds.F:23
integer, parameter, public dp
Definition kinds.F:34
integer, parameter, public default_string_length
Definition kinds.F:57
Interface to the message passing library MPI.
Coordination number routines for dispersion pairpotentials.
subroutine, public setr0ab(rout, rcov, r2r4)
...
subroutine, public dftd3_param_from_library(c6ab, maxci, r0ab, rcov, r2r4, pp_type, ref_functional, s6, s8, a1, a2, sr6, sr8, para_env, error, calc_scaling)
...
subroutine, public dftd3_functional_supported(pp_type, ref_functional, found)
Check if a functional is supported by the s-dftd3 library.
stores all the informations relevant to an mpi environment