53#include "./base/base_uses.f90"
59 CHARACTER(len=*),
PARAMETER,
PRIVATE :: moduleN =
'kpoint_types'
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.
100 LOGICAL :: mos_prefilled = .false.
105 TYPE(
cp_fm_type),
DIMENSION(:, :),
POINTER :: ot_hmat => null()
115 REAL(
dp),
ALLOCATABLE :: lowdin_sqrt(:)
129 REAL(kind=
dp),
DIMENSION(:, :),
POINTER :: rmat => null()
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()
157 TYPE kpoint_sym_p_type
159 END TYPE kpoint_sym_p_type
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.
202 LOGICAL :: symmetry = .false.
203 LOGICAL :: full_grid = .false.
205 LOGICAL :: inversion_symmetry_only = .false.
208 LOGICAL :: verbose = .false.
209 REAL(kind=
dp) :: eps_geo = 0.0_dp
210 INTEGER :: parallel_group_size = -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()
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
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()
233 POINTER :: kp_env => null()
235 POINTER :: kp_aux_env => null()
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()
243 POINTER :: kind_rotmat => null()
245 POINTER :: kind_rotmat_aux => null()
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.
270 cpassert(.NOT.
ASSOCIATED(kpoint))
274 kpoint%kp_scheme =
""
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.
282 kpoint%inversion_symmetry_only = .false.
285 kpoint%use_real_wfn = .false.
286 kpoint%eps_geo = 1.0e-6_dp
287 kpoint%parallel_group_size = -1
290 kpoint%phases_calibrated = .false.
292 NULLIFY (kpoint%xkp, kpoint%wkp)
293 NULLIFY (kpoint%xkp_input, kpoint%wkp_input)
294 NULLIFY (kpoint%kp_dist)
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.
304 NULLIFY (kpoint%kp_env)
305 NULLIFY (kpoint%mpools)
307 ALLOCATE (kpoint%cell_to_index(0:0, 0:0, 0:0))
308 kpoint%cell_to_index(:, :, :) = 1
310 ALLOCATE (kpoint%index_to_cell(0:0, 0:0))
311 kpoint%index_to_cell(:, :) = 0
325 IF (
ASSOCIATED(kpoint))
THEN
328 IF (
ASSOCIATED(kpoint%xkp))
THEN
329 DEALLOCATE (kpoint%xkp)
331 IF (
ASSOCIATED(kpoint%wkp))
THEN
332 DEALLOCATE (kpoint%wkp)
334 IF (
ASSOCIATED(kpoint%xkp_input))
THEN
335 DEALLOCATE (kpoint%xkp_input)
337 IF (
ASSOCIATED(kpoint%wkp_input))
THEN
338 DEALLOCATE (kpoint%wkp_input)
340 IF (
ASSOCIATED(kpoint%kp_dist))
THEN
341 DEALLOCATE (kpoint%kp_dist)
354 IF (
ASSOCIATED(kpoint%cell_to_index))
DEALLOCATE (kpoint%cell_to_index)
355 IF (
ASSOCIATED(kpoint%index_to_cell))
DEALLOCATE (kpoint%index_to_cell)
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)
361 DEALLOCATE (kpoint%kp_env)
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)
368 DEALLOCATE (kpoint%kp_aux_env)
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)
375 DEALLOCATE (kpoint%kp_sym)
378 IF (
ASSOCIATED(kpoint%atype))
DEALLOCATE (kpoint%atype)
379 IF (
ASSOCIATED(kpoint%ibrot))
DEALLOCATE (kpoint%ibrot)
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)
389 DEALLOCATE (kpoint%kind_rotmat)
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)
400 DEALLOCATE (kpoint%kind_rotmat_aux)
403 IF (
ASSOCIATED(kpoint%scf_diis_buffer))
THEN
405 DEALLOCATE (kpoint%scf_diis_buffer)
423 IF (
ALLOCATED(kpoint%scf_smat))
THEN
424 DO ikp = 1,
SIZE(kpoint%scf_smat)
427 DEALLOCATE (kpoint%scf_smat)
443 IF (
ALLOCATED(kpoint%lowdin_orbitals))
THEN
444 DEALLOCATE (kpoint%lowdin_orbitals, kpoint%lowdin_q, kpoint%lowdin_q_new, kpoint%lowdin_v)
446 kpoint%lowdin_density_ready = .false.
447 kpoint%lowdin_population_ready = .false.
449 IF (
ASSOCIATED(kpoint%xkp))
THEN
450 DEALLOCATE (kpoint%xkp)
453 IF (
ASSOCIATED(kpoint%wkp))
THEN
454 DEALLOCATE (kpoint%wkp)
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)
464 IF (
ASSOCIATED(kpoint%kp_dist))
THEN
465 DEALLOCATE (kpoint%kp_dist)
466 NULLIFY (kpoint%kp_dist)
479 IF (
ASSOCIATED(kpoint%cell_to_index))
THEN
480 DEALLOCATE (kpoint%cell_to_index)
481 NULLIFY (kpoint%cell_to_index)
483 IF (
ASSOCIATED(kpoint%index_to_cell))
THEN
484 DEALLOCATE (kpoint%index_to_cell)
485 NULLIFY (kpoint%index_to_cell)
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)
492 DEALLOCATE (kpoint%kp_env)
493 NULLIFY (kpoint%kp_env)
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)
500 DEALLOCATE (kpoint%kp_aux_env)
501 NULLIFY (kpoint%kp_aux_env)
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)
508 DEALLOCATE (kpoint%kp_sym)
509 NULLIFY (kpoint%kp_sym)
512 IF (
ASSOCIATED(kpoint%atype))
THEN
513 DEALLOCATE (kpoint%atype)
514 NULLIFY (kpoint%atype)
516 IF (
ASSOCIATED(kpoint%ibrot))
THEN
517 DEALLOCATE (kpoint%ibrot)
518 NULLIFY (kpoint%ibrot)
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)
530 DEALLOCATE (kpoint%kind_rotmat)
531 NULLIFY (kpoint%kind_rotmat)
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)
543 DEALLOCATE (kpoint%kind_rotmat_aux)
544 NULLIFY (kpoint%kind_rotmat_aux)
547 IF (
ASSOCIATED(kpoint%scf_diis_buffer))
THEN
549 DEALLOCATE (kpoint%scf_diis_buffer)
550 NULLIFY (kpoint%scf_diis_buffer)
553 NULLIFY (kpoint%sab_nl)
554 NULLIFY (kpoint%sab_nl_nosym)
556 ALLOCATE (kpoint%cell_to_index(0:0, 0:0, 0:0))
557 kpoint%cell_to_index(:, :, :) = 1
559 ALLOCATE (kpoint%index_to_cell(0:0, 0:0))
560 kpoint%index_to_cell(:, :) = 0
562 IF (.NOT.
ASSOCIATED(kpoint%wkp)) kpoint%nkp = 0
563 kpoint%nkp_groups = 0
565 kpoint%iogrp = .false.
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)
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
630 POINTER :: kp_env, kp_aux_env
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
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
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
659 IF (
PRESENT(eps_geo)) eps_geo = kpoint%eps_geo
660 IF (
PRESENT(parallel_group_size)) parallel_group_size = kpoint%parallel_group_size
662 IF (
PRESENT(nkp)) nkp = kpoint%nkp
663 IF (
PRESENT(wkp)) wkp => kpoint%wkp
664 IF (
PRESENT(xkp)) xkp => kpoint%xkp
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
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
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
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
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)
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
748 POINTER :: kp_env, kp_aux_env
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
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
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
775 IF (
PRESENT(eps_geo)) kpoint%eps_geo = eps_geo
776 IF (
PRESENT(parallel_group_size)) kpoint%parallel_group_size = parallel_group_size
778 IF (
PRESENT(nkp)) kpoint%nkp = nkp
779 IF (
PRESENT(wkp)) kpoint%wkp => wkp
780 IF (
PRESENT(xkp)) kpoint%xkp => xkp
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
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
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
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
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
822 REAL(kind=
dp),
DIMENSION(3, 3),
INTENT(IN) :: a_vec
823 TYPE(
cell_type),
OPTIONAL,
POINTER :: cell
825 REAL(kind=
dp),
PARAMETER :: eps_cell = 1.0e-14_dp
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, &
835 REAL(kind=
dp),
DIMENSION(3, 3) :: cart_a_vec
836 REAL(kind=
dp),
DIMENSION(:),
POINTER :: reallist
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(:, :)
848 nval =
SIZE(tmpstringlist)
850 kpoint%kp_scheme = tmpstringlist(1)
854 SELECT CASE (kpoint%kp_scheme)
859 CASE (
"MONKHORST-PACK")
862 READ (tmpstringlist(i), *) kpoint%nkp_grid(i - 1)
867 READ (tmpstringlist(i), *) kpoint%nkp_grid(i - 1)
870 READ (tmpstringlist(i), *) kpoint%kp_shift(i - 4)
877 IF (
ASSOCIATED(kpoint%xkp_input))
THEN
878 DEALLOCATE (kpoint%xkp_input)
879 NULLIFY (kpoint%xkp_input)
881 IF (
ASSOCIATED(kpoint%wkp_input))
THEN
882 DEALLOCATE (kpoint%wkp_input)
883 NULLIFY (kpoint%wkp_input)
885 ALLOCATE (kpoint%xkp(3, n_rep), kpoint%wkp(n_rep))
889 nval =
SIZE(reallist)
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) + &
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
903 cpabort(
"Unknown Unit for kpoint definition")
905 kpoint%wkp(i) = reallist(4)
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)
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)//
">")
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")
933 l_val=kpoint%inversion_symmetry_only)
935 i_val=kpoint%symmetry_backend, explicit=backend_explicit)
937 i_val=kpoint%symmetry_reduction_method, explicit=reduction_explicit)
938 CALL resolve_kpoint_symmetry_settings(kpoint, backend_explicit, reduction_explicit)
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.")
956 i_val=kpoint%parallel_group_size)
957 SELECT CASE (wfntype)
959 kpoint%use_real_wfn = .true.
961 kpoint%use_real_wfn = .false.
963 cpabort(
"The WAVEFUNCTIONS option should be either REAL or COMPLEX")
967 kpoint%kp_scheme =
"NONE"
978 SUBROUTINE resolve_kpoint_symmetry_settings(kpoint, backend_explicit, reduction_explicit)
980 LOGICAL,
INTENT(IN) :: backend_explicit, reduction_explicit
982 IF (backend_explicit .AND. .NOT. reduction_explicit)
THEN
983 SELECT CASE (kpoint%symmetry_backend)
989 cpabort(
"Unknown k-point symmetry backend")
995 CALL cp_abort(__location__, &
996 "SYMMETRY_BACKEND SPGLIB requires SYMMETRY_REDUCTION_METHOD SPGLIB")
999 END SUBROUTINE resolve_kpoint_symmetry_settings
1010 INTEGER,
INTENT(IN),
OPTIONAL :: iounit
1019 IF (
PRESENT(dft_section))
THEN
1021 ELSE IF (
PRESENT(iounit))
THEN
1029 IF (kpoint%kp_scheme /=
"NONE")
THEN
1030 WRITE (punit,
'(/," ",79("*"),/,T37,A,/," ",79("*"))')
"Kpoints"
1032 SELECT CASE (kpoint%kp_scheme)
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'
1043 WRITE (punit,
'(A,T66,G15.6)') &
1044 ' BRILLOUIN| K-point symmetry accuracy', kpoint%eps_geo
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'
1052 WRITE (punit,
'(A,T66,G15.6)') &
1053 ' BRILLOUIN| K-point symmetry accuracy', kpoint%eps_geo
1055 WRITE (punit,
'(A,T71,A10)')
' BRILLOUIN| K-point scheme ',
' General'
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)//
">")
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'
1067 WRITE (punit,
'(A,T76,A)')
' BRILLOUIN| K-Point point group symmetrization',
' OFF'
1069 IF (kpoint%inversion_symmetry_only)
THEN
1070 WRITE (punit,
'(A,T76,A)')
' BRILLOUIN| Restrict symmetry to inversion',
' ON'
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'
1082 cpabort(
"Unknown k-point symmetry backend")
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'
1090 cpabort(
"Unknown k-point symmetry reduction method")
1093 IF (kpoint%use_real_wfn)
THEN
1094 WRITE (punit,
'(A,T76,A)')
' BRILLOUIN| Wavefunction type',
' REAL'
1096 WRITE (punit,
'(A,T73,A)')
' BRILLOUIN| Wavefunction type',
' COMPLEX'
1098 IF (kpoint%full_grid)
THEN
1099 WRITE (punit,
'(A,T76,A)')
' BRILLOUIN| Use full k-point grid '
1101 IF (kpoint%kp_scheme /=
"GAMMA")
THEN
1102 WRITE (punit,
'(A,T71,I10)')
' BRILLOUIN| Number of k-points', kpoint%nkp
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)
1113 WRITE (punit,
'(" ",79("*"))')
1118 IF (
PRESENT(dft_section))
THEN
1132 cpassert(.NOT.
ASSOCIATED(kp_env))
1139 kp_env%is_local = .false.
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)
1155 SUBROUTINE kpoint_env_release(kp_env)
1160 IF (
ASSOCIATED(kp_env))
THEN
1162 IF (
ASSOCIATED(kp_env%mos))
THEN
1163 DO is = 1,
SIZE(kp_env%mos)
1166 DEALLOCATE (kp_env%mos)
1186 CALL kp_env%lowdin_gemm%destroy()
1192 END SUBROUTINE kpoint_env_release
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
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
1228 cpassert(.NOT.
ASSOCIATED(kp_sym))
1234 kp_sym%apply_symmetry = .false.
1236 NULLIFY (kp_sym%rot)
1237 NULLIFY (kp_sym%xkp)
1238 NULLIFY (kp_sym%rotp)
1240 NULLIFY (kp_sym%fcell)
1241 NULLIFY (kp_sym%fcell_gauge)
1242 NULLIFY (kp_sym%phase_mode)
1251 SUBROUTINE kpoint_sym_release(kp_sym)
1254 IF (
ASSOCIATED(kp_sym))
THEN
1256 IF (
ASSOCIATED(kp_sym%rot))
THEN
1257 DEALLOCATE (kp_sym%rot)
1259 IF (
ASSOCIATED(kp_sym%xkp))
THEN
1260 DEALLOCATE (kp_sym%xkp)
1262 IF (
ASSOCIATED(kp_sym%f0))
THEN
1263 DEALLOCATE (kp_sym%f0)
1265 IF (
ASSOCIATED(kp_sym%fcell))
THEN
1266 DEALLOCATE (kp_sym%fcell)
1268 IF (
ASSOCIATED(kp_sym%fcell_gauge))
THEN
1269 DEALLOCATE (kp_sym%fcell_gauge)
1271 IF (
ASSOCIATED(kp_sym%phase_mode))
THEN
1272 DEALLOCATE (kp_sym%phase_mode)
1274 IF (
ASSOCIATED(kp_sym%rotp))
THEN
1275 DEALLOCATE (kp_sym%rotp)
1282 END SUBROUTINE kpoint_sym_release
1292 INTEGER,
INTENT(IN) :: rotp
1294 INTEGER :: irot, rot_abs
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
Handles all functions related to the CELL.
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
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)
...
Defines the basic variable types.
integer, parameter, public dp
integer, parameter, public default_string_length
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:
real(kind=dp), parameter, public angstrom
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.
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.
represent a blacs multidimensional parallel environment (for the mpi corrispective see cp_paratypes/m...
Represent a complex 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