ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/group/trunk/OOPSE/libmdtools/do_Forces.F90
Revision: 439
Committed: Mon Mar 31 22:09:39 2003 UTC (21 years, 3 months ago) by chuckv
File size: 20803 byte(s)
Log Message:
Fixed bug with pot_local not zeroed.

File Contents

# Content
1 !! do_Forces.F90
2 !! module do_Forces
3 !! Calculates Long Range forces.
4
5 !! @author Charles F. Vardeman II
6 !! @author Matthew Meineke
7 !! @version $Id: do_Forces.F90,v 1.6 2003-03-31 22:09:39 chuckv Exp $, $Date: 2003-03-31 22:09:39 $, $Name: not supported by cvs2svn $, $Revision: 1.6 $
8
9 module do_Forces
10 use force_globals
11 use simulation
12 use definitions
13 use atype_module
14 use neighborLists
15 use lj
16 use sticky_pair
17 use dipole_dipole
18 use reaction_field
19 use gb_pair
20 #ifdef IS_MPI
21 use mpiSimulation
22 #endif
23
24 implicit none
25 PRIVATE
26
27 #define __FORTRAN90
28 #include "fForceField.h"
29
30 logical, save :: do_forces_initialized = .false.
31 logical, save :: FF_uses_LJ
32 logical, save :: FF_uses_sticky
33 logical, save :: FF_uses_dipoles
34 logical, save :: FF_uses_RF
35 logical, save :: FF_uses_GB
36 logical, save :: FF_uses_EAM
37
38 public :: init_FF
39 public :: do_force_loop
40
41 contains
42
43 subroutine init_FF(LJMIXPOLICY, use_RF_c, thisStat)
44
45 integer, intent(in) :: LJMIXPOLICY
46 logical, intent(in) :: use_RF_c
47
48 integer, intent(out) :: thisStat
49 integer :: my_status, nMatches
50 integer, pointer :: MatchList(:) => null()
51 real(kind=dp) :: rcut, rrf, rt, dielect
52
53 !! assume things are copacetic, unless they aren't
54 thisStat = 0
55
56 !! Fortran's version of a cast:
57 FF_uses_RF = use_RF_c
58
59 !! init_FF is called *after* all of the atom types have been
60 !! defined in atype_module using the new_atype subroutine.
61 !!
62 !! this will scan through the known atypes and figure out what
63 !! interactions are used by the force field.
64
65 FF_uses_LJ = .false.
66 FF_uses_sticky = .false.
67 FF_uses_dipoles = .false.
68 FF_uses_GB = .false.
69 FF_uses_EAM = .false.
70
71 call getMatchingElementList(atypes, "is_LJ", .true., nMatches, MatchList)
72 if (nMatches .gt. 0) FF_uses_LJ = .true.
73
74 call getMatchingElementList(atypes, "is_DP", .true., nMatches, MatchList)
75 if (nMatches .gt. 0) FF_uses_dipoles = .true.
76
77 call getMatchingElementList(atypes, "is_Sticky", .true., nMatches, &
78 MatchList)
79 if (nMatches .gt. 0) FF_uses_Sticky = .true.
80
81 call getMatchingElementList(atypes, "is_GB", .true., nMatches, MatchList)
82 if (nMatches .gt. 0) FF_uses_GB = .true.
83
84 call getMatchingElementList(atypes, "is_EAM", .true., nMatches, MatchList)
85 if (nMatches .gt. 0) FF_uses_EAM = .true.
86
87 !! check to make sure the FF_uses_RF setting makes sense
88
89 if (FF_uses_dipoles) then
90 rrf = getRrf()
91 rt = getRt()
92 call initialize_dipole(rrf, rt)
93 if (FF_uses_RF) then
94 dielect = getDielect()
95 call initialize_rf(rrf, rt, dielect)
96 endif
97 else
98 if (FF_uses_RF) then
99 write(default_error,*) 'Using Reaction Field with no dipoles? Huh?'
100 thisStat = -1
101 return
102 endif
103 endif
104
105 if (FF_uses_LJ) then
106
107 call getRcut(rcut)
108
109 select case (LJMIXPOLICY)
110 case (LB_MIXING_RULE)
111 call init_lj_FF(LB_MIXING_RULE, rcut, my_status)
112 case (EXPLICIT_MIXING_RULE)
113 call init_lj_FF(EXPLICIT_MIXING_RULE, rcut, my_status)
114 case default
115 write(default_error,*) 'unknown LJ Mixing Policy!'
116 thisStat = -1
117 return
118 end select
119 if (my_status /= 0) then
120 thisStat = -1
121 return
122 end if
123 endif
124
125 if (FF_uses_sticky) then
126 call check_sticky_FF(my_status)
127 if (my_status /= 0) then
128 thisStat = -1
129 return
130 end if
131 endif
132
133 if (FF_uses_GB) then
134 call check_gb_pair_FF(my_status)
135 if (my_status .ne. 0) then
136 thisStat = -1
137 return
138 endif
139 endif
140
141 if (FF_uses_GB .and. FF_uses_LJ) then
142 endif
143
144
145 do_forces_initialized = .true.
146
147 end subroutine init_FF
148
149
150 !! Does force loop over i,j pairs. Calls do_pair to calculates forces.
151 !------------------------------------------------------------->
152 subroutine do_force_loop(q, A, u_l, f, t, tau, pot, do_pot_c, do_stress_c, &
153 error)
154 !! Position array provided by C, dimensioned by getNlocal
155 real ( kind = dp ), dimension(3,getNlocal()) :: q
156 !! Rotation Matrix for each long range particle in simulation.
157 real( kind = dp), dimension(9,getNlocal()) :: A
158 !! Unit vectors for dipoles (lab frame)
159 real( kind = dp ), dimension(3,getNlocal()) :: u_l
160 !! Force array provided by C, dimensioned by getNlocal
161 real ( kind = dp ), dimension(3,getNlocal()) :: f
162 !! Torsion array provided by C, dimensioned by getNlocal
163 real( kind = dp ), dimension(3,getNlocal()) :: t
164 !! Stress Tensor
165 real( kind = dp), dimension(9) :: tau
166 real ( kind = dp ) :: pot
167 logical ( kind = 2) :: do_pot_c, do_stress_c
168 logical :: do_pot
169 logical :: do_stress
170 #ifdef IS_MPI
171 real( kind = DP ) :: pot_local = 0.0_dp
172 integer :: nrow
173 integer :: ncol
174 #endif
175 integer :: nlocal
176 integer :: natoms
177 logical :: update_nlist
178 integer :: i, j, jbeg, jend, jnab
179 integer :: nlist
180 real( kind = DP ) :: rijsq, rlistsq, rcutsq, rlist, rcut
181 real(kind=dp),dimension(3) :: d
182 real(kind=dp) :: rfpot, mu_i, virial
183 integer :: me_i
184 logical :: is_dp_i
185 integer :: neighborListSize
186 integer :: listerror, error
187 integer :: localError
188
189 !! initialize local variables
190
191 #ifdef IS_MPI
192 nlocal = getNlocal()
193 nrow = getNrow(plan_row)
194 ncol = getNcol(plan_col)
195 #else
196 nlocal = getNlocal()
197 natoms = nlocal
198 #endif
199
200 call getRcut(rcut,rc2=rcutsq)
201 call getRlist(rlist,rlistsq)
202
203 call check_initialization(localError)
204 if ( localError .ne. 0 ) then
205 error = -1
206 return
207 end if
208 call zero_work_arrays()
209
210 do_pot = do_pot_c
211 do_stress = do_stress_c
212
213 ! Gather all information needed by all force loops:
214
215 #ifdef IS_MPI
216
217 call gather(q,q_Row,plan_row3d)
218 call gather(q,q_Col,plan_col3d)
219
220 if (FF_UsesDirectionalAtoms() .and. SimUsesDirectionalAtoms()) then
221 call gather(u_l,u_l_Row,plan_row3d)
222 call gather(u_l,u_l_Col,plan_col3d)
223
224 call gather(A,A_Row,plan_row_rotation)
225 call gather(A,A_Col,plan_col_rotation)
226 endif
227
228 #endif
229
230 if (FF_RequiresPrepairCalc() .and. SimRequiresPrepairCalc()) then
231 !! See if we need to update neighbor lists
232 call checkNeighborList(nlocal, q, rcut, rlist, update_nlist)
233 !! if_mpi_gather_stuff_for_prepair
234 !! do_prepair_loop_if_needed
235 !! if_mpi_scatter_stuff_from_prepair
236 !! if_mpi_gather_stuff_from_prepair_to_main_loop
237 else
238 !! See if we need to update neighbor lists
239 call checkNeighborList(nlocal, q, rcut, rlist, update_nlist)
240 endif
241
242 #ifdef IS_MPI
243
244 if (update_nlist) then
245
246 !! save current configuration, construct neighbor list,
247 !! and calculate forces
248 call saveNeighborList(q)
249
250 neighborListSize = size(list)
251 nlist = 0
252
253 do i = 1, nrow
254 point(i) = nlist + 1
255
256 inner: do j = 1, ncol
257
258 if (skipThisPair(i,j)) cycle inner
259
260 call get_interatomic_vector(q_Row(:,i), q_Col(:,j), d, rijsq)
261
262 if (rijsq < rlistsq) then
263
264 nlist = nlist + 1
265
266 if (nlist > neighborListSize) then
267 call expandNeighborList(nlocal, listerror)
268 if (listerror /= 0) then
269 error = -1
270 write(DEFAULT_ERROR,*) "ERROR: nlist > list size and max allocations exceeded."
271 return
272 end if
273 neighborListSize = size(list)
274 endif
275
276 list(nlist) = j
277
278 if (rijsq < rcutsq) then
279 call do_pair(i, j, rijsq, d, do_pot, do_stress, &
280 u_l, A, f, t,pot)
281 endif
282 endif
283 enddo inner
284 enddo
285
286 point(nrow + 1) = nlist + 1
287
288 else !! (of update_check)
289
290 ! use the list to find the neighbors
291 do i = 1, nrow
292 JBEG = POINT(i)
293 JEND = POINT(i+1) - 1
294 ! check thiat molecule i has neighbors
295 if (jbeg .le. jend) then
296
297 do jnab = jbeg, jend
298 j = list(jnab)
299
300 call get_interatomic_vector(q_Row(:,i), q_Col(:,j), d, rijsq)
301 call do_pair(i, j, rijsq, d, do_pot, do_stress, &
302 u_l, A, f, t,pot)
303
304 enddo
305 endif
306 enddo
307 endif
308
309 #else
310
311 if (update_nlist) then
312
313 ! save current configuration, contruct neighbor list,
314 ! and calculate forces
315 call saveNeighborList(q)
316
317 neighborListSize = size(list)
318
319 nlist = 0
320
321 do i = 1, natoms-1
322 point(i) = nlist + 1
323
324 inner: do j = i+1, natoms
325
326 if (skipThisPair(i,j)) cycle inner
327
328 call get_interatomic_vector(q(:,i), q(:,j), d, rijsq)
329
330
331 if (rijsq < rlistsq) then
332
333 nlist = nlist + 1
334
335 if (nlist > neighborListSize) then
336 call expandNeighborList(natoms, listerror)
337 if (listerror /= 0) then
338 error = -1
339 write(DEFAULT_ERROR,*) "ERROR: nlist > list size and max allocations exceeded."
340 return
341 end if
342 neighborListSize = size(list)
343 endif
344
345 list(nlist) = j
346
347 if (rijsq < rcutsq) then
348 call do_pair(i, j, rijsq, d, do_pot, do_stress, &
349 u_l, A, f, t,pot)
350 endif
351 endif
352 enddo inner
353 enddo
354
355 point(natoms) = nlist + 1
356
357 else !! (update)
358
359 ! use the list to find the neighbors
360 do i = 1, natoms-1
361 JBEG = POINT(i)
362 JEND = POINT(i+1) - 1
363 ! check thiat molecule i has neighbors
364 if (jbeg .le. jend) then
365
366 do jnab = jbeg, jend
367 j = list(jnab)
368
369 call get_interatomic_vector(q(:,i), q(:,j), d, rijsq)
370 call do_pair(i, j, rijsq, d, do_pot, do_stress, &
371 u_l, A, f, t,pot)
372
373 enddo
374 endif
375 enddo
376 endif
377
378 #endif
379
380 ! phew, done with main loop.
381
382 #ifdef IS_MPI
383 !!distribute forces
384
385 f_temp = 0.0_dp
386 call scatter(f_Row,f_temp,plan_row3d)
387 do i = 1,nlocal
388 f(1:3,i) = f(1:3,i) + f_temp(1:3,i)
389 end do
390
391 f_temp = 0.0_dp
392 call scatter(f_Col,f_temp,plan_col3d)
393 do i = 1,nlocal
394 f(1:3,i) = f(1:3,i) + f_temp(1:3,i)
395 end do
396
397 if (FF_UsesDirectionalAtoms() .and. SimUsesDirectionalAtoms()) then
398 t_temp = 0.0_dp
399 call scatter(t_Row,t_temp,plan_row3d)
400 do i = 1,nlocal
401 t(1:3,i) = t(1:3,i) + t_temp(1:3,i)
402 end do
403 t_temp = 0.0_dp
404 call scatter(t_Col,t_temp,plan_col3d)
405
406 do i = 1,nlocal
407 t(1:3,i) = t(1:3,i) + t_temp(1:3,i)
408 end do
409 endif
410
411 if (do_pot) then
412 ! scatter/gather pot_row into the members of my column
413 call scatter(pot_Row, pot_Temp, plan_row)
414
415 ! scatter/gather pot_local into all other procs
416 ! add resultant to get total pot
417 do i = 1, nlocal
418 pot_local = pot_local + pot_Temp(i)
419 enddo
420
421 pot_Temp = 0.0_DP
422
423 call scatter(pot_Col, pot_Temp, plan_col)
424 do i = 1, nlocal
425 pot_local = pot_local + pot_Temp(i)
426 enddo
427
428 endif
429 #endif
430
431 if (FF_RequiresPostpairCalc() .and. SimRequiresPostpairCalc()) then
432
433 if (FF_uses_RF .and. SimUsesRF()) then
434
435 #ifdef IS_MPI
436 call scatter(rf_Row,rf,plan_row3d)
437 call scatter(rf_Col,rf_Temp,plan_col3d)
438 do i = 1,nlocal
439 rf(1:3,i) = rf(1:3,i) + rf_Temp(1:3,i)
440 end do
441 #endif
442
443 do i = 1, getNlocal()
444
445 rfpot = 0.0_DP
446 #ifdef IS_MPI
447 me_i = atid_row(i)
448 #else
449 me_i = atid(i)
450 #endif
451 call getElementProperty(atypes, me_i, "is_DP", is_DP_i)
452 if ( is_DP_i ) then
453 call getElementProperty(atypes, me_i, "dipole_moment", mu_i)
454 !! The reaction field needs to include a self contribution
455 !! to the field:
456 call accumulate_self_rf(i, mu_i, u_l)
457 !! Get the reaction field contribution to the
458 !! potential and torques:
459 call reaction_field_final(i, mu_i, u_l, rfpot, t, do_pot)
460 #ifdef IS_MPI
461 pot_local = pot_local + rfpot
462 #else
463 pot = pot + rfpot
464
465 #endif
466 endif
467 enddo
468 endif
469 endif
470
471
472 #ifdef IS_MPI
473
474 if (do_pot) then
475 pot = pot_local
476 !! we assume the c code will do the allreduce to get the total potential
477 !! we could do it right here if we needed to...
478 endif
479
480 if (do_stress) then
481 call mpi_allreduce(tau, tau_Temp,9,mpi_double_precision,mpi_sum, &
482 mpi_comm_world,mpi_err)
483 call mpi_allreduce(virial, virial_Temp,1,mpi_double_precision,mpi_sum, &
484 mpi_comm_world,mpi_err)
485 endif
486
487 #else
488
489 if (do_stress) then
490 tau = tau_Temp
491 virial = virial_Temp
492 endif
493
494 #endif
495
496 end subroutine do_force_loop
497
498 subroutine do_pair(i, j, rijsq, d, do_pot, do_stress, u_l, A, f, t,pot)
499
500 real( kind = dp ) :: pot
501 real( kind = dp ), dimension(:,:) :: u_l
502 real (kind=dp), dimension(:,:) :: A
503 real (kind=dp), dimension(:,:) :: f
504 real (kind=dp), dimension(:,:) :: t
505
506 logical, intent(inout) :: do_pot, do_stress
507 integer, intent(in) :: i, j
508 real ( kind = dp ), intent(inout) :: rijsq
509 real ( kind = dp ) :: r
510 real ( kind = dp ), intent(inout) :: d(3)
511 logical :: is_LJ_i, is_LJ_j
512 logical :: is_DP_i, is_DP_j
513 logical :: is_GB_i, is_GB_j
514 logical :: is_Sticky_i, is_Sticky_j
515 integer :: me_i, me_j
516
517 r = sqrt(rijsq)
518
519 #ifdef IS_MPI
520
521 me_i = atid_row(i)
522 me_j = atid_col(j)
523
524 #else
525
526 me_i = atid(i)
527 me_j = atid(j)
528
529 #endif
530
531 if (FF_uses_LJ .and. SimUsesLJ()) then
532 call getElementProperty(atypes, me_i, "is_LJ", is_LJ_i)
533 call getElementProperty(atypes, me_j, "is_LJ", is_LJ_j)
534
535 if ( is_LJ_i .and. is_LJ_j ) &
536 call do_lj_pair(i, j, d, r, rijsq, pot, f, do_pot, do_stress)
537 endif
538
539 if (FF_uses_dipoles .and. SimUsesDipoles()) then
540 call getElementProperty(atypes, me_i, "is_DP", is_DP_i)
541 call getElementProperty(atypes, me_j, "is_DP", is_DP_j)
542
543 if ( is_DP_i .and. is_DP_j ) then
544
545 call do_dipole_pair(i, j, d, r, rijsq, pot, u_l, f, t, &
546 do_pot, do_stress)
547 if (FF_uses_RF .and. SimUsesRF()) then
548 call accumulate_rf(i, j, r, u_l)
549 call rf_correct_forces(i, j, d, r, u_l, f, do_stress)
550 endif
551
552 endif
553 endif
554
555 if (FF_uses_Sticky .and. SimUsesSticky()) then
556
557 call getElementProperty(atypes, me_i, "is_Sticky", is_Sticky_i)
558 call getElementProperty(atypes, me_j, "is_Sticky", is_Sticky_j)
559
560 if ( is_Sticky_i .and. is_Sticky_j ) then
561 call do_sticky_pair(i, j, d, r, rijsq, A, pot, f, t, &
562 do_pot, do_stress)
563 endif
564 endif
565
566
567 if (FF_uses_GB .and. SimUsesGB()) then
568
569 call getElementProperty(atypes, me_i, "is_GB", is_GB_i)
570 call getElementProperty(atypes, me_j, "is_GB", is_GB_j)
571
572 if ( is_GB_i .and. is_GB_j ) then
573 call do_gb_pair(i, j, d, r, rijsq, u_l, pot, f, t, &
574 do_pot, do_stress)
575 endif
576 endif
577
578 end subroutine do_pair
579
580
581 subroutine get_interatomic_vector(q_i, q_j, d, r_sq)
582
583 real (kind = dp), dimension(3) :: q_i
584 real (kind = dp), dimension(3) :: q_j
585 real ( kind = dp ), intent(out) :: r_sq
586 real( kind = dp ) :: d(3)
587 real( kind = dp ) :: d_old(3)
588 d(1:3) = q_i(1:3) - q_j(1:3)
589 d_old = d
590 ! Wrap back into periodic box if necessary
591 if ( SimUsesPBC() ) then
592
593 d(1:3) = d(1:3) - box(1:3) * sign(1.0_dp,d(1:3)) * &
594 int(abs(d(1:3)/box(1:3)) + 0.5_dp)
595
596 endif
597 r_sq = dot_product(d,d)
598
599 end subroutine get_interatomic_vector
600
601 subroutine check_initialization(error)
602 integer, intent(out) :: error
603
604 error = 0
605 ! Make sure we are properly initialized.
606 if (.not. do_forces_initialized) then
607 error = -1
608 return
609 endif
610
611 #ifdef IS_MPI
612 if (.not. isMPISimSet()) then
613 write(default_error,*) "ERROR: mpiSimulation has not been initialized!"
614 error = -1
615 return
616 endif
617 #endif
618
619 return
620 end subroutine check_initialization
621
622
623 subroutine zero_work_arrays()
624
625 #ifdef IS_MPI
626
627 q_Row = 0.0_dp
628 q_Col = 0.0_dp
629
630 u_l_Row = 0.0_dp
631 u_l_Col = 0.0_dp
632
633 A_Row = 0.0_dp
634 A_Col = 0.0_dp
635
636 f_Row = 0.0_dp
637 f_Col = 0.0_dp
638 f_Temp = 0.0_dp
639
640 t_Row = 0.0_dp
641 t_Col = 0.0_dp
642 t_Temp = 0.0_dp
643
644 pot_Row = 0.0_dp
645 pot_Col = 0.0_dp
646 pot_Temp = 0.0_dp
647
648 rf_Row = 0.0_dp
649 rf_Col = 0.0_dp
650 rf_Temp = 0.0_dp
651
652 #endif
653
654 rf = 0.0_dp
655 tau_Temp = 0.0_dp
656 virial_Temp = 0.0_dp
657
658 end subroutine zero_work_arrays
659
660 function skipThisPair(atom1, atom2) result(skip_it)
661 integer, intent(in) :: atom1
662 integer, intent(in), optional :: atom2
663 logical :: skip_it
664 integer :: unique_id_1, unique_id_2
665 integer :: me_i,me_j
666 integer :: i
667
668 skip_it = .false.
669
670 !! there are a number of reasons to skip a pair or a particle
671 !! mostly we do this to exclude atoms who are involved in short
672 !! range interactions (bonds, bends, torsions), but we also need
673 !! to exclude some overcounted interactions that result from
674 !! the parallel decomposition
675
676 #ifdef IS_MPI
677 !! in MPI, we have to look up the unique IDs for each atom
678 unique_id_1 = tagRow(atom1)
679 #else
680 !! in the normal loop, the atom numbers are unique
681 unique_id_1 = atom1
682 #endif
683
684 !! We were called with only one atom, so just check the global exclude
685 !! list for this atom
686 if (.not. present(atom2)) then
687 do i = 1, nExcludes_global
688 if (excludesGlobal(i) == unique_id_1) then
689 skip_it = .true.
690 return
691 end if
692 end do
693 return
694 end if
695
696 #ifdef IS_MPI
697 unique_id_2 = tagColumn(atom2)
698 #else
699 unique_id_2 = atom2
700 #endif
701
702 #ifdef IS_MPI
703 !! this situation should only arise in MPI simulations
704 if (unique_id_1 == unique_id_2) then
705 skip_it = .true.
706 return
707 end if
708
709 !! this prevents us from doing the pair on multiple processors
710 if (unique_id_1 < unique_id_2) then
711 if (mod(unique_id_1 + unique_id_2,2) == 0) skip_it = .true.
712 return
713 else
714 if (mod(unique_id_1 + unique_id_2,2) == 1) skip_it = .true.
715 return
716 endif
717 #endif
718
719 !! the rest of these situations can happen in all simulations:
720 do i = 1, nExcludes_global
721 if ((excludesGlobal(i) == unique_id_1) .or. &
722 (excludesGlobal(i) == unique_id_2)) then
723 skip_it = .true.
724 return
725 endif
726 enddo
727
728 do i = 1, nExcludes_local
729 if (excludesLocal(1,i) == unique_id_1) then
730 if (excludesLocal(2,i) == unique_id_2) then
731 skip_it = .true.
732 return
733 endif
734 else
735 if (excludesLocal(1,i) == unique_id_2) then
736 if (excludesLocal(2,i) == unique_id_1) then
737 skip_it = .true.
738 return
739 endif
740 endif
741 endif
742 end do
743
744 return
745 end function skipThisPair
746
747 function FF_UsesDirectionalAtoms() result(doesit)
748 logical :: doesit
749 doesit = FF_uses_dipoles .or. FF_uses_sticky .or. &
750 FF_uses_GB .or. FF_uses_RF
751 end function FF_UsesDirectionalAtoms
752
753 function FF_RequiresPrepairCalc() result(doesit)
754 logical :: doesit
755 doesit = FF_uses_EAM
756 end function FF_RequiresPrepairCalc
757
758 function FF_RequiresPostpairCalc() result(doesit)
759 logical :: doesit
760 doesit = FF_uses_RF
761 end function FF_RequiresPostpairCalc
762
763 end module do_Forces