eigen.F90 8.33 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.
!--------------------------------------------------------------------------------
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
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

24
    USE m_constants, ONLY : pi_const,sfp_const
25 26
    USE m_types
    USE m_apws
27 28
    USE m_eigen_hssetup
    USE m_pot_io
29
    USE m_eigen_diag
30
    USE m_add_vnonlocal
31
    USE m_subvxc
32
    !USE m_hsefunctional
33
    USE m_mt_setup
34
    USE m_util
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
39
#ifdef CPP_MPI
40
    USE m_mpi_bc_potden
41
#endif
42 43 44

    IMPLICIT NONE
    TYPE(t_results),INTENT(INOUT):: results
45
    CLASS(t_xcpot),INTENT(IN)    :: xcpot
46
    TYPE(t_mpi),INTENT(IN)       :: mpi
47
    TYPE(t_dimension),INTENT(IN) :: DIMENSION
48
    TYPE(t_oneD),INTENT(IN)      :: oneD
49
    TYPE(t_hybrid),INTENT(INOUT) :: hybrid
50
    TYPE(t_enpara),INTENT(INOUT) :: enpara
51 52 53 54
    TYPE(t_obsolete),INTENT(IN)  :: obsolete
    TYPE(t_input),INTENT(IN)     :: input
    TYPE(t_vacuum),INTENT(IN)    :: vacuum
    TYPE(t_noco),INTENT(IN)      :: noco
55
    TYPE(t_banddos),INTENT(IN)   :: banddos
Daniel Wortmann's avatar
Daniel Wortmann committed
56
    TYPE(t_sym),INTENT(IN)       :: sym  
57 58 59 60
    TYPE(t_stars),INTENT(IN)     :: stars
    TYPE(t_cell),INTENT(IN)      :: cell
    TYPE(t_kpts),INTENT(IN)      :: kpts
    TYPE(t_sphhar),INTENT(IN)    :: sphhar
61 62 63 64
    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
   
65 66 67 68 69
#ifdef CPP_MPI
    INCLUDE 'mpif.h'
#endif
    !     ..
    !     .. Scalar Arguments ..
70
    INTEGER,INTENT(IN)    :: iter
71
    INTEGER,INTENT(INOUT) :: eig_id
72 73 74 75 76
    !     ..
    !-odim
    !+odim
    !     ..
    !     .. Local Scalars ..
77
    INTEGER jsp,nk,nred,ne_all,ne_found
78
    INTEGER ne,lh0
79
    INTEGER isp,i,j,err
Daniel Wortmann's avatar
Daniel Wortmann committed
80
    LOGICAL l_wu,l_file,l_real,l_zref
81
    
82 83
    !     ..
    !     .. Local Arrays ..
84
    INTEGER, PARAMETER :: lmaxb=3
85
    REAL,    ALLOCATABLE :: bkpt(:)
86
    REAL,    ALLOCATABLE :: eig(:)
87

88
    COMPLEX, ALLOCATABLE :: vs_mmp(:,:,:,:)
89 90 91
    TYPE(t_tlmplm)  :: td
    TYPE(t_usdus)   :: ud
    TYPE(t_lapw)    :: lapw
92 93
    CLASS(t_Mat),ALLOCATABLE    :: zMat
    CLASS(t_mat),ALLOCATABLE    :: hmat,smat
Daniel Wortmann's avatar
Daniel Wortmann committed
94
    TYPE(T_mat)     :: olap
95
    !
96
    INTEGER nn,n
97
    INTEGER ierr(3)
98
    INTEGER :: neigBuffer(kpts%nkpt,input%jspins)
Daniel Wortmann's avatar
Daniel Wortmann committed
99

100
    !     .. variables for HF or hybrid functional calculation ..
101
    INTEGER                 ::  comm(kpts%nkpt),irank2(kpts%nkpt),isize2(kpts%nkpt)
102
    
Daniel Wortmann's avatar
Daniel Wortmann committed
103
    call ud%init(atoms,DIMENSION%jspd)
104
    ALLOCATE (eig(DIMENSION%neigd),bkpt(3))
Daniel Wortmann's avatar
Daniel Wortmann committed
105
    
106 107
    l_real=sym%invs.AND..NOT.noco%l_noco
    !check if z-reflection trick can be used
108

109 110 111 112
    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
113
    CALL mpi_bc_potden(mpi,stars,sphhar,atoms,input,vacuum,oneD,noco,v)
114
#endif
115
    !IF (mpi%irank.EQ.0) CALL openXMLElementFormPoly('iteration',(/'numberForCurrentRun','overallNumber      '/),(/iter,v%iter/),&
116
    !                                                RESHAPE((/19,13,5,5/),(/2,2/)))
117 118
    
     eig_id=open_eig(&
119
          mpi%mpi_comm,DIMENSION%nbasfcn,DIMENSION%neigd,kpts%nkpt,DIMENSION%jspd,atoms%lmaxd,&
120 121 122
         atoms%nlod,atoms%ntype,atoms%nlotot,noco%l_noco,.TRUE.,l_real,noco%l_soc,.FALSE.,&
         mpi%n_size,layers=vacuum%layers,nstars=vacuum%nstars,ncored=DIMENSION%nstd,&
         nsld=atoms%nat,nat=atoms%nat,l_dos=banddos%dos.OR.input%cdinf,l_mcd=banddos%l_mcd,&
123
         l_orb=banddos%l_orb)
124

125 126 127
     !---> set up and solve the eigenvalue problem
     !--->    loop over spins
     !--->       set up k-point independent t(l'm',lm) matrices
128
     CALL mt_setup(atoms,sym,sphhar,input,noco,enpara,inden,v,mpi,results,DIMENSION,td,ud)
129

130
    neigBuffer = 0
131
    results%neig = 0
132
    results%eig = 1.0e300
133

134
    DO jsp = 1,MERGE(1,input%jspins,noco%l_noco)
Daniel Wortmann's avatar
Daniel Wortmann committed
135
       k_loop:DO nk = mpi%n_start,kpts%nkpt,mpi%n_stride
136 137 138

          !
          !--->         set up lapw list
139 140 141
        
          CALL lapw%init(input,noco, kpts,atoms,sym,nk,cell,l_zref, mpi)
          call timestart("Setup of H&S matrices")
142
          CALL eigen_hssetup(jsp,mpi,DIMENSION,hybrid,enpara,input,vacuum,noco,sym,&
143 144 145
               stars,cell,sphhar,atoms,ud,td,v,lapw,l_real,smat,hmat)
          CALL timestop("Setup of H&S matrices")
        
146
          IF( hybrid%l_hybrid ) THEN
Daniel Wortmann's avatar
Daniel Wortmann committed
147 148
             !write overlap matrix b to direct access file olap
             print *,"Wrong overlap matrix used, fix this later"
149 150
             !call write_olap(smat,nrec)
             STOP "TODO"
151
             PRINT *,"BASIS:",lapw%nv(jsp),atoms%nlotot
152
             !if (hybrid%l_addhf) CALL add_Vnonlocal(nk,hybrid,dimension, kpts,jsp,results,xcpot,hamovlp)
153 154
             
             
155
             IF( hybrid%l_subvxc ) THEN
156 157 158
                !CALL subvxc(lapw,kpts%bk(:,nk),DIMENSION,input,jsp,v%mt(:,0,:,:),atoms,ud,hybrid,enpara%el0,enpara%ello0,&
                 !    sym, atoms%nlotot,kveclo, cell,sphhar, stars, xcpot,mpi,&
                 !    oneD,  hamovlp,vx)
159 160
             END IF

161
          END IF ! hybrid%l_hybrid
162 163 164
          l_wu=.FALSE.
          ne_all=DIMENSION%neigd
          if (allocated(zmat)) deallocate(zmat)
165
          CALL eigen_diag(mpi,hmat,smat,nk,jsp,iter,ne_all,eig,zMat)
166
          DEALLOCATE(hmat,smat)
167 168 169 170 171 172
          !
          !--->         output results
          !
          CALL timestart("EV output")
#if defined(CPP_MPI)
          !Collect number of all eigenvalues
173
          ne_found=ne_all
Daniel Wortmann's avatar
Daniel Wortmann committed
174
          CALL MPI_ALLREDUCE(ne_found,ne_all,1,MPI_INTEGER,MPI_SUM, mpi%sub_comm,ierr)
175
          ne_all=MIN(DIMENSION%neigd,ne_all)
176 177 178
#else
          ne_found=ne_all
#endif          
179
          IF (.NOT.l_real) THEN
180
             zMat%data_c(:lapw%nmat,:ne_found) = CONJG(zMat%data_c(:lapw%nmat,:ne_found))
181
          ENDIF
182 183
          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)
184
          neigBuffer(nk,jsp) = ne_found
185 186 187 188
#if defined(CPP_MPI)
          !RMA synchronization
          CALL MPI_BARRIER(mpi%MPI_COMM,ierr)
#endif
189 190 191 192 193
          CALL timestop("EV output")
       END DO  k_loop
    END DO ! spin loop ends

#ifdef CPP_MPI
194
    CALL MPI_ALLREDUCE(neigBuffer,results%neig,kpts%nkpt*input%jspins,MPI_INTEGER,MPI_SUM,mpi%sub_comm,ierr)
195
    CALL MPI_BARRIER(mpi%MPI_COMM,ierr)
196
#else
197
    results%neig(:,:) = neigBuffer(:,:)
198
#endif
199 200 201 202 203 204 205 206 207

    ! 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)
208
#endif
209 210 211
       END DO
    END DO

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

214
    IF( input%jspins .EQ. 1 .AND. hybrid%l_hybrid ) THEN
215 216 217
       results%te_hfex%valence = 2*results%te_hfex%valence
       results%te_hfex%core    = 2*results%te_hfex%core
    END IF
218 219
    enpara%epara_min = MINVAL(enpara%el0)
    enpara%epara_min = MIN(MINVAL(enpara%ello0),enpara%epara_min)
220 221
  END SUBROUTINE eigen
END MODULE m_eigen
222