quantum-espresso/PW/ewald.f90

169 lines
5.0 KiB
Fortran

!
! Copyright (C) 2001 PWSCF group
! This file is distributed under the terms of the
! GNU General Public License. See the file `License'
! in the root directory of the present distribution,
! or http://www.gnu.org/copyleft/gpl.txt .
!
!
!-----------------------------------------------------------------------
function ewald (alat, nat, ntyp, ityp, zv, at, bg, tau, omega, g, &
gg, ngm, gcutm, gstart, gamma_only, strf)
!-----------------------------------------------------------------------
!
! Calculates Ewald energy with both G- and R-space terms.
! Determines optimal alpha. Should hopefully work for any structure.
!
!
USE kinds
USE constants, ONLY : tpi, e2
USE mp_global, ONLY : intra_pool_comm
USE mp, ONLY : mp_sum
implicit none
!
! first the dummy variables
!
integer :: nat, ntyp, ityp (nat), ngm, gstart
! input: number of atoms in the unit cell
! input: number of different types of atoms
! input: the type of each atom
! input: number of plane waves for G sum
! input: first non-zero G vector
logical :: gamma_only
real(DP) :: tau (3, nat), g (3, ngm), gg (ngm), zv (ntyp), &
at (3, 3), bg (3, 3), omega, alat, gcutm
! input: the positions of the atoms in the cell
! input: the coordinates of G vectors
! input: the square moduli of G vectors
! input: the charge of each type of atoms
! input: the direct lattice vectors
! input: the reciprocal lattice vectors
! input: the volume of the unit cell
! input: lattice parameter
! input: cut-off of g vectors
complex(DP) :: strf (ngm, ntyp)
! input: structure factor
real(DP) :: ewald
! output: the ewald energy
!
! here the local variables
!
integer, parameter :: mxr = 50
! the maximum number of R vectors included in r
integer :: ng, nr, na, nb, nt, nrm, ipol
! counter over reciprocal G vectors
! counter over direct vectors
! counter on atoms
! counter on atoms
! counter on atomic types
! number of R vectors included in r sum
! counter on polarization
real(DP) :: charge, tpiba2, ewaldg, ewaldr, dtau (3), alpha, &
r (3, mxr), r2 (mxr), rmax, rr, upperbound, fact
! total ionic charge in the cell
! length in reciprocal space
! ewald energy computed in reciprocal space
! ewald energy computed in real space
! the difference tau_s - tau_s'
! alpha term in ewald sum
! input of the rgen routine ( not used here )
! the square modulus of R_j-tau_s-tau_s'
! the maximum radius to consider real space sum
! buffer variable
! used to optimize alpha
complex(DP) :: rhon
real(DP), external :: erfc
tpiba2 = (tpi / alat) **2
charge = 0.d0
do na = 1, nat
charge = charge+zv (ityp (na) )
enddo
alpha = 2.9d0
100 alpha = alpha - 0.1d0
!
! choose alpha in order to have convergence in the sum over G
! upperbound is a safe upper bound for the error in the sum over G
!
if (alpha.le.0.d0) call errore ('ewald', 'optimal alpha not found', 1)
upperbound = 2.d0 * charge**2 * sqrt (2.d0 * alpha / tpi) * erfc ( &
sqrt (tpiba2 * gcutm / 4.d0 / alpha) )
if (upperbound.gt.1.0d-7) goto 100
!
! G-space sum here.
! Determine if this processor contains G=0 and set the constant term
!
if (gstart==2) then
ewaldg = - charge**2 / alpha / 4.0d0
else
ewaldg = 0.0d0
endif
if (gamma_only) then
fact = 2.d0
else
fact = 1.d0
end if
do ng = gstart, ngm
rhon = (0.d0, 0.d0)
do nt = 1, ntyp
rhon = rhon + zv (nt) * CONJG(strf (ng, nt) )
enddo
ewaldg = ewaldg + fact * abs (rhon) **2 * exp ( - gg (ng) * tpiba2 / &
alpha / 4.d0) / gg (ng) / tpiba2
enddo
ewaldg = 2.d0 * tpi / omega * ewaldg
!
! Here add the other constant term
!
if (gstart.eq.2) then
do na = 1, nat
ewaldg = ewaldg - zv (ityp (na) ) **2 * sqrt (8.d0 / tpi * &
alpha)
enddo
endif
!
! R-space sum here (only for the processor that contains G=0)
!
ewaldr = 0.d0
if (gstart.eq.2) then
rmax = 4.d0 / sqrt (alpha) / alat
!
! with this choice terms up to ZiZj*erfc(4) are counted (erfc(4)=2x10^-8
!
do na = 1, nat
do nb = 1, nat
dtau (:) = tau (:, na) - tau (:, nb)
!
! generates nearest-neighbors shells
!
call rgen (dtau, rmax, mxr, at, bg, r, r2, nrm)
!
! and sum to the real space part
!
do nr = 1, nrm
rr = sqrt (r2 (nr) ) * alat
ewaldr = ewaldr + zv (ityp (na) ) * zv (ityp (nb) ) * erfc ( &
sqrt (alpha) * rr) / rr
enddo
enddo
enddo
endif
ewald = 0.5d0 * e2 * (ewaldg + ewaldr)
#ifdef __PARA
call mp_sum( ewald, intra_pool_comm )
#endif
! call mp_sum( ewaldr, intra_pool_comm )
! call mp_sum( ewaldg, intra_pool_comm )
! WRITE( stdout,'(/5x,"alpha used in ewald term: ",f4.2/
! + 5x,"R-space term: ",f12.7,5x,"G-space term: ",f12.7/)')
! + alpha, ewaldr, ewaldg
return
end function ewald