ec_env_types.F

Go to the documentation of this file.

!--------------------------------------------------------------------------------------------------!
!   CP2K: A general program to perform molecular dynamics simulations                              !
!   Copyright 2000-2026 CP2K developers group <https://cp2k.org>                                   !
!                                                                                                  !
!   SPDX-License-Identifier: GPL-2.0-or-later                                                      !
!--------------------------------------------------------------------------------------------------!
 
! **************************************************************************************************
!> \brief Types needed for a for a Energy Correction
!> \par History
!>       2019.09 created
!> \author JGH
! **************************************************************************************************
MODULE ec_env_types
   USE cp_dbcsr_api,                    ONLY: dbcsr_p_type
   USE cp_dbcsr_operations,             ONLY: dbcsr_deallocate_matrix_set
   USE cp_fm_types,                     ONLY: cp_fm_release,&
                                              cp_fm_type
   USE dm_ls_scf_types,                 ONLY: ls_scf_env_type,&
                                              ls_scf_release
   USE hfx_types,                       ONLY: hfx_release,&
                                              hfx_type
   USE input_section_types,             ONLY: section_vals_release,&
                                              section_vals_type
   USE kinds,                           ONLY: dp
   USE pw_types,                        ONLY: pw_r3d_rs_type
   USE qs_dispersion_types,             ONLY: qs_dispersion_release,&
                                              qs_dispersion_type
   USE qs_force_types,                  ONLY: deallocate_qs_force,&
                                              qs_force_type
   USE qs_local_rho_types,              ONLY: local_rho_set_release,&
                                              local_rho_type
   USE qs_neighbor_list_types,          ONLY: neighbor_list_set_p_type,&
                                              release_neighbor_list_sets
   USE qs_oce_types,                    ONLY: deallocate_oce_set,&
                                              oce_matrix_type
   USE qs_p_env_types,                  ONLY: p_env_release,&
                                              qs_p_env_type
   USE qs_period_efield_types,          ONLY: efield_berry_release,&
                                              efield_berry_type
   USE task_list_types,                 ONLY: deallocate_task_list,&
                                              task_list_type
#include "./base/base_uses.f90"
 
   IMPLICIT NONE
 
   PRIVATE
 
   CHARACTER(len=*), PARAMETER, PRIVATE :: moduleN = 'ec_env_types'
 
   PUBLIC :: energy_correction_type, ec_env_release
   PUBLIC :: ec_env_matrix_release, ec_env_potential_release
 
! *****************************************************************************
!> \brief Contains information on the energy correction functional for KG
!> \par History
!>       03.2014 created
!> \author JGH
! *****************************************************************************
   TYPE energy_correction_type
      CHARACTER(len=20)                                :: ec_name = ""
      INTEGER                                          :: energy_functional = 0
      INTEGER                                          :: ks_solver = 0
      INTEGER                                          :: factorization = 0
      INTEGER                                          :: ec_initial_guess = 0
      REAL(kind=dp)                                    :: eps_default = 0.0_dp
      LOGICAL                                          :: do_ec_admm = .false.
      LOGICAL                                          :: do_ec_hfx = .false.
      LOGICAL                                          :: should_update = .false.
      LOGICAL                                          :: use_ls_solver = .false.
      LOGICAL                                          :: reuse_hfx = .false.
      LOGICAL                                          :: basis_inconsistent = .false.
      ! debug
      LOGICAL                                          :: debug_forces = .false.
      LOGICAL                                          :: debug_stress = .false.
      LOGICAL                                          :: debug_external = .false.
      REAL(kind=dp)                                    :: orbrot_index = 0.0_dp
      REAL(kind=dp)                                    :: phase_index = 0.0_dp
      ! basis set
      CHARACTER(len=20)                                :: basis = ""
      LOGICAL                                          :: mao = .false.
      ! Skip EC calculation if ground-state didnt converge
      LOGICAL                                          :: do_skip = .false., skip_ec = .false.
      INTEGER                                          :: mao_max_iter = 0
      REAL(kind=dp)                                    :: mao_eps_grad = 0.0_dp
      REAL(kind=dp)                                    :: mao_eps1 = 0.0_dp
      INTEGER                                          :: mao_iolevel = 0
      ! energy components
      REAL(kind=dp)                                    :: etotal = 0.0_dp, old_etotal = 0.0_dp
      REAL(kind=dp)                                    :: eband = 0.0_dp, ecore = 0.0_dp, exc = 0.0_dp, &
                                                          ehartree = 0.0_dp, vhxc = 0.0_dp
      REAL(kind=dp)                                    :: edispersion = 0.0_dp, efield_elec = 0.0_dp, &
                                                          efield_nuclear = 0.0_dp, ex = 0.0_dp, exc_aux_fit = 0.0_dp
      REAL(kind=dp)                                    :: exc1 = 0.0_dp, exc1_aux_fit = 0.0_dp, ehartree_1c = 0.0_dp
      ! forces
      TYPE(qs_force_type), DIMENSION(:), POINTER       :: force => null()
      ! full neighbor lists and corresponding task list
      TYPE(neighbor_list_set_p_type), &
         DIMENSION(:), POINTER                         :: sab_orb => null(), sac_ppl => null(), &
                                                          sac_ae => null(), sap_ppnl => null(), &
                                                          sap_oce => null()
      TYPE(task_list_type), POINTER                    :: task_list => null()
      TYPE(task_list_type), POINTER                    :: task_list_soft => null()
      ! the XC function to be used for the correction, dispersion info
      TYPE(section_vals_type), POINTER                 :: xc_section => null()
      TYPE(qs_dispersion_type), POINTER                :: dispersion_env => null()
      ! matrices in complete basis
      ! KS: Kohn-Sham; H: Core; S: overlap; T: kinetic energy;
      ! P: Harris density, W: Harris energy weighted density
      TYPE(dbcsr_p_type), DIMENSION(:, :), POINTER     :: matrix_ks => null(), &
                                                          matrix_h => null(), &
                                                          matrix_s => null(), &
                                                          matrix_t => null(), &
                                                          matrix_p => null(), &
                                                          matrix_w => null()
      ! GAPW
      TYPE(local_rho_type), POINTER                    :: local_rho_set => null()
      TYPE(local_rho_type), POINTER                    :: local_rho_set_admm => null()
      TYPE(oce_matrix_type), POINTER                   :: oce => null()
      ! reduce basis
      TYPE(dbcsr_p_type), DIMENSION(:), POINTER        :: mao_coef => null()
      ! external energy calclulation
      TYPE(cp_fm_type), DIMENSION(:), POINTER          :: mo_occ => null()
      TYPE(cp_fm_type), DIMENSION(:), POINTER          :: cpmos => null()
      ! CP equations
      TYPE(qs_p_env_type), POINTER                     :: p_env => null()
      TYPE(dbcsr_p_type), DIMENSION(:), POINTER        :: matrix_hz => null(), matrix_wz => null(), &
                                                          matrix_z => null(), z_admm => null()
      ! Harris (rhoout), and response density (rhoz) on grid
      TYPE(pw_r3d_rs_type), DIMENSION(:), POINTER      :: rhoout_r => null(), &
                                                          rhoz_r => null()
      ! potentials from input density
      TYPE(pw_r3d_rs_type)                             :: vh_rspace = pw_r3d_rs_type()
      TYPE(pw_r3d_rs_type), DIMENSION(:), POINTER      :: vxc_rspace => null(), &
                                                          vtau_rspace => null(), &
                                                          vadmm_rspace => null()
      ! efield
      TYPE(efield_berry_type), POINTER                 :: efield => null()
      ! LS matrices and types
      TYPE(ls_scf_env_type), POINTER                   :: ls_env => null()
      ! Environment for Hartree-Fock exchange
      TYPE(hfx_type), DIMENSION(:, :), POINTER         :: x_data => null()
      ! ADMM XC environments
      TYPE(section_vals_type), POINTER                 :: xc_section_primary => null(), &
                                                          xc_section_aux => null()
      ! External
      CHARACTER(len=40)                                :: exresp_fn = ""
      CHARACTER(len=40)                                :: exresperr_fn = ""
      CHARACTER(len=40)                                :: exresult_fn = ""
      LOGICAL                                          :: do_error = .false.
      CHARACTER(len=1)                                 :: error_method = "E"
      REAL(kind=dp)                                    :: error_cutoff = 0.0_dp
      INTEGER                                          :: error_subspace = 0
      REAL(kind=dp), DIMENSION(3, 3)                   :: rpv = 0.0_dp
      REAL(kind=dp), DIMENSION(:, :), POINTER          :: rf => null()
      TYPE(cp_fm_type), DIMENSION(:), POINTER          :: cpref => null()
   END TYPE energy_correction_type
 
CONTAINS
 
! **************************************************************************************************
!> \brief ...
!> \param ec_env ...
! **************************************************************************************************
   SUBROUTINE ec_env_release(ec_env)
      TYPE(energy_correction_type), POINTER              :: ec_env
 
      CHARACTER(LEN=*), PARAMETER                        :: routinen = 'ec_env_release'
 
      INTEGER                                            :: handle
 
      CALL timeset(routinen, handle)
 
      IF (ASSOCIATED(ec_env)) THEN
         ! neighbor lists
         CALL release_neighbor_list_sets(ec_env%sab_orb)
         CALL release_neighbor_list_sets(ec_env%sac_ppl)
         CALL release_neighbor_list_sets(ec_env%sac_ae)
         CALL release_neighbor_list_sets(ec_env%sap_ppnl)
         CALL release_neighbor_list_sets(ec_env%sap_oce)
         ! forces
         IF (ASSOCIATED(ec_env%force)) CALL deallocate_qs_force(ec_env%force)
         ! operator matrices
         IF (ASSOCIATED(ec_env%matrix_ks)) CALL dbcsr_deallocate_matrix_set(ec_env%matrix_ks)
         IF (ASSOCIATED(ec_env%matrix_h)) CALL dbcsr_deallocate_matrix_set(ec_env%matrix_h)
         IF (ASSOCIATED(ec_env%matrix_s)) CALL dbcsr_deallocate_matrix_set(ec_env%matrix_s)
         IF (ASSOCIATED(ec_env%matrix_t)) CALL dbcsr_deallocate_matrix_set(ec_env%matrix_t)
         IF (ASSOCIATED(ec_env%matrix_p)) CALL dbcsr_deallocate_matrix_set(ec_env%matrix_p)
         IF (ASSOCIATED(ec_env%matrix_w)) CALL dbcsr_deallocate_matrix_set(ec_env%matrix_w)
         ! GAPW
         IF (ASSOCIATED(ec_env%oce)) CALL deallocate_oce_set(ec_env%oce)
         ! task lists for collocate/integrate
         IF (ASSOCIATED(ec_env%task_list)) THEN
            CALL deallocate_task_list(ec_env%task_list)
         END IF
         IF (ASSOCIATED(ec_env%task_list_soft)) THEN
            CALL deallocate_task_list(ec_env%task_list_soft)
         END IF
         ! reduced basis
         IF (ASSOCIATED(ec_env%mao_coef)) CALL dbcsr_deallocate_matrix_set(ec_env%mao_coef)
         ! dispersion environment
         IF (ASSOCIATED(ec_env%dispersion_env)) THEN
            CALL qs_dispersion_release(ec_env%dispersion_env)
         END IF
 
         CALL ec_env_matrix_release(ec_env)
 
         IF (ASSOCIATED(ec_env%p_env)) THEN
            CALL p_env_release(ec_env%p_env)
            DEALLOCATE (ec_env%p_env)
         END IF
         ! potential
         CALL ec_env_potential_release(ec_env)
         !
         CALL efield_berry_release(ec_env%efield)
 
         IF (ASSOCIATED(ec_env%ls_env)) THEN
            CALL ls_scf_release(ec_env%ls_env)
         END IF
 
         IF (.NOT. ec_env%reuse_hfx) THEN
            IF (ASSOCIATED(ec_env%x_data)) CALL hfx_release(ec_env%x_data)
         END IF
 
         IF (ASSOCIATED(ec_env%xc_section_aux)) CALL section_vals_release(ec_env%xc_section_aux)
         IF (ASSOCIATED(ec_env%xc_section_primary)) CALL section_vals_release(ec_env%xc_section_primary)
 
         CALL cp_fm_release(ec_env%mo_occ)
         CALL cp_fm_release(ec_env%cpmos)
         CALL cp_fm_release(ec_env%cpref)
 
         IF (ASSOCIATED(ec_env%rf)) THEN
            DEALLOCATE (ec_env%rf)
         END IF
 
         DEALLOCATE (ec_env)
 
      END IF
 
      NULLIFY (ec_env)
 
      CALL timestop(handle)
 
   END SUBROUTINE ec_env_release
 
! **************************************************************************************************
!> \brief ...
!> \param ec_env ...
! **************************************************************************************************
   SUBROUTINE ec_env_matrix_release(ec_env)
      TYPE(energy_correction_type), POINTER              :: ec_env
 
      IF (ASSOCIATED(ec_env)) THEN
         IF (ASSOCIATED(ec_env%matrix_hz)) CALL dbcsr_deallocate_matrix_set(ec_env%matrix_hz)
         NULLIFY (ec_env%matrix_hz)
         IF (ASSOCIATED(ec_env%matrix_wz)) CALL dbcsr_deallocate_matrix_set(ec_env%matrix_wz)
         NULLIFY (ec_env%matrix_wz)
         IF (ASSOCIATED(ec_env%matrix_z)) CALL dbcsr_deallocate_matrix_set(ec_env%matrix_z)
         NULLIFY (ec_env%matrix_z)
         IF (ASSOCIATED(ec_env%z_admm)) CALL dbcsr_deallocate_matrix_set(ec_env%z_admm)
         NULLIFY (ec_env%z_admm)
      END IF
 
   END SUBROUTINE ec_env_matrix_release
 
! **************************************************************************************************
!> \brief ...
!> \param ec_env ...
! **************************************************************************************************
   SUBROUTINE ec_env_potential_release(ec_env)
      TYPE(energy_correction_type), POINTER              :: ec_env
 
      INTEGER                                            :: iab
 
      IF (ASSOCIATED(ec_env)) THEN
         IF (ASSOCIATED(ec_env%vh_rspace%pw_grid)) THEN
            CALL ec_env%vh_rspace%release()
         END IF
         IF (ASSOCIATED(ec_env%vxc_rspace)) THEN
            DO iab = 1, SIZE(ec_env%vxc_rspace)
               CALL ec_env%vxc_rspace(iab)%release()
            END DO
            DEALLOCATE (ec_env%vxc_rspace)
            NULLIFY (ec_env%vxc_rspace)
         END IF
         IF (ASSOCIATED(ec_env%vtau_rspace)) THEN
            DO iab = 1, SIZE(ec_env%vtau_rspace)
               CALL ec_env%vtau_rspace(iab)%release()
            END DO
            DEALLOCATE (ec_env%vtau_rspace)
            NULLIFY (ec_env%vtau_rspace)
         END IF
         IF (ASSOCIATED(ec_env%vadmm_rspace)) THEN
            DO iab = 1, SIZE(ec_env%vadmm_rspace)
               CALL ec_env%vadmm_rspace(iab)%release()
            END DO
            DEALLOCATE (ec_env%vadmm_rspace)
            NULLIFY (ec_env%vadmm_rspace)
         END IF
         IF (ASSOCIATED(ec_env%local_rho_set)) THEN
            CALL local_rho_set_release(ec_env%local_rho_set)
            NULLIFY (ec_env%local_rho_set)
         END IF
         IF (ASSOCIATED(ec_env%local_rho_set_admm)) THEN
            CALL local_rho_set_release(ec_env%local_rho_set_admm)
            NULLIFY (ec_env%local_rho_set_admm)
         END IF
      END IF
 
   END SUBROUTINE ec_env_potential_release
 
END MODULE ec_env_types