-
Notifications
You must be signed in to change notification settings - Fork 25
/
Copy pathshr_mpi_mod.F90
2217 lines (1732 loc) · 78 KB
/
shr_mpi_mod.F90
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
Module shr_mpi_mod
!-------------------------------------------------------------------------------
! PURPOSE: general layer on MPI functions
!-------------------------------------------------------------------------------
use shr_kind_mod
use shr_log_mod, only: s_loglev => shr_log_Level
use shr_log_mod, only: s_logunit => shr_log_Unit
implicit none
private
! PUBLIC: Public interfaces
public :: shr_mpi_chkerr
public :: shr_mpi_send
public :: shr_mpi_recv
public :: shr_mpi_bcast
public :: shr_mpi_gathScatVInit
public :: shr_mpi_gatherV
public :: shr_mpi_scatterV
public :: shr_mpi_sum
public :: shr_mpi_min
public :: shr_mpi_max
public :: shr_mpi_commsize
public :: shr_mpi_commrank
public :: shr_mpi_initialized
public :: shr_mpi_abort
public :: shr_mpi_barrier
public :: shr_mpi_init
public :: shr_mpi_finalize
interface shr_mpi_send ; module procedure &
shr_mpi_sendi0, &
shr_mpi_sendi1, &
shr_mpi_sendr0, &
shr_mpi_sendr1, &
shr_mpi_sendr3
end interface shr_mpi_send
interface shr_mpi_recv ; module procedure &
shr_mpi_recvi0, &
shr_mpi_recvi1, &
shr_mpi_recvr0, &
shr_mpi_recvr1, &
shr_mpi_recvr3
end interface shr_mpi_recv
interface shr_mpi_bcast ; module procedure &
shr_mpi_bcastc0, &
shr_mpi_bcastc1, &
shr_mpi_bcastl0, &
shr_mpi_bcastl1, &
shr_mpi_bcasti0, &
shr_mpi_bcasti1, &
shr_mpi_bcasti80, &
shr_mpi_bcasti81, &
shr_mpi_bcasti2, &
shr_mpi_bcastr0, &
shr_mpi_bcastr1, &
shr_mpi_bcastr2, &
shr_mpi_bcastr3
end interface shr_mpi_bcast
interface shr_mpi_gathScatVInit ; module procedure &
shr_mpi_gathScatVInitr1
end interface shr_mpi_gathScatVInit
interface shr_mpi_gatherv ; module procedure &
shr_mpi_gatherVr1
end interface shr_mpi_gatherv
interface shr_mpi_scatterv ; module procedure &
shr_mpi_scatterVr1
end interface shr_mpi_scatterv
interface shr_mpi_sum ; module procedure &
shr_mpi_sumi0, &
shr_mpi_sumi1, &
shr_mpi_sumb0, &
shr_mpi_sumb1, &
shr_mpi_sumr0, &
shr_mpi_sumr1, &
shr_mpi_sumr2, &
shr_mpi_sumr3
end interface shr_mpi_sum
interface shr_mpi_min ; module procedure &
shr_mpi_mini0, &
shr_mpi_mini1, &
shr_mpi_minr0, &
shr_mpi_minr1
end interface shr_mpi_min
interface shr_mpi_max ; module procedure &
shr_mpi_maxi0, &
shr_mpi_maxi1, &
shr_mpi_maxr0, &
shr_mpi_maxr1
end interface shr_mpi_max
! mpi library include file
#include <mpif.h>
!===============================================================================
CONTAINS
!===============================================================================
SUBROUTINE shr_mpi_chkerr(rcode,string)
IMPLICIT none
!----- arguments ---
integer(SHR_KIND_IN), intent(in) :: rcode ! input MPI error code
character(*), intent(in) :: string ! message
!----- local ---
character(*),parameter :: subName = '(shr_mpi_chkerr) '
character(MPI_MAX_ERROR_STRING) :: lstring
integer(SHR_KIND_IN) :: len
integer(SHR_KIND_IN) :: ierr
!-------------------------------------------------------------------------------
! PURPOSE: layer on MPI error checking
!-------------------------------------------------------------------------------
if (rcode /= MPI_SUCCESS) then
call MPI_ERROR_STRING(rcode,lstring,len,ierr)
write(s_logunit,*) trim(subName),":",lstring(1:len)
call shr_mpi_abort(string,rcode)
endif
END SUBROUTINE shr_mpi_chkerr
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_sendi0(lvec,pid,tag,comm,string)
IMPLICIT none
!----- arguments ---
integer(SHR_KIND_IN), intent(in) :: lvec ! send value
integer(SHR_KIND_IN), intent(in) :: pid ! pid to send to
integer(SHR_KIND_IN), intent(in) :: tag ! tag
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
!----- local ---
character(*),parameter :: subName = '(shr_mpi_sendi0) '
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: ierr
!-------------------------------------------------------------------------------
! PURPOSE: Send a single integer
!-------------------------------------------------------------------------------
lsize = 1
call MPI_SEND(lvec,lsize,MPI_INTEGER,pid,tag,comm,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_sendi0
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_sendi1(lvec,pid,tag,comm,string)
IMPLICIT none
!----- arguments ---
integer(SHR_KIND_IN), intent(in) :: lvec(:) ! in/out local values
integer(SHR_KIND_IN), intent(in) :: pid ! pid to send to
integer(SHR_KIND_IN), intent(in) :: tag ! tag
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
!----- local ---
character(*),parameter :: subName = '(shr_mpi_sendi1) '
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: ierr
!-------------------------------------------------------------------------------
! PURPOSE: Send a vector of integers
!-------------------------------------------------------------------------------
lsize = size(lvec)
call MPI_SEND(lvec,lsize,MPI_INTEGER,pid,tag,comm,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_sendi1
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_sendr0(lvec,pid,tag,comm,string)
IMPLICIT none
!----- arguments ---
real(SHR_KIND_R8), intent(in) :: lvec ! in/out local values
integer(SHR_KIND_IN), intent(in) :: pid ! pid to send to
integer(SHR_KIND_IN), intent(in) :: tag ! tag
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
!----- local ---
character(*),parameter :: subName = '(shr_mpi_sendr0) '
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: ierr
!-------------------------------------------------------------------------------
! PURPOSE: Send a real scalar
!-------------------------------------------------------------------------------
lsize = 1
call MPI_SEND(lvec,lsize,MPI_REAL8,pid,tag,comm,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_sendr0
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_sendr1(lvec,pid,tag,comm,string)
IMPLICIT none
!----- arguments ---
real(SHR_KIND_R8), intent(in) :: lvec(:) ! in/out local values
integer(SHR_KIND_IN), intent(in) :: pid ! pid to send to
integer(SHR_KIND_IN), intent(in) :: tag ! tag
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
!----- local ---
character(*),parameter :: subName = '(shr_mpi_sendr1) '
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: ierr
!-------------------------------------------------------------------------------
! PURPOSE: Send a vector of reals
!-------------------------------------------------------------------------------
lsize = size(lvec)
call MPI_SEND(lvec,lsize,MPI_REAL8,pid,tag,comm,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_sendr1
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_sendr3(array,pid,tag,comm,string)
IMPLICIT none
!----- arguments ---
real (SHR_KIND_R8), intent(in) :: array(:,:,:) ! in/out local values
integer(SHR_KIND_IN), intent(in) :: pid ! pid to send to
integer(SHR_KIND_IN), intent(in) :: tag ! tag
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
!----- local ---
character(*),parameter :: subName = '(shr_mpi_sendr3) '
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: ierr
!-------------------------------------------------------------------------------
! PURPOSE: Send a vector of reals
!-------------------------------------------------------------------------------
lsize = size(array)
call MPI_SEND(array,lsize,MPI_REAL8,pid,tag,comm,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_sendr3
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_recvi0(lvec,pid,tag,comm,string)
IMPLICIT none
!----- arguments ---
integer(SHR_KIND_IN), intent(out):: lvec ! in/out local values
integer(SHR_KIND_IN), intent(in) :: pid ! pid to recv from
integer(SHR_KIND_IN), intent(in) :: tag ! tag
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
!----- local ---
character(*),parameter :: subName = '(shr_mpi_recvi0) '
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: status(MPI_STATUS_SIZE) ! mpi status info
integer(SHR_KIND_IN) :: ierr
!-------------------------------------------------------------------------------
! PURPOSE: Recv a vector of reals
!-------------------------------------------------------------------------------
lsize = 1
call MPI_RECV(lvec,lsize,MPI_INTEGER,pid,tag,comm,status,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_recvi0
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_recvi1(lvec,pid,tag,comm,string)
IMPLICIT none
!----- arguments ---
integer(SHR_KIND_IN), intent(out):: lvec(:) ! in/out local values
integer(SHR_KIND_IN), intent(in) :: pid ! pid to recv from
integer(SHR_KIND_IN), intent(in) :: tag ! tag
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
!----- local ---
character(*),parameter :: subName = '(shr_mpi_recvi1) '
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: status(MPI_STATUS_SIZE) ! mpi status info
integer(SHR_KIND_IN) :: ierr
!-------------------------------------------------------------------------------
! PURPOSE: Recv a vector of reals
!-------------------------------------------------------------------------------
lsize = size(lvec)
call MPI_RECV(lvec,lsize,MPI_INTEGER,pid,tag,comm,status,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_recvi1
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_recvr0(lvec,pid,tag,comm,string)
IMPLICIT none
!----- arguments ---
real(SHR_KIND_R8), intent(out):: lvec ! in/out local values
integer(SHR_KIND_IN), intent(in) :: pid ! pid to recv from
integer(SHR_KIND_IN), intent(in) :: tag ! tag
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
!----- local ---
character(*),parameter :: subName = '(shr_mpi_recvr0) '
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: status(MPI_STATUS_SIZE) ! mpi status info
integer(SHR_KIND_IN) :: ierr
!-------------------------------------------------------------------------------
! PURPOSE: Recv a vector of reals
!-------------------------------------------------------------------------------
lsize = 1
call MPI_RECV(lvec,lsize,MPI_REAL8,pid,tag,comm,status,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_recvr0
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_recvr1(lvec,pid,tag,comm,string)
IMPLICIT none
!----- arguments ---
real(SHR_KIND_R8), intent(out):: lvec(:) ! in/out local values
integer(SHR_KIND_IN), intent(in) :: pid ! pid to recv from
integer(SHR_KIND_IN), intent(in) :: tag ! tag
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
!----- local ---
character(*),parameter :: subName = '(shr_mpi_recvr1) '
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: status(MPI_STATUS_SIZE) ! mpi status info
integer(SHR_KIND_IN) :: ierr
!-------------------------------------------------------------------------------
! PURPOSE: Recv a vector of reals
!-------------------------------------------------------------------------------
lsize = size(lvec)
call MPI_RECV(lvec,lsize,MPI_REAL8,pid,tag,comm,status,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_recvr1
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_recvr3(array,pid,tag,comm,string)
IMPLICIT none
!----- arguments ---
real (SHR_KIND_R8), intent(out):: array(:,:,:) ! in/out local values
integer(SHR_KIND_IN), intent(in) :: pid ! pid to recv from
integer(SHR_KIND_IN), intent(in) :: tag ! tag
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
!----- local ---
character(*),parameter :: subName = '(shr_mpi_recvr3) '
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: status(MPI_STATUS_SIZE) ! mpi status info
integer(SHR_KIND_IN) :: ierr
!-------------------------------------------------------------------------------
! PURPOSE: Recv a vector of reals
!-------------------------------------------------------------------------------
lsize = size(array)
call MPI_RECV(array,lsize,MPI_REAL8,pid,tag,comm,status,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_recvr3
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_bcasti0(vec,comm,string,pebcast)
IMPLICIT none
!----- arguments ---
integer(SHR_KIND_IN), intent(inout):: vec ! vector of 1
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
integer(SHR_KIND_IN), optional, intent(in) :: pebcast ! bcast pe (otherwise zero)
!----- local ---
character(*),parameter :: subName = '(shr_mpi_bcasti0) '
integer(SHR_KIND_IN) :: ierr
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: lpebcast
!-------------------------------------------------------------------------------
! PURPOSE: Broadcast an integer
!-------------------------------------------------------------------------------
lsize = 1
lpebcast = 0
if (present(pebcast)) lpebcast = pebcast
call MPI_BCAST(vec,lsize,MPI_INTEGER,lpebcast,comm,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_bcasti0
SUBROUTINE shr_mpi_bcasti80(vec,comm,string,pebcast)
IMPLICIT none
!----- arguments ---
integer(SHR_KIND_I8), intent(inout):: vec ! vector of 1
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
integer(SHR_KIND_IN), optional, intent(in) :: pebcast ! bcast pe (otherwise zero)
!----- local ---
character(*),parameter :: subName = '(shr_mpi_bcasti0) '
integer(SHR_KIND_IN) :: ierr
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: lpebcast
!-------------------------------------------------------------------------------
! PURPOSE: Broadcast an integer
!-------------------------------------------------------------------------------
lsize = 1
lpebcast = 0
if (present(pebcast)) lpebcast = pebcast
call MPI_BCAST(vec,lsize,MPI_INTEGER8,lpebcast,comm,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_bcasti80
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_bcastl0(vec,comm,string,pebcast)
IMPLICIT none
!----- arguments ---
logical, intent(inout):: vec ! vector of 1
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
integer(SHR_KIND_IN), optional, intent(in) :: pebcast ! bcast pe (otherwise zero)
!----- local ---
character(*),parameter :: subName = '(shr_mpi_bcastl0) '
integer(SHR_KIND_IN) :: ierr
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: lpebcast
!-------------------------------------------------------------------------------
! PURPOSE: Broadcast a logical
!-------------------------------------------------------------------------------
lsize = 1
lpebcast = 0
if (present(pebcast)) lpebcast = pebcast
call MPI_BCAST(vec,lsize,MPI_LOGICAL,lpebcast,comm,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_bcastl0
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_bcastc0(vec,comm,string,pebcast)
IMPLICIT none
!----- arguments ---
character(len=*), intent(inout) :: vec ! vector of 1
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
integer(SHR_KIND_IN), optional, intent(in) :: pebcast ! bcast pe (otherwise zero)
!----- local ---
character(*),parameter :: subName = '(shr_mpi_bcastc0) '
integer(SHR_KIND_IN) :: ierr
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: lpebcast
!-------------------------------------------------------------------------------
! PURPOSE: Broadcast a character string
!-------------------------------------------------------------------------------
lsize = len(vec)
lpebcast = 0
if (present(pebcast)) lpebcast = pebcast
call MPI_BCAST(vec,lsize,MPI_CHARACTER,lpebcast,comm,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_bcastc0
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_bcastc1(vec,comm,string,pebcast)
IMPLICIT none
!----- arguments ---
character(len=*), intent(inout) :: vec(:) ! 1D vector
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
integer(SHR_KIND_IN), optional, intent(in) :: pebcast ! bcast pe (otherwise zero)
!----- local ---
character(*),parameter :: subName = '(shr_mpi_bcastc1) '
integer(SHR_KIND_IN) :: ierr
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: lpebcast
!-------------------------------------------------------------------------------
! PURPOSE: Broadcast a character string
!-------------------------------------------------------------------------------
lsize = size(vec)*len(vec)
lpebcast = 0
if (present(pebcast)) lpebcast = pebcast
call MPI_BCAST(vec,lsize,MPI_CHARACTER,lpebcast,comm,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_bcastc1
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_bcastr0(vec,comm,string,pebcast)
IMPLICIT none
!----- arguments ---
real(SHR_KIND_R8), intent(inout):: vec ! vector of 1
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
integer(SHR_KIND_IN), optional, intent(in) :: pebcast ! bcast pe (otherwise zero)
!----- local ---
character(*),parameter :: subName = '(shr_mpi_bcastr0) '
integer(SHR_KIND_IN) :: ierr
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: lpebcast
!-------------------------------------------------------------------------------
! PURPOSE: Broadcast a real
!-------------------------------------------------------------------------------
lsize = 1
lpebcast = 0
if (present(pebcast)) lpebcast = pebcast
call MPI_BCAST(vec,lsize,MPI_REAL8,lpebcast,comm,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_bcastr0
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_bcasti1(vec,comm,string,pebcast)
IMPLICIT none
!----- arguments ---
integer(SHR_KIND_IN), intent(inout):: vec(:) ! vector
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
integer(SHR_KIND_IN), optional, intent(in) :: pebcast ! bcast pe (otherwise zero)
!----- local ---
character(*),parameter :: subName = '(shr_mpi_bcasti1) '
integer(SHR_KIND_IN) :: ierr
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: lpebcast
!-------------------------------------------------------------------------------
! PURPOSE: Broadcast a vector of integers
!-------------------------------------------------------------------------------
lsize = size(vec)
lpebcast = 0
if (present(pebcast)) lpebcast = pebcast
call MPI_BCAST(vec,lsize,MPI_INTEGER,lpebcast,comm,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_bcasti1
SUBROUTINE shr_mpi_bcasti81(vec,comm,string,pebcast)
IMPLICIT none
!----- arguments ---
integer(SHR_KIND_I8), intent(inout):: vec(:) ! vector
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
integer(SHR_KIND_IN), optional, intent(in) :: pebcast ! bcast pe (otherwise zero)
!----- local ---
character(*),parameter :: subName = '(shr_mpi_bcasti1) '
integer(SHR_KIND_IN) :: ierr
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: lpebcast
!-------------------------------------------------------------------------------
! PURPOSE: Broadcast a vector of integers
!-------------------------------------------------------------------------------
lsize = size(vec)
lpebcast = 0
if (present(pebcast)) lpebcast = pebcast
call MPI_BCAST(vec,lsize,MPI_INTEGER8,lpebcast,comm,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_bcasti81
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_bcastl1(vec,comm,string,pebcast)
IMPLICIT none
!----- arguments ---
logical, intent(inout):: vec(:) ! vector of 1
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
integer(SHR_KIND_IN), optional, intent(in) :: pebcast ! bcast pe (otherwise zero)
!----- local ---
character(*),parameter :: subName = '(shr_mpi_bcastl1) '
integer(SHR_KIND_IN) :: ierr
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: lpebcast
!-------------------------------------------------------------------------------
! PURPOSE: Broadcast a logical
!-------------------------------------------------------------------------------
lsize = size(vec)
lpebcast = 0
if (present(pebcast)) lpebcast = pebcast
call MPI_BCAST(vec,lsize,MPI_LOGICAL,lpebcast,comm,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_bcastl1
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_bcastr1(vec,comm,string,pebcast)
IMPLICIT none
!----- arguments ---
real(SHR_KIND_R8), intent(inout):: vec(:) ! vector
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
integer(SHR_KIND_IN), optional, intent(in) :: pebcast ! bcast pe (otherwise zero)
!----- local ---
character(*),parameter :: subName = '(shr_mpi_bcastr1) '
integer(SHR_KIND_IN) :: ierr
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: lpebcast
!-------------------------------------------------------------------------------
! PURPOSE: Broadcast a vector of reals
!-------------------------------------------------------------------------------
lsize = size(vec)
lpebcast = 0
if (present(pebcast)) lpebcast = pebcast
call MPI_BCAST(vec,lsize,MPI_REAL8,lpebcast,comm,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_bcastr1
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_bcastr2(arr,comm,string,pebcast)
IMPLICIT none
!----- arguments -----
real(SHR_KIND_R8), intent(inout):: arr(:,:) ! array, 2d
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
integer(SHR_KIND_IN), optional, intent(in) :: pebcast ! bcast pe (otherwise zero)
!----- local -----
integer(SHR_KIND_IN) :: ierr
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: lpebcast
!----- formats -----
character(*),parameter :: subName = '(shr_mpi_bcastr2) '
!-------------------------------------------------------------------------------
! PURPOSE: Broadcast a 2d array of reals
!-------------------------------------------------------------------------------
lsize = size(arr)
lpebcast = 0
if (present(pebcast)) lpebcast = pebcast
call MPI_BCAST(arr,lsize,MPI_REAL8,lpebcast,comm,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_bcastr2
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_bcasti2(arr,comm,string,pebcast)
IMPLICIT none
!----- arguments -----
integer, intent(inout):: arr(:,:) ! array, 2d
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
integer(SHR_KIND_IN), optional, intent(in) :: pebcast ! bcast pe (otherwise zero)
!----- local -----
integer(SHR_KIND_IN) :: ierr
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: lpebcast
!----- formats -----
character(*),parameter :: subName = '(shr_mpi_bcasti2) '
!-------------------------------------------------------------------------------
! PURPOSE: Broadcast a 2d array of integers
!-------------------------------------------------------------------------------
lsize = size(arr)
lpebcast = 0
if (present(pebcast)) lpebcast = pebcast
call MPI_BCAST(arr,lsize,MPI_INTEGER,lpebcast,comm,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_bcasti2
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_bcastr3(arr,comm,string,pebcast)
IMPLICIT none
!----- arguments -----
real(SHR_KIND_R8), intent(inout):: arr(:,:,:) ! array, 3d
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
character(*),optional,intent(in) :: string ! message
integer(SHR_KIND_IN), optional, intent(in) :: pebcast ! bcast pe (otherwise zero)
!----- local -----
integer(SHR_KIND_IN) :: ierr
integer(SHR_KIND_IN) :: lsize
integer(SHR_KIND_IN) :: lpebcast
!----- formats -----
character(*),parameter :: subName = '(shr_mpi_bcastr3) '
!-------------------------------------------------------------------------------
! PURPOSE: Broadcast a 3d array of reals
!-------------------------------------------------------------------------------
lsize = size(arr)
lpebcast = 0
if (present(pebcast)) lpebcast = pebcast
call MPI_BCAST(arr,lsize,MPI_REAL8,lpebcast,comm,ierr)
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
END SUBROUTINE shr_mpi_bcastr3
!===============================================================================
!===============================================================================
SUBROUTINE shr_mpi_gathScatvInitr1(comm, rootid, locArr, glob1DArr, globSize, &
displs, string )
IMPLICIT none
!----- arguments -----
integer(SHR_KIND_IN), intent(in) :: comm ! mpi communicator
integer(SHR_KIND_IN), intent(in) :: rootid ! MPI task to gather/scatter on
real(SHR_KIND_R8), intent(in) :: locArr(:) ! Local array of distributed data
real(SHR_KIND_R8), pointer :: glob1DArr(:) ! Global 1D array of gathered data
integer(SHR_KIND_IN), pointer :: globSize(:) ! Size of each distributed piece
integer(SHR_KIND_IN), pointer :: displs(:) ! Displacements for receive
character(*),optional,intent(in) :: string ! message
!----- local -----
integer(SHR_KIND_IN) :: npes ! Number of MPI tasks
integer(SHR_KIND_IN) :: locSize ! Size of local distributed data
integer(SHR_KIND_IN), pointer :: sendSize(:) ! Size to send for initial gather
integer(SHR_KIND_IN) :: i ! Index
integer(SHR_KIND_IN) :: rank ! Rank of this MPI task
integer(SHR_KIND_IN) :: nSize ! Maximum size to send
integer(SHR_KIND_IN) :: ierr ! Error code
integer(SHR_KIND_IN) :: nSiz1D ! Size of 1D global array
integer(SHR_KIND_IN) :: maxSize ! Maximum size
!----- formats -----
character(*),parameter :: subName = '(shr_mpi_gathScatvInitr1) '
!-------------------------------------------------------------------------------
! PURPOSE: Setup arrays for a gatherv/scatterv operation
!-------------------------------------------------------------------------------
locSize = size(locarr)
call shr_mpi_commsize( comm, npes )
call shr_mpi_commrank( comm, rank )
allocate( globSize(npes) )
!
! --- Gather the send global sizes from each MPI task -----------------------
!
allocate( sendSize(npes) )
sendSize(:) = 1
globSize(:) = 1
call MPI_GATHER( locSize, 1, MPI_INTEGER, globSize, sendSize, &
MPI_INTEGER, rootid, comm, ierr )
if (present(string)) then
call shr_mpi_chkerr(ierr,subName//trim(string))
else
call shr_mpi_chkerr(ierr,subName)
endif
deallocate( sendSize )
!
! --- Prepare the displacement and allocate arrays -------------------------
!
allocate( displs(npes) )
displs(1) = 0
if ( rootid /= rank )then
maxSize = 1
globSize = 1