(git:dbd702d)
Loading...
Searching...
No Matches
kpoint_types.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
8! **************************************************************************************************
9!> \brief Types and basic routines needed for a kpoint calculation
10!> \par History
11!> 2014.07 created [JGH]
12!> 2014.11 unified k-point and gamma-point code [Ole Schuett]
13!> \author JGH
14! **************************************************************************************************
16 USE cell_types, ONLY: cell_type
19 USE cp_cfm_types, ONLY: cp_cfm_release,&
21 USE cp_fm_types, ONLY: cp_fm_release,&
38 USE kinds, ONLY: default_string_length,&
39 dp
41 USE mathconstants, ONLY: twopi
44 USE physcon, ONLY: angstrom
53#include "./base/base_uses.f90"
54
55 IMPLICIT NONE
56
57 PRIVATE
58
59 CHARACTER(len=*), PARAMETER, PRIVATE :: moduleN = 'kpoint_types'
60
61 PUBLIC :: kpoint_type
64 PUBLIC :: kpoint_clear_scf_smat
67 PUBLIC :: kind_rotmat_type
68 PUBLIC :: kpoint_sym_type
70
71! **************************************************************************************************
72!> \brief Keeps information about a specific k-point
73!> \param nkpoint the kpoint index
74!> \param wkp weight of this kpoint
75!> \param xkp kpoint coordinates in units of b-vector
76!> \param is_local if this kpoint is calculated on a single thread
77!> \param mos associated MOs (spin); complex coefficients use native CFM storage
78!> \param mos_prefilled the MOS hold meaningful coefficients (refilled and
79!> reorthogonalized by wavefunction extrapolation for the
80!> current geometry) rather than being only allocated
81!> \param pmat associated density matrix (r/i,spin)
82!> \param wmat associated energy weighted density matrix (r/i,spin)
83!> \param smat real ADMM auxiliary overlap matrix
84!> \param amat real ADMM basis projection matrix
85!> \param csmat complex ADMM auxiliary overlap matrix
86!> \param camat complex ADMM basis projection matrix
87!> \param ot_hmat channel-local Kohn-Sham matrix for k-point OT (r/i,spin)
88!> \param ot_smat channel-local overlap matrix for k-point OT (r/i)
89!> \param ot_tmat channel-local kinetic-energy matrix for k-point OT (r/i)
90!> \param shalf S(K)^(1/2) DFT+U Lowdin method (real wfn)
91!> \param cshalf S(K)^(1/2) DFT+U Lowdin method (complex wfn)
92!> \author JGH
93! **************************************************************************************************
95 INTEGER :: nkpoint = -1
96 REAL(kind=dp) :: wkp = 0.0_dp
97 REAL(kind=dp), DIMENSION(3) :: xkp = 0.0_dp
98 LOGICAL :: is_local = .false.
99 TYPE(mo_set_type), DIMENSION(:), POINTER :: mos => null()
100 LOGICAL :: mos_prefilled = .false.
101 TYPE(cp_fm_type), DIMENSION(:, :), POINTER :: pmat => null()
102 TYPE(cp_fm_type), DIMENSION(:, :), POINTER :: wmat => null()
103 TYPE(cp_fm_type) :: smat, amat
104 TYPE(cp_cfm_type) :: csmat, camat
105 TYPE(cp_fm_type), DIMENSION(:, :), POINTER :: ot_hmat => null()
106 TYPE(cp_fm_type), DIMENSION(:), POINTER :: ot_smat => null()
107 TYPE(cp_fm_type), DIMENSION(:), POINTER :: ot_tmat => null()
108 TYPE(cp_fm_type) :: shalf
109 TYPE(cp_cfm_type) :: cshalf
110 ! Selected columns of S(k)**(1/2), with one reusable product workspace.
111 TYPE(cp_fm_type) :: lowdin_b, lowdin_work
112 TYPE(cp_cfm_type) :: lowdin_cb, lowdin_cwork
113 ! Spectrum of S for analytic Lowdin derivatives, retained only for force runs.
114 TYPE(cp_cfm_type) :: lowdin_evec
115 REAL(dp), ALLOCATABLE :: lowdin_sqrt(:)
116 TYPE(local_gemm_ctxt_type) :: lowdin_gemm
117 END TYPE kpoint_env_type
118
120 TYPE(kpoint_env_type), POINTER :: kpoint_env => null()
121 END TYPE kpoint_env_p_type
122
123! **************************************************************************************************
124!> \brief Rotation matrices for basis sets
125!> \param rmat atom basis function rotation matrix
126!> \author JGH
127! **************************************************************************************************
129 REAL(kind=dp), DIMENSION(:, :), POINTER :: rmat => null()
130 END TYPE kind_rotmat_type
131
132! **************************************************************************************************
133!> \brief Keeps symmetry information about a specific k-point
134!> \param apply_symmetry ...
135!> \param nwght kpoint multiplicity
136!> \param xkp kpoint coordinates
137!> \param rot rotation matrices
138!> \param f0 atom permutation
139!> \param fcell atom cell shifts generated by the symmetry operation
140!> \param fcell_gauge atom cell shifts in CP2K's internal PBC gauge
141!> \param phase_mode Bloch phase direction selected from overlap covariance
142!> \author JGH
143! **************************************************************************************************
145 LOGICAL :: apply_symmetry = .false.
146 INTEGER :: nwght = -1
147 INTEGER :: nwred = -1
148 REAL(kind=dp), DIMENSION(:, :), POINTER :: xkp => null()
149 REAL(kind=dp), DIMENSION(:, :, :), POINTER :: rot => null()
150 INTEGER, DIMENSION(:), POINTER :: rotp => null()
151 INTEGER, DIMENSION(:, :), POINTER :: f0 => null()
152 INTEGER, DIMENSION(:, :, :), POINTER :: fcell => null()
153 INTEGER, DIMENSION(:, :, :), POINTER :: fcell_gauge => null()
154 INTEGER, DIMENSION(:), POINTER :: phase_mode => null()
155 END TYPE kpoint_sym_type
156
157 TYPE kpoint_sym_p_type
158 TYPE(kpoint_sym_type), POINTER :: kpoint_sym => null()
159 END TYPE kpoint_sym_p_type
160
161! **************************************************************************************************
162!> \brief Contains information about kpoints
163!> \par History
164!> 2014.07 created [JGH]
165!> \param kp_scheme [input] Type of kpoint grid
166!> \param nkp_grid [input] Grid points
167!> \param kp_shift [input] Shift of the grid
168!> \param use_real_wfn [input] real/complex wfn
169!> \param symmetry [input] use symmetry (atoms) to reduce kpoints
170!> \param full_grid [input] don't reduce kpoints at all
171!> \param rskp_transform [input] R-to-K/K-to-R backend (GEMM or FFT)
172!> \param inversion_symmetry_only [input] reduce kpoints only by inversion symmetry
173!> \param symmetry_backend [input] k-point symmetry backend
174!> \param symmetry_reduction_method [input] k-point symmetry reduction method
175!> \param verbose [input] more output information
176!> \param eps_geo [input] accuracy of atom symmetry detection
177!> \param parallel_group_size [input] kpoint group size
178!> \param nkp number of kpoints
179!> \param xkp kpoint coordinates
180!> \param wkp kpoint weights
181!> \param xkp_input explicit GENERAL kpoint coordinates as read from the input
182!> \param wkp_input explicit GENERAL kpoint weights as read from the input
183!> \param para_env 'global' parallel environment
184!> \param para_env_kp parallel environment of the kpoint calculation
185!> \param para_env_inter_kp parallel environment between kpoints
186!> \param iogrp this kpoint group has the IO processor
187!> \param nkp_groups number of kpoint groups
188!> \param kp_dist kpoints distribution on groups
189!> \param kp_range kpoints distribution for local processor
190!> \param blacs_env BLACS env for the kpoint group
191!> \param opmats Operator matrices
192!> \param kp_env Information for each kpoint
193!> \param mpools FM matrix pools for kpoint groups
194!> \author JGH
195! **************************************************************************************************
197 CHARACTER(LEN=default_string_length) :: kp_scheme = ""
198 INTEGER, DIMENSION(3) :: nkp_grid = -1
199 REAL(kind=dp), DIMENSION(3) :: kp_shift = 0.0_dp
200 LOGICAL :: gamma_centered = .false.
201 LOGICAL :: use_real_wfn = .false.
202 LOGICAL :: symmetry = .false.
203 LOGICAL :: full_grid = .false.
204 INTEGER :: rskp_transform = rskp_backend_gemm
205 LOGICAL :: inversion_symmetry_only = .false.
206 INTEGER :: symmetry_backend = use_k290_kpoint_backend
207 INTEGER :: symmetry_reduction_method = use_k290_kpoint_symmetry
208 LOGICAL :: verbose = .false.
209 REAL(kind=dp) :: eps_geo = 0.0_dp
210 INTEGER :: parallel_group_size = -1
211 INTEGER :: nkp = -1
212 REAL(kind=dp), DIMENSION(:, :), POINTER :: xkp => null()
213 REAL(kind=dp), DIMENSION(:), POINTER :: wkp => null()
214 REAL(kind=dp), DIMENSION(:, :), POINTER :: xkp_input => null()
215 REAL(kind=dp), DIMENSION(:), POINTER :: wkp_input => null()
216 ! parallel environment
217 TYPE(mp_para_env_type), POINTER :: para_env => null()
218 TYPE(cp_blacs_env_type), POINTER :: blacs_env_all => null()
219 TYPE(mp_para_env_type), POINTER :: para_env_kp => null(), &
220 para_env_inter_kp => null()
221 LOGICAL :: iogrp = .false.
222 INTEGER :: nkp_groups = -1
223 INTEGER, DIMENSION(:, :), POINTER :: kp_dist => null()
224 INTEGER, DIMENSION(2) :: kp_range = -1
225 TYPE(cp_blacs_env_type), POINTER :: blacs_env => null()
226 INTEGER, DIMENSION(:, :, :), POINTER :: cell_to_index => null()
227 INTEGER, DIMENSION(:, :), POINTER :: index_to_cell => null()
229 DIMENSION(:), POINTER :: sab_nl => null(), &
230 sab_nl_nosym => null()
231 ! environment
232 TYPE(kpoint_env_p_type), DIMENSION(:), &
233 POINTER :: kp_env => null()
234 TYPE(kpoint_env_p_type), DIMENSION(:), &
235 POINTER :: kp_aux_env => null()
236 ! symmetry
237 TYPE(kpoint_sym_p_type), DIMENSION(:), &
238 POINTER :: kp_sym => null()
239 LOGICAL :: phases_calibrated = .false.
240 INTEGER, DIMENSION(:), POINTER :: atype => null()
241 INTEGER, DIMENSION(:), POINTER :: ibrot => null()
242 TYPE(kind_rotmat_type), DIMENSION(:, :), &
243 POINTER :: kind_rotmat => null()
244 TYPE(kind_rotmat_type), DIMENSION(:, :), &
245 POINTER :: kind_rotmat_aux => null()
246 ! pools
247 TYPE(qs_matrix_pools_type), POINTER :: mpools => null()
248 TYPE(qs_diis_buffer_type_kp), POINTER :: scf_diis_buffer => null()
249 ! Unmodified complex overlaps for the current SCF run, indexed by local k-point.
250 TYPE(cp_cfm_type), ALLOCATABLE, DIMENSION(:) :: scf_smat
251 ! Selected AO indices, accepted density/potential, and a separate cached trial density.
252 INTEGER, ALLOCATABLE :: lowdin_orbitals(:)
253 REAL(dp), ALLOCATABLE :: lowdin_q(:, :), lowdin_v(:, :), lowdin_q_new(:, :)
254 LOGICAL :: lowdin_density_ready = .false., lowdin_population_ready = .false.
255 TYPE(qs_matrix_pools_type), POINTER :: mpools_aux_fit => null()
256 END TYPE kpoint_type
257
258! **************************************************************************************************
259
260CONTAINS
261
262! **************************************************************************************************
263!> \brief Create a kpoint environment
264!> \param kpoint All the kpoint information
265!> \author JGH
266! **************************************************************************************************
267 SUBROUTINE kpoint_create(kpoint)
268 TYPE(kpoint_type), POINTER :: kpoint
269
270 cpassert(.NOT. ASSOCIATED(kpoint))
271
272 ALLOCATE (kpoint)
273
274 kpoint%kp_scheme = ""
275 kpoint%nkp_grid = 0
276 kpoint%kp_shift = 0.0_dp
277 kpoint%gamma_centered = .false.
278 kpoint%symmetry = .false.
279 kpoint%verbose = .false.
280 kpoint%full_grid = .false.
281 kpoint%rskp_transform = rskp_backend_gemm
282 kpoint%inversion_symmetry_only = .false.
283 kpoint%symmetry_backend = use_k290_kpoint_backend
284 kpoint%symmetry_reduction_method = use_k290_kpoint_symmetry
285 kpoint%use_real_wfn = .false.
286 kpoint%eps_geo = 1.0e-6_dp
287 kpoint%parallel_group_size = -1
288
289 kpoint%nkp = 0
290 kpoint%phases_calibrated = .false.
291
292 NULLIFY (kpoint%xkp, kpoint%wkp)
293 NULLIFY (kpoint%xkp_input, kpoint%wkp_input)
294 NULLIFY (kpoint%kp_dist)
295
296 NULLIFY (kpoint%para_env)
297 NULLIFY (kpoint%blacs_env_all)
298 NULLIFY (kpoint%para_env_kp, kpoint%para_env_inter_kp)
299 NULLIFY (kpoint%blacs_env)
300 kpoint%nkp_groups = 0
301 kpoint%iogrp = .false.
302 kpoint%kp_range = 0
303
304 NULLIFY (kpoint%kp_env)
305 NULLIFY (kpoint%mpools)
306
307 ALLOCATE (kpoint%cell_to_index(0:0, 0:0, 0:0))
308 kpoint%cell_to_index(:, :, :) = 1
309
310 ALLOCATE (kpoint%index_to_cell(0:0, 0:0))
311 kpoint%index_to_cell(:, :) = 0
312
313 END SUBROUTINE kpoint_create
314
315! **************************************************************************************************
316!> \brief Release a kpoint environment, deallocate all data
317!> \param kpoint The kpoint environment
318!> \author JGH
319! **************************************************************************************************
320 SUBROUTINE kpoint_release(kpoint)
321 TYPE(kpoint_type), POINTER :: kpoint
322
323 INTEGER :: i, ik, j
324
325 IF (ASSOCIATED(kpoint)) THEN
326 CALL kpoint_clear_scf_smat(kpoint)
327
328 IF (ASSOCIATED(kpoint%xkp)) THEN
329 DEALLOCATE (kpoint%xkp)
330 END IF
331 IF (ASSOCIATED(kpoint%wkp)) THEN
332 DEALLOCATE (kpoint%wkp)
333 END IF
334 IF (ASSOCIATED(kpoint%xkp_input)) THEN
335 DEALLOCATE (kpoint%xkp_input)
336 END IF
337 IF (ASSOCIATED(kpoint%wkp_input)) THEN
338 DEALLOCATE (kpoint%wkp_input)
339 END IF
340 IF (ASSOCIATED(kpoint%kp_dist)) THEN
341 DEALLOCATE (kpoint%kp_dist)
342 END IF
343
344 CALL mpools_release(kpoint%mpools)
345 CALL mpools_release(kpoint%mpools_aux_fit)
346
347 CALL cp_blacs_env_release(kpoint%blacs_env)
348 CALL cp_blacs_env_release(kpoint%blacs_env_all)
349
350 CALL mp_para_env_release(kpoint%para_env)
351 CALL mp_para_env_release(kpoint%para_env_kp)
352 CALL mp_para_env_release(kpoint%para_env_inter_kp)
353
354 IF (ASSOCIATED(kpoint%cell_to_index)) DEALLOCATE (kpoint%cell_to_index)
355 IF (ASSOCIATED(kpoint%index_to_cell)) DEALLOCATE (kpoint%index_to_cell)
356
357 IF (ASSOCIATED(kpoint%kp_env)) THEN
358 DO ik = 1, SIZE(kpoint%kp_env)
359 CALL kpoint_env_release(kpoint%kp_env(ik)%kpoint_env)
360 END DO
361 DEALLOCATE (kpoint%kp_env)
362 END IF
363
364 IF (ASSOCIATED(kpoint%kp_aux_env)) THEN
365 DO ik = 1, SIZE(kpoint%kp_aux_env)
366 CALL kpoint_env_release(kpoint%kp_aux_env(ik)%kpoint_env)
367 END DO
368 DEALLOCATE (kpoint%kp_aux_env)
369 END IF
370
371 IF (ASSOCIATED(kpoint%kp_sym)) THEN
372 DO ik = 1, SIZE(kpoint%kp_sym)
373 CALL kpoint_sym_release(kpoint%kp_sym(ik)%kpoint_sym)
374 END DO
375 DEALLOCATE (kpoint%kp_sym)
376 END IF
377
378 IF (ASSOCIATED(kpoint%atype)) DEALLOCATE (kpoint%atype)
379 IF (ASSOCIATED(kpoint%ibrot)) DEALLOCATE (kpoint%ibrot)
380
381 IF (ASSOCIATED(kpoint%kind_rotmat)) THEN
382 DO i = 1, SIZE(kpoint%kind_rotmat, 1)
383 DO j = 1, SIZE(kpoint%kind_rotmat, 2)
384 IF (ASSOCIATED(kpoint%kind_rotmat(i, j)%rmat)) THEN
385 DEALLOCATE (kpoint%kind_rotmat(i, j)%rmat)
386 END IF
387 END DO
388 END DO
389 DEALLOCATE (kpoint%kind_rotmat)
390 END IF
391
392 IF (ASSOCIATED(kpoint%kind_rotmat_aux)) THEN
393 DO i = 1, SIZE(kpoint%kind_rotmat_aux, 1)
394 DO j = 1, SIZE(kpoint%kind_rotmat_aux, 2)
395 IF (ASSOCIATED(kpoint%kind_rotmat_aux(i, j)%rmat)) THEN
396 DEALLOCATE (kpoint%kind_rotmat_aux(i, j)%rmat)
397 END IF
398 END DO
399 END DO
400 DEALLOCATE (kpoint%kind_rotmat_aux)
401 END IF
402
403 IF (ASSOCIATED(kpoint%scf_diis_buffer)) THEN
404 CALL qs_diis_b_release_kp(kpoint%scf_diis_buffer)
405 DEALLOCATE (kpoint%scf_diis_buffer)
406 END IF
407
408 DEALLOCATE (kpoint)
409
410 END IF
411
412 END SUBROUTINE kpoint_release
413
414! **************************************************************************************************
415!> \brief Release overlap matrices cached for a single SCF run.
416!> \param kpoint The kpoint environment
417! **************************************************************************************************
418 SUBROUTINE kpoint_clear_scf_smat(kpoint)
419 TYPE(kpoint_type), INTENT(INOUT) :: kpoint
420
421 INTEGER :: ikp
422
423 IF (ALLOCATED(kpoint%scf_smat)) THEN
424 DO ikp = 1, SIZE(kpoint%scf_smat)
425 CALL cp_cfm_release(kpoint%scf_smat(ikp))
426 END DO
427 DEALLOCATE (kpoint%scf_smat)
428 END IF
429
430 END SUBROUTINE kpoint_clear_scf_smat
431
432! **************************************************************************************************
433!> \brief Reset all data derived from a concrete k-point initialization.
434!> Input options such as the scheme, grid, shifts and symmetry settings are kept.
435!> \param kpoint The kpoint environment
436! **************************************************************************************************
438 TYPE(kpoint_type), INTENT(INOUT) :: kpoint
439
440 INTEGER :: i, ik, j
441
442 CALL kpoint_clear_scf_smat(kpoint)
443 IF (ALLOCATED(kpoint%lowdin_orbitals)) THEN
444 DEALLOCATE (kpoint%lowdin_orbitals, kpoint%lowdin_q, kpoint%lowdin_q_new, kpoint%lowdin_v)
445 END IF
446 kpoint%lowdin_density_ready = .false.
447 kpoint%lowdin_population_ready = .false.
448
449 IF (ASSOCIATED(kpoint%xkp)) THEN
450 DEALLOCATE (kpoint%xkp)
451 NULLIFY (kpoint%xkp)
452 END IF
453 IF (ASSOCIATED(kpoint%wkp)) THEN
454 DEALLOCATE (kpoint%wkp)
455 NULLIFY (kpoint%wkp)
456 END IF
457 IF (kpoint%kp_scheme == "GENERAL" .AND. ASSOCIATED(kpoint%xkp_input) .AND. &
458 ASSOCIATED(kpoint%wkp_input)) THEN
459 kpoint%nkp = SIZE(kpoint%wkp_input)
460 ALLOCATE (kpoint%xkp(3, kpoint%nkp), kpoint%wkp(kpoint%nkp))
461 kpoint%xkp(1:3, 1:kpoint%nkp) = kpoint%xkp_input(1:3, 1:kpoint%nkp)
462 kpoint%wkp(1:kpoint%nkp) = kpoint%wkp_input(1:kpoint%nkp)
463 END IF
464 IF (ASSOCIATED(kpoint%kp_dist)) THEN
465 DEALLOCATE (kpoint%kp_dist)
466 NULLIFY (kpoint%kp_dist)
467 END IF
468
469 CALL mpools_release(kpoint%mpools)
470 CALL mpools_release(kpoint%mpools_aux_fit)
471
472 CALL cp_blacs_env_release(kpoint%blacs_env)
473 CALL cp_blacs_env_release(kpoint%blacs_env_all)
474
475 CALL mp_para_env_release(kpoint%para_env)
476 CALL mp_para_env_release(kpoint%para_env_kp)
477 CALL mp_para_env_release(kpoint%para_env_inter_kp)
478
479 IF (ASSOCIATED(kpoint%cell_to_index)) THEN
480 DEALLOCATE (kpoint%cell_to_index)
481 NULLIFY (kpoint%cell_to_index)
482 END IF
483 IF (ASSOCIATED(kpoint%index_to_cell)) THEN
484 DEALLOCATE (kpoint%index_to_cell)
485 NULLIFY (kpoint%index_to_cell)
486 END IF
487
488 IF (ASSOCIATED(kpoint%kp_env)) THEN
489 DO ik = 1, SIZE(kpoint%kp_env)
490 CALL kpoint_env_release(kpoint%kp_env(ik)%kpoint_env)
491 END DO
492 DEALLOCATE (kpoint%kp_env)
493 NULLIFY (kpoint%kp_env)
494 END IF
495
496 IF (ASSOCIATED(kpoint%kp_aux_env)) THEN
497 DO ik = 1, SIZE(kpoint%kp_aux_env)
498 CALL kpoint_env_release(kpoint%kp_aux_env(ik)%kpoint_env)
499 END DO
500 DEALLOCATE (kpoint%kp_aux_env)
501 NULLIFY (kpoint%kp_aux_env)
502 END IF
503
504 IF (ASSOCIATED(kpoint%kp_sym)) THEN
505 DO ik = 1, SIZE(kpoint%kp_sym)
506 CALL kpoint_sym_release(kpoint%kp_sym(ik)%kpoint_sym)
507 END DO
508 DEALLOCATE (kpoint%kp_sym)
509 NULLIFY (kpoint%kp_sym)
510 END IF
511
512 IF (ASSOCIATED(kpoint%atype)) THEN
513 DEALLOCATE (kpoint%atype)
514 NULLIFY (kpoint%atype)
515 END IF
516 IF (ASSOCIATED(kpoint%ibrot)) THEN
517 DEALLOCATE (kpoint%ibrot)
518 NULLIFY (kpoint%ibrot)
519 END IF
520
521 IF (ASSOCIATED(kpoint%kind_rotmat)) THEN
522 DO i = 1, SIZE(kpoint%kind_rotmat, 1)
523 DO j = 1, SIZE(kpoint%kind_rotmat, 2)
524 IF (ASSOCIATED(kpoint%kind_rotmat(i, j)%rmat)) THEN
525 DEALLOCATE (kpoint%kind_rotmat(i, j)%rmat)
526 NULLIFY (kpoint%kind_rotmat(i, j)%rmat)
527 END IF
528 END DO
529 END DO
530 DEALLOCATE (kpoint%kind_rotmat)
531 NULLIFY (kpoint%kind_rotmat)
532 END IF
533
534 IF (ASSOCIATED(kpoint%kind_rotmat_aux)) THEN
535 DO i = 1, SIZE(kpoint%kind_rotmat_aux, 1)
536 DO j = 1, SIZE(kpoint%kind_rotmat_aux, 2)
537 IF (ASSOCIATED(kpoint%kind_rotmat_aux(i, j)%rmat)) THEN
538 DEALLOCATE (kpoint%kind_rotmat_aux(i, j)%rmat)
539 NULLIFY (kpoint%kind_rotmat_aux(i, j)%rmat)
540 END IF
541 END DO
542 END DO
543 DEALLOCATE (kpoint%kind_rotmat_aux)
544 NULLIFY (kpoint%kind_rotmat_aux)
545 END IF
546
547 IF (ASSOCIATED(kpoint%scf_diis_buffer)) THEN
548 CALL qs_diis_b_release_kp(kpoint%scf_diis_buffer)
549 DEALLOCATE (kpoint%scf_diis_buffer)
550 NULLIFY (kpoint%scf_diis_buffer)
551 END IF
552
553 NULLIFY (kpoint%sab_nl)
554 NULLIFY (kpoint%sab_nl_nosym)
555
556 ALLOCATE (kpoint%cell_to_index(0:0, 0:0, 0:0))
557 kpoint%cell_to_index(:, :, :) = 1
558
559 ALLOCATE (kpoint%index_to_cell(0:0, 0:0))
560 kpoint%index_to_cell(:, :) = 0
561
562 IF (.NOT. ASSOCIATED(kpoint%wkp)) kpoint%nkp = 0
563 kpoint%nkp_groups = 0
564 kpoint%kp_range = 0
565 kpoint%iogrp = .false.
566
567 END SUBROUTINE kpoint_reset_initialization
568
569! **************************************************************************************************
570!> \brief Retrieve information from a kpoint environment
571!> \param kpoint The kpoint environment
572!> \param kp_scheme Type of kpoint grid
573!> \param nkp_grid Grid points
574!> \param kp_shift Shift of the grid
575!> \param symmetry use symmetry (atoms) to reduce kpoints
576!> \param verbose more output information
577!> \param full_grid don't reduce kpoints at all
578!> \param use_real_wfn real/complex wfn
579!> \param eps_geo accuracy of atom symmetry detection
580!> \param parallel_group_size kpoint group size
581!> \param kp_range kpoints distribution for local processor
582!> \param nkp number of kpoints
583!> \param xkp kpoint coordinates in units of b-vector
584!> \param wkp kpoint weights
585!> \param para_env 'global' parallel environment
586!> \param blacs_env_all BLACS env for the total environment
587!> \param para_env_kp parallel environment of the kpoint calculation
588!> \param para_env_inter_kp parallel environment between kpoints
589!> \param blacs_env BLACS env for the kpoint group
590!> \param kp_env Information for each kpoint
591!> \param kp_aux_env ...
592!> \param mpools FM matrix pools for kpoint groups
593!> \param iogrp this kpoint group has the IO processor
594!> \param nkp_groups number of kpoint groups
595!> \param kp_dist kpoints distribution on groups
596!> \param cell_to_index given a cell triple, returns the real space index
597!> \param index_to_cell ...
598!> \param sab_nl neighbourlist that defines real space matrices
599!> \param sab_nl_nosym neighbourlist that defines real space matrices, non-symmetric
600!> \param inversion_symmetry_only reduce kpoints only by inversion symmetry
601!> \param symmetry_backend k-point symmetry backend
602!> \param symmetry_reduction_method k-point symmetry reduction method
603!> \param gamma_centered ...
604!> \param rskp_transform R-to-K/K-to-R backend (GEMM or FFT)
605!> \author JGH
606! **************************************************************************************************
607 SUBROUTINE get_kpoint_info(kpoint, kp_scheme, nkp_grid, kp_shift, symmetry, verbose, &
608 full_grid, use_real_wfn, eps_geo, parallel_group_size, kp_range, nkp, xkp, wkp, &
609 para_env, blacs_env_all, para_env_kp, para_env_inter_kp, blacs_env, &
610 kp_env, kp_aux_env, mpools, iogrp, nkp_groups, kp_dist, cell_to_index, index_to_cell, &
611 sab_nl, sab_nl_nosym, inversion_symmetry_only, symmetry_backend, &
612 symmetry_reduction_method, gamma_centered, rskp_transform)
613 TYPE(kpoint_type), INTENT(IN) :: kpoint
614 CHARACTER(LEN=*), OPTIONAL :: kp_scheme
615 INTEGER, DIMENSION(3), OPTIONAL :: nkp_grid
616 REAL(kind=dp), DIMENSION(3), OPTIONAL :: kp_shift
617 LOGICAL, OPTIONAL :: symmetry, verbose, full_grid, &
619 REAL(kind=dp), OPTIONAL :: eps_geo
620 INTEGER, OPTIONAL :: parallel_group_size
621 INTEGER, DIMENSION(2), OPTIONAL :: kp_range
622 INTEGER, OPTIONAL :: nkp
623 REAL(kind=dp), DIMENSION(:, :), OPTIONAL, POINTER :: xkp
624 REAL(kind=dp), DIMENSION(:), OPTIONAL, POINTER :: wkp
625 TYPE(mp_para_env_type), OPTIONAL, POINTER :: para_env
626 TYPE(cp_blacs_env_type), OPTIONAL, POINTER :: blacs_env_all
627 TYPE(mp_para_env_type), OPTIONAL, POINTER :: para_env_kp, para_env_inter_kp
628 TYPE(cp_blacs_env_type), OPTIONAL, POINTER :: blacs_env
629 TYPE(kpoint_env_p_type), DIMENSION(:), OPTIONAL, &
630 POINTER :: kp_env, kp_aux_env
631 TYPE(qs_matrix_pools_type), OPTIONAL, POINTER :: mpools
632 LOGICAL, OPTIONAL :: iogrp
633 INTEGER, OPTIONAL :: nkp_groups
634 INTEGER, DIMENSION(:, :), OPTIONAL, POINTER :: kp_dist
635 INTEGER, DIMENSION(:, :, :), OPTIONAL, POINTER :: cell_to_index
636 INTEGER, DIMENSION(:, :), OPTIONAL, POINTER :: index_to_cell
637 TYPE(neighbor_list_set_p_type), DIMENSION(:), &
638 OPTIONAL, POINTER :: sab_nl, sab_nl_nosym
639 LOGICAL, OPTIONAL :: inversion_symmetry_only
640 INTEGER, OPTIONAL :: symmetry_backend, &
641 symmetry_reduction_method
642 LOGICAL, OPTIONAL :: gamma_centered
643 INTEGER, OPTIONAL :: rskp_transform
644
645 IF (PRESENT(kp_scheme)) kp_scheme = kpoint%kp_scheme
646 IF (PRESENT(nkp_grid)) nkp_grid = kpoint%nkp_grid
647 IF (PRESENT(kp_shift)) kp_shift = kpoint%kp_shift
648 IF (PRESENT(gamma_centered)) gamma_centered = kpoint%gamma_centered
649 IF (PRESENT(symmetry)) symmetry = kpoint%symmetry
650 IF (PRESENT(verbose)) verbose = kpoint%verbose
651 IF (PRESENT(full_grid)) full_grid = kpoint%full_grid
652 IF (PRESENT(rskp_transform)) rskp_transform = kpoint%rskp_transform
653 IF (PRESENT(inversion_symmetry_only)) inversion_symmetry_only = kpoint%inversion_symmetry_only
654 IF (PRESENT(symmetry_backend)) symmetry_backend = kpoint%symmetry_backend
655 IF (PRESENT(symmetry_reduction_method)) THEN
656 symmetry_reduction_method = kpoint%symmetry_reduction_method
657 END IF
658 IF (PRESENT(use_real_wfn)) use_real_wfn = kpoint%use_real_wfn
659 IF (PRESENT(eps_geo)) eps_geo = kpoint%eps_geo
660 IF (PRESENT(parallel_group_size)) parallel_group_size = kpoint%parallel_group_size
661
662 IF (PRESENT(nkp)) nkp = kpoint%nkp
663 IF (PRESENT(wkp)) wkp => kpoint%wkp
664 IF (PRESENT(xkp)) xkp => kpoint%xkp
665
666 IF (PRESENT(para_env)) para_env => kpoint%para_env
667 IF (PRESENT(para_env_kp)) para_env_kp => kpoint%para_env_kp
668 IF (PRESENT(para_env_inter_kp)) para_env_inter_kp => kpoint%para_env_inter_kp
669 IF (PRESENT(blacs_env_all)) blacs_env_all => kpoint%blacs_env_all
670 IF (PRESENT(blacs_env)) blacs_env => kpoint%blacs_env
671
672 IF (PRESENT(iogrp)) iogrp = kpoint%iogrp
673 IF (PRESENT(kp_range)) kp_range = kpoint%kp_range
674 IF (PRESENT(nkp_groups)) nkp_groups = kpoint%nkp_groups
675 IF (PRESENT(kp_dist)) kp_dist => kpoint%kp_dist
676
677 IF (PRESENT(kp_env)) kp_env => kpoint%kp_env
678 IF (PRESENT(kp_aux_env)) kp_aux_env => kpoint%kp_aux_env
679 IF (PRESENT(mpools)) mpools => kpoint%mpools
680
681 IF (PRESENT(cell_to_index)) cell_to_index => kpoint%cell_to_index
682 IF (PRESENT(index_to_cell)) index_to_cell => kpoint%index_to_cell
683 IF (PRESENT(sab_nl)) sab_nl => kpoint%sab_nl
684 IF (PRESENT(sab_nl_nosym)) sab_nl_nosym => kpoint%sab_nl_nosym
685
686 END SUBROUTINE get_kpoint_info
687
688! **************************************************************************************************
689!> \brief Set information in a kpoint environment
690!> \param kpoint The kpoint environment
691!> \param kp_scheme Type of kpoint grid
692!> \param nkp_grid Grid points
693!> \param kp_shift Shift of the grid
694!> \param symmetry use symmetry (atoms) to reduce kpoints
695!> \param verbose more output information
696!> \param full_grid don't reduce kpoints at all
697!> \param use_real_wfn real/complex wfn
698!> \param eps_geo accuracy of atom symmetry detection
699!> \param parallel_group_size kpoint group size
700!> \param kp_range kpoints distribution for local processor
701!> \param nkp number of kpoints
702!> \param xkp kpoint coordinates
703!> \param wkp kpoint weights
704!> \param para_env 'global' parallel environment
705!> \param blacs_env_all BLACS env for the total environment
706!> \param para_env_kp parallel environment of the kpoint calculation
707!> \param para_env_inter_kp parallel environment between kpoints
708!> \param blacs_env BLACS env for the kpoint group
709!> \param kp_env Information for each kpoint
710!> \param kp_aux_env ...
711!> \param mpools FM matrix pools for kpoint groups
712!> \param iogrp this kpoint group has the IO processor
713!> \param nkp_groups number of kpoint groups
714!> \param kp_dist kpoints distribution on groups
715!> \param cell_to_index given a cell triple, returns the real space index
716!> \param index_to_cell ...
717!> \param sab_nl neighbourlist that defines real space matrices
718!> \param sab_nl_nosym neighbourlist that defines real space matrices
719!> \param inversion_symmetry_only reduce kpoints only by inversion symmetry
720!> \param symmetry_backend k-point symmetry backend
721!> \param symmetry_reduction_method k-point symmetry reduction method
722!> \param gamma_centered ...
723!> \author JGH
724! **************************************************************************************************
725 SUBROUTINE set_kpoint_info(kpoint, kp_scheme, nkp_grid, kp_shift, symmetry, verbose, &
726 full_grid, use_real_wfn, eps_geo, parallel_group_size, kp_range, nkp, xkp, wkp, &
727 para_env, blacs_env_all, para_env_kp, para_env_inter_kp, blacs_env, &
728 kp_env, kp_aux_env, mpools, iogrp, nkp_groups, kp_dist, cell_to_index, index_to_cell, &
729 sab_nl, sab_nl_nosym, inversion_symmetry_only, symmetry_backend, &
730 symmetry_reduction_method, gamma_centered)
731 TYPE(kpoint_type), INTENT(INOUT) :: kpoint
732 CHARACTER(LEN=*), OPTIONAL :: kp_scheme
733 INTEGER, DIMENSION(3), OPTIONAL :: nkp_grid
734 REAL(kind=dp), DIMENSION(3), OPTIONAL :: kp_shift
735 LOGICAL, OPTIONAL :: symmetry, verbose, full_grid, &
737 REAL(kind=dp), OPTIONAL :: eps_geo
738 INTEGER, OPTIONAL :: parallel_group_size
739 INTEGER, DIMENSION(2), OPTIONAL :: kp_range
740 INTEGER, OPTIONAL :: nkp
741 REAL(kind=dp), DIMENSION(:, :), OPTIONAL, POINTER :: xkp
742 REAL(kind=dp), DIMENSION(:), OPTIONAL, POINTER :: wkp
743 TYPE(mp_para_env_type), OPTIONAL, POINTER :: para_env
744 TYPE(cp_blacs_env_type), OPTIONAL, POINTER :: blacs_env_all
745 TYPE(mp_para_env_type), OPTIONAL, POINTER :: para_env_kp, para_env_inter_kp
746 TYPE(cp_blacs_env_type), OPTIONAL, POINTER :: blacs_env
747 TYPE(kpoint_env_p_type), DIMENSION(:), OPTIONAL, &
748 POINTER :: kp_env, kp_aux_env
749 TYPE(qs_matrix_pools_type), OPTIONAL, POINTER :: mpools
750 LOGICAL, OPTIONAL :: iogrp
751 INTEGER, OPTIONAL :: nkp_groups
752 INTEGER, DIMENSION(:, :), OPTIONAL, POINTER :: kp_dist
753 INTEGER, DIMENSION(:, :, :), OPTIONAL, POINTER :: cell_to_index
754 INTEGER, DIMENSION(:, :), OPTIONAL, POINTER :: index_to_cell
755 TYPE(neighbor_list_set_p_type), DIMENSION(:), &
756 OPTIONAL, POINTER :: sab_nl, sab_nl_nosym
757 LOGICAL, OPTIONAL :: inversion_symmetry_only
758 INTEGER, OPTIONAL :: symmetry_backend, &
759 symmetry_reduction_method
760 LOGICAL, OPTIONAL :: gamma_centered
761
762 IF (PRESENT(kp_scheme)) kpoint%kp_scheme = kp_scheme
763 IF (PRESENT(nkp_grid)) kpoint%nkp_grid = nkp_grid
764 IF (PRESENT(kp_shift)) kpoint%kp_shift = kp_shift
765 IF (PRESENT(gamma_centered)) kpoint%gamma_centered = gamma_centered
766 IF (PRESENT(symmetry)) kpoint%symmetry = symmetry
767 IF (PRESENT(verbose)) kpoint%verbose = verbose
768 IF (PRESENT(full_grid)) kpoint%full_grid = full_grid
769 IF (PRESENT(inversion_symmetry_only)) kpoint%inversion_symmetry_only = inversion_symmetry_only
770 IF (PRESENT(symmetry_backend)) kpoint%symmetry_backend = symmetry_backend
771 IF (PRESENT(symmetry_reduction_method)) THEN
772 kpoint%symmetry_reduction_method = symmetry_reduction_method
773 END IF
774 IF (PRESENT(use_real_wfn)) kpoint%use_real_wfn = use_real_wfn
775 IF (PRESENT(eps_geo)) kpoint%eps_geo = eps_geo
776 IF (PRESENT(parallel_group_size)) kpoint%parallel_group_size = parallel_group_size
777
778 IF (PRESENT(nkp)) kpoint%nkp = nkp
779 IF (PRESENT(wkp)) kpoint%wkp => wkp
780 IF (PRESENT(xkp)) kpoint%xkp => xkp
781
782 IF (PRESENT(para_env)) kpoint%para_env => para_env
783 IF (PRESENT(para_env_kp)) kpoint%para_env_kp => para_env_kp
784 IF (PRESENT(para_env_inter_kp)) kpoint%para_env_inter_kp => para_env_inter_kp
785 IF (PRESENT(blacs_env_all)) kpoint%blacs_env_all => blacs_env_all
786 IF (PRESENT(blacs_env)) kpoint%blacs_env => blacs_env
787
788 IF (PRESENT(iogrp)) kpoint%iogrp = iogrp
789 IF (PRESENT(kp_range)) kpoint%kp_range = kp_range
790 IF (PRESENT(nkp_groups)) kpoint%nkp_groups = nkp_groups
791 IF (PRESENT(kp_dist)) kpoint%kp_dist => kp_dist
792
793 IF (PRESENT(kp_env)) kpoint%kp_env => kp_env
794 IF (PRESENT(kp_env)) kpoint%kp_aux_env => kp_aux_env
795 IF (PRESENT(mpools)) kpoint%mpools => mpools
796 IF (PRESENT(sab_nl)) kpoint%sab_nl => sab_nl
797 IF (PRESENT(sab_nl_nosym)) kpoint%sab_nl_nosym => sab_nl_nosym
798
799 IF (PRESENT(cell_to_index)) THEN
800 IF (ASSOCIATED(kpoint%cell_to_index)) DEALLOCATE (kpoint%cell_to_index)
801 kpoint%cell_to_index => cell_to_index
802 END IF
803
804 IF (PRESENT(index_to_cell)) THEN
805 IF (ASSOCIATED(kpoint%index_to_cell)) DEALLOCATE (kpoint%index_to_cell)
806 kpoint%index_to_cell => index_to_cell
807 END IF
808
809 END SUBROUTINE set_kpoint_info
810
811! **************************************************************************************************
812!> \brief Read the kpoint input section
813!> \param kpoint The kpoint environment
814!> \param kpoint_section The input section
815!> \param a_vec ...
816!> \param cell ...
817!> \author JGH
818! **************************************************************************************************
819 SUBROUTINE read_kpoint_section(kpoint, kpoint_section, a_vec, cell)
820 TYPE(kpoint_type), INTENT(INOUT) :: kpoint
821 TYPE(section_vals_type), POINTER :: kpoint_section
822 REAL(kind=dp), DIMENSION(3, 3), INTENT(IN) :: a_vec
823 TYPE(cell_type), OPTIONAL, POINTER :: cell
824
825 REAL(kind=dp), PARAMETER :: eps_cell = 1.0e-14_dp
826
827 CHARACTER(LEN=default_string_length) :: ustr
828 CHARACTER(LEN=default_string_length), &
829 DIMENSION(:), POINTER :: tmpstringlist
830 INTEGER :: i, n_rep, nval, wfntype
831 LOGICAL :: available, backend_explicit, &
832 non_lower_triangular_cell, &
833 reduction_explicit
834 REAL(kind=dp) :: ff
835 REAL(kind=dp), DIMENSION(3, 3) :: cart_a_vec
836 REAL(kind=dp), DIMENSION(:), POINTER :: reallist
837
838 CALL section_vals_get(kpoint_section, explicit=available)
839 cart_a_vec(:, :) = a_vec(:, :)
840 IF (PRESENT(cell)) THEN
841 IF (ASSOCIATED(cell)) THEN
842 IF (cell%input_cell_canonicalized) cart_a_vec(:, :) = cell%input_hmat(:, :)
843 END IF
844 END IF
845
846 IF (available) THEN
847 CALL section_vals_val_get(kpoint_section, "SCHEME", c_vals=tmpstringlist)
848 nval = SIZE(tmpstringlist)
849 cpassert(nval >= 1)
850 kpoint%kp_scheme = tmpstringlist(1)
851 CALL uppercase(kpoint%kp_scheme)
852
853 ! SCHEME [None, Gamma, Monkhorst-Pack, MacDonald, General]
854 SELECT CASE (kpoint%kp_scheme)
855 CASE ("NONE")
856 ! do nothing
857 CASE ("GAMMA")
858 ! do nothing
859 CASE ("MONKHORST-PACK")
860 cpassert(nval >= 4)
861 DO i = 2, 4
862 READ (tmpstringlist(i), *) kpoint%nkp_grid(i - 1)
863 END DO
864 CASE ("MACDONALD")
865 cpassert(nval >= 7)
866 DO i = 2, 4
867 READ (tmpstringlist(i), *) kpoint%nkp_grid(i - 1)
868 END DO
869 DO i = 5, 7
870 READ (tmpstringlist(i), *) kpoint%kp_shift(i - 4)
871 END DO
872 CASE ("GENERAL")
873 CALL section_vals_val_get(kpoint_section, "UNITS", c_val=ustr)
874 CALL uppercase(ustr)
875 CALL section_vals_val_get(kpoint_section, "KPOINT", n_rep_val=n_rep)
876 kpoint%nkp = n_rep
877 IF (ASSOCIATED(kpoint%xkp_input)) THEN
878 DEALLOCATE (kpoint%xkp_input)
879 NULLIFY (kpoint%xkp_input)
880 END IF
881 IF (ASSOCIATED(kpoint%wkp_input)) THEN
882 DEALLOCATE (kpoint%wkp_input)
883 NULLIFY (kpoint%wkp_input)
884 END IF
885 ALLOCATE (kpoint%xkp(3, n_rep), kpoint%wkp(n_rep))
886 DO i = 1, n_rep
887 CALL section_vals_val_get(kpoint_section, "KPOINT", i_rep_val=i, &
888 r_vals=reallist)
889 nval = SIZE(reallist)
890 cpassert(nval >= 4)
891 SELECT CASE (ustr)
892 CASE ("B_VECTOR")
893 kpoint%xkp(1:3, i) = reallist(1:3)
894 CASE ("CART_ANGSTROM")
895 kpoint%xkp(1:3, i) = (reallist(1)*cart_a_vec(1, 1:3) + &
896 reallist(2)*cart_a_vec(2, 1:3) + &
897 reallist(3)*cart_a_vec(3, 1:3))/twopi*angstrom
898 CASE ("CART_BOHR")
899 kpoint%xkp(1:3, i) = (reallist(1)*cart_a_vec(1, 1:3) + &
900 reallist(2)*cart_a_vec(2, 1:3) + &
901 reallist(3)*cart_a_vec(3, 1:3))/twopi
902 CASE DEFAULT
903 cpabort("Unknown Unit for kpoint definition")
904 END SELECT
905 kpoint%wkp(i) = reallist(4)
906 END DO
907 ff = 1.0_dp/sum(kpoint%wkp(:))
908 kpoint%wkp(:) = ff*kpoint%wkp(:)
909 ALLOCATE (kpoint%xkp_input(3, n_rep), kpoint%wkp_input(n_rep))
910 kpoint%xkp_input(1:3, 1:n_rep) = kpoint%xkp(1:3, 1:n_rep)
911 kpoint%wkp_input(1:n_rep) = kpoint%wkp(1:n_rep)
912 CASE DEFAULT
913 CALL cp_abort(__location__, &
914 "<NONE>, <GAMMA>, <MONKHORST-PACK>, <MACDONALD>, "// &
915 "<GENERAL> are supported as the <kpoint%kp_scheme> for "// &
916 "read_kpoint_section, found unknown option "// &
917 "<"//trim(kpoint%kp_scheme)//">")
918 END SELECT
919
920 CALL section_vals_val_get(kpoint_section, "GAMMA_CENTERED", l_val=kpoint%gamma_centered)
921 IF (kpoint%gamma_centered .AND. kpoint%kp_scheme /= "MONKHORST-PACK" .AND. &
922 kpoint%kp_scheme /= "MACDONALD") THEN
923 CALL cp_abort(__location__, &
924 "KPOINTS%GAMMA_CENTERED is only supported with SCHEME MONKHORST-PACK or MACDONALD")
925 END IF
926
927 CALL section_vals_val_get(kpoint_section, "SYMMETRY", l_val=kpoint%symmetry)
928 CALL section_vals_val_get(kpoint_section, "WAVEFUNCTIONS", i_val=wfntype)
929 CALL section_vals_val_get(kpoint_section, "VERBOSE", l_val=kpoint%verbose)
930 CALL section_vals_val_get(kpoint_section, "FULL_GRID", l_val=kpoint%full_grid)
931 CALL section_vals_val_get(kpoint_section, "RSKP_TRANSFORM", i_val=kpoint%rskp_transform)
932 CALL section_vals_val_get(kpoint_section, "INVERSION_SYMMETRY_ONLY", &
933 l_val=kpoint%inversion_symmetry_only)
934 CALL section_vals_val_get(kpoint_section, "SYMMETRY_BACKEND", &
935 i_val=kpoint%symmetry_backend, explicit=backend_explicit)
936 CALL section_vals_val_get(kpoint_section, "SYMMETRY_REDUCTION_METHOD", &
937 i_val=kpoint%symmetry_reduction_method, explicit=reduction_explicit)
938 CALL resolve_kpoint_symmetry_settings(kpoint, backend_explicit, reduction_explicit)
939 CALL section_vals_val_get(kpoint_section, "EPS_SYMMETRY", r_val=kpoint%eps_geo)
940 IF ((kpoint%kp_scheme == "MONKHORST-PACK" .OR. kpoint%kp_scheme == "MACDONALD") .AND. &
941 kpoint%symmetry .AND. .NOT. kpoint%full_grid .AND. &
942 .NOT. kpoint%inversion_symmetry_only) THEN
943 non_lower_triangular_cell = (abs(a_vec(2, 1)) > eps_cell) .OR. &
944 (abs(a_vec(3, 1)) > eps_cell) .OR. &
945 (abs(a_vec(3, 2)) > eps_cell)
946 IF (non_lower_triangular_cell) THEN
947 kpoint%inversion_symmetry_only = .true.
948 CALL cp_warn(__location__, &
949 "Full atomic k-point symmetry was requested for a cell matrix that does "// &
950 "not follow the CP2K lower-triangular convention. Falling back to "// &
951 "KPOINTS%INVERSION_SYMMETRY_ONLY. Use ABC/ALPHA_BETA_GAMMA or canonical "// &
952 "A/B/C vectors to enable full point-group k-point reduction.")
953 END IF
954 END IF
955 CALL section_vals_val_get(kpoint_section, "PARALLEL_GROUP_SIZE", &
956 i_val=kpoint%parallel_group_size)
957 SELECT CASE (wfntype)
958 CASE (use_real_wfn)
959 kpoint%use_real_wfn = .true.
960 CASE (use_complex_wfn)
961 kpoint%use_real_wfn = .false.
962 CASE DEFAULT
963 cpabort("The WAVEFUNCTIONS option should be either REAL or COMPLEX")
964 END SELECT
965
966 ELSE
967 kpoint%kp_scheme = "NONE"
968 END IF
969
970 END SUBROUTINE read_kpoint_section
971
972! **************************************************************************************************
973!> \brief Resolve legacy and backend k-point symmetry settings
974!> \param kpoint ...
975!> \param backend_explicit whether SYMMETRY_BACKEND was given
976!> \param reduction_explicit whether SYMMETRY_REDUCTION_METHOD was given
977! **************************************************************************************************
978 SUBROUTINE resolve_kpoint_symmetry_settings(kpoint, backend_explicit, reduction_explicit)
979 TYPE(kpoint_type), INTENT(INOUT) :: kpoint
980 LOGICAL, INTENT(IN) :: backend_explicit, reduction_explicit
981
982 IF (backend_explicit .AND. .NOT. reduction_explicit) THEN
983 SELECT CASE (kpoint%symmetry_backend)
985 kpoint%symmetry_reduction_method = use_k290_kpoint_symmetry
987 kpoint%symmetry_reduction_method = use_spglib_kpoint_symmetry
988 CASE DEFAULT
989 cpabort("Unknown k-point symmetry backend")
990 END SELECT
991 END IF
992
993 IF (kpoint%symmetry_backend == use_spglib_kpoint_backend .AND. &
994 kpoint%symmetry_reduction_method /= use_spglib_kpoint_symmetry) THEN
995 CALL cp_abort(__location__, &
996 "SYMMETRY_BACKEND SPGLIB requires SYMMETRY_REDUCTION_METHOD SPGLIB")
997 END IF
998
999 END SUBROUTINE resolve_kpoint_symmetry_settings
1000
1001! **************************************************************************************************
1002!> \brief Write information on the kpoints to output
1003!> \param kpoint The kpoint environment
1004!> \param iounit output unit
1005!> \param dft_section DFT section information for output unit
1006!> \author JGH
1007! **************************************************************************************************
1008 SUBROUTINE write_kpoint_info(kpoint, iounit, dft_section)
1009 TYPE(kpoint_type), INTENT(IN) :: kpoint
1010 INTEGER, INTENT(IN), OPTIONAL :: iounit
1011 TYPE(section_vals_type), INTENT(IN), OPTIONAL :: dft_section
1012
1013 INTEGER :: i, punit
1014 TYPE(cp_logger_type), POINTER :: logger
1015
1016 NULLIFY (logger)
1017 logger => cp_get_default_logger()
1018
1019 IF (PRESENT(dft_section)) THEN
1020 punit = cp_print_key_unit_nr(logger, dft_section, "PRINT%KPOINTS", extension=".Log")
1021 ELSE IF (PRESENT(iounit)) THEN
1022 punit = iounit
1023 ELSE
1024 punit = cp_logger_get_default_unit_nr(logger)
1025 END IF
1026
1027 IF (punit > 0) THEN
1028
1029 IF (kpoint%kp_scheme /= "NONE") THEN
1030 WRITE (punit, '(/," ",79("*"),/,T37,A,/," ",79("*"))') "Kpoints"
1031 END IF
1032 SELECT CASE (kpoint%kp_scheme)
1033 CASE ("NONE")
1034 ! be silent
1035 CASE ("GAMMA")
1036 WRITE (punit, '(A,T57,A)') ' BRILLOUIN|', ' Gamma-point calculation'
1037 CASE ("MONKHORST-PACK")
1038 WRITE (punit, '(A,T61,A20)') ' BRILLOUIN| K-point scheme ', ' Monkhorst-Pack'
1039 WRITE (punit, '(A,T66,3I5)') ' BRILLOUIN| K-Point grid', kpoint%nkp_grid
1040 IF (kpoint%gamma_centered) THEN
1041 WRITE (punit, '(A,T76,A)') ' BRILLOUIN| Gamma-centered k-point mesh', ' ON'
1042 END IF
1043 WRITE (punit, '(A,T66,G15.6)') &
1044 ' BRILLOUIN| K-point symmetry accuracy', kpoint%eps_geo
1045 CASE ("MACDONALD")
1046 WRITE (punit, '(A,T71,A10)') ' BRILLOUIN| K-point scheme ', ' MacDonald'
1047 WRITE (punit, '(A,T66,3I5)') ' BRILLOUIN| K-Point grid', kpoint%nkp_grid
1048 WRITE (punit, '(A,T51,3F10.4)') ' BRILLOUIN| K-Point shift', kpoint%kp_shift
1049 IF (kpoint%gamma_centered) THEN
1050 WRITE (punit, '(A,T76,A)') ' BRILLOUIN| Gamma-centered k-point mesh', ' ON'
1051 END IF
1052 WRITE (punit, '(A,T66,G15.6)') &
1053 ' BRILLOUIN| K-point symmetry accuracy', kpoint%eps_geo
1054 CASE ("GENERAL")
1055 WRITE (punit, '(A,T71,A10)') ' BRILLOUIN| K-point scheme ', ' General'
1056 CASE DEFAULT
1057 CALL cp_abort(__location__, &
1058 "<NONE>, <GAMMA>, <MONKHORST-PACK>, <MACDONALD>, "// &
1059 "<GENERAL> are supported as the <kpoint%kp_scheme> for "// &
1060 "write_kpoint_info, found unknown option "// &
1061 "<"//trim(kpoint%kp_scheme)//">")
1062 END SELECT
1063 IF (kpoint%kp_scheme /= "NONE") THEN
1064 IF (kpoint%symmetry) THEN
1065 WRITE (punit, '(A,T76,A)') ' BRILLOUIN| K-Point point group symmetrization', ' ON'
1066 ELSE
1067 WRITE (punit, '(A,T76,A)') ' BRILLOUIN| K-Point point group symmetrization', ' OFF'
1068 END IF
1069 IF (kpoint%inversion_symmetry_only) THEN
1070 WRITE (punit, '(A,T76,A)') ' BRILLOUIN| Restrict symmetry to inversion', ' ON'
1071 END IF
1072 IF (kpoint%symmetry .AND. .NOT. kpoint%full_grid .AND. &
1073 .NOT. kpoint%inversion_symmetry_only .AND. &
1074 (kpoint%kp_scheme == "MONKHORST-PACK" .OR. kpoint%kp_scheme == "MACDONALD" .OR. &
1075 kpoint%kp_scheme == "GENERAL")) THEN
1076 SELECT CASE (kpoint%symmetry_backend)
1078 WRITE (punit, '(A,T73,A)') ' BRILLOUIN| Symmetry backend', ' K290'
1080 WRITE (punit, '(A,T73,A)') ' BRILLOUIN| Symmetry backend', ' SPGLIB'
1081 CASE DEFAULT
1082 cpabort("Unknown k-point symmetry backend")
1083 END SELECT
1084 SELECT CASE (kpoint%symmetry_reduction_method)
1086 WRITE (punit, '(A,T73,A)') ' BRILLOUIN| Symmetry reduction method', ' K290'
1088 WRITE (punit, '(A,T73,A)') ' BRILLOUIN| Symmetry reduction method', ' SPGLIB'
1089 CASE DEFAULT
1090 cpabort("Unknown k-point symmetry reduction method")
1091 END SELECT
1092 END IF
1093 IF (kpoint%use_real_wfn) THEN
1094 WRITE (punit, '(A,T76,A)') ' BRILLOUIN| Wavefunction type', ' REAL'
1095 ELSE
1096 WRITE (punit, '(A,T73,A)') ' BRILLOUIN| Wavefunction type', ' COMPLEX'
1097 END IF
1098 IF (kpoint%full_grid) THEN
1099 WRITE (punit, '(A,T76,A)') ' BRILLOUIN| Use full k-point grid '
1100 END IF
1101 IF (kpoint%kp_scheme /= "GAMMA") THEN
1102 WRITE (punit, '(A,T71,I10)') ' BRILLOUIN| Number of k-points', kpoint%nkp
1103 END IF
1104 IF (kpoint%kp_scheme /= "GAMMA" .AND. kpoint%verbose) THEN
1105 WRITE (punit, '(A)') ' BRILLOUIN| List of k-points [2 Pi/Bohr]'
1106 WRITE (punit, '(A,T30,A,T48,A,T63,A,T78,A)') &
1107 ' BRILLOUIN| Number ', 'Weight', 'X', 'Y', 'Z'
1108 DO i = 1, kpoint%nkp
1109 WRITE (punit, '(A,I5,3X,4F15.5)') ' BRILLOUIN| ', i, kpoint%wkp(i), &
1110 kpoint%xkp(1, i), kpoint%xkp(2, i), kpoint%xkp(3, i)
1111 END DO
1112 END IF
1113 WRITE (punit, '(" ",79("*"))')
1114 END IF
1115
1116 END IF
1117
1118 IF (PRESENT(dft_section)) THEN
1119 CALL cp_print_key_finished_output(punit, logger, dft_section, "PRINT%KPOINTS")
1120 END IF
1121
1122 END SUBROUTINE write_kpoint_info
1123
1124! **************************************************************************************************
1125!> \brief Create a single kpoint environment
1126!> \param kp_env Single kpoint environment
1127!> \author JGH
1128! **************************************************************************************************
1129 SUBROUTINE kpoint_env_create(kp_env)
1130 TYPE(kpoint_env_type), POINTER :: kp_env
1131
1132 cpassert(.NOT. ASSOCIATED(kp_env))
1133
1134 ALLOCATE (kp_env)
1135
1136 kp_env%nkpoint = 0
1137 kp_env%wkp = 0.0_dp
1138 kp_env%xkp = 0.0_dp
1139 kp_env%is_local = .false.
1140
1141 NULLIFY (kp_env%mos)
1142 NULLIFY (kp_env%pmat)
1143 NULLIFY (kp_env%wmat)
1144 NULLIFY (kp_env%ot_hmat)
1145 NULLIFY (kp_env%ot_smat)
1146 NULLIFY (kp_env%ot_tmat)
1147
1148 END SUBROUTINE kpoint_env_create
1149
1150! **************************************************************************************************
1151!> \brief Release a single kpoint environment
1152!> \param kp_env Single kpoint environment
1153!> \author JGH
1154! **************************************************************************************************
1155 SUBROUTINE kpoint_env_release(kp_env)
1156 TYPE(kpoint_env_type), POINTER :: kp_env
1157
1158 INTEGER :: is
1159
1160 IF (ASSOCIATED(kp_env)) THEN
1161
1162 IF (ASSOCIATED(kp_env%mos)) THEN
1163 DO is = 1, SIZE(kp_env%mos)
1164 CALL deallocate_mo_set(kp_env%mos(is))
1165 END DO
1166 DEALLOCATE (kp_env%mos)
1167 END IF
1168
1169 CALL cp_fm_release(kp_env%pmat)
1170 CALL cp_fm_release(kp_env%wmat)
1171 CALL cp_fm_release(kp_env%smat)
1172 CALL cp_fm_release(kp_env%amat)
1173 CALL cp_cfm_release(kp_env%csmat)
1174 CALL cp_cfm_release(kp_env%camat)
1175 CALL cp_fm_release(kp_env%ot_hmat)
1176 CALL cp_fm_release(kp_env%ot_smat)
1177 CALL cp_fm_release(kp_env%ot_tmat)
1178
1179 CALL cp_fm_release(kp_env%shalf)
1180 CALL cp_cfm_release(kp_env%cshalf)
1181 CALL cp_fm_release(kp_env%lowdin_b)
1182 CALL cp_fm_release(kp_env%lowdin_work)
1183 CALL cp_cfm_release(kp_env%lowdin_cb)
1184 CALL cp_cfm_release(kp_env%lowdin_cwork)
1185 CALL cp_cfm_release(kp_env%lowdin_evec)
1186 CALL kp_env%lowdin_gemm%destroy()
1187
1188 DEALLOCATE (kp_env)
1189
1190 END IF
1191
1192 END SUBROUTINE kpoint_env_release
1193
1194! **************************************************************************************************
1195!> \brief Get information from a single kpoint environment
1196!> \param kpoint_env Single kpoint environment
1197!> \param nkpoint Index of kpoint
1198!> \param wkp Weight of kpoint
1199!> \param xkp Coordinates of kpoint
1200!> \param is_local Is this kpoint local (single cpu group)
1201!> \param mos MOs of this kpoint
1202!> \author JGH
1203! **************************************************************************************************
1204 SUBROUTINE get_kpoint_env(kpoint_env, nkpoint, wkp, xkp, is_local, mos)
1205 TYPE(kpoint_env_type), INTENT(IN) :: kpoint_env
1206 INTEGER, OPTIONAL :: nkpoint
1207 REAL(kind=dp), OPTIONAL :: wkp
1208 REAL(kind=dp), DIMENSION(3), OPTIONAL :: xkp
1209 LOGICAL, OPTIONAL :: is_local
1210 TYPE(mo_set_type), DIMENSION(:), OPTIONAL, POINTER :: mos
1211
1212 IF (PRESENT(nkpoint)) nkpoint = kpoint_env%nkpoint
1213 IF (PRESENT(wkp)) wkp = kpoint_env%wkp
1214 IF (PRESENT(xkp)) xkp = kpoint_env%xkp
1215 IF (PRESENT(is_local)) is_local = kpoint_env%is_local
1216 IF (PRESENT(mos)) mos => kpoint_env%mos
1217
1218 END SUBROUTINE get_kpoint_env
1219
1220! **************************************************************************************************
1221!> \brief Create a single kpoint symmetry environment
1222!> \param kp_sym ...
1223!> \author JGH
1224! **************************************************************************************************
1225 SUBROUTINE kpoint_sym_create(kp_sym)
1226 TYPE(kpoint_sym_type), POINTER :: kp_sym
1227
1228 cpassert(.NOT. ASSOCIATED(kp_sym))
1229
1230 ALLOCATE (kp_sym)
1231
1232 kp_sym%nwght = 0
1233 kp_sym%nwred = 0
1234 kp_sym%apply_symmetry = .false.
1235
1236 NULLIFY (kp_sym%rot)
1237 NULLIFY (kp_sym%xkp)
1238 NULLIFY (kp_sym%rotp)
1239 NULLIFY (kp_sym%f0)
1240 NULLIFY (kp_sym%fcell)
1241 NULLIFY (kp_sym%fcell_gauge)
1242 NULLIFY (kp_sym%phase_mode)
1243
1244 END SUBROUTINE kpoint_sym_create
1245
1246! **************************************************************************************************
1247!> \brief Release a single kpoint symmetry environment
1248!> \param kp_sym ...
1249!> \author JGH
1250! **************************************************************************************************
1251 SUBROUTINE kpoint_sym_release(kp_sym)
1252 TYPE(kpoint_sym_type), POINTER :: kp_sym
1253
1254 IF (ASSOCIATED(kp_sym)) THEN
1255
1256 IF (ASSOCIATED(kp_sym%rot)) THEN
1257 DEALLOCATE (kp_sym%rot)
1258 END IF
1259 IF (ASSOCIATED(kp_sym%xkp)) THEN
1260 DEALLOCATE (kp_sym%xkp)
1261 END IF
1262 IF (ASSOCIATED(kp_sym%f0)) THEN
1263 DEALLOCATE (kp_sym%f0)
1264 END IF
1265 IF (ASSOCIATED(kp_sym%fcell)) THEN
1266 DEALLOCATE (kp_sym%fcell)
1267 END IF
1268 IF (ASSOCIATED(kp_sym%fcell_gauge)) THEN
1269 DEALLOCATE (kp_sym%fcell_gauge)
1270 END IF
1271 IF (ASSOCIATED(kp_sym%phase_mode)) THEN
1272 DEALLOCATE (kp_sym%phase_mode)
1273 END IF
1274 IF (ASSOCIATED(kp_sym%rotp)) THEN
1275 DEALLOCATE (kp_sym%rotp)
1276 END IF
1277
1278 DEALLOCATE (kp_sym)
1279
1280 END IF
1281
1282 END SUBROUTINE kpoint_sym_release
1283
1284! **************************************************************************************************
1285!> \brief Locate the basis-rotation slot corresponding to a signed k-point symmetry operation.
1286!> \param qs_kpoint SCF k-point object
1287!> \param rotp signed operation identifier
1288!> \return rotation slot, or zero when no slot matches
1289! **************************************************************************************************
1290 INTEGER FUNCTION find_kpoint_rotation_slot(qs_kpoint, rotp) RESULT(rot_slot)
1291 TYPE(kpoint_type), POINTER :: qs_kpoint
1292 INTEGER, INTENT(IN) :: rotp
1293
1294 INTEGER :: irot, rot_abs
1295
1296 rot_slot = 0
1297 rot_abs = abs(rotp)
1298 IF (.NOT. ASSOCIATED(qs_kpoint%ibrot)) RETURN
1299 DO irot = 1, SIZE(qs_kpoint%ibrot)
1300 IF (rot_abs == qs_kpoint%ibrot(irot)) THEN
1301 rot_slot = irot
1302 RETURN
1303 END IF
1304 END DO
1305
1306 END FUNCTION find_kpoint_rotation_slot
1307
1308END MODULE kpoint_types
Handles all functions related to the CELL.
Definition cell_types.F:15
methods related to the blacs parallel environment
subroutine, public cp_blacs_env_release(blacs_env)
releases the given blacs_env
Represents a complex full matrix distributed on many processors.
subroutine, public cp_cfm_release(matrix)
Releases a full matrix.
represent a full matrix distributed on many processors
Definition cp_fm_types.F:15
various routines to log and control the output. The idea is that decisions about where to log should ...
recursive integer function, public cp_logger_get_default_unit_nr(logger, local, skip_not_ionode)
asks the default unit number of the given logger. try to use cp_logger_get_unit_nr
type(cp_logger_type) function, pointer, public cp_get_default_logger()
returns the default logger
routines to handle the output, The idea is to remove the decision of wheter to output and what to out...
subroutine, public cp_print_key_finished_output(unit_nr, logger, basis_section, print_key_path, local, ignore_should_output, on_file, mpi_io)
should be called after you finish working with a unit obtained with cp_print_key_unit_nr,...
integer function, public cp_print_key_unit_nr(logger, basis_section, print_key_path, extension, middle_name, local, log_filename, ignore_should_output, file_form, file_position, file_action, file_status, do_backup, on_file, is_new_file, mpi_io, fout, file_access)
...
collects all constants needed in input so that they can be used without circular dependencies
integer, parameter, public rskp_backend_gemm
function that build the kpoints section of the input
integer, parameter, public use_spglib_kpoint_symmetry
integer, parameter, public use_k290_kpoint_symmetry
integer, parameter, public use_real_wfn
integer, parameter, public use_spglib_kpoint_backend
integer, parameter, public use_k290_kpoint_backend
integer, parameter, public use_complex_wfn
objects that represent the structure of input sections and the data contained in an input section
subroutine, public section_vals_get(section_vals, ref_count, n_repetition, n_subs_vals_rep, section, explicit)
returns various attributes about the section_vals
subroutine, public section_vals_val_get(section_vals, keyword_name, i_rep_section, i_rep_val, n_rep_val, val, l_val, i_val, r_val, c_val, l_vals, i_vals, r_vals, c_vals, explicit)
returns the requested value
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
Types and basic routines needed for a kpoint calculation.
subroutine, public kpoint_sym_create(kp_sym)
Create a single kpoint symmetry environment.
subroutine, public kpoint_clear_scf_smat(kpoint)
Release overlap matrices cached for a single SCF run.
subroutine, public set_kpoint_info(kpoint, kp_scheme, nkp_grid, kp_shift, symmetry, verbose, full_grid, use_real_wfn, eps_geo, parallel_group_size, kp_range, nkp, xkp, wkp, para_env, blacs_env_all, para_env_kp, para_env_inter_kp, blacs_env, kp_env, kp_aux_env, mpools, iogrp, nkp_groups, kp_dist, cell_to_index, index_to_cell, sab_nl, sab_nl_nosym, inversion_symmetry_only, symmetry_backend, symmetry_reduction_method, gamma_centered)
Set information in a kpoint environment.
integer function, public find_kpoint_rotation_slot(qs_kpoint, rotp)
Locate the basis-rotation slot corresponding to a signed k-point symmetry operation.
subroutine, public get_kpoint_env(kpoint_env, nkpoint, wkp, xkp, is_local, mos)
Get information from a single kpoint environment.
subroutine, public kpoint_reset_initialization(kpoint)
Reset all data derived from a concrete k-point initialization. Input options such as the scheme,...
subroutine, public kpoint_env_create(kp_env)
Create a single kpoint environment.
subroutine, public write_kpoint_info(kpoint, iounit, dft_section)
Write information on the kpoints to output.
subroutine, public get_kpoint_info(kpoint, kp_scheme, nkp_grid, kp_shift, symmetry, verbose, full_grid, use_real_wfn, eps_geo, parallel_group_size, kp_range, nkp, xkp, wkp, para_env, blacs_env_all, para_env_kp, para_env_inter_kp, blacs_env, kp_env, kp_aux_env, mpools, iogrp, nkp_groups, kp_dist, cell_to_index, index_to_cell, sab_nl, sab_nl_nosym, inversion_symmetry_only, symmetry_backend, symmetry_reduction_method, gamma_centered, rskp_transform)
Retrieve information from a kpoint environment.
subroutine, public kpoint_release(kpoint)
Release a kpoint environment, deallocate all data.
subroutine, public kpoint_create(kpoint)
Create a kpoint environment.
subroutine, public read_kpoint_section(kpoint, kpoint_section, a_vec, cell)
Read the kpoint input section.
Definition of mathematical constants and functions.
real(kind=dp), parameter, public twopi
Interface to the message passing library MPI.
subroutine, public mp_para_env_release(para_env)
releases the para object (to be called when you don't want anymore the shared copy of this object)
Definition of physical constants:
Definition physcon.F:68
real(kind=dp), parameter, public angstrom
Definition physcon.F:144
buffer for the diis of the scf
subroutine, public qs_diis_b_release_kp(diis_buffer)
releases the given diis KP buffer
wrapper for the pools of matrixes
subroutine, public mpools_release(mpools)
releases the given mpools
Definition and initialisation of the mo data type.
Definition qs_mo_types.F:22
subroutine, public deallocate_mo_set(mo_set)
Deallocate a wavefunction data structure.
Define the neighbor list data types and the corresponding functionality.
Utilities for string manipulations.
elemental subroutine, public uppercase(string)
Convert all lower case characters in a string to upper case.
Type defining parameters related to the simulation cell.
Definition cell_types.F:60
represent a blacs multidimensional parallel environment (for the mpi corrispective see cp_paratypes/m...
Represent a complex full matrix.
represent a full matrix
type of a logger, at the moment it contains just a print level starting at which level it should be l...
Rotation matrices for basis sets.
Keeps information about a specific k-point.
Keeps symmetry information about a specific k-point.
Contains information about kpoints.
stores all the informations relevant to an mpi environment
build arrau of pointers to diis buffers in the k-point (complex full matrices) case
container for the pools of matrixes used by qs