LCOV - code coverage report
Current view: top level - src - qs_vcd_utils.F (source / functions) Coverage Total Hit
Test: CP2K Regtests (git:6d276e9) Lines: 88.3 % 435 384
Test Date: 2026-09-10 07:29:18 Functions: 100.0 % 5 5

            Line data    Source code
       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              : MODULE qs_vcd_utils
       9              :    USE cell_types,                      ONLY: cell_type
      10              :    USE commutator_rpnl,                 ONLY: build_com_mom_nl
      11              :    USE cp_control_types,                ONLY: dft_control_type
      12              :    USE cp_dbcsr_api,                    ONLY: dbcsr_copy,&
      13              :                                               dbcsr_create,&
      14              :                                               dbcsr_init_p,&
      15              :                                               dbcsr_p_type,&
      16              :                                               dbcsr_set,&
      17              :                                               dbcsr_type_antisymmetric,&
      18              :                                               dbcsr_type_no_symmetry
      19              :    USE cp_dbcsr_cp2k_link,              ONLY: cp_dbcsr_alloc_block_from_nbl
      20              :    USE cp_dbcsr_operations,             ONLY: dbcsr_allocate_matrix_set,&
      21              :                                               dbcsr_deallocate_matrix_set
      22              :    USE cp_files,                        ONLY: close_file,&
      23              :                                               open_file
      24              :    USE cp_fm_types,                     ONLY: cp_fm_create,&
      25              :                                               cp_fm_get_info,&
      26              :                                               cp_fm_get_submatrix,&
      27              :                                               cp_fm_release,&
      28              :                                               cp_fm_set_submatrix,&
      29              :                                               cp_fm_type
      30              :    USE cp_log_handling,                 ONLY: cp_get_default_logger,&
      31              :                                               cp_logger_get_default_io_unit,&
      32              :                                               cp_logger_type,&
      33              :                                               cp_to_string
      34              :    USE cp_output_handling,              ONLY: cp_p_file,&
      35              :                                               cp_print_key_finished_output,&
      36              :                                               cp_print_key_generate_filename,&
      37              :                                               cp_print_key_should_output,&
      38              :                                               cp_print_key_unit_nr
      39              :    USE cp_result_methods,               ONLY: get_results
      40              :    USE cp_result_types,                 ONLY: cp_result_type
      41              :    USE input_constants,                 ONLY: use_mom_ref_user
      42              :    USE input_section_types,             ONLY: section_vals_get_subs_vals,&
      43              :                                               section_vals_type,&
      44              :                                               section_vals_val_get
      45              :    USE kinds,                           ONLY: default_path_length,&
      46              :                                               default_string_length,&
      47              :                                               dp
      48              :    USE message_passing,                 ONLY: mp_para_env_type
      49              :    USE molecule_types,                  ONLY: molecule_type
      50              :    USE moments_utils,                   ONLY: get_reference_point
      51              :    USE orbital_pointers,                ONLY: init_orbital_pointers
      52              :    USE particle_types,                  ONLY: particle_type
      53              :    USE qs_dcdr_utils,                   ONLY: dcdr_env_cleanup,&
      54              :                                               dcdr_env_init
      55              :    USE qs_environment_types,            ONLY: get_qs_env,&
      56              :                                               qs_environment_type
      57              :    USE qs_kind_types,                   ONLY: qs_kind_type
      58              :    USE qs_ks_types,                     ONLY: qs_ks_env_type
      59              :    USE qs_linres_types,                 ONLY: vcd_env_type
      60              :    USE qs_mo_types,                     ONLY: get_mo_set,&
      61              :                                               mo_set_type
      62              :    USE qs_moments,                      ONLY: build_local_moments_der_matrix
      63              :    USE qs_neighbor_list_types,          ONLY: neighbor_list_set_p_type
      64              :    USE qs_operators_ao,                 ONLY: build_lin_mom_matrix
      65              :    USE qs_vcd_ao,                       ONLY: build_com_rpnl_r,&
      66              :                                               build_matrix_hr_rh
      67              :    USE string_utilities,                ONLY: xstring
      68              : #include "./base/base_uses.f90"
      69              : 
      70              :    IMPLICIT NONE
      71              : 
      72              :    PRIVATE
      73              :    PUBLIC :: vcd_env_cleanup, vcd_env_init
      74              :    PUBLIC :: vcd_read_restart, vcd_write_restart
      75              :    PUBLIC :: vcd_print
      76              : 
      77              :    CHARACTER(len=*), PARAMETER, PRIVATE :: moduleN = 'qs_vcd_utils'
      78              : 
      79              :    REAL(dp), DIMENSION(3, 3, 3), PARAMETER  :: Levi_Civita = RESHAPE([ &
      80              :                                                           0.0_dp, 0.0_dp, 0.0_dp, 0.0_dp, 0.0_dp, -1.0_dp, 0.0_dp, 1.0_dp, 0.0_dp, &
      81              :                                                           0.0_dp, 0.0_dp, 1.0_dp, 0.0_dp, 0.0_dp, 0.0_dp, -1.0_dp, 0.0_dp, 0.0_dp, &
      82              :                                                 0.0_dp, -1.0_dp, 0.0_dp, 1.0_dp, 0.0_dp, 0.0_dp, 0.0_dp, 0.0_dp, 0.0_dp], [3, 3, 3])
      83              : 
      84              : CONTAINS
      85              : 
      86              : ! *****************************************************************************
      87              : !> \brief Initialize the vcd environment
      88              : !> \param vcd_env ...
      89              : !> \param qs_env ...
      90              : !> \author Edward Ditler
      91              : ! **************************************************************************************************
      92            2 :    SUBROUTINE vcd_env_init(vcd_env, qs_env)
      93              :       TYPE(vcd_env_type), TARGET                         :: vcd_env
      94              :       TYPE(qs_environment_type), POINTER                 :: qs_env
      95              : 
      96              :       CHARACTER(LEN=*), PARAMETER                        :: routineN = 'vcd_env_init'
      97              : 
      98              :       INTEGER                                            :: handle, i, idir, ispin, j, natom, &
      99              :                                                             nspins, output_unit, reference, &
     100              :                                                             unit_number
     101              :       LOGICAL                                            :: explicit
     102            2 :       REAL(KIND=dp), DIMENSION(:), POINTER               :: ref_point
     103              :       TYPE(cell_type), POINTER                           :: cell
     104              :       TYPE(cp_logger_type), POINTER                      :: logger
     105            2 :       TYPE(dbcsr_p_type), DIMENSION(:), POINTER          :: matrix_ks
     106              :       TYPE(dft_control_type), POINTER                    :: dft_control
     107              :       TYPE(neighbor_list_set_p_type), DIMENSION(:), &
     108            2 :          POINTER                                         :: sab_all, sab_orb, sap_ppnl
     109            2 :       TYPE(particle_type), DIMENSION(:), POINTER         :: particle_set
     110            2 :       TYPE(qs_kind_type), DIMENSION(:), POINTER          :: qs_kind_set
     111              :       TYPE(qs_ks_env_type), POINTER                      :: ks_env
     112              :       TYPE(section_vals_type), POINTER                   :: lr_section, vcd_section
     113              : 
     114            2 :       CALL timeset(routineN, handle)
     115            2 :       vcd_env%do_mfp = .FALSE.
     116              : 
     117              :       ! Set up the logger
     118            2 :       NULLIFY (logger, vcd_section, lr_section)
     119            2 :       logger => cp_get_default_logger()
     120            2 :       vcd_section => section_vals_get_subs_vals(qs_env%input, "PROPERTIES%LINRES%VCD")
     121              :       vcd_env%output_unit = cp_print_key_unit_nr(logger, vcd_section, "PRINT%VCD", &
     122              :                                                  extension=".data", middle_name="vcd", log_filename=.FALSE., &
     123            2 :                                                  file_position="REWIND", file_status="REPLACE")
     124              : 
     125            2 :       lr_section => section_vals_get_subs_vals(qs_env%input, "PROPERTIES%LINRES")
     126              :       output_unit = cp_print_key_unit_nr(logger, lr_section, "PRINT%PROGRAM_RUN_INFO", &
     127            2 :                                          extension=".linresLog")
     128            2 :       unit_number = cp_print_key_unit_nr(logger, lr_section, "PRINT%PROGRAM_RUN_INFO", extension=".linresLog")
     129              : 
     130              :       ! We can't run a NVPT/MFPT calculation without the coefficients dC/dR.
     131            2 :       CALL dcdr_env_init(vcd_env%dcdr_env, qs_env)
     132              :       ! vcd_env%dcdr_env%output_unit = vcd_env%output_unit
     133              : 
     134            2 :       IF (output_unit > 0) THEN
     135            1 :          WRITE (output_unit, "(/,T20,A,/)") "*** Start NVPT/MFPT calculation ***"
     136              :       END IF
     137              : 
     138              :       ! Just to make sure. The memory requirements are tiny.
     139            2 :       CALL init_orbital_pointers(12)
     140              : 
     141            2 :       CALL section_vals_val_get(vcd_section, "DISTRIBUTED_ORIGIN", l_val=vcd_env%distributed_origin)
     142            2 :       CALL section_vals_val_get(vcd_section, "ORIGIN_DEPENDENT_MFP", l_val=vcd_env%origin_dependent_op_mfp)
     143              : 
     144              :       ! Reference point
     145            8 :       vcd_env%magnetic_origin = 0._dp
     146            8 :       vcd_env%spatial_origin = 0._dp
     147              :       ! Get the magnetic origin from the input
     148            2 :       CALL section_vals_val_get(vcd_section, "MAGNETIC_ORIGIN", i_val=reference)
     149            2 :       CALL section_vals_val_get(vcd_section, "MAGNETIC_ORIGIN_REFERENCE", explicit=explicit)
     150            2 :       IF (explicit) THEN
     151            0 :          CALL section_vals_val_get(vcd_section, "MAGNETIC_ORIGIN_REFERENCE", r_vals=ref_point)
     152              :       ELSE
     153            2 :          IF (reference == use_mom_ref_user) THEN
     154            0 :             CPABORT("User-defined reference point should be given explicitly")
     155              :          END IF
     156              :       END IF
     157              : 
     158              :       CALL get_reference_point(rpoint=vcd_env%magnetic_origin, qs_env=qs_env, &
     159              :                                reference=reference, &
     160            2 :                                ref_point=ref_point)
     161              : 
     162              :       ! Get the spatial origin from the input
     163            2 :       CALL section_vals_val_get(vcd_section, "SPATIAL_ORIGIN", i_val=reference)
     164            2 :       CALL section_vals_val_get(vcd_section, "SPATIAL_ORIGIN_REFERENCE", explicit=explicit)
     165            2 :       IF (explicit) THEN
     166            0 :          CALL section_vals_val_get(vcd_section, "SPATIAL_ORIGIN_REFERENCE", r_vals=ref_point)
     167              :       ELSE
     168            2 :          IF (reference == use_mom_ref_user) THEN
     169            0 :             CPABORT("User-defined reference point should be given explicitly")
     170              :          END IF
     171              :       END IF
     172              : 
     173              :       CALL get_reference_point(rpoint=vcd_env%spatial_origin, qs_env=qs_env, &
     174              :                                reference=reference, &
     175            2 :                                ref_point=ref_point)
     176              : 
     177            8 :       IF (vcd_env%distributed_origin .AND. ANY(vcd_env%magnetic_origin /= vcd_env%spatial_origin)) THEN
     178            0 :          CPWARN("The magnetic and spatial origins don't match")
     179              :          ! This is fine for NVP but will give unphysical results for MFP.
     180              :       END IF
     181              : 
     182            2 :       IF (vcd_env%output_unit > 0) WRITE (vcd_env%output_unit, "(A,3F10.6)") &
     183            1 :          'The reference point is', vcd_env%dcdr_env%ref_point
     184            2 :       IF (vcd_env%output_unit > 0) WRITE (vcd_env%output_unit, "(A,3F10.6)") &
     185            1 :          'The magnetic origin is', vcd_env%magnetic_origin
     186            2 :       IF (vcd_env%output_unit > 0) WRITE (vcd_env%output_unit, "(A,3F10.6)") &
     187            1 :          'The velocity origin is', vcd_env%spatial_origin
     188              : 
     189            8 :       vcd_env%magnetic_origin_atom = vcd_env%magnetic_origin
     190            8 :       vcd_env%spatial_origin_atom = vcd_env%spatial_origin
     191              : 
     192              :       CALL get_qs_env(qs_env=qs_env, &
     193              :                       ks_env=ks_env, &
     194              :                       dft_control=dft_control, &
     195              :                       sab_orb=sab_orb, &
     196              :                       sab_all=sab_all, &
     197              :                       sap_ppnl=sap_ppnl, &
     198              :                       particle_set=particle_set, &
     199              :                       matrix_ks=matrix_ks, &
     200              :                       cell=cell, &
     201            2 :                       qs_kind_set=qs_kind_set)
     202              : 
     203            2 :       natom = SIZE(particle_set)
     204            2 :       nspins = dft_control%nspins
     205              : 
     206            6 :       ALLOCATE (vcd_env%apt_el_nvpt(3, 3, natom))
     207            4 :       ALLOCATE (vcd_env%apt_nuc_nvpt(3, 3, natom))
     208            4 :       ALLOCATE (vcd_env%apt_total_nvpt(3, 3, natom))
     209            4 :       ALLOCATE (vcd_env%aat_atom_nvpt(3, 3, natom))
     210            4 :       ALLOCATE (vcd_env%aat_atom_mfp(3, 3, natom))
     211           80 :       vcd_env%apt_el_nvpt = 0._dp
     212           80 :       vcd_env%apt_nuc_nvpt = 0._dp
     213           80 :       vcd_env%apt_total_nvpt = 0._dp
     214           80 :       vcd_env%aat_atom_nvpt = 0._dp
     215           80 :       vcd_env%aat_atom_mfp = 0._dp
     216              : 
     217            8 :       ALLOCATE (vcd_env%dCV(nspins))
     218            6 :       ALLOCATE (vcd_env%dCV_prime(nspins))
     219            6 :       ALLOCATE (vcd_env%op_dV(nspins))
     220            6 :       ALLOCATE (vcd_env%op_dB(nspins))
     221            4 :       DO ispin = 1, nspins
     222            2 :          CALL cp_fm_create(vcd_env%dCV(ispin), vcd_env%dcdr_env%likemos_fm_struct(1)%struct, set_zero=.TRUE.)
     223            2 :          CALL cp_fm_create(vcd_env%dCV_prime(ispin), vcd_env%dcdr_env%likemos_fm_struct(1)%struct, set_zero=.TRUE.)
     224            2 :          CALL cp_fm_create(vcd_env%op_dV(ispin), vcd_env%dcdr_env%likemos_fm_struct(1)%struct, set_zero=.TRUE.)
     225            4 :          CALL cp_fm_create(vcd_env%op_dB(ispin), vcd_env%dcdr_env%likemos_fm_struct(1)%struct, set_zero=.TRUE.)
     226              :       END DO
     227              : 
     228            8 :       ALLOCATE (vcd_env%dCB(3))
     229            8 :       ALLOCATE (vcd_env%dCB_prime(3))
     230            8 :       DO i = 1, 3
     231            6 :          CALL cp_fm_create(vcd_env%dCB(i), vcd_env%dcdr_env%likemos_fm_struct(1)%struct, set_zero=.TRUE.)
     232            8 :          CALL cp_fm_create(vcd_env%dCB_prime(i), vcd_env%dcdr_env%likemos_fm_struct(1)%struct, set_zero=.TRUE.)
     233              :       END DO
     234              : 
     235              :       ! DBCSR matrices
     236            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%moments_der, 9, 3)
     237            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%moments_der_right, 9, 3)
     238            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%moments_der_left, 9, 3)
     239            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%matrix_difdip2, 3, 3)
     240            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%matrix_dSdV, 3)
     241            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%matrix_dSdB, 3)
     242            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%matrix_hxc_dsdv, nspins)
     243              : 
     244            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%hcom, 3)
     245            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%matrix_rcomr, 3, 3)
     246            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%matrix_rrcom, 3, 3)
     247            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%matrix_dcom, 3, 3)
     248            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%matrix_hr, nspins, 3)
     249            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%matrix_rh, nspins, 3)
     250            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%matrix_drpnl, 3)
     251            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%dipvel_ao, 3)
     252            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%dipvel_ao_delta, 3)
     253            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%matrix_rxrv, 3)
     254            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%matrix_r_rxvr, 3, 3)
     255            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%matrix_rxvr_r, 3, 3)
     256            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%matrix_r_doublecom, 3, 3)
     257              : 
     258            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%matrix_nosym_temp_33, 3, 3)
     259            2 :       CALL dbcsr_allocate_matrix_set(vcd_env%matrix_nosym_temp2_33, 3, 3)
     260           20 :       DO i = 1, 9 ! x, y, z, xx, xy, xz, yy, yz, zz
     261           74 :          DO idir = 1, 3 ! d/dx, d/dy, d/dz
     262           54 :             CALL dbcsr_init_p(vcd_env%moments_der(i, idir)%matrix)
     263           54 :             CALL dbcsr_init_p(vcd_env%moments_der_right(i, idir)%matrix)
     264           54 :             CALL dbcsr_init_p(vcd_env%moments_der_left(i, idir)%matrix)
     265              : 
     266              :             CALL dbcsr_create(vcd_env%moments_der(i, idir)%matrix, template=matrix_ks(1)%matrix, &
     267           54 :                               matrix_type=dbcsr_type_antisymmetric)
     268           54 :             CALL cp_dbcsr_alloc_block_from_nbl(vcd_env%moments_der(i, idir)%matrix, sab_orb)
     269           54 :             CALL dbcsr_set(vcd_env%moments_der(i, idir)%matrix, 0.0_dp)
     270              : 
     271              :             ! And the ones which will be multiplied by delta_(mu/nu)
     272              :             CALL dbcsr_copy(vcd_env%moments_der_right(i, idir)%matrix, &
     273           54 :                             vcd_env%dcdr_env%matrix_nosym_temp(1)%matrix)
     274              :             CALL dbcsr_copy(vcd_env%moments_der_left(i, idir)%matrix, &
     275           72 :                             vcd_env%dcdr_env%matrix_nosym_temp(1)%matrix)
     276              :          END DO
     277              :       END DO
     278              : 
     279            8 :       DO i = 1, 3
     280           24 :          DO j = 1, 3
     281           18 :             CALL dbcsr_init_p(vcd_env%matrix_difdip2(i, j)%matrix)
     282           18 :             CALL dbcsr_copy(vcd_env%matrix_difdip2(i, j)%matrix, vcd_env%dcdr_env%matrix_nosym_temp(1)%matrix)
     283           18 :             CALL dbcsr_set(vcd_env%matrix_difdip2(i, j)%matrix, 0.0_dp)
     284              : 
     285           18 :             CALL dbcsr_init_p(vcd_env%matrix_nosym_temp_33(i, j)%matrix)
     286              :             CALL dbcsr_create(vcd_env%matrix_nosym_temp_33(i, j)%matrix, template=matrix_ks(1)%matrix, &
     287           18 :                               matrix_type=dbcsr_type_no_symmetry)
     288           18 :             CALL cp_dbcsr_alloc_block_from_nbl(vcd_env%matrix_nosym_temp_33(i, j)%matrix, sab_all)
     289           18 :             CALL dbcsr_set(vcd_env%matrix_nosym_temp_33(i, j)%matrix, 0._dp)
     290              : 
     291           18 :             CALL dbcsr_init_p(vcd_env%matrix_nosym_temp2_33(i, j)%matrix)
     292              :             CALL dbcsr_create(vcd_env%matrix_nosym_temp2_33(i, j)%matrix, template=matrix_ks(1)%matrix, &
     293           18 :                               matrix_type=dbcsr_type_no_symmetry)
     294           18 :             CALL cp_dbcsr_alloc_block_from_nbl(vcd_env%matrix_nosym_temp2_33(i, j)%matrix, sab_all)
     295           24 :             CALL dbcsr_set(vcd_env%matrix_nosym_temp2_33(i, j)%matrix, 0._dp)
     296              : 
     297              :          END DO
     298            6 :          CALL dbcsr_init_p(vcd_env%matrix_dSdV(i)%matrix)
     299            6 :          CALL dbcsr_copy(vcd_env%matrix_dSdV(i)%matrix, vcd_env%dcdr_env%matrix_nosym_temp(1)%matrix)
     300            6 :          CALL dbcsr_init_p(vcd_env%matrix_dSdB(i)%matrix)
     301            8 :          CALL dbcsr_copy(vcd_env%matrix_dSdB(i)%matrix, vcd_env%dcdr_env%matrix_nosym_temp(1)%matrix)
     302              :       END DO
     303              : 
     304            4 :       DO ispin = 1, nspins
     305            2 :          CALL dbcsr_init_p(vcd_env%matrix_hxc_dsdv(ispin)%matrix)
     306            4 :          CALL dbcsr_copy(vcd_env%matrix_hxc_dsdv(ispin)%matrix, vcd_env%dcdr_env%matrix_nosym_temp(1)%matrix)
     307              :       END DO
     308              : 
     309              :       ! Things for op_dV
     310              :       ! lin_mom
     311            8 :       DO i = 1, 3
     312            6 :          CALL dbcsr_init_p(vcd_env%dipvel_ao(i)%matrix)
     313            6 :          CALL dbcsr_copy(vcd_env%dipvel_ao(i)%matrix, vcd_env%dcdr_env%matrix_nosym_temp(1)%matrix)
     314              : 
     315            6 :          CALL dbcsr_init_p(vcd_env%dipvel_ao_delta(i)%matrix)
     316            8 :          CALL dbcsr_copy(vcd_env%dipvel_ao_delta(i)%matrix, vcd_env%dcdr_env%matrix_nosym_temp(1)%matrix)
     317              :       END DO
     318              : 
     319              :       ! [V, r]
     320            8 :       DO i = 1, 3
     321            6 :          CALL dbcsr_init_p(vcd_env%hcom(i)%matrix)
     322              :          CALL dbcsr_create(vcd_env%hcom(i)%matrix, template=matrix_ks(1)%matrix, &
     323            6 :                            matrix_type=dbcsr_type_antisymmetric)
     324            6 :          CALL cp_dbcsr_alloc_block_from_nbl(vcd_env%hcom(i)%matrix, sab_orb)
     325              : 
     326            6 :          CALL dbcsr_init_p(vcd_env%matrix_rxrv(i)%matrix)
     327              :          CALL dbcsr_create(vcd_env%matrix_rxrv(i)%matrix, template=matrix_ks(1)%matrix, &
     328            6 :                            matrix_type=dbcsr_type_antisymmetric)
     329            6 :          CALL cp_dbcsr_alloc_block_from_nbl(vcd_env%matrix_rxrv(i)%matrix, sab_orb)
     330              : 
     331           26 :          DO j = 1, 3
     332           18 :             CALL dbcsr_init_p(vcd_env%matrix_rcomr(i, j)%matrix)
     333           18 :             CALL dbcsr_copy(vcd_env%matrix_rcomr(i, j)%matrix, vcd_env%dcdr_env%matrix_nosym_temp(1)%matrix)
     334           18 :             CALL dbcsr_init_p(vcd_env%matrix_rrcom(i, j)%matrix)
     335           18 :             CALL dbcsr_copy(vcd_env%matrix_rrcom(i, j)%matrix, vcd_env%dcdr_env%matrix_nosym_temp(1)%matrix)
     336           18 :             CALL dbcsr_init_p(vcd_env%matrix_dcom(i, j)%matrix)
     337           18 :             CALL dbcsr_copy(vcd_env%matrix_dcom(i, j)%matrix, matrix_ks(1)%matrix)
     338           18 :             CALL dbcsr_set(vcd_env%matrix_dcom(i, j)%matrix, 0._dp)
     339              : 
     340           18 :             CALL dbcsr_init_p(vcd_env%matrix_r_rxvr(i, j)%matrix)
     341           18 :             CALL dbcsr_copy(vcd_env%matrix_r_rxvr(i, j)%matrix, vcd_env%dcdr_env%matrix_nosym_temp(1)%matrix)
     342           18 :             CALL dbcsr_set(vcd_env%matrix_r_rxvr(i, j)%matrix, 0._dp)
     343              : 
     344           18 :             CALL dbcsr_init_p(vcd_env%matrix_rxvr_r(i, j)%matrix)
     345           18 :             CALL dbcsr_copy(vcd_env%matrix_rxvr_r(i, j)%matrix, vcd_env%dcdr_env%matrix_nosym_temp(1)%matrix)
     346           18 :             CALL dbcsr_set(vcd_env%matrix_rxvr_r(i, j)%matrix, 0._dp)
     347              : 
     348           18 :             CALL dbcsr_init_p(vcd_env%matrix_r_doublecom(i, j)%matrix)
     349           18 :             CALL dbcsr_copy(vcd_env%matrix_r_doublecom(i, j)%matrix, vcd_env%dcdr_env%matrix_nosym_temp(1)%matrix)
     350           24 :             CALL dbcsr_set(vcd_env%matrix_r_doublecom(i, j)%matrix, 0._dp)
     351              :          END DO
     352              :       END DO
     353              : 
     354              :       ! matrix_hr: nonsymmetric dbcsr matrix
     355            4 :       DO ispin = 1, nspins
     356           10 :          DO i = 1, 3
     357            6 :             CALL dbcsr_init_p(vcd_env%matrix_hr(ispin, i)%matrix)
     358            6 :             CALL dbcsr_copy(vcd_env%matrix_hr(ispin, i)%matrix, vcd_env%dcdr_env%matrix_nosym_temp(1)%matrix)
     359              : 
     360            6 :             CALL dbcsr_init_p(vcd_env%matrix_rh(ispin, i)%matrix)
     361            8 :             CALL dbcsr_copy(vcd_env%matrix_rh(ispin, i)%matrix, vcd_env%dcdr_env%matrix_nosym_temp(1)%matrix)
     362              :          END DO
     363              :       END DO
     364              : 
     365              :       ! drpnl for the operator
     366            8 :       DO i = 1, 3
     367            6 :          CALL dbcsr_init_p(vcd_env%matrix_drpnl(i)%matrix)
     368            8 :          CALL dbcsr_copy(vcd_env%matrix_drpnl(i)%matrix, vcd_env%dcdr_env%matrix_nosym_temp(1)%matrix)
     369              :       END DO
     370              : 
     371              :       ! NVP matrices
     372              :       ! hr matrices
     373            2 :       CALL build_matrix_hr_rh(vcd_env, qs_env, [0._dp, 0._dp, 0._dp])
     374              : 
     375              :       ! commutator terms
     376              :       ! - [V, r]
     377              :       CALL build_com_mom_nl(qs_kind_set, sab_orb, sap_ppnl, dft_control%qs_control%eps_ppnl, &
     378            2 :                             particle_set, cell=cell, matrix_rv=vcd_env%hcom)
     379              :       ! <[V, r] * r> and <r * [V, r]>
     380              :       CALL build_com_rpnl_r(vcd_env%matrix_rcomr, qs_kind_set, sab_all, sap_ppnl, &
     381            2 :                             dft_control%qs_control%eps_ppnl, particle_set, cell, .TRUE.)
     382              :       CALL build_com_rpnl_r(vcd_env%matrix_rrcom, qs_kind_set, sab_all, sap_ppnl, &
     383            2 :                             dft_control%qs_control%eps_ppnl, particle_set, cell, .FALSE.)
     384              : 
     385              :       ! lin_mom
     386            2 :       CALL build_lin_mom_matrix(qs_env, vcd_env%dipvel_ao)
     387              : 
     388              :       ! AAT
     389              :       ! The moments are set to zero and then recomputed in the routine.
     390              :       CALL build_local_moments_der_matrix(qs_env, moments_der=vcd_env%moments_der, &
     391            2 :                                           nmoments_der=2, nmoments=0, ref_point=[0._dp, 0._dp, 0._dp])
     392              : 
     393              :       ! PP terms
     394              :       CALL build_com_mom_nl(qs_kind_set, sab_orb, sap_ppnl, dft_control%qs_control%eps_ppnl, &
     395              :                             particle_set, matrix_rxrv=vcd_env%matrix_rxrv, ref_point=[0._dp, 0._dp, 0._dp], &
     396            2 :                             cell=cell)
     397              : 
     398              :       CALL build_com_mom_nl(qs_kind_set, sab_all, sap_ppnl, dft_control%qs_control%eps_ppnl, &
     399              :                             particle_set, ref_point=[0._dp, 0._dp, 0._dp], cell=cell, &
     400            2 :                             matrix_r_rxvr=vcd_env%matrix_r_rxvr, matrix_rxvr_r=vcd_env%matrix_rxvr_r)
     401              : 
     402              :       ! Done with NVP matrices
     403              : 
     404              :       CALL cp_print_key_finished_output(output_unit, logger, lr_section, &
     405            2 :                                         "PRINT%PROGRAM_RUN_INFO")
     406              : 
     407            2 :       CALL timestop(handle)
     408              : 
     409            6 :    END SUBROUTINE vcd_env_init
     410              : 
     411              : ! *****************************************************************************
     412              : !> \brief Deallocate the vcd environment
     413              : !> \param qs_env ...
     414              : !> \param vcd_env ...
     415              : !> \author Edward Ditler
     416              : ! **************************************************************************************************
     417            2 :    SUBROUTINE vcd_env_cleanup(qs_env, vcd_env)
     418              : 
     419              :       TYPE(qs_environment_type), POINTER                 :: qs_env
     420              :       TYPE(vcd_env_type)                                 :: vcd_env
     421              : 
     422              :       CHARACTER(LEN=*), PARAMETER                        :: routineN = 'vcd_env_cleanup'
     423              : 
     424              :       INTEGER                                            :: handle
     425              : 
     426            2 :       CALL timeset(routineN, handle)
     427              : 
     428              :       ! We can't run a NVPT/MFPT calculation without the coefficients dC/dR.
     429            2 :       CALL dcdr_env_cleanup(qs_env, vcd_env%dcdr_env)
     430              : 
     431            2 :       DEALLOCATE (vcd_env%apt_el_nvpt)
     432            2 :       DEALLOCATE (vcd_env%apt_nuc_nvpt)
     433            2 :       DEALLOCATE (vcd_env%apt_total_nvpt)
     434            2 :       DEALLOCATE (vcd_env%aat_atom_nvpt)
     435            2 :       DEALLOCATE (vcd_env%aat_atom_mfp)
     436              : 
     437            2 :       CALL cp_fm_release(vcd_env%dCV)
     438            2 :       CALL cp_fm_release(vcd_env%dCV_prime)
     439            2 :       CALL cp_fm_release(vcd_env%op_dV)
     440            2 :       CALL cp_fm_release(vcd_env%op_dB)
     441              : 
     442            2 :       CALL cp_fm_release(vcd_env%dCB)
     443            2 :       CALL cp_fm_release(vcd_env%dCB_prime)
     444              : 
     445              :       ! DBCSR matrices
     446              :       ! Probably, the memory requirements could be reduced by quite a bit
     447              :       ! by not storing each term in its own set of matrices.
     448              :       ! On the other hand, the memory bottleneck is usually the numerical
     449              :       ! integration grid.
     450            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%moments_der)
     451            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%moments_der_right)
     452            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%moments_der_left)
     453            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%matrix_difdip2)
     454            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%matrix_dSdV)
     455            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%matrix_dSdB)
     456            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%matrix_hxc_dsdv)
     457            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%hcom)
     458            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%matrix_rcomr)
     459            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%matrix_rrcom)
     460            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%matrix_dcom)
     461            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%matrix_hr)
     462            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%matrix_rh)
     463            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%matrix_drpnl)
     464            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%dipvel_ao)
     465            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%dipvel_ao_delta)
     466            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%matrix_rxrv)
     467            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%matrix_r_rxvr)
     468            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%matrix_rxvr_r)
     469            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%matrix_r_doublecom)
     470            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%matrix_nosym_temp_33)
     471            2 :       CALL dbcsr_deallocate_matrix_set(vcd_env%matrix_nosym_temp2_33)
     472            2 :       CALL timestop(handle)
     473              : 
     474            2 :    END SUBROUTINE vcd_env_cleanup
     475              : 
     476              : ! **************************************************************************************************
     477              : !> \brief Copied from linres_read_restart
     478              : !> \param qs_env ...
     479              : !> \param linres_section ...
     480              : !> \param vec ...
     481              : !> \param lambda ...
     482              : !> \param beta ...
     483              : !> \param tag ...
     484              : !> \author Edward Ditler
     485              : ! **************************************************************************************************
     486           18 :    SUBROUTINE vcd_read_restart(qs_env, linres_section, vec, lambda, beta, tag)
     487              :       TYPE(qs_environment_type), POINTER                 :: qs_env
     488              :       TYPE(section_vals_type), POINTER                   :: linres_section
     489              :       TYPE(cp_fm_type), DIMENSION(:), INTENT(IN)         :: vec
     490              :       INTEGER, INTENT(IN)                                :: lambda, beta
     491              :       CHARACTER(LEN=*)                                   :: tag
     492              : 
     493              :       CHARACTER(LEN=*), PARAMETER                        :: routineN = 'vcd_read_restart'
     494              : 
     495              :       CHARACTER(LEN=default_path_length)                 :: filename
     496              :       CHARACTER(LEN=default_string_length)               :: my_middle
     497              :       INTEGER :: beta_tmp, handle, i, i_block, ia, ie, iostat, iounit, ispin, j, lambda_tmp, &
     498              :          max_block, n_rep_val, nao, nao_tmp, nmo, nmo_tmp, nspins, nspins_tmp, rst_unit
     499              :       LOGICAL                                            :: file_exists
     500           18 :       REAL(KIND=dp), DIMENSION(:, :), POINTER            :: vecbuffer
     501              :       TYPE(cp_fm_type), POINTER                          :: mo_coeff
     502              :       TYPE(cp_logger_type), POINTER                      :: logger
     503           18 :       TYPE(mo_set_type), DIMENSION(:), POINTER           :: mos
     504              :       TYPE(mp_para_env_type), POINTER                    :: para_env
     505              :       TYPE(section_vals_type), POINTER                   :: print_key
     506              : 
     507           18 :       file_exists = .FALSE.
     508              : 
     509           18 :       CALL timeset(routineN, handle)
     510              : 
     511           18 :       NULLIFY (mos, para_env, logger, print_key, vecbuffer)
     512           18 :       logger => cp_get_default_logger()
     513              : 
     514              :       iounit = cp_print_key_unit_nr(logger, linres_section, &
     515           18 :                                     "PRINT%PROGRAM_RUN_INFO", extension=".Log")
     516              : 
     517              :       CALL get_qs_env(qs_env=qs_env, &
     518              :                       para_env=para_env, &
     519           18 :                       mos=mos)
     520              : 
     521           18 :       nspins = SIZE(mos)
     522              : 
     523           18 :       rst_unit = -1
     524           18 :       IF (para_env%is_source()) THEN
     525              :          CALL section_vals_val_get(linres_section, "WFN_RESTART_FILE_NAME", &
     526            9 :                                    n_rep_val=n_rep_val)
     527              : 
     528            9 :          CALL XSTRING(tag, ia, ie)
     529              :          my_middle = "RESTART-"//tag(ia:ie)//TRIM("-")//TRIM(ADJUSTL(cp_to_string(beta))) &
     530            9 :                      //TRIM("-")//TRIM(ADJUSTL(cp_to_string(lambda)))
     531              : 
     532            9 :          IF (n_rep_val > 0) THEN
     533            0 :             CALL section_vals_val_get(linres_section, "WFN_RESTART_FILE_NAME", c_val=filename)
     534            0 :             CALL xstring(filename, ia, ie)
     535            0 :             filename = filename(ia:ie)//TRIM(my_middle)//".lr"
     536              :          ELSE
     537              :             ! try to read from the filename that is generated automatically from the printkey
     538            9 :             print_key => section_vals_get_subs_vals(linres_section, "PRINT%RESTART")
     539              :             filename = cp_print_key_generate_filename(logger, print_key, &
     540            9 :                                                       extension=".lr", middle_name=TRIM(my_middle), my_local=.FALSE.)
     541              :          END IF
     542            9 :          INQUIRE (FILE=filename, exist=file_exists)
     543              :          !
     544              :          ! open file
     545            9 :          IF (file_exists) THEN
     546              :             CALL open_file(file_name=TRIM(filename), &
     547              :                            file_action="READ", &
     548              :                            file_form="UNFORMATTED", &
     549              :                            file_position="REWIND", &
     550              :                            file_status="OLD", &
     551            0 :                            unit_number=rst_unit)
     552              : 
     553            0 :             IF (iounit > 0) WRITE (iounit, "(T2,A)") &
     554            0 :                "LINRES| Reading response wavefunctions from the restart file <"//TRIM(ADJUSTL(filename))//">"
     555              :          ELSE
     556            9 :             IF (iounit > 0) WRITE (iounit, "(T2,A)") &
     557            9 :                "LINRES| Restart file  <"//TRIM(ADJUSTL(filename))//"> not found"
     558              :          END IF
     559              :       END IF
     560              : 
     561           18 :       CALL para_env%bcast(file_exists)
     562              : 
     563           18 :       IF (file_exists) THEN
     564              : 
     565            0 :          CALL get_mo_set(mos(1), mo_coeff=mo_coeff)
     566            0 :          CALL cp_fm_get_info(mo_coeff, nrow_global=nao, ncol_block=max_block)
     567              : 
     568            0 :          ALLOCATE (vecbuffer(nao, max_block))
     569              :          !
     570              :          ! read headers
     571            0 :          IF (rst_unit > 0) READ (rst_unit, IOSTAT=iostat) lambda_tmp, beta_tmp, nspins_tmp, nao_tmp
     572            0 :          CALL para_env%bcast(iostat)
     573              : 
     574            0 :          CALL para_env%bcast(beta_tmp)
     575            0 :          CALL para_env%bcast(lambda_tmp)
     576            0 :          CALL para_env%bcast(nspins_tmp)
     577            0 :          CALL para_env%bcast(nao_tmp)
     578              : 
     579              :          ! check that the number nao, nmo and nspins are
     580              :          ! the same as in the current mos
     581            0 :          IF (nspins_tmp /= nspins) THEN
     582            0 :             CPABORT("nspins not consistent")
     583              :          END IF
     584            0 :          IF (nao_tmp /= nao) CPABORT("nao not consistent")
     585              :          ! check that it's the right file
     586              :          ! the same as in the current mos
     587            0 :          IF (lambda_tmp /= lambda) CPABORT("lambda not consistent")
     588            0 :          IF (beta_tmp /= beta) CPABORT("beta not consistent")
     589              :          !
     590            0 :          DO ispin = 1, nspins
     591            0 :             CALL get_mo_set(mos(ispin), mo_coeff=mo_coeff)
     592            0 :             CALL cp_fm_get_info(mo_coeff, ncol_global=nmo)
     593              :             !
     594            0 :             IF (rst_unit > 0) READ (rst_unit) nmo_tmp
     595            0 :             CALL para_env%bcast(nmo_tmp)
     596            0 :             IF (nmo_tmp /= nmo) CPABORT("nmo not consistent")
     597              :             !
     598              :             ! read the response
     599            0 :             DO i = 1, nmo, MAX(max_block, 1)
     600            0 :                i_block = MIN(max_block, nmo - i + 1)
     601            0 :                DO j = 1, i_block
     602            0 :                   IF (rst_unit > 0) READ (rst_unit) vecbuffer(1:nao, j)
     603              :                END DO
     604            0 :                CALL para_env%bcast(vecbuffer)
     605            0 :                CALL cp_fm_set_submatrix(vec(ispin), vecbuffer, 1, i, nao, i_block)
     606              :             END DO
     607              :          END DO
     608              : 
     609            0 :          IF (iostat /= 0) THEN
     610            0 :             IF (iounit > 0) WRITE (iounit, "(T2,A)") &
     611            0 :                "LINRES| Restart file <"//TRIM(ADJUSTL(filename))//"> not found"
     612              :          END IF
     613              : 
     614            0 :          DEALLOCATE (vecbuffer)
     615              : 
     616              :       END IF
     617              : 
     618           18 :       IF (para_env%is_source()) THEN
     619            9 :          IF (file_exists) CALL close_file(unit_number=rst_unit)
     620              :       END IF
     621              : 
     622           18 :       CALL timestop(handle)
     623              : 
     624           18 :    END SUBROUTINE vcd_read_restart
     625              : 
     626              : ! **************************************************************************************************
     627              : !> \brief Copied from linres_write_restart
     628              : !> \param qs_env ...
     629              : !> \param linres_section ...
     630              : !> \param vec ...
     631              : !> \param lambda ...
     632              : !> \param beta ...
     633              : !> \param tag ...
     634              : !> \author Edward Ditler
     635              : ! **************************************************************************************************
     636           18 :    SUBROUTINE vcd_write_restart(qs_env, linres_section, vec, lambda, beta, tag)
     637              :       TYPE(qs_environment_type), POINTER                 :: qs_env
     638              :       TYPE(section_vals_type), POINTER                   :: linres_section
     639              :       TYPE(cp_fm_type), DIMENSION(:), INTENT(IN)         :: vec
     640              :       INTEGER, INTENT(IN)                                :: lambda, beta
     641              :       CHARACTER(LEN=*)                                   :: tag
     642              : 
     643              :       CHARACTER(LEN=*), PARAMETER                        :: routineN = 'vcd_write_restart'
     644              : 
     645              :       CHARACTER(LEN=default_path_length)                 :: filename
     646              :       CHARACTER(LEN=default_string_length)               :: my_middle, my_pos, my_status
     647              :       INTEGER                                            :: handle, i, i_block, ia, ie, iounit, &
     648              :                                                             ispin, j, max_block, nao, nmo, nspins, &
     649              :                                                             rst_unit
     650           18 :       REAL(KIND=dp), DIMENSION(:, :), POINTER            :: vecbuffer
     651              :       TYPE(cp_fm_type), POINTER                          :: mo_coeff
     652              :       TYPE(cp_logger_type), POINTER                      :: logger
     653           18 :       TYPE(mo_set_type), DIMENSION(:), POINTER           :: mos
     654              :       TYPE(mp_para_env_type), POINTER                    :: para_env
     655              :       TYPE(section_vals_type), POINTER                   :: print_key
     656              : 
     657           18 :       NULLIFY (logger, mo_coeff, mos, para_env, print_key, vecbuffer)
     658              : 
     659           18 :       CALL timeset(routineN, handle)
     660              : 
     661           18 :       logger => cp_get_default_logger()
     662              : 
     663           18 :       IF (BTEST(cp_print_key_should_output(logger%iter_info, linres_section, "PRINT%RESTART", &
     664              :                                            used_print_key=print_key), &
     665              :                 cp_p_file)) THEN
     666              : 
     667              :          iounit = cp_print_key_unit_nr(logger, linres_section, &
     668           18 :                                        "PRINT%PROGRAM_RUN_INFO", extension=".Log")
     669              : 
     670              :          CALL get_qs_env(qs_env=qs_env, &
     671              :                          mos=mos, &
     672           18 :                          para_env=para_env)
     673              : 
     674           18 :          nspins = SIZE(mos)
     675              : 
     676           18 :          my_status = "REPLACE"
     677           18 :          my_pos = "REWIND"
     678           18 :          CALL XSTRING(tag, ia, ie)
     679              :          my_middle = "RESTART-"//tag(ia:ie)//TRIM("-")//TRIM(ADJUSTL(cp_to_string(beta))) &
     680           18 :                      //TRIM("-")//TRIM(ADJUSTL(cp_to_string(lambda)))
     681              :          rst_unit = cp_print_key_unit_nr(logger, linres_section, "PRINT%RESTART", &
     682              :                                          extension=".lr", middle_name=TRIM(my_middle), file_status=TRIM(my_status), &
     683           18 :                                          file_position=TRIM(my_pos), file_action="WRITE", file_form="UNFORMATTED")
     684              : 
     685              :          filename = cp_print_key_generate_filename(logger, print_key, &
     686           18 :                                                    extension=".lr", middle_name=TRIM(my_middle), my_local=.FALSE.)
     687              : 
     688           18 :          IF (iounit > 0) THEN
     689              :             WRITE (UNIT=iounit, FMT="(T2,A)") &
     690            9 :                "LINRES| Writing response functions to the restart file <"//TRIM(ADJUSTL(filename))//">"
     691              :          END IF
     692              : 
     693              :          !
     694              :          ! write data to file
     695              :          ! use the scalapack block size as a default for buffering columns
     696           18 :          CALL get_mo_set(mos(1), mo_coeff=mo_coeff)
     697           18 :          CALL cp_fm_get_info(mo_coeff, nrow_global=nao, ncol_block=max_block)
     698           72 :          ALLOCATE (vecbuffer(nao, max_block))
     699              : 
     700           18 :          IF (rst_unit > 0) WRITE (rst_unit) lambda, beta, nspins, nao
     701              : 
     702           36 :          DO ispin = 1, nspins
     703           18 :             CALL cp_fm_get_info(vec(ispin), ncol_global=nmo)
     704              : 
     705           18 :             IF (rst_unit > 0) WRITE (rst_unit) nmo
     706              : 
     707           72 :             DO i = 1, nmo, MAX(max_block, 1)
     708           18 :                i_block = MIN(max_block, nmo - i + 1)
     709           18 :                CALL cp_fm_get_submatrix(vec(ispin), vecbuffer, 1, i, nao, i_block)
     710              :                ! doing this in one write would increase efficiency, but breaks RESTART compatibility.
     711              :                ! to old ones, and in cases where max_block is different between runs, as might happen during
     712              :                ! restarts with a different number of CPUs
     713          108 :                DO j = 1, i_block
     714          306 :                   IF (rst_unit > 0) WRITE (rst_unit) vecbuffer(1:nao, j)
     715              :                END DO
     716              :             END DO
     717              :          END DO
     718              : 
     719           18 :          DEALLOCATE (vecbuffer)
     720              : 
     721              :          CALL cp_print_key_finished_output(rst_unit, logger, linres_section, &
     722           36 :                                            "PRINT%RESTART")
     723              :       END IF
     724              : 
     725           18 :       CALL timestop(handle)
     726              : 
     727           18 :    END SUBROUTINE vcd_write_restart
     728              : 
     729              : ! **************************************************************************************************
     730              : !> \brief Print the APTs, AATs, and sum rules
     731              : !> \param vcd_env ...
     732              : !> \param qs_env ...
     733              : !> \author Edward Ditler
     734              : ! **************************************************************************************************
     735            2 :    SUBROUTINE vcd_print(vcd_env, qs_env)
     736              :       TYPE(vcd_env_type)                                 :: vcd_env
     737              :       TYPE(qs_environment_type), POINTER                 :: qs_env
     738              : 
     739              :       CHARACTER(len=*), PARAMETER                        :: routineN = 'vcd_print'
     740              : 
     741              :       CHARACTER(LEN=default_string_length)               :: description
     742              :       INTEGER                                            :: alpha, beta, delta, gamma, handle, i, l, &
     743              :                                                             lambda, natom, nsubset, output_unit
     744              :       REAL(dp)                                           :: mean, standard_deviation, &
     745              :                                                             standard_deviation_sum
     746            2 :       REAL(dp), DIMENSION(:, :, :), POINTER              :: apt_el_dcdr, apt_el_nvpt, apt_nuc_dcdr, &
     747            2 :                                                             apt_nuc_nvpt, apt_total_dcdr, &
     748            2 :                                                             apt_total_nvpt
     749            2 :       REAL(dp), DIMENSION(:, :, :, :), POINTER           :: apt_center_dcdr, apt_subset_dcdr
     750              :       REAL(kind=dp), DIMENSION(3, 3)                     :: sum_rule_0, sum_rule_0_second, &
     751              :                                                             sum_rule_1, sum_rule_2, &
     752              :                                                             sum_rule_2_second, sum_rule_3_mfp, &
     753              :                                                             sum_rule_3_second
     754              :       TYPE(cp_logger_type), POINTER                      :: logger
     755              :       TYPE(cp_result_type), POINTER                      :: results
     756            2 :       TYPE(molecule_type), DIMENSION(:), POINTER         :: molecule_set
     757            2 :       TYPE(particle_type), DIMENSION(:), POINTER         :: particle_set
     758              :       TYPE(section_vals_type), POINTER                   :: vcd_section
     759              : 
     760            2 :       CALL timeset(routineN, handle)
     761              : 
     762            2 :       NULLIFY (logger)
     763              : 
     764            2 :       logger => cp_get_default_logger()
     765            2 :       output_unit = cp_logger_get_default_io_unit(logger)
     766              : 
     767            2 :       vcd_section => section_vals_get_subs_vals(qs_env%input, "PROPERTIES%LINRES%VCD")
     768              : 
     769            2 :       NULLIFY (particle_set)
     770            2 :       CALL get_qs_env(qs_env=qs_env, particle_set=particle_set, molecule_set=molecule_set)
     771            2 :       natom = SIZE(particle_set)
     772            2 :       nsubset = SIZE(molecule_set)
     773              : 
     774            2 :       apt_el_dcdr => vcd_env%dcdr_env%apt_el_dcdr
     775            2 :       apt_nuc_dcdr => vcd_env%dcdr_env%apt_nuc_dcdr
     776            2 :       apt_total_dcdr => vcd_env%dcdr_env%apt_total_dcdr
     777            2 :       apt_subset_dcdr => vcd_env%dcdr_env%apt_el_dcdr_per_subset
     778            2 :       apt_center_dcdr => vcd_env%dcdr_env%apt_el_dcdr_per_center
     779              : 
     780            2 :       apt_el_nvpt => vcd_env%apt_el_nvpt
     781            2 :       apt_nuc_nvpt => vcd_env%apt_nuc_nvpt
     782            2 :       apt_total_nvpt => vcd_env%apt_total_nvpt
     783              : 
     784            2 :       IF (vcd_env%output_unit > 0) WRITE (vcd_env%output_unit, "(A)") &
     785            1 :          'APT | Write the final APT matrix per atom (Position perturbation)'
     786            8 :       DO l = 1, natom
     787            6 :          IF (vcd_env%output_unit > 0) WRITE (vcd_env%output_unit, "(A,I3,A,F15.6)") &
     788            3 :             'APT | Atom', l, ' - GAPT ', &
     789              :             (apt_total_dcdr(1, 1, l) &
     790              :              + apt_total_dcdr(2, 2, l) &
     791            6 :              + apt_total_dcdr(3, 3, l))/3._dp
     792           26 :          DO i = 1, 3
     793           51 :             IF (vcd_env%output_unit > 0) WRITE (vcd_env%output_unit, "(A,F15.6,F15.6,F15.6)") "APT | ", apt_total_dcdr(i, :, l)
     794              :          END DO
     795              :       END DO
     796              : 
     797            2 :       IF (vcd_env%output_unit > 0) WRITE (vcd_env%output_unit, "(A)") &
     798            1 :          'NVP | Write the final APT matrix per atom (Velocity perturbation)'
     799            8 :       DO l = 1, natom
     800            6 :          IF (vcd_env%output_unit > 0) WRITE (vcd_env%output_unit, "(A,I3,A,F15.6)") &
     801            3 :             'NVP | Atom', l, ' - GAPT ', &
     802              :             (apt_total_nvpt(1, 1, l) &
     803              :              + apt_total_nvpt(2, 2, l) &
     804            6 :              + apt_total_nvpt(3, 3, l))/3._dp
     805           26 :          DO i = 1, 3
     806           24 :             IF (vcd_env%output_unit > 0) THEN
     807              :                WRITE (vcd_env%output_unit, "(A,F15.6,F15.6,F15.6)") &
     808           36 :                   "NVP | ", apt_total_nvpt(i, :, l)
     809              :             END IF
     810              :          END DO
     811              :       END DO
     812              : 
     813            2 :       IF (vcd_env%output_unit > 0) WRITE (vcd_env%output_unit, "(A)") &
     814            1 :          'NVP | Write the final AAT matrix per atom (Velocity perturbation)'
     815            8 :       DO l = 1, natom
     816            6 :          IF (vcd_env%output_unit > 0) WRITE (vcd_env%output_unit, "(A,I3)") &
     817            3 :             'NVP | Atom', l
     818           26 :          DO i = 1, 3
     819           24 :             IF (vcd_env%output_unit > 0) THEN
     820              :                WRITE (vcd_env%output_unit, "(A,F15.6,F15.6,F15.6)") &
     821            9 :                   "NVP | ", vcd_env%aat_atom_nvpt(i, :, l)
     822              :             END IF
     823              :          END DO
     824              :       END DO
     825              : 
     826            2 :       IF (vcd_env%do_mfp) THEN
     827            0 :          IF (vcd_env%output_unit > 0) WRITE (vcd_env%output_unit, "(A)") &
     828            0 :             'MFP | Write the final AAT matrix per atom (Magnetic Field perturbation)'
     829            0 :          DO l = 1, natom
     830            0 :             IF (vcd_env%output_unit > 0) WRITE (vcd_env%output_unit, "(A,I3)") &
     831            0 :                'MFP | Atom', l
     832            0 :             DO i = 1, 3
     833            0 :                IF (vcd_env%output_unit > 0) THEN
     834              :                   WRITE (vcd_env%output_unit, "(A,F15.6,F15.6,F15.6)") &
     835            0 :                      "MFP | ", vcd_env%aat_atom_mfp(i, :, l)
     836              :                END IF
     837              :             END DO
     838              :          END DO
     839              :       END IF
     840              : 
     841              :       ! Get the dipole
     842            2 :       CALL get_qs_env(qs_env, results=results)
     843            2 :       description = "[DIPOLE]"
     844            2 :       CALL get_results(results=results, description=description, values=vcd_env%dcdr_env%dipole_pos(1:3))
     845              : 
     846              :       ! Sum rules [for all alpha, beta]
     847            2 :       sum_rule_0 = 0._dp
     848            2 :       sum_rule_1 = 0._dp
     849            2 :       sum_rule_2 = 0._dp
     850            2 :       sum_rule_0_second = 0._dp
     851            2 :       sum_rule_2_second = 0._dp
     852            2 :       sum_rule_3_second = 0._dp
     853            2 :       sum_rule_3_mfp = 0._dp
     854              :       standard_deviation = 0._dp
     855            2 :       standard_deviation_sum = 0._dp
     856              : 
     857            8 :       DO alpha = 1, 3
     858           26 :          DO beta = 1, 3
     859              :             ! 0: sum_lambda apt(alpha, beta, lambda)
     860           72 :             DO lambda = 1, natom
     861              :                sum_rule_0(alpha, beta) = sum_rule_0(alpha, beta) &
     862           54 :                                          + apt_total_dcdr(alpha, beta, lambda)
     863              :                sum_rule_0_second(alpha, beta) = sum_rule_0_second(alpha, beta) &
     864           72 :                                                 + apt_total_nvpt(alpha, beta, lambda)
     865              :             END DO
     866              : 
     867              :             ! 1: sum_gamma epsilon_(alpha beta gamma) mu_gamma
     868           72 :             DO gamma = 1, 3
     869              :                sum_rule_1(alpha, beta) = sum_rule_1(alpha, beta) &
     870           72 :                                          + Levi_Civita(alpha, beta, gamma)*vcd_env%dcdr_env%dipole_pos(gamma)
     871              :             END DO
     872              : 
     873              :             ! 2: sum_(lambda gamma delta) R^lambda_gamma apt(delta, alpha, lambda)
     874           72 :             DO lambda = 1, natom
     875          234 :                DO gamma = 1, 3
     876          702 :                   DO delta = 1, 3
     877              :                      sum_rule_2(alpha, beta) = sum_rule_2(alpha, beta) &
     878              :                                                + Levi_Civita(beta, gamma, delta) &
     879              :                                                *particle_set(lambda)%r(gamma) &
     880          486 :                                                *apt_total_dcdr(delta, alpha, lambda)
     881              :                      sum_rule_2_second(alpha, beta) = sum_rule_2_second(alpha, beta) &
     882              :                                                       + Levi_Civita(beta, gamma, delta) &
     883              :                                                       *particle_set(lambda)%r(gamma) &
     884          648 :                                                       *apt_total_nvpt(delta, alpha, lambda)
     885              :                   END DO
     886              :                END DO
     887              :             END DO
     888              : 
     889              :             ! 3: 2c * sum_lambda aat(alpha, beta, lambda)
     890           72 :             DO lambda = 1, natom
     891              :                sum_rule_3_second(alpha, beta) = sum_rule_3_second(alpha, beta) &
     892           72 :                                                 + vcd_env%aat_atom_nvpt(alpha, beta, lambda)
     893              :                ! + 2._dp*c_light_au*vcd_env%aat_atom_nvpt(alpha, beta, lambda)
     894              :             END DO
     895              : 
     896           24 :             IF (vcd_env%do_mfp) THEN
     897              :                ! 3: 2c * sum_lambda aat(alpha, beta, lambda)
     898            0 :                DO lambda = 1, natom
     899              :                   sum_rule_3_mfp(alpha, beta) = sum_rule_3_mfp(alpha, beta) &
     900            0 :                                                 + vcd_env%aat_atom_mfp(alpha, beta, lambda)
     901              :                END DO
     902              :             END IF
     903              : 
     904              :          END DO ! beta
     905              :       END DO   ! alpha
     906              : 
     907            2 :       IF (vcd_env%output_unit > 0) WRITE (vcd_env%output_unit, "(A)") "APT | Position perturbation sum rules"
     908            2 :       IF (vcd_env%output_unit > 0) WRITE (vcd_env%output_unit, "(A,T19,A,T35,A,T50,A,T65,A)") &
     909            1 :          "APT |", " Total APT", "Dipole", "R * APT", "AAT"
     910              :       standard_deviation_sum = 0._dp
     911            8 :       DO alpha = 1, 3
     912           26 :          DO beta = 1, 3
     913           18 :             mean = (sum_rule_1(alpha, beta) + sum_rule_2(alpha, beta) + sum_rule_3_mfp(alpha, beta))/3
     914              :             standard_deviation = &
     915              :                SQRT((sum_rule_1(alpha, beta)**2 + sum_rule_2(alpha, beta)**2 + sum_rule_3_mfp(alpha, beta)**2)/3 &
     916           18 :                     - mean**2)
     917           18 :             standard_deviation_sum = standard_deviation_sum + standard_deviation
     918              : 
     919           18 :             IF (vcd_env%output_unit > 0) WRITE (vcd_env%output_unit, &
     920              :                                                 "(A,I3,I3,F15.6,F15.6,F15.6,F15.6,F15.6)") &
     921            9 :                "APT | ", &
     922            9 :                alpha, beta, &
     923            9 :                sum_rule_0(alpha, beta), &
     924            9 :                sum_rule_1(alpha, beta), &
     925            9 :                sum_rule_2(alpha, beta), &
     926            9 :                sum_rule_3_mfp(alpha, beta), &
     927           24 :                standard_deviation
     928              :          END DO
     929              :       END DO
     930            2 :       IF (vcd_env%output_unit > 0) WRITE (vcd_env%output_unit, "(T73,F15.6)") standard_deviation_sum
     931              : 
     932            2 :       IF (vcd_env%output_unit > 0) THEN
     933            1 :          WRITE (vcd_env%output_unit, "(A)") "NVP | Velocity perturbation sum rules"
     934            1 :          WRITE (vcd_env%output_unit, "(A,T19,A,T35,A,T50,A,T65,A)") "NVP |", " Total APT", "Dipole", "R * APT", "AAT"
     935              :       END IF
     936              : 
     937            2 :       standard_deviation_sum = 0._dp
     938            8 :       DO alpha = 1, 3
     939           26 :          DO beta = 1, 3
     940           18 :             mean = (sum_rule_1(alpha, beta) + sum_rule_2_second(alpha, beta) + sum_rule_3_second(alpha, beta))/3
     941              :             standard_deviation = &
     942              :                SQRT((sum_rule_1(alpha, beta)**2 + sum_rule_2_second(alpha, beta)**2 + sum_rule_3_second(alpha, beta)**2)/3 &
     943           18 :                     - mean**2)
     944           18 :             standard_deviation_sum = standard_deviation_sum + standard_deviation
     945           18 :             IF (vcd_env%output_unit > 0) WRITE (vcd_env%output_unit, &
     946              :                                                 "(A,I3,I3,F15.6,F15.6,F15.6,F15.6,F15.6)") &
     947            9 :                "NVP | ", &
     948            9 :                alpha, &
     949            9 :                beta, &
     950            9 :                sum_rule_0_second(alpha, beta), &
     951            9 :                sum_rule_1(alpha, beta), &
     952            9 :                sum_rule_2_second(alpha, beta), &
     953            9 :                sum_rule_3_second(alpha, beta), &
     954           24 :                standard_deviation
     955              :          END DO
     956              :       END DO
     957            2 :       IF (vcd_env%output_unit > 0) WRITE (vcd_env%output_unit, "(T73,F15.6)") standard_deviation_sum
     958              : 
     959            2 :       CALL timestop(handle)
     960            2 :    END SUBROUTINE vcd_print
     961              : 
     962              : END MODULE qs_vcd_utils
        

Generated by: LCOV version 2.0-1