eigen.F90 9.69 KB
Newer Older
1 2 3 4 5
!--------------------------------------------------------------------------------
! Copyright (c) 2016 Peter Grünberg Institut, Forschungszentrum Jülich, Germany
! This file is part of FLEUR and available as free software under the conditions
! of the MIT license as expressed in the LICENSE file in more detail.
!--------------------------------------------------------------------------------
Daniel Wortmann's avatar
Daniel Wortmann committed
6 7 8
!<@brief
!<The eigen routine sets up and solves the generalized eigenvalue problem
!More description at end of file
9
MODULE m_eigen
10
  USE m_juDFT
11
  IMPLICIT NONE
12
CONTAINS
Daniel Wortmann's avatar
Daniel Wortmann committed
13 14 15 16 17 18 19 20
  !>The eigenvalue problem is constructed and solved in this routine. The following steps are performed:
  !> 1. Preparation: generate energy parameters, open eig-file
  !> 2. CALL to mt_setup() : this constructs the local Hamiltonian (i.e. the Hamiltonian in the \f$ u,\dot u, u_{lo} \f$ basis) LDA+U is also added here
  !> 3. within the (collinear)spin and k-point loop: CALL to eigen_hssetup() to generate the matrices, CALL to eigen_diag() to perform diagonalization 
  !> 4. writing (saving) of eigenvectors
  !>
  !> The matrices generated and diagonalized here are of type m_mat as defined in m_types_mat. 
  !>@author D. Wortmann
21
  SUBROUTINE eigen(mpi,stars,sphhar,atoms,obsolete,xcpot,sym,kpts,DIMENSION,vacuum,input,&
22
                   cell,enpara,banddos,noco,oneD,hybrid,iter,eig_id,results,inden,v,vx)
23

Daniel Wortmann's avatar
Daniel Wortmann committed
24
    USE m_constants, ONLY : pi_const,sfp_const
25 26
    USE m_types
    USE m_apws
Daniel Wortmann's avatar
Daniel Wortmann committed
27 28
    USE m_eigen_hssetup
    USE m_pot_io
29
    USE m_eigen_diag
Daniel Wortmann's avatar
Daniel Wortmann committed
30
    USE m_add_vnonlocal
31
    USE m_subvxc
Daniel Wortmann's avatar
Daniel Wortmann committed
32
    !USE m_hsefunctional
Daniel Wortmann's avatar
Daniel Wortmann committed
33
    USE m_mt_setup
34
    USE m_util
Daniel Wortmann's avatar
Daniel Wortmann committed
35 36
    USE m_io_hybrid
    !USE m_icorrkeys
37
    USE m_eig66_io, ONLY : open_eig, write_eig, close_eig,read_eig
38
    USE m_xmlOutput
Daniel Wortmann's avatar
Daniel Wortmann committed
39
#ifdef CPP_MPI
40
    USE m_mpi_bc_potden
Daniel Wortmann's avatar
Daniel Wortmann committed
41
#endif
42
    USE m_symmetrize_matrix
43 44
    USE m_unfold_band_kpts !used for unfolding bands
    USE m_types_mpimat
45

46
    
47 48
    IMPLICIT NONE
    TYPE(t_results),INTENT(INOUT):: results
49
    CLASS(t_xcpot),INTENT(IN)    :: xcpot
50
    TYPE(t_mpi),INTENT(IN)       :: mpi
51
    TYPE(t_dimension),INTENT(IN) :: DIMENSION
52
    TYPE(t_oneD),INTENT(IN)      :: oneD
53
    TYPE(t_hybrid),INTENT(INOUT) :: hybrid
54
    TYPE(t_enpara),INTENT(INOUT) :: enpara
55 56 57 58
    TYPE(t_obsolete),INTENT(IN)  :: obsolete
    TYPE(t_input),INTENT(IN)     :: input
    TYPE(t_vacuum),INTENT(IN)    :: vacuum
    TYPE(t_noco),INTENT(IN)      :: noco
59
    TYPE(t_banddos),INTENT(IN)   :: banddos
Daniel Wortmann's avatar
Daniel Wortmann committed
60
    TYPE(t_sym),INTENT(IN)       :: sym  
61 62 63 64
    TYPE(t_stars),INTENT(IN)     :: stars
    TYPE(t_cell),INTENT(IN)      :: cell
    TYPE(t_kpts),INTENT(IN)      :: kpts
    TYPE(t_sphhar),INTENT(IN)    :: sphhar
65 66 67 68
    TYPE(t_atoms),INTENT(IN)     :: atoms
    TYPE(t_potden),INTENT(IN)    :: inden,vx
    TYPE(t_potden),INTENT(INOUT) :: v    !u_setup will modify the potential matrix
   
69 70 71
#ifdef CPP_MPI
    INCLUDE 'mpif.h'
#endif
72 73

    ! Scalar Arguments
74
    INTEGER,INTENT(IN)    :: iter
75
    INTEGER,INTENT(IN)    :: eig_id
76 77

    ! Local Scalars
78
    INTEGER jsp,nk,nred,ne_all,ne_found
79
    INTEGER ne,lh0
Daniel Wortmann's avatar
Daniel Wortmann committed
80
    INTEGER isp,i,j,err
Daniel Wortmann's avatar
Daniel Wortmann committed
81
    LOGICAL l_wu,l_file,l_real,l_zref
82 83 84 85 86

    ! Local Arrays
    INTEGER              :: ierr(3)
    INTEGER              :: neigBuffer(kpts%nkpt,input%jspins)
    INTEGER, PARAMETER   :: lmaxb = 3
87
    REAL,    ALLOCATABLE :: bkpt(:)
88
    REAL,    ALLOCATABLE :: eig(:)
Daniel Wortmann's avatar
Daniel Wortmann committed
89
    COMPLEX, ALLOCATABLE :: vs_mmp(:,:,:,:)
90 91 92 93 94 95

    TYPE(t_tlmplm)            :: td
    TYPE(t_usdus)             :: ud
    TYPE(t_lapw)              :: lapw
    CLASS(t_mat), ALLOCATABLE :: zMat
    CLASS(t_mat), ALLOCATABLE :: hmat,smat
96
    CLASS(t_mat), ALLOCATABLE :: smat_unfold !used for unfolding bandstructure
97 98

    ! Variables for HF or hybrid functional calculation
99 100
    INTEGER                   :: comm(kpts%nkpt),irank2(kpts%nkpt),isize2(kpts%nkpt), dealloc_stat
    character(len=300)        :: errmsg
Daniel Wortmann's avatar
Daniel Wortmann committed
101
    
Daniel Wortmann's avatar
Daniel Wortmann committed
102
    call ud%init(atoms,DIMENSION%jspd)
103
    ALLOCATE (eig(DIMENSION%neigd),bkpt(3))
Daniel Wortmann's avatar
Daniel Wortmann committed
104
    
Daniel Wortmann's avatar
Daniel Wortmann committed
105
    l_real=sym%invs.AND..NOT.noco%l_noco
106

107
    ! check if z-reflection trick can be used
Daniel Wortmann's avatar
Daniel Wortmann committed
108 109 110 111
    l_zref=(sym%zrfs.AND.(SUM(ABS(kpts%bk(3,:kpts%nkpt))).LT.1e-9).AND..NOT.noco%l_noco) 
    IF (mpi%n_size > 1) l_zref = .FALSE.
 
#ifdef CPP_MPI
112
    CALL mpi_bc_potden(mpi,stars,sphhar,atoms,input,vacuum,oneD,noco,v)
Daniel Wortmann's avatar
Daniel Wortmann committed
113
#endif
114

115
    !IF (mpi%irank.EQ.0) CALL openXMLElementFormPoly('iteration',(/'numberForCurrentRun','overallNumber      '/),(/iter,v%iter/),&
116
    !                                                RESHAPE((/19,13,5,5/),(/2,2/)))
Daniel Wortmann's avatar
Daniel Wortmann committed
117
    
118 119 120
    ! Set up and solve the eigenvalue problem
    !   loop over spins
    !     set up k-point independent t(l'm',lm) matrices
121
    CALL mt_setup(atoms,sym,sphhar,input,noco,enpara,inden,v,mpi,results,DIMENSION,td,ud)
Gregor Michalicek's avatar
Gregor Michalicek committed
122

123
    neigBuffer = 0
Gregor Michalicek's avatar
Gregor Michalicek committed
124
    results%neig = 0
125
    results%eig = 1.0e300
Gregor Michalicek's avatar
Gregor Michalicek committed
126

Daniel Wortmann's avatar
Daniel Wortmann committed
127
    DO jsp = 1,MERGE(1,input%jspins,noco%l_noco)
Daniel Wortmann's avatar
Daniel Wortmann committed
128
       k_loop:DO nk = mpi%n_start,kpts%nkpt,mpi%n_stride
129

130
          ! Set up lapw list        
Daniel Wortmann's avatar
Daniel Wortmann committed
131 132
          CALL lapw%init(input,noco, kpts,atoms,sym,nk,cell,l_zref, mpi)
          call timestart("Setup of H&S matrices")
133
          CALL eigen_hssetup(jsp,mpi,DIMENSION,hybrid,enpara,input,vacuum,noco,sym,&
134
                             stars,cell,sphhar,atoms,ud,td,v,lapw,l_real,smat,hmat)
Daniel Wortmann's avatar
Daniel Wortmann committed
135
          CALL timestop("Setup of H&S matrices")
136

137
          IF(hybrid%l_hybrid) THEN
138 139 140 141 142 143 144 145 146 147 148 149

      DO i = 1, hmat%matsize1
         DO j = 1, i
            IF (hmat%l_real) THEN
               IF ((i.LE.5).AND.(j.LE.5)) THEN
                  WRITE(1233,'(2i7,2f15.8)') i, j, hmat%data_r(i,j), hmat%data_r(j,i)
               END IF
            ELSE
            ENDIF
         END DO
      END DO

150
             ! Write overlap matrix smat to direct access file olap
Daniel Wortmann's avatar
Daniel Wortmann committed
151
             print *,"Wrong overlap matrix used, fix this later"
152
             CALL write_olap(smat,(jsp-1)*kpts%nkpt+nk) ! Note: At this moment this only works without MPI parallelization
153 154
             PRINT *,"TODO"
!             STOP "TODO"
155
             PRINT *,"BASIS:", lapw%nv(jsp), atoms%nlotot
156
             IF (hybrid%l_addhf) CALL add_Vnonlocal(nk,lapw,atoms,hybrid,dimension,kpts,jsp,results,xcpot,noco,hmat)
157 158

             IF(hybrid%l_subvxc) THEN
159 160
                CALL subvxc(lapw,kpts%bk(:,nk),DIMENSION,input,jsp,v%mt(:,0,:,:),atoms,ud,hybrid,enpara%el0,enpara%ello0,&
                            sym,cell,sphhar,stars,xcpot,mpi,oneD,hmat,vx)
161
             END IF
162
          END IF ! hybrid%l_hybrid
163

Daniel Wortmann's avatar
Daniel Wortmann committed
164 165
          l_wu=.FALSE.
          ne_all=DIMENSION%neigd
166 167 168 169 170 171
          if (allocated(zmat)) then
             deallocate(zmat, stat=dealloc_stat, errmsg=errmsg)
             if(dealloc_stat /= 0) call juDFT_error("deallocate failed for zmat",&
                                                hint=errmsg, calledby="eigen.F90")
          endif

172 173 174
          !Try to symmetrize matrix
          CALL symmetrize_matrix(mpi,noco,kpts,nk,hmat,smat)
          
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
          IF (banddos%unfoldband) THEN
		select type(smat)
		type is (t_mat)
			allocate(t_mat::smat_unfold)
			select type(smat_unfold)
		             type is (t_mat)
			     smat_unfold=smat
			end select
		type is (t_mpimat)
			allocate(t_mpimat::smat_unfold)
			select type(smat_unfold)
		             type is (t_mpimat)
			     smat_unfold=smat
			end select
		end select
          END IF

192
          CALL eigen_diag(mpi,hmat,smat,nk,jsp,iter,ne_all,eig,zMat)
193
          CALL smat%free()
194 195 196
          DEALLOCATE(hmat,smat, stat=dealloc_stat, errmsg=errmsg)
          if(dealloc_stat /= 0) call juDFT_error("deallocate failed for hmat or smat",&
                                             hint=errmsg, calledby="eigen.F90")
197 198

          ! Output results
199 200
          CALL timestart("EV output")
#if defined(CPP_MPI)
201
          ! Collect number of all eigenvalues
Daniel Wortmann's avatar
Daniel Wortmann committed
202
          ne_found=ne_all
Daniel Wortmann's avatar
Daniel Wortmann committed
203
          CALL MPI_ALLREDUCE(ne_found,ne_all,1,MPI_INTEGER,MPI_SUM, mpi%sub_comm,ierr)
204
          ne_all=MIN(DIMENSION%neigd,ne_all)
Daniel Wortmann's avatar
Daniel Wortmann committed
205 206 207
#else
          ne_found=ne_all
#endif          
Daniel Wortmann's avatar
Daniel Wortmann committed
208
          IF (.NOT.zmat%l_real) THEN
Gregor Michalicek's avatar
Gregor Michalicek committed
209
             zMat%data_c(:lapw%nmat,:ne_found) = CONJG(zMat%data_c(:lapw%nmat,:ne_found))
210
          END IF
Gregor Michalicek's avatar
Gregor Michalicek committed
211 212
          CALL write_eig(eig_id, nk,jsp,ne_found,ne_all,&
                         eig(:ne_found),n_start=mpi%n_size,n_end=mpi%n_rank,zmat=zMat)
213
          neigBuffer(nk,jsp) = ne_found
214
#if defined(CPP_MPI)
215
          ! RMA synchronization
216 217
          CALL MPI_BARRIER(mpi%MPI_COMM,ierr)
#endif
218
          CALL timestop("EV output")
219 220

          IF (banddos%unfoldband) THEN
221
               CALL calculate_plot_w_n(banddos,cell,kpts,smat_unfold,zMat,lapw,nk,jsp,eig,results,input,atoms)
222 223 224
	       DEALLOCATE(smat_unfold, stat=dealloc_stat, errmsg=errmsg)
          if(dealloc_stat /= 0) call juDFT_error("deallocate failed for smat_unfold",&
                                             hint=errmsg, calledby="eigen.F90")
225 226
          END IF

227 228 229 230
       END DO  k_loop
    END DO ! spin loop ends

#ifdef CPP_MPI
231
    CALL MPI_ALLREDUCE(neigBuffer,results%neig,kpts%nkpt*input%jspins,MPI_INTEGER,MPI_SUM,mpi%sub_comm,ierr)
232
    CALL MPI_BARRIER(mpi%MPI_COMM,ierr)
Gregor Michalicek's avatar
Gregor Michalicek committed
233
#else
234
    results%neig(:,:) = neigBuffer(:,:)
235
#endif
236 237 238 239 240 241 242 243 244

    ! Sorry for the following strange workaround to fill the results%eig array.
    ! At some point someone should have a closer look at how the eigenvalues are
    ! distributed and fill the array without using the eigenvalue-IO.
    DO jsp = 1,MERGE(1,input%jspins,noco%l_noco)
       DO nk = 1,kpts%nkpt
          CALL read_eig(eig_id,nk,jsp,results%neig(nk,jsp),results%eig(:,nk,jsp))
#ifdef CPP_MPI
          CALL MPI_BARRIER(mpi%MPI_COMM,ierr)
245
#endif
246 247 248
       END DO
    END DO

Daniel Wortmann's avatar
Daniel Wortmann committed
249
    !IF (hybrid%l_hybrid.OR.hybrid%l_calhf) CALL close_eig(eig_id)
250

251
    IF( input%jspins .EQ. 1 .AND. hybrid%l_hybrid ) THEN
252
       results%te_hfex%valence = 2*results%te_hfex%valence
253
       IF(hybrid%l_calhf) results%te_hfex%core = 2*results%te_hfex%core
254
    END IF
255 256
    enpara%epara_min = MINVAL(enpara%el0)
    enpara%epara_min = MIN(MINVAL(enpara%ello0),enpara%epara_min)
257 258
  END SUBROUTINE eigen
END MODULE m_eigen
Daniel Wortmann's avatar
Daniel Wortmann committed
259