quantum-espresso/Modules/constraints_module.f90

1457 lines
47 KiB
Fortran

!
! Copyright (C) 2002-2005 Quantum ESPRESSO 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 .
!
#define __REMOVE_CONSTRAINT_FORCE
!#define __DEBUG_CONSTRAINTS
#define __USE_PBC
!
!----------------------------------------------------------------------------
MODULE constraints_module
!----------------------------------------------------------------------------
!! Variables and methods for constraint Molecular Dynamics and
!! constrained ionic relaxations (the SHAKE algorithm based on
!! lagrange multipliers) are defined here.
!
!! Most of these variables and methods are also used for meta-dynamics
!! and free-energy smd: indeed the collective variables are implemented
!! as constraints.
!
!! Written by Carlo Sbraccia ( 24/02/2004 ).
!! References:
!
!! 1) M. P. Allen and D. J. Tildesley, Computer Simulations of Liquids,
!! Clarendon Press - Oxford (1986)
!
USE kinds, ONLY : DP
USE constants, ONLY : eps32, tpi, fpi
USE io_global, ONLY : stdout
!
USE basic_algebra_routines
!
IMPLICIT NONE
!
SAVE
!
PRIVATE
!
! ... public methods
!
PUBLIC :: init_constraint, &
check_constraint, &
remove_constr_force, &
remove_constr_vec, &
deallocate_constraint, &
compute_dmax, &
pbc, &
constraint_grad, &
check_wall_constraint
!
!
! ... public variables (assigned in the CONSTRAINTS input card)
!
PUBLIC :: nconstr, &
nconstr_ndof, &
constr_tol, &
constr_type, &
constr, &
lagrange, &
constr_target, &
dmax, &
gp
!
! ... global variables
!
INTEGER :: nconstr=0, nconstr_ndof
REAL(DP) :: constr_tol
INTEGER, ALLOCATABLE :: constr_type(:)
REAL(DP), ALLOCATABLE :: constr(:,:)
REAL(DP), ALLOCATABLE :: constr_target(:)
REAL(DP), ALLOCATABLE :: lagrange(:)
REAL(DP), ALLOCATABLE :: gp(:)
REAL(DP) :: dmax
!
! ... If any of the constraints that require gradient calculation is
! ... requested, has_constr_grad_types is set to .true. in init_constraint
! ... If potential wall is requested, has_constr_wall is set to .true.
!
LOGICAL :: has_constr_grad_types, has_constr_wall
!
! ... constants that define constraints types
!
INTEGER, PARAMETER :: constr_type_coord = 1, constr_atom_coord = 2, &
constr_distance = 3, constr_planar_angle = 4, &
constr_torsional_angle = 5, constr_struct_fac = 6, &
constr_sph_struct_fac = 7, constr_bennett_proj = 8, constr_wall = 9
INTEGER, PARAMETER, DIMENSION(8) :: constr_grad_types = (/ &
constr_type_coord, constr_atom_coord, constr_distance, &
constr_planar_angle, constr_torsional_angle, constr_struct_fac, &
constr_sph_struct_fac, constr_bennett_proj/)
!
CONTAINS
!
! ... public methods
!
!-----------------------------------------------------------------------
SUBROUTINE init_constraint( nat, tau, ityp, tau_units )
!-----------------------------------------------------------------------
!
!! This routine is used to initialize constraints variables and
!! collective variables (notice that collective variables are
!! implemented as normal constraints but are read using specific
!! input variables).
!
USE input_parameters, ONLY : nconstr_inp, constr_tol_inp, &
constr_type_inp, constr_inp, &
constr_target_inp, &
constr_target_set, nc_fields
!
IMPLICIT NONE
!
INTEGER, INTENT(in) :: nat
REAL(DP), INTENT(in) :: tau(3,nat)
INTEGER, INTENT(in) :: ityp(nat)
REAL(DP), INTENT(in) :: tau_units
!
INTEGER :: i, j
INTEGER :: ia, ia0, ia1, ia2, ia3, n_type_coord1
REAL(DP) :: d0(3), d1(3), d2(3)
REAL(DP) :: smoothing, r_c
INTEGER :: type_coord1, type_coord2
REAL(DP) :: dtau(3), norm_dtau
REAL(DP) :: k(3), phase, norm_k
COMPLEX(DP) :: struc_fac
CHARACTER(20),ALLOCATABLE :: tmp_type_inp(:)
LOGICAL,ALLOCATABLE :: tmp_target_set(:)
REAL(DP),ALLOCATABLE :: tmp_target_inp(:)
!
CHARACTER(len=6), EXTERNAL :: int_to_char
!
!
nconstr = nconstr_inp
constr_tol = constr_tol_inp
WRITE(stdout,'(5x,a,i4,a,f12.6)') &
'Setting up ',nconstr,' constraints; tolerance:', constr_tol
!
ALLOCATE( lagrange( nconstr ) )
ALLOCATE( constr_target( nconstr ) )
ALLOCATE( constr_type( nconstr ) )
!
ALLOCATE( constr( nc_fields, nconstr ) )
ALLOCATE( gp( nconstr ) )
ALLOCATE( tmp_type_inp(nconstr),tmp_target_set(nconstr),tmp_target_inp(nconstr) )
!
! ... setting constr to 0 to findout which elements have been
! ... set to an atomic index. This is required for CP.
!
constr(:,:) = 0.0_DP
!
constr(:,1:nconstr) = constr_inp(:,1:nconstr_inp)
tmp_type_inp(1:nconstr) = constr_type_inp(1:nconstr_inp)
tmp_target_set(1:nconstr) = constr_target_set(1:nconstr_inp)
tmp_target_inp(1:nconstr) = constr_target_inp(1:nconstr_inp)
!
! ... set the largest possible distance among two atoms within
! ... the supercell
!
IF ( any( tmp_type_inp(:) == 'distance' ) ) CALL compute_dmax()
!
! ... initializations of constr_target values for the constraints :
!
DO ia = 1, nconstr
!
SELECT CASE ( tmp_type_inp(ia) )
CASE( 'type_coord' )
!
! ... constraint on global coordination-number, i.e. the average
! ... number of atoms of type B surrounding the atoms of type A
!
constr_type(ia) = constr_type_coord
IF ( tmp_target_set(ia) ) THEN
constr_target(ia) = tmp_target_inp(ia)
ELSE
CALL set_type_coord( ia )
ENDIF
!
WRITE(stdout,'(7x,i3,a,i3,a,i2,a,2f12.6,a,f12.6)') &
ia,') type #',int(constr_inp(1,ia)) ,' coordination wrt type:', int(constr(2,ia)), &
' cutoff distance and smoothing:', constr(3:4,ia), &
'; target:', constr_target(ia)
!
CASE( 'atom_coord' )
!
! ... constraint on local coordination-number, i.e. the average
! ... number of atoms of type A surrounding a specific atom
!
constr_type(ia) = constr_atom_coord
IF ( tmp_target_set(ia) ) THEN
constr_target(ia) = tmp_target_inp(ia)
ELSE
CALL set_atom_coord( ia )
ENDIF
!
WRITE(stdout,'(7x,i3,a,i3,a,i2,a,2f12.6,a,f12.6)') &
ia,') atom #',int(constr_inp(1,ia)) ,' coordination wrt type:', int(constr(2,ia)), &
' cutoff distance and smoothing:', constr(3:4,ia), &
'; target:', constr_target(ia)
!
CASE( 'distance' )
!
constr_type(ia) = constr_distance
IF ( tmp_target_set(ia) ) THEN
constr_target(ia) = tmp_target_inp(ia)
ELSE
CALL set_distance( ia )
ENDIF
!
IF ( constr_target(ia) > dmax ) THEN
!
WRITE( stdout, '(/,5X,"target = ",F12.8,/, &
& 5X,"dmax = ",F12.8)' ) &
constr_target(ia), dmax
CALL errore( 'init_constraint', 'the target for constraint ' //&
& trim( int_to_char( ia ) ) // ' is larger than ' //&
& 'the largest possible value', 1 )
!
ENDIF
!
WRITE(stdout,'(7x,i3,a,2i3,a,f12.6)') &
ia,') distance between atoms: ', int(constr(1:2,ia)), '; target:', constr_target(ia)
!
CASE( 'planar_angle' )
!
! ... constraint on planar angle (for the notation used here see
! ... Appendix C of the Allen-Tildesley book)
!
constr_type(ia) = constr_planar_angle
IF ( tmp_target_set(ia) ) THEN
!
! ... the input value of target for the torsional angle (given
! ... in degrees) is converted to the cosine of the angle
!
constr_target(ia) = tmp_target_inp(ia)
ELSE
CALL set_planar_angle( ia )
ENDIF
!
WRITE(stdout, '(7x,i3,a,3i3,a,f12.6)') &
ia,') planar angle between atoms: ', int(constr(1:3,ia)), '; target:', constr_target(ia)
!
CASE( 'torsional_angle' )
!
! ... constraint on torsional angle (for the notation used here
! ... see Appendix C of the Allen-Tildesley book)
!
constr_type(ia) = constr_torsional_angle
IF ( tmp_target_set(ia) ) THEN
!
! ... the input value of target for the torsional angle (given
! ... in degrees) is converted to the cosine of the angle
!
constr_target(ia) = tmp_target_inp(ia)
ELSE
CALL set_torsional_angle( ia )
ENDIF
!
WRITE(stdout, '(7x,i3,a,4i3,a,f12.6)') &
ia,') torsional angle between atoms: ', int(constr(1:4,ia)), '; target:', constr_target(ia)
!
CASE( 'struct_fac' )
!
! ... constraint on structure factor at a given k-vector
!
constr_type(ia) = constr_struct_fac
IF ( tmp_target_set(ia) ) THEN
constr_target(ia) = tmp_target_inp(ia)
ELSE
CALL set_structure_factor( ia )
ENDIF
!
CASE( 'sph_struct_fac' )
!
! ... constraint on spherical average of the structure factor for
! ... a given k-vector of norm k
!
constr_type(ia) = constr_sph_struct_fac
IF ( tmp_target_set(ia) ) THEN
constr_target(ia) = tmp_target_inp(ia)
ELSE
CALL set_sph_structure_factor( ia )
ENDIF
!
CASE( 'bennett_proj' )
!
! ... constraint on the projection onto a given direction of the
! ... vector defined by the position of one atom minus the center
! ... of mass of the others
! ... ( Ch.H. Bennett in Diffusion in Solids, Recent Developments,
! ... Ed. by A.S. Nowick and J.J. Burton, New York 1975 )
!
constr_type(ia) = constr_bennett_proj
IF ( tmp_target_set(ia) ) THEN
constr_target(ia) = tmp_target_inp(ia)
ELSE
CALL set_bennett_proj( ia )
ENDIF
!
CASE ( 'potential_wall' )
!
constr_type(ia) = constr_wall
!
CASE DEFAULT
!
CALL errore( 'init_constraint', &
'collective-variable or constrait type not implemented', 1 )
!
END SELECT
!
ENDDO
!
DEALLOCATE( tmp_type_inp,tmp_target_set,tmp_target_inp )
!
has_constr_grad_types = .FALSE.
has_constr_wall = .FALSE.
nconstr_ndof = 0
DO ia = 1, nconstr
IF( ANY( constr_grad_types .EQ. constr_type(ia) ) ) THEN
has_constr_grad_types = .TRUE.
!
! Only used in dynamics_module :: get_ndof
! It differs from the nconstr, by the potential_wall constraint
nconstr_ndof = nconstr_ndof + 1
ELSE IF (constr_type(ia) .EQ. constr_wall) THEN
!
IF (has_constr_wall) &
CALL errore( 'init_constraint', &
'only only potential_wall constraint can be set', 1 )
!
has_constr_wall = .TRUE.
END IF
END DO
!
RETURN
!
CONTAINS
!
!-------------------------------------------------------------------
SUBROUTINE set_type_coord( ia )
!-------------------------------------------------------------------
!
INTEGER, INTENT(in) :: ia
!
type_coord1 = anint( constr(1,ia) )
type_coord2 = anint( constr(2,ia) )
!
r_c = constr(3,ia)
!
smoothing = 1.0_DP / constr(4,ia)
!
constr_target(ia) = 0.0_DP
!
n_type_coord1 = 0
!
DO ia1 = 1, nat
!
IF ( ityp(ia1) /= type_coord1 ) CYCLE
!
DO ia2 = 1, nat
!
IF ( ia2 == ia1 ) CYCLE
!
IF ( ityp(ia2) /= type_coord2 ) CYCLE
!
dtau(:) = pbc( ( tau(:,ia1) - tau(:,ia2) )*tau_units )
!
norm_dtau = norm( dtau(:) )
!
constr_target(ia) = constr_target(ia) + 1.0_DP / &
( exp( smoothing*( norm_dtau - r_c ) ) + 1.0_DP )
!
ENDDO
!
n_type_coord1 = n_type_coord1 + 1
!
ENDDO
!
constr_target(ia) = constr_target(ia) / dble( n_type_coord1 )
!
END SUBROUTINE set_type_coord
!
!-------------------------------------------------------------------
SUBROUTINE set_atom_coord( ia )
!-------------------------------------------------------------------
!
INTEGER, INTENT(in) :: ia
!
ia1 = anint( constr(1,ia) )
type_coord1 = anint( constr(2,ia) )
!
r_c = constr(3,ia)
!
smoothing = 1.0_DP / constr(4,ia)
!
constr_target(ia) = 0.0_DP
!
DO ia2 = 1, nat
!
IF ( ia2 == ia1 ) CYCLE
!
IF ( ityp(ia2) /= type_coord1 ) CYCLE
!
dtau(:) = pbc( ( tau(:,ia1) - tau(:,ia2) )*tau_units )
!
norm_dtau = norm( dtau(:) )
!
constr_target(ia) = constr_target(ia) + 1.0_DP / &
( exp( smoothing*( norm_dtau - r_c ) ) + 1.0_DP )
!
ENDDO
!
END SUBROUTINE set_atom_coord
!
!-------------------------------------------------------------------
SUBROUTINE set_distance( ia )
!-------------------------------------------------------------------
!
INTEGER, INTENT(in) :: ia
!
ia1 = anint( constr(1,ia) )
ia2 = anint( constr(2,ia) )
!
dtau(:) = pbc( ( tau(:,ia1) - tau(:,ia2) )*tau_units )
!
constr_target(ia) = norm( dtau(:) )
!
END SUBROUTINE set_distance
!
!-------------------------------------------------------------------
SUBROUTINE set_planar_angle( ia )
!-------------------------------------------------------------------
!
INTEGER, INTENT(in) :: ia
!
ia0 = anint( constr(1,ia) )
ia1 = anint( constr(2,ia) )
ia2 = anint( constr(3,ia) )
!
d0(:) = pbc( ( tau(:,ia0) - tau(:,ia1) )*tau_units )
d1(:) = pbc( ( tau(:,ia1) - tau(:,ia2) )*tau_units )
!
d0(:) = d0(:) / norm( d0(:) )
d1(:) = d1(:) / norm( d1(:) )
!
constr_target(ia) = acos(- d0(:) .dot. d1(:))*360.0_DP/tpi
!
END SUBROUTINE set_planar_angle
!
!-------------------------------------------------------------------
SUBROUTINE set_torsional_angle( ia )
!-------------------------------------------------------------------
!
INTEGER, INTENT(in) :: ia
REAL(DP) :: x01(3),x12(3),phi
!
ia0 = anint( constr(1,ia) )
ia1 = anint( constr(2,ia) )
ia2 = anint( constr(3,ia) )
ia3 = anint( constr(4,ia) )
!
d0(:) = pbc( ( tau(:,ia0) - tau(:,ia1) )*tau_units )
d1(:) = pbc( ( tau(:,ia1) - tau(:,ia2) )*tau_units )
d2(:) = pbc( ( tau(:,ia2) - tau(:,ia3) )*tau_units )
!
x01(:) = cross(d0,d1)
x12(:) = cross(d1,d2)
!
IF((x01.dot.x01)<eps32 .or. (x12.dot.x12)<eps32)THEN
write(stdout,*)'torsional angle constraint #',ia,' contains collinear atoms'
CALL errore('set_torsional_angle','collinear atoms in torsional angle constraint', 1)
ENDIF
!
phi = atan2(sqrt(d1.dot.d1)*d0.dot.x12 , x01.dot.x12)
!
constr_target(ia) = phi*360.0_DP/tpi
!
END SUBROUTINE set_torsional_angle
!
!-------------------------------------------------------------------
SUBROUTINE set_structure_factor( ia )
!-------------------------------------------------------------------
!
INTEGER, INTENT(in) :: ia
!
k(1) = constr(1,ia) * tpi / tau_units
k(2) = constr(2,ia) * tpi / tau_units
k(3) = constr(3,ia) * tpi / tau_units
!
struc_fac = ( 0.0_DP, 0.0_DP )
!
DO i = 1, nat
!
dtau(:) = pbc( ( tau(:,i) - tau(:,1) )*tau_units )
!
phase = k(:) .dot. dtau(:)
!
struc_fac = struc_fac + cmplx( cos(phase), sin(phase), kind=DP )
!
ENDDO
!
constr_target(ia) = conjg( struc_fac )*struc_fac / dble( nat*nat )
!
END SUBROUTINE set_structure_factor
!
!-------------------------------------------------------------------
SUBROUTINE set_sph_structure_factor( ia )
!-------------------------------------------------------------------
!
INTEGER, INTENT(in) :: ia
!
norm_k = constr(1,ia)*tpi/tau_units
!
constr_target(ia) = 0.0_DP
!
DO i = 1, nat - 1
!
DO j = i + 1, nat
!
dtau(:) = pbc( ( tau(:,i) - tau(:,j) )*tau_units )
!
norm_dtau = norm( dtau(:) )
!
phase = norm_k*norm_dtau
!
IF ( phase < eps32 ) THEN
!
constr_target(ia) = constr_target(ia) + 1.0_DP
!
ELSE
!
constr_target(ia) = constr_target(ia) + sin( phase ) / phase
!
ENDIF
!
ENDDO
!
ENDDO
!
constr_target(ia) = 2.0_DP * fpi * constr_target(ia) / dble( nat )
!
END SUBROUTINE set_sph_structure_factor
!
!-------------------------------------------------------------------
SUBROUTINE set_bennett_proj( ia )
!-------------------------------------------------------------------
!
INTEGER, INTENT(in) :: ia
!
ia0 = anint( constr(1,ia) )
!
d0(:) = tau(:,ia0)
d1(:) = sum( tau(:,:), dim = 2 )
!
d1(:) = pbc( ( d1(:) - d0(:) )*tau_units ) / dble( nat - 1 ) - &
pbc( d0(:)*tau_units )
!
d2(:) = constr(2:4,ia)
!
constr_target(ia) = ( d1(:) .dot. d2(:) ) / tau_units
!
END SUBROUTINE set_bennett_proj
!
END SUBROUTINE init_constraint
!
!-----------------------------------------------------------------------
SUBROUTINE constraint_grad( idx, nat, tau, &
if_pos, ityp, tau_units, g, dg )
!-----------------------------------------------------------------------
!
!! This routine computes the value of the constraint equation and
!! the corresponding constraint gradient.
!
IMPLICIT NONE
!
INTEGER, INTENT(in) :: idx
INTEGER, INTENT(in) :: nat
REAL(DP), INTENT(in) :: tau(:,:)
INTEGER, INTENT(in) :: if_pos(:,:)
INTEGER, INTENT(in) :: ityp(:)
REAL(DP), INTENT(in) :: tau_units
REAL(DP), INTENT(out) :: dg(:,:)
REAL(DP), INTENT(out) :: g
!
INTEGER :: i, j
INTEGER :: ia, ia0, ia1, ia2, ia3, n_type_coord1
REAL(DP) :: d0(3), d1(3), d2(3), n1, x01(3), x12(3), x20(3), phi, X
REAL(DP) :: s012,x01x12,d0phi(3),d1phi(3),d2phi(3)
REAL(DP) :: inv_den
REAL(DP) :: C00, C01, C11
REAL(DP) :: smoothing, r_c
INTEGER :: type_coord1, type_coord2
REAL(DP) :: dtau(3), norm_dtau, norm_dtau_sq, expo
REAL(DP) :: r0(3), r1(3), r2(3), ri(3), k(3), phase, ksin(3), norm_k, sinxx
COMPLEX(DP) :: struc_fac
!
CHARACTER(len=6), EXTERNAL :: int_to_char
!
dg(:,:) = 0.0_DP
!
SELECT CASE ( constr_type(idx) )
CASE( constr_type_coord )
!
! ... constraint on global coordination
!
type_coord1 = anint( constr(1,idx) )
type_coord2 = anint( constr(2,idx) )
!
r_c = constr(3,idx)
!
smoothing = 1.0_DP / constr(4,idx)
!
g = 0.0_DP
!
n_type_coord1 = 0
!
DO ia1 = 1, nat
!
IF ( ityp(ia1) /= type_coord1 ) CYCLE
!
DO ia2 = 1, nat
!
IF ( ia2 == ia1 ) CYCLE
!
IF ( ityp(ia2) /= type_coord2 ) CYCLE
!
dtau(:) = pbc( ( tau(:,ia1) - tau(:,ia2) )*tau_units )
!
norm_dtau = norm( dtau(:) )
!
dtau(:) = dtau(:) / norm_dtau
!
expo = exp( smoothing*( norm_dtau - r_c ) )
!
g = g + 1.0_DP / ( expo + 1.0_DP )
!
dtau(:) = dtau(:) * smoothing*expo / ( expo + 1.0_DP )**2
!
dg(:,ia2) = dg(:,ia2) + dtau(:)
dg(:,ia1) = dg(:,ia1) - dtau(:)
!
ENDDO
!
n_type_coord1 = n_type_coord1 + 1
!
ENDDO
!
g = g / dble( n_type_coord1 )
dg = dg / dble( n_type_coord1 )
!
g = ( g - constr_target(idx) )
!
CASE( constr_atom_coord )
!
! ... constraint on local coordination
!
ia = anint( constr(1,idx) )
type_coord1 = anint( constr(2,idx) )
!
r_c = constr(3,idx)
!
smoothing = 1.0_DP / constr(4,idx)
!
g = 0.0_DP
!
DO ia1 = 1, nat
!
IF ( ia1 == ia ) CYCLE
!
IF ( ityp(ia1) /= type_coord1 ) CYCLE
!
dtau(:) = pbc( ( tau(:,ia) - tau(:,ia1) )*tau_units )
!
norm_dtau = norm( dtau(:) )
!
dtau(:) = dtau(:) / norm_dtau
!
expo = exp( smoothing*( norm_dtau - r_c ) )
!
g = g + 1.0_DP / ( expo + 1.0_DP )
!
dtau(:) = dtau(:) * smoothing * expo / ( expo + 1.0_DP )**2
!
dg(:,ia1) = dg(:,ia1) + dtau(:)
dg(:,ia) = dg(:,ia) - dtau(:)
!
ENDDO
!
g = ( g - constr_target(idx) )
!
CASE( constr_distance )
!
! ... constraint on distances
!
ia1 = anint( constr(1,idx) )
ia2 = anint( constr(2,idx) )
!
dtau(:) = pbc( ( tau(:,ia1) - tau(:,ia2) )*tau_units )
!
norm_dtau = norm( dtau(:) )
!
g = ( norm_dtau - constr_target(idx) )
!
dg(:,ia1) = dtau(:) / norm_dtau
!
dg(:,ia2) = - dg(:,ia1)
!
CASE( constr_planar_angle )
!
! ... constraint on planar angles (for the notation used here see
! ... Appendix C of the Allen-Tildesley book)
!
ia0 = anint( constr(1,idx) )
ia1 = anint( constr(2,idx) )
ia2 = anint( constr(3,idx) )
!
d0(:) = pbc( ( tau(:,ia0) - tau(:,ia1) )*tau_units )
d1(:) = pbc( ( tau(:,ia1) - tau(:,ia2) )*tau_units )
!
C00 = d0(:) .dot. d0(:)
C01 = d0(:) .dot. d1(:)
C11 = d1(:) .dot. d1(:)
!
inv_den = 1.0_DP / sqrt( C00*C11 )
!
g = ( acos(- C01 * inv_den)*360.d0/tpi - constr_target(idx) )
!
! d/dx acos(x) = -1/sqrt(1-x**2)
! d/dx acos(-x)*360/tpi = (360/tpi)/sqrt(1-x**2))
!
X = (360.d0/tpi)/sqrt(1-(C01 * inv_den)**2)
dg(:,ia0) = X * ( d1(:) - C01/C00*d0(:) ) * inv_den
dg(:,ia2) = X * ( C01/C11*d1(:) - d0(:) ) * inv_den
dg(:,ia1) = - dg(:,ia0) - dg(:,ia2)
!
CASE( constr_torsional_angle )
!
! ... constraint on torsional angle (for the notation used here
! ... see Appendix C of the Allen-Tildesley book)
!
ia0 = anint( constr(1,idx) )
ia1 = anint( constr(2,idx) )
ia2 = anint( constr(3,idx) )
ia3 = anint( constr(4,idx) )
!
r0(:) = pbc( ( tau(:,ia0) - tau(:,ia1) )*tau_units )
r1(:) = pbc( ( tau(:,ia1) - tau(:,ia2) )*tau_units )
r2(:) = pbc( ( tau(:,ia2) - tau(:,ia3) )*tau_units )
n1 = sqrt(r1.dot.r1)
!
x01(:) = cross(r0,r1)
x12(:) = cross(r1,r2)
x20(:) = cross(r2,r0)
!
s012 = r0.dot.x12
x01x12 = x01.dot.x12
!
phi = atan2(n1*s012 , x01x12)
!
g = phi*360.0_DP/tpi - constr_target(idx)
g = modulo(g+180.0_DP,360.0_DP)-180.0_DP
!
! d/dx atan(x) = 1/1+x**2
! d/dy atan2(y,x) = x/(x**2+y**2)
! d/dx atan2(y,x) = -y/(x**2+y**2)
! d(atan2(A,B)) = (BdA-AdB)/(A**2+B**2)
!
! dd0(:,ia0) = 1 ; dd1(:,ia0) = 0 ; dd2(:,ia0) = 0
! dd0(:,ia1) = -1 ; dd1(:,ia1) = 1 ; dd2(:,ia1) = 0
! dd0(:,ia2) = 0 ; dd1(:,ia2) = -1 ; dd2(:,ia2) = 1
! dd0(:,ia3) = 0 ; dd1(:,ia3) = 0 ; dd2(:,ia3) = -1
!
! d(s012) / d(r0) = x12
! d(s012) / d(r1) = x20
! d(s012) / d(r2) = x01
!
! d(x01x12) / d(r0) = r1 x x12
! d(x01x12) / d(r1) = r2 x x01 + x12 x r0
! d(x01x12) / d(r2) = x01 x r1
!
! d(n1) / d(r1) = r1 / n1
!
! d(phi) = (x01x12 * d(n1 * s012) - n1*s012 * d(x01x12)
! /
! (x01x12 ** 2 + n1*s012 ** 2)
!
! d(phi)/d(d0) = (x01x12 * n1*x12 - n1*s012 * r1 x x12)
! / DENOM
! d(phi)/d(d1) = (x01x12 * (n1*x20 + d1/n1 * s012) - n1*s012 * (r2 x x01 + x12 x r0))
! / DENOM
! d(phi)/d(d2) = (x01x12 * n1*x01 - n1*s012 * x01 x r1)
! / DENOM
!
inv_den = 1.0_DP / (x01x12 ** 2 + n1*s012 ** 2)
d0phi(:) = (x01x12 * n1*x12 - n1*s012 * cross(r1,x12)) * inv_den
d1phi(:) = (x01x12 * (n1*x20 + d1/n1 * s012) - n1*s012 * (cross(r2,x01) + cross(x12,r0))) * inv_den
d2phi(:) = (x01x12 * n1*x01 - n1*s012 * cross(x01,r1)) * inv_den
!
dg(:,ia0) = d0phi*360.0_DP/tpi
dg(:,ia1) = (d1phi-d0phi)*360.0_DP/tpi
dg(:,ia2) = (d2phi-d1phi)*360.0_DP/tpi
dg(:,ia3) = (-d2phi)*360.0_DP/tpi
!
CASE( constr_struct_fac )
!
! ... constraint on structure factor at a given k vector
!
k(1) = constr(1,idx)*tpi/tau_units
k(2) = constr(2,idx)*tpi/tau_units
k(3) = constr(3,idx)*tpi/tau_units
!
struc_fac = ( 1.0_DP, 0.0_DP )
!
r0(:) = tau(:,1)
!
DO i = 1, nat - 1
!
dtau(:) = pbc( ( tau(:,i+1) - r0(:) )*tau_units )
!
phase = k(1)*dtau(1) + k(2)*dtau(2) + k(3)*dtau(3)
!
struc_fac = struc_fac + cmplx( cos(phase), sin(phase), kind=DP )
!
ri(:) = tau(:,i)
!
DO j = i + 1, nat
!
dtau(:) = pbc( ( tau(:,j) - ri(:) )*tau_units )
!
phase = k(1)*dtau(1) + k(2)*dtau(2) + k(3)*dtau(3)
!
ksin(:) = k(:)*sin( phase )
!
dg(:,i) = dg(:,i) + ksin(:)
dg(:,j) = dg(:,j) - ksin(:)
!
ENDDO
!
ENDDO
!
g = ( conjg( struc_fac )*struc_fac ) / dble( nat*nat )
!
g = ( g - constr_target(idx) )
!
dg(:,:) = dg(:,:)*2.0_DP/dble( nat*nat )
!
CASE( constr_sph_struct_fac )
!
! ... constraint on spherical average of the structure factor for
! ... a given k-vector of norm k
!
norm_k = constr(1,idx)*tpi/tau_units
!
g = 0.0_DP
!
DO i = 1, nat - 1
!
ri(:) = tau(:,i)
!
DO j = i + 1, nat
!
dtau(:) = pbc( ( ri(:) - tau(:,j) )*tau_units )
!
norm_dtau_sq = dtau(1)**2 + dtau(2)**2 + dtau(3)**2
!
norm_dtau = sqrt( norm_dtau_sq )
!
phase = norm_k * norm_dtau
!
IF ( phase < eps32 ) THEN
!
g = g + 1.0_DP
!
ELSE
!
sinxx = sin( phase ) / phase
!
g = g + sinxx
!
dtau(:) = dtau(:) / norm_dtau_sq*( cos( phase ) - sinxx )
!
dg(:,i) = dg(:,i) + dtau(:)
dg(:,j) = dg(:,j) - dtau(:)
!
ENDIF
!
ENDDO
!
ENDDO
!
g = ( 2.0_DP*fpi*g / dble( nat ) - constr_target(idx) )
!
dg(:,:) = 4.0_DP*fpi*dg(:,:) / dble( nat )
!
CASE( constr_bennett_proj )
!
! ... constraint on Bennett projection
!
ia0 = anint( constr(1,idx) )
!
d0(:) = tau(:,ia0)
d1(:) = sum( tau(:,:), dim = 2 )
!
d1(:) = pbc( ( d1(:) - d0(:) )*tau_units ) / dble( nat - 1 ) - &
pbc( d0(:)*tau_units )
!
d2(:) = constr(2:4,idx)
!
g = ( d1(:) .dot. d2(:) ) / tau_units - constr_target( idx )
!
dg = 0.0_DP
!
C00 = ( 1.0_DP / dble( nat - 1 ) ) / tau_units
C01 = -1.0_DP / tau_units
!
DO i = 1, nat
!
dg(:,i) = d2(:)*C00
!
ENDDO
!
dg(:,ia0) = d2(:)*C01
!
CASE DEFAULT
!
CALL errore( 'constraint_grad', 'constrait type ' //&
trim(int_to_char(constr_type(idx))) // ' not implemented', 1 )
!
END SELECT
!
dg(:,:) = dg(:,:)*dble( if_pos(:,:) )
!
RETURN
!
END SUBROUTINE constraint_grad
!
!-----------------------------------------------------------------------
SUBROUTINE check_constraint( nat, taup, tau0, &
force, if_pos, ityp, tau_units, dt, massconv )
!-----------------------------------------------------------------------
!! Update taup (predicted positions) so that the constraint equation
!! g=0 is satisfied, using the recursion formula:
!! $$ \text{taup} = \text{taup} - \frac{g(\text{taup})}{M^{-1}\langle
!! dg(\text{taup})|dg(\text{tau0})\rangle} dg(\text{tau0})$$
!! in normal cases the constraint equation should be satisfied at
!! the very first iteration.
!
! g(taup)
! taup = taup - ----------------------- * dg(tau0)
! M^-1<dg(taup)|dg(tau0)>
!
USE ions_base, ONLY : amass
!
IMPLICIT NONE
!
INTEGER, INTENT(in) :: nat
REAL(DP), INTENT(inout) :: taup(3,nat)
REAL(DP), INTENT(in) :: tau0(3,nat)
INTEGER, INTENT(in) :: if_pos(3,nat)
REAL(DP), INTENT(inout) :: force(3,nat)
INTEGER, INTENT(in) :: ityp(nat)
REAL(DP), INTENT(in) :: tau_units
REAL(DP), INTENT(in) :: dt
REAL(DP), INTENT(in) :: massconv
!
INTEGER :: na, i, idx, dim
REAL(DP), ALLOCATABLE :: dgp(:,:), dg0(:,:,:)
REAL(DP) :: g0
REAL(DP) :: lambda, fac, invdtsq
LOGICAL, ALLOCATABLE :: ltest(:)
LOGICAL :: global_test
INTEGER, PARAMETER :: maxiter = 100
!
REAL(DP), EXTERNAL :: ddot
!
!
IF (.NOT.has_constr_grad_types) RETURN
!
ALLOCATE( dgp( 3, nat ) )
ALLOCATE( dg0( 3, nat, nconstr ) )
!
ALLOCATE( ltest( nconstr ) )
!
invdtsq = 1.0_DP / dt**2
!
dim = 3*nat
!
DO idx = 1, nconstr
!
CALL constraint_grad( idx, nat, tau0, &
if_pos, ityp, tau_units, g0, dg0(:,:,idx) )
!
ENDDO
!
outer_loop: DO i = 1, maxiter
!
inner_loop: DO idx = 1, nconstr
!
ltest(idx) = .false.
!
CALL constraint_grad( idx, nat, taup, &
if_pos, ityp, tau_units, gp(idx), dgp )
!
! ... check if gp = 0
!
#if defined (__DEBUG_CONSTRAINTS)
WRITE( stdout, '(2(2X,I3),F12.8)' ) i, idx, abs( gp(idx) )
#endif
!
IF ( abs( gp(idx) ) < constr_tol ) THEN
!
ltest(idx) = .true.
!
CYCLE inner_loop
!
ENDIF
!
! ... if gp <> 0 find new taup and check again
! ... ( gp is in bohr and taup in tau_units )
!
DO na = 1, nat
!
dgp(:,na) = dgp(:,na) / ( amass(ityp(na))*massconv )
!
ENDDO
!
lambda = gp(idx) / ddot( dim, dgp, 1, dg0(:,:,idx), 1 )
!
DO na = 1, nat
!
fac = amass(ityp(na))*massconv*tau_units
!
taup(:,na) = taup(:,na) - lambda*dg0(:,na,idx)/fac
!
ENDDO
!
lagrange(idx) = lagrange(idx) + lambda*invdtsq
!
force(:,:) = force(:,:) - lambda*dg0(:,:,idx)*invdtsq
!
ENDDO inner_loop
!
global_test = all( ltest(:) )
!
! ... all constraints are satisfied
!
IF ( global_test ) exit outer_loop
!
ENDDO outer_loop
!
IF ( .not. global_test ) THEN
!
! ... error messages
!
WRITE( stdout, '(/,5X,"Number of step(s): ",I3)') min( i, maxiter )
WRITE( stdout, '(/,5X,"constr_target convergence: ")' )
!
DO i = 1, nconstr
!
WRITE( stdout, '(5X,"constr # ",I3,2X,L1,3(2X,F16.10))' ) &
i, ltest(i), abs( gp(i) ), constr_tol, constr_target(i)
!
ENDDO
!
CALL errore( 'check_constraint', &
'on some constraint g = 0 is not satisfied', 1 )
!
ENDIF
!
DEALLOCATE( dgp )
DEALLOCATE( dg0 )
DEALLOCATE( ltest )
!
RETURN
!
END SUBROUTINE check_constraint
!
!-----------------------------------------------------------------------
SUBROUTINE remove_constr_force( nat, tau, &
if_pos, ityp, tau_units, force )
!-----------------------------------------------------------------------
!
!! The component of the force that is orthogonal to the
!! ipersurface defined by the constraint equations is removed
!! and the corresponding value of the lagrange multiplier computed.
!
IMPLICIT NONE
!
INTEGER, INTENT(in) :: nat
REAL(DP), INTENT(in) :: tau(:,:)
INTEGER, INTENT(in) :: if_pos(:,:)
INTEGER, INTENT(in) :: ityp(:)
REAL(DP), INTENT(in) :: tau_units
REAL(DP), INTENT(inout) :: force(:,:)
!
INTEGER :: i, j, dim
REAL(DP) :: g, ndg, dgidgj
REAL(DP) :: norm_before, norm_after
REAL(DP), ALLOCATABLE :: dg(:,:,:)
REAL(DP), ALLOCATABLE :: dg_matrix(:,:)
INTEGER, ALLOCATABLE :: iwork(:)
!
REAL(DP), EXTERNAL :: ddot, dnrm2
!
!
IF (.NOT.has_constr_grad_types) RETURN
!
dim = 3*nat
!
lagrange(:) = 0.0_DP
!
#if defined (__REMOVE_CONSTRAINT_FORCE)
!
norm_before = dnrm2( 3*nat, force, 1 )
!
ALLOCATE( dg( 3, nat, nconstr ) )
!
IF ( nconstr == 1 ) THEN
!
CALL constraint_grad( 1, nat, tau, &
if_pos, ityp, tau_units, g, dg(:,:,1) )
!
lagrange(1) = ddot( dim, force, 1, dg(:,:,1), 1 )
!
ndg = ddot( dim, dg(:,:,1), 1, dg(:,:,1), 1 )
!
force(:,:) = force(:,:) - lagrange(1)*dg(:,:,1)/ndg
!
ELSE
!
ALLOCATE( dg_matrix( nconstr, nconstr ) )
ALLOCATE( iwork( nconstr ) )
!
DO i = 1, nconstr
!
CALL constraint_grad( i, nat, tau, &
if_pos, ityp, tau_units, g, dg(:,:,i) )
!
ENDDO
!
DO i = 1, nconstr
!
dg_matrix(i,i) = ddot( dim, dg(:,:,i), 1, dg(:,:,i), 1 )
!
lagrange(i) = ddot( dim, force, 1, dg(:,:,i), 1 )
!
DO j = i + 1, nconstr
!
dgidgj = ddot( dim, dg(:,:,i), 1, dg(:,:,j), 1 )
!
dg_matrix(i,j) = dgidgj
dg_matrix(j,i) = dgidgj
!
ENDDO
!
ENDDO
!
CALL DGESV( nconstr, 1, dg_matrix, &
nconstr, iwork, lagrange, nconstr, i )
!
IF ( i /= 0 ) &
CALL errore( 'remove_constr_force', &
'error in the solution of the linear system', i )
!
DO i = 1, nconstr
!
force(:,:) = force(:,:) - lagrange(i)*dg(:,:,i)
!
ENDDO
!
DEALLOCATE( dg_matrix )
DEALLOCATE( iwork )
!
ENDIF
!
#if defined (__DEBUG_CONSTRAINTS)
!
WRITE( stdout, '(/,5X,"Intermediate forces (Ry/au):",/)')
!
DO i = 1, nat
!
WRITE( stdout, '(5X,"atom ",I3," type ",I2,3X,"force = ",3F14.8)' ) &
i, ityp(i), force(:,i)
!
ENDDO
!
#endif
!
norm_after = dnrm2( dim, force, 1 )
!
IF ( norm_before < norm_after ) THEN
!
WRITE( stdout, '(/,5X,"norm before = ",F16.10)' ) norm_before
WRITE( stdout, '( 5X,"norm after = ",F16.10)' ) norm_after
!
CALL errore( 'remove_constr_force', &
'norm(F) before < norm(F) after', 1 )
!
ENDIF
!
DEALLOCATE( dg )
!
#endif
!
END SUBROUTINE remove_constr_force
!
!-----------------------------------------------------------------------
SUBROUTINE remove_constr_vec( nat, tau, &
if_pos, ityp, tau_units, vec )
!-----------------------------------------------------------------------
!
!! The component of a displacement vector that is orthogonal to the
!! ipersurface defined by the constraint equations is removed
!! and the corresponding value of the lagrange multiplier computed.
!
IMPLICIT NONE
!
INTEGER, INTENT(in) :: nat
REAL(DP), INTENT(in) :: tau(:,:)
INTEGER, INTENT(in) :: if_pos(:,:)
INTEGER, INTENT(in) :: ityp(:)
REAL(DP), INTENT(in) :: tau_units
REAL(DP), INTENT(inout) :: vec(:,:)
!
INTEGER :: i, j, dim
REAL(DP) :: g, ndg, dgidgj
REAL(DP), ALLOCATABLE :: dg(:,:,:), dg_matrix(:,:), lambda(:)
INTEGER, ALLOCATABLE :: iwork(:)
!
REAL(DP), EXTERNAL :: ddot
!
!
IF (.NOT.has_constr_grad_types) RETURN
!
dim = 3*nat
!
ALLOCATE( lambda( nconstr ) )
ALLOCATE( dg( 3, nat, nconstr ) )
!
IF ( nconstr == 1 ) THEN
!
CALL constraint_grad( 1, nat, tau, &
if_pos, ityp, tau_units, g, dg(:,:,1) )
!
lambda(1) = ddot( dim, vec, 1, dg(:,:,1), 1 )
!
ndg = ddot( dim, dg(:,:,1), 1, dg(:,:,1), 1 )
!
vec(:,:) = vec(:,:) - lambda(1)*dg(:,:,1)/ndg
!
ELSE
!
ALLOCATE( dg_matrix( nconstr, nconstr ) )
ALLOCATE( iwork( nconstr ) )
!
DO i = 1, nconstr
!
CALL constraint_grad( i, nat, tau, &
if_pos, ityp, tau_units, g, dg(:,:,i) )
!
ENDDO
!
DO i = 1, nconstr
!
dg_matrix(i,i) = ddot( dim, dg(:,:,i), 1, dg(:,:,i), 1 )
!
lambda(i) = ddot( dim, vec, 1, dg(:,:,i), 1 )
!
DO j = i + 1, nconstr
!
dgidgj = ddot( dim, dg(:,:,i), 1, dg(:,:,j), 1 )
!
dg_matrix(i,j) = dgidgj
dg_matrix(j,i) = dgidgj
!
ENDDO
!
ENDDO
!
CALL DGESV( nconstr, 1, dg_matrix, &
nconstr, iwork, lambda, nconstr, i )
!
IF ( i /= 0 ) &
CALL errore( 'remove_constr_vec', &
'error in the solution of the linear system', i )
!
DO i = 1, nconstr
!
vec(:,:) = vec(:,:) - lambda(i)*dg(:,:,i)
!
ENDDO
!
DEALLOCATE( dg_matrix )
DEALLOCATE( iwork )
!
ENDIF
!
DEALLOCATE( lambda, dg )
!
END SUBROUTINE remove_constr_vec
!
!-----------------------------------------------------------------------
SUBROUTINE deallocate_constraint()
!-----------------------------------------------------------------------
!
IMPLICIT NONE
!
!
IF ( allocated( lagrange ) ) DEALLOCATE( lagrange )
IF ( allocated( constr ) ) DEALLOCATE( constr )
IF ( allocated( constr_type ) ) DEALLOCATE( constr_type )
IF ( allocated( constr_target ) ) DEALLOCATE( constr_target )
IF ( allocated( gp ) ) DEALLOCATE( gp )
!
RETURN
!
END SUBROUTINE deallocate_constraint
!
!-----------------------------------------------------------------------
FUNCTION cross(A,B)
!-----------------------------------------------------------------------
!! Cross product.
!
IMPLICIT NONE
!
REAL(DP),INTENT(in) :: A(3),B(3)
REAL(DP) cross(3)
!
cross(1) = A(2)*B(3)-A(3)*B(2)
cross(2) = A(3)*B(1)-A(1)*B(3)
cross(3) = A(1)*B(2)-A(2)*B(1)
!
END FUNCTION
!
!-----------------------------------------------------------------------
FUNCTION pbc( vect )
!-----------------------------------------------------------------------
!
!! Periodic boundary conditions ( vect is assumed to be given
!! in cartesian coordinates and in atomic units )
!
USE cell_base, ONLY : at, bg, alat
!
IMPLICIT NONE
!
REAL(DP), INTENT(in) :: vect(3)
REAL(DP) :: pbc(3)
!
!
#if defined (__USE_PBC)
!
pbc(:) = matmul( vect(:), bg(:,:) )/alat
!
pbc(:) = pbc(:) - anint( pbc(:) )
!
pbc(:) = matmul( at(:,:), pbc(:) )*alat
!
#else
!
pbc(:) = vect(:)
!
#endif
RETURN
!
END FUNCTION pbc
!
!-----------------------------------------------------------------------
SUBROUTINE compute_dmax()
!-----------------------------------------------------------------------
!
!! Dmax corresponds to one half the longest diagonal of the cell.
!
USE cell_base, ONLY : at, alat
!
IMPLICIT NONE
!
INTEGER :: x,y,z
REAL(DP) :: diago(3)
!
dmax = 0._dp !norm(at(:,1)+at(:,2)+at(:,3))
!
DO z = -1,1,2
DO y = -1,1,2
DO x = -1,1,2
diago = x*at(:,1) + y*at(:,2) + z*at(:,3)
dmax = max(dmax, norm(diago))
ENDDO
ENDDO
ENDDO
!
dmax= dmax*alat*.5_dp
!
RETURN
!
END SUBROUTINE compute_dmax
!
!-----------------------------------------------------------------------
SUBROUTINE check_wall_constraint( nat, tau, &
if_pos, ityp, tau_units, force )
!-----------------------------------------------------------------------
!
!! If potential wall constraint is requested, update force accordingly.
!
IMPLICIT NONE
!
INTEGER, INTENT(in) :: nat
REAL(DP), INTENT(in) :: tau(:,:)
INTEGER, INTENT(in) :: if_pos(:,:)
INTEGER, INTENT(in) :: ityp(:)
REAL(DP), INTENT(in) :: tau_units
REAL(DP), INTENT(inout) :: force(:,:)
!
INTEGER :: na, ia
INTEGER, PARAMETER :: dir = 3 ! Hard-coded for Z-axis
REAL(DP) :: tau_pbc_vec(3), tau_abs, tau_pbc, rcut
REAL(DP) :: prefac, exponent
REAL(DP), PARAMETER :: inner_cutoff = 0.1_dp ! In a.u. Hard-coded
!
CHARACTER(len=6), EXTERNAL :: int_to_char
!
!
IF (.NOT.has_constr_wall) RETURN
!
DO ia = 1, nconstr
IF (constr_type(ia) .EQ. constr_wall) THEN
prefac = constr(1, ia)
exponent = constr(2, ia)
rcut = constr(3, ia)
EXIT
END IF
END DO
!
DO na = 1, nat
!
! This computes shortest vector from the origin to the atom coordinates
! given the PBCs. Origin is picked since the wall is at the origin.
tau_pbc_vec = pbc( tau(:,na)*tau_units )
tau_pbc = tau_pbc_vec( dir )
tau_abs = abs( tau_pbc )
!
! Atom's Z-coordinate too far from the wall, cycle
IF (tau_abs .GT. rcut) CYCLE
!
! Prevent force blow up by error-ing out
IF (tau_abs .LE. inner_cutoff) &
CALL errore( 'check_wall_constraint', 'Atom ' // &
trim(int_to_char(na)) // ' too close to the wall.', 1)
!
! Repulsive energy is C/r^n - C/rcut^n. Force is derivative:
force(dir, na) = force(dir, na) + prefac * exponent * &
tau_abs ** (-exponent) / tau_pbc
END DO
!
END SUBROUTINE check_wall_constraint
!
END MODULE constraints_module