forked from uturuncoglu/RegESM
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmod_esmf_cop.F90
1715 lines (1714 loc) · 70.5 KB
/
mod_esmf_cop.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
!=======================================================================
! Regional Earth System Model (RegESM)
! Copyright (c) 2013-2017 Ufuk Turuncoglu
! Licensed under the MIT License.
!=======================================================================
#define FILENAME "mod_esmf_cop.F90"
!
!-----------------------------------------------------------------------
! COP gridded component code
!-----------------------------------------------------------------------
!
module mod_esmf_cop
!
!-----------------------------------------------------------------------
! Used module declarations
!-----------------------------------------------------------------------
!
use ESMF
use NUOPC
use NUOPC_Model, &
NUOPC_SetServices => SetServices, &
NUOPC_Label_Advance => label_Advance, &
NUOPC_Label_DataInitialize => label_DataInitialize, &
NUOPC_Label_SetClock => label_SetClock
!
use mod_types
use mod_shared
!
implicit none
private
!
!-----------------------------------------------------------------------
! Public subroutines
!-----------------------------------------------------------------------
!
public :: COP_SetServices
!
!-----------------------------------------------------------------------
! Component specific variables
!-----------------------------------------------------------------------
!
integer :: nports
character(255), allocatable :: input_ports(:)
character(ESMF_MAXSTR), allocatable, save :: gridnames(:)
!
integer :: tuw(3), tlw(3)
logical :: hasRight, hasLeft, hasTop, hasBottom
!
type(ESMF_RouteHandle), allocatable :: routeHandle(:)
!
interface
subroutine create_grid(name, nProc, myRank, dims, lb, ub, &
nPoints, lonCoord, latCoord, &
levCoord) bind(C, name="create_grid")
use iso_c_binding
character :: name
integer(c_int), value :: nProc
integer(c_int), value :: myRank
integer(c_int) :: dims(*)
integer(c_int) :: lb(*)
integer(c_int) :: ub(*)
integer(c_int), value :: nPoints
real(c_double) :: lonCoord(*)
real(c_double) :: latCoord(*)
real(c_double), optional :: levCoord(*)
end subroutine
end interface
!
contains
!
subroutine COP_SetServices(gcomp, rc)
implicit none
!
!-----------------------------------------------------------------------
! Imported variable declarations
!-----------------------------------------------------------------------
!
type(ESMF_GridComp) :: gcomp
integer, intent(out) :: rc
!
rc = ESMF_SUCCESS
!
!-----------------------------------------------------------------------
! Register NUOPC generic routines
!-----------------------------------------------------------------------
!
call NUOPC_CompDerive(gcomp, NUOPC_SetServices, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! Register initialize routines (Phase 1 and Phase 2)
!-----------------------------------------------------------------------
!
call ESMF_GridCompSetEntryPoint(gcomp, ESMF_METHOD_INITIALIZE, &
userRoutine=COP_SetInitializeP0, &
phase=0, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
call NUOPC_CompSetEntryPoint(gcomp, &
methodflag=ESMF_METHOD_INITIALIZE, &
phaseLabelList=(/"IPDv03p1"/), &
userRoutine=COP_SetInitializeP1, &
rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
call NUOPC_CompSetEntryPoint(gcomp, &
methodflag=ESMF_METHOD_INITIALIZE, &
phaseLabelList=(/"IPDv03p4"/), &
userRoutine=COP_SetInitializeP4, &
rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
call NUOPC_CompSetEntryPoint(gcomp, &
methodflag=ESMF_METHOD_INITIALIZE, &
phaseLabelList=(/"IPDv03p5"/), &
userRoutine=COP_SetInitializeP5, &
rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! Attach phase independent specializing methods
!-----------------------------------------------------------------------
!
call NUOPC_CompSpecialize(gcomp, &
specLabel=NUOPC_Label_DataInitialize, &
specRoutine=COP_DataInit, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
call NUOPC_CompSpecialize(gcomp, specLabel=NUOPC_Label_SetClock, &
specRoutine=COP_SetClock, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
call NUOPC_CompSpecialize(gcomp, specLabel=NUOPC_Label_Advance, &
specRoutine=COP_ModelAdvance, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
end subroutine COP_SetServices
!
subroutine COP_SetInitializeP0(gcomp, &
importState, &
exportState, &
clock, &
rc)
implicit none
!
!-----------------------------------------------------------------------
! Imported variable declarations
!-----------------------------------------------------------------------
!
type(ESMF_GridComp) :: gcomp
type(ESMF_State) :: importState, exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc
!
!-----------------------------------------------------------------------
! Local variable declarations
!-----------------------------------------------------------------------
!
logical :: file_exists
integer :: i, k, localPet, petCount, comm, nports, nf
character(255), allocatable :: pipelines(:)
!
type(ESMF_VM) :: vm
!
rc = ESMF_SUCCESS
!
!-----------------------------------------------------------------------
! Query component
!-----------------------------------------------------------------------
!
call ESMF_GridCompGet(gcomp, vm=vm, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
call ESMF_VMGet(vm, localPet=localPet, petCount=petCount, &
mpiCommunicator=comm, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! Switch to IPDv03 by filtering all other phaseMap entries
!-----------------------------------------------------------------------
!
call NUOPC_CompFilterPhaseMap(gcomp, ESMF_METHOD_INITIALIZE, &
acceptStringList=(/"IPDv03p"/), &
rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! Create list of input ports
!-----------------------------------------------------------------------
!
if (.not. allocated(input_ports)) then
k = 0
do i = 1, nModels
if (connectors(i,Icopro)%modActive) then
k = k+1
end if
end do
!
nports = k*2
allocate(input_ports(nports))
input_ports = ""
allocate(gridnames(nports))
gridnames = ""
!
k = 1
do i = 1, nModels
if (connectors(i,Icopro)%modActive) then
input_ports(k) = to_lower(trim(models(i)%name))// &
"_input2d"//char(0)
input_ports(k+1) = to_lower(trim(models(i)%name))// &
"_input3d"//char(0)
k = k+2
end if
end do
end if
!
if (localPet == models(Icopro)%petList(1)) then
do i = 1, nports
write(*,10) "[LOG "//trim(models(Icopro)%name)//"] - "// &
"input port [", i, "] is defined as "// &
trim(input_ports(i))
end do
end if
!
!-----------------------------------------------------------------------
! Allocate routehandle array for halo update
!-----------------------------------------------------------------------
!
if (.not. allocated(routeHandle)) then
allocate(routeHandle(nports))
end if
!
!-----------------------------------------------------------------------
! Initialize co-processor
!-----------------------------------------------------------------------
!
nf = ubound(coproc_fnames, dim=1)
if (.not. allocated(pipelines)) allocate(pipelines(nf))
!
do i = 1, nf
inquire(file=trim(coproc_fnames(i)), exist=file_exists)
if (file_exists) then
pipelines(i) = trim(coproc_fnames(i))//char(0)
else
if (localPet == models(Icopro)%petList(1)) then
write(*,20) "[ERROR "//trim(models(Icopro)%name)//"] - "// &
trim(coproc_fnames(i))//" not found! Exiting!"
end if
call ESMF_Finalize(endflag=ESMF_END_ABORT)
end if
end do
!
call my_coprocessorinitializewithpython(comm, pipelines, nf, &
input_ports, nports)
!
if (allocated(pipelines)) deallocate(pipelines)
!
!-----------------------------------------------------------------------
! Format definition
!-----------------------------------------------------------------------
!
10 format(A,I02,A)
20 format(A)
!
end subroutine COP_SetInitializeP0
!
subroutine COP_SetInitializeP1(gcomp, &
importState, &
exportState, &
clock, &
rc)
implicit none
!
!-----------------------------------------------------------------------
! Imported variable declarations
!-----------------------------------------------------------------------
!
type(ESMF_GridComp) :: gcomp
type(ESMF_State) :: importState
type(ESMF_State) :: exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc
!
!-----------------------------------------------------------------------
! Local variable declarations
!-----------------------------------------------------------------------
!
integer :: i
!
rc = ESMF_SUCCESS
!
!-----------------------------------------------------------------------
! Set import fields (one-way interaction, there is no export fields)
!-----------------------------------------------------------------------
!
do i = 1, ubound(models(Icopro)%importField, dim=1)
call NUOPC_Advertise(importState, &
StandardName=trim(models(Icopro)%importField(i)%long_name),&
name=trim(models(Icopro)%importField(i)%short_name), &
TransferOfferGeomObject="cannot provide", &
rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
end do
!
end subroutine COP_SetInitializeP1
!
subroutine COP_SetInitializeP4(gcomp, &
importState, &
exportState, &
clock, &
rc)
implicit none
!
!-----------------------------------------------------------------------
! Imported variable declarations
!-----------------------------------------------------------------------
!
type(ESMF_GridComp) :: gcomp
type(ESMF_State) :: importState, exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc
!
!-----------------------------------------------------------------------
! Local variable declarations
!-----------------------------------------------------------------------
!
integer :: i, j, k
integer :: itemCount, localDeCount, dimCount, tileCount
integer :: connectionCount, petCount, deCountPTile, extraDEs
integer, allocatable :: minIndexPTile(:,:), maxIndexPTile(:,:)
integer, allocatable :: regDecompPTile(:,:)
character(ESMF_MAXSTR), allocatable :: itemNameList(:)
character(ESMF_MAXSTR) :: gname
!
type(ESMF_Array) :: arrX
type(ESMF_Field) :: field
type(ESMF_Grid) :: grid
type(ESMF_DistGrid) :: distgrid
type(ESMF_DistGridConnection), allocatable :: connectionList(:)
!
!-----------------------------------------------------------------------
! Get list of import fields
!-----------------------------------------------------------------------
!
call ESMF_StateGet(importState, itemCount=itemCount, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
if (.not. allocated(itemNameList)) then
allocate(itemNameList(itemCount))
end if
!
call ESMF_StateGet(importState, itemNameList=itemNameList, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! Loop over import fields
!-----------------------------------------------------------------------
!
do i = 1, itemCount
!
!-----------------------------------------------------------------------
! Get field from import state
!-----------------------------------------------------------------------
!
call ESMF_StateGet(importState, trim(itemNameList(i)), &
field, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! Get grid from field
!-----------------------------------------------------------------------
!
call ESMF_FieldGet(field, grid=grid, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! Access localDeCount to show this is a real Grid
!-----------------------------------------------------------------------
!
call ESMF_GridGet(grid, localDeCount=localDeCount, &
distgrid=distgrid, name=gname, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! Query distgrid to get rank and tile information
!-----------------------------------------------------------------------
!
call ESMF_DistGridGet(distgrid, dimCount=dimCount, &
tileCount=tileCount, &
connectionCount=connectionCount, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! allocate minIndexPTile, maxIndexPTile and connectionList
!-----------------------------------------------------------------------
!
if (.not. allocated(minIndexPTile)) then
allocate(minIndexPTile(dimCount, tileCount), &
maxIndexPTile(dimCount, tileCount))
allocate(connectionList(connectionCount))
end if
!
!-----------------------------------------------------------------------
! Get minIndex and maxIndex arrays
!-----------------------------------------------------------------------
!
call ESMF_DistGridGet(distgrid, minIndexPTile=minIndexPTile, &
maxIndexPTile=maxIndexPTile, &
connectionList=connectionList, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! Construct a default regDecompPTile
!-----------------------------------------------------------------------
!
if (.not. allocated(regDecompPTile)) then
allocate(regDecompPTile(dimCount, tileCount))
end if
!
do k = 1, dimCount
if (k < 3) then
regDecompPTile(k, 1) = models(Icopro)%tile(3-k)
else
regDecompPTile(k, 1) = 1
end if
end do
!
!-----------------------------------------------------------------------
! Create the new DistGrid with the same minIndexPTile and
! maxIndexPTile but with a default regDecompPTile
!-----------------------------------------------------------------------
!
distgrid = ESMF_DistGridCreate(minIndexPTile=minIndexPTile, &
maxIndexPTile=maxIndexPTile, &
regDecompPTile=regDecompPTile, &
connectionList=connectionList, &
rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! Create a new Grid on the new DistGrid and swap it in the Field
!-----------------------------------------------------------------------
!
grid = ESMF_GridCreate(distgrid, name=trim(gname), rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
call ESMF_FieldEmptySet(field, grid=grid, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! Deallocate temporary arrays to free the memory
!-----------------------------------------------------------------------
!
if (allocated(minIndexPTile)) deallocate(minIndexPTile)
if (allocated(maxIndexPTile)) deallocate(maxIndexPTile)
if (allocated(connectionList)) deallocate(connectionList)
if (allocated(regDecompPTile)) deallocate(regDecompPTile)
!
end do
!
end subroutine COP_SetInitializeP4
!
subroutine COP_SetInitializeP5(gcomp, &
importState, &
exportState, &
clock, &
rc)
implicit none
!
!-----------------------------------------------------------------------
! Imported variable declarations
!-----------------------------------------------------------------------
!
type(ESMF_GridComp) :: gcomp
type(ESMF_State) :: importState, exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc
!
!-----------------------------------------------------------------------
! Local variable declarations
!-----------------------------------------------------------------------
!
integer :: i, j, k, localPet, rank, itemCount, localDECount
integer :: tileX, tileY
character(ESMF_MAXSTR), allocatable :: itemNameList(:)
real(ESMF_KIND_R8), pointer :: ptr2d(:,:)
real(ESMF_KIND_R8), pointer :: ptr3d(:,:,:)
!
type(ESMF_VM) :: vm
type(ESMF_Field) :: field
!
!-----------------------------------------------------------------------
! Query component
!-----------------------------------------------------------------------
!
call ESMF_GridCompGet(gcomp, vm=vm, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
call ESMF_VMGet(vm, localPet=localPet, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! Get list of import fields
!-----------------------------------------------------------------------
!
call ESMF_StateGet(importState, itemCount=itemCount, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
if (.not. allocated(itemNameList)) then
allocate(itemNameList(itemCount))
end if
!
call ESMF_StateGet(importState, itemNameList=itemNameList, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! Loop over import fields
!-----------------------------------------------------------------------
!
do i = 1, itemCount
!
k = get_varid(models(Icopro)%importField, trim(itemNameList(i)))
rank = models(Icopro)%importField(k)%rank
!
!-----------------------------------------------------------------------
! Get field from import state
!-----------------------------------------------------------------------
!
call ESMF_StateGet(importState, trim(itemNameList(i)), &
field, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! Allocate data by complete
! It also adds extra halo regions to top and right
!-----------------------------------------------------------------------
!
tileX = models(Icopro)%tile(1)
tileY = models(Icopro)%tile(2)
!
hasRight = .false.
if ((localPet/tileY+1) < tileX) hasRight = .true.
!
hasLeft = .false.
if ((localPet/tileY+1) > 1) hasLeft = .true.
!
hasTop = .false.
if (mod(localPet+1,tileY) /= 0) hasTop = .true.
!
hasBottom = .false.
if (mod(localPet,tileY) > 0) hasBottom = .true.
!
tuw = 0
tlw = 0
if (hasTop) tuw(1) = models(Icopro)%haloWidth
if (hasRight) tuw(2) = models(Icopro)%haloWidth
if (hasBottom) tlw(1) = models(Icopro)%haloWidth
if (hasLeft) tlw(2) = models(Icopro)%haloWidth
!
call ESMF_FieldEmptyComplete(field, &
typekind=ESMF_TYPEKIND_R8, &
totalLWidth=tlw(:rank), &
totalUWidth=tuw(:rank), &
rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! Get local DE count
!-----------------------------------------------------------------------
!
call ESMF_FieldGet(field, localDECount=localDECount, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! Loop over decomposition elements (DEs)
!-----------------------------------------------------------------------
!
do j = 0, localDECount-1
if (models(Icopro)%importField(k)%rank .eq. 2) then
!
!-----------------------------------------------------------------------
! Get pointer from field
!-----------------------------------------------------------------------
!
call ESMF_FieldGet(field, localDE=j, farrayPtr=ptr2d, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! Set initial value to missing
!-----------------------------------------------------------------------
!
ptr2d = MISSING_R8
!
!-----------------------------------------------------------------------
! Nullify pointer to make sure that it does not point on a random
! part in the memory
!-----------------------------------------------------------------------
!
if (associated(ptr2d)) then
nullify(ptr2d)
end if
!
else if (models(Icopro)%importField(k)%rank .eq. 3) then
!
!-----------------------------------------------------------------------
! Get pointer from field
!-----------------------------------------------------------------------
!
call ESMF_FieldGet(field, localDE=j, farrayPtr=ptr3d, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! Set initial value to missing
!-----------------------------------------------------------------------
!
ptr3d = MISSING_R8
!
!-----------------------------------------------------------------------
! Nullify pointer to make sure that it does not point on a random
! part in the memory
!-----------------------------------------------------------------------
!
if (associated(ptr3d)) then
nullify(ptr3d)
end if
!
end if
!
end do
!
end do
!
end subroutine COP_SetInitializeP5
!
subroutine COP_DataInit(gcomp, rc)
implicit none
!
!-----------------------------------------------------------------------
! Imported variable declarations
!-----------------------------------------------------------------------
!
type(ESMF_GridComp) :: gcomp
integer, intent(out) :: rc
!
!-----------------------------------------------------------------------
! Local variable declarations
!-----------------------------------------------------------------------
!
integer :: i, itemCount
!
type(ESMF_State) :: importState
!
!-----------------------------------------------------------------------
! Set attribute for data initialization
!-----------------------------------------------------------------------
!
call NUOPC_CompAttributeSet(gcomp, &
name="InitializeDataComplete", &
value="true", rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
end subroutine COP_DataInit
!
subroutine COP_SetClock(gcomp, rc)
implicit none
!
!-----------------------------------------------------------------------
! Imported variable declarations
!-----------------------------------------------------------------------
!
type(ESMF_GridComp) :: gcomp
integer, intent(out) :: rc
!
!-----------------------------------------------------------------------
! Local variable declarations
!-----------------------------------------------------------------------
!
integer :: fac1, fac2, maxdiv
!
type(ESMF_Clock) :: cmpClock
type(ESMF_TimeInterval) :: timeStep
!
rc = ESMF_SUCCESS
!
!-----------------------------------------------------------------------
! Get component clock
!-----------------------------------------------------------------------
!
call ESMF_GridCompGet(gcomp, clock=cmpClock, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
call ESMF_ClockGet(cmpClock, timeStep=timeStep, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
!-----------------------------------------------------------------------
! Modify component clock time step
!-----------------------------------------------------------------------
!
fac1 = maxval(connectors(Icopro,:)%divDT,mask=models(:)%modActive)
fac2 = maxval(connectors(:,Icopro)%divDT,mask=models(:)%modActive)
maxdiv = max(fac1, fac2)
!
call ESMF_ClockSet(cmpClock, name='cop_clock', &
timeStep=timeStep/maxdiv, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
end subroutine COP_SetClock
!
subroutine COP_ModelAdvance(gcomp, rc)
implicit none
!
!-----------------------------------------------------------------------
! Imported variable declarations
!-----------------------------------------------------------------------
!
type(ESMF_GridComp) :: gcomp
integer, intent(out) :: rc
!
!-----------------------------------------------------------------------
! Local variable declarations
!-----------------------------------------------------------------------
!
logical :: flag
integer :: i, j, k, its, tileX, tileY, rank
integer :: localPet, petCount, itemCount, dimCount, tileCount
integer :: nPoints2D, nPoints3D
integer :: cc2d(2), cc3d(3), lb(3), ub(3), dims(3)
integer, allocatable :: minIndexPTile(:,:), maxIndexPTile(:,:)
character(ESMF_MAXSTR) :: ofile, gname, rname, str1, str2
character(ESMF_MAXSTR), allocatable :: itemNameList(:)
real(ESMF_KIND_R8) :: stime, etime, dtime
real(ESMF_KIND_R8), dimension(:,:), pointer :: ptr2X
real(ESMF_KIND_R8), dimension(:,:), pointer :: ptr2Y
real(ESMF_KIND_R8), dimension(:,:,:), pointer :: ptr3X
real(ESMF_KIND_R8), dimension(:,:,:), pointer :: ptr3Y
real(ESMF_KIND_R8), dimension(:,:,:), pointer :: ptr3Z
real(ESMF_KIND_R8), allocatable, dimension(:) :: lon1d
real(ESMF_KIND_R8), allocatable, dimension(:) :: lat1d
real(ESMF_KIND_R8), allocatable, dimension(:) :: lev1d
real(ESMF_KIND_R8), allocatable, dimension(:,:) :: lon2d
real(ESMF_KIND_R8), allocatable, dimension(:,:) :: lat2d
real(ESMF_KIND_R8), allocatable, dimension(:,:,:) :: lon3d
real(ESMF_KIND_R8), allocatable, dimension(:,:,:) :: lat3d
real(ESMF_KIND_R8), allocatable, dimension(:,:,:) :: lev3d
real(ESMF_KIND_R8), dimension(:,:), pointer :: ptr2d
real(ESMF_KIND_R8), dimension(:,:,:), pointer :: ptr3d
real(ESMF_KIND_R8), allocatable, dimension(:) :: var1d
real(ESMF_KIND_R8), dimension(3) :: low, upp
!
type(ESMF_VM) :: vm
type(ESMF_Grid) :: grid
type(ESMF_Field) :: field
type(ESMF_Array) :: arrX, arrY, arrZ
type(ESMF_Clock) :: clock
type(ESMF_TimeInterval) :: elapsedTime, timeStep
type(ESMF_Time) :: startTime, currTime
type(ESMF_DistGrid) :: distgrid
type(ESMF_State) :: importState
!
rc = ESMF_SUCCESS
!
!-----------------------------------------------------------------------
! Query component
!-----------------------------------------------------------------------
!
call NUOPC_ModelGet(gcomp, modelClock=clock, &
importState=importState, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
!
call ESMF_GridCompGet(gcomp, vm=vm, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
!
call ESMF_VMGet(vm, localPet=localPet, petCount=petCount, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
!
!-----------------------------------------------------------------------
! Calculate elapsed time
!-----------------------------------------------------------------------
!
call ESMF_ClockGet(clock, currTime=currTime, &
startTime=startTime, timeStep=timeStep, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
!
call ESMF_TimeGet(currTime, &
timeStringISOFrac=str1, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
call ESMF_TimeGet(currTime+timeStep, &
timeStringISOFrac=str2, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) return
!
elapsedTime = currTime-startTime
!
call ESMF_TimeIntervalGet(elapsedTime, s_r8=dtime, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
!
its = int(elapsedTime/timeStep)
!
!-----------------------------------------------------------------------
! Get list of import fields
!-----------------------------------------------------------------------
!
call ESMF_StateGet(importState, itemCount=itemCount, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
!
if (.not. allocated(itemNameList)) then
allocate(itemNameList(itemCount))
end if
!
call ESMF_StateGet(importState, itemNameList=itemNameList, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
!
!-----------------------------------------------------------------------
! Loop over import fields
!-----------------------------------------------------------------------
!
j = 1
do i = 1, itemCount
!
!-----------------------------------------------------------------------
! Get field from import state
!-----------------------------------------------------------------------
!
call ESMF_StateGet(importState, trim(itemNameList(i)), &
field, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
!
!-----------------------------------------------------------------------
! Query underlying grid
!-----------------------------------------------------------------------
!
call ESMF_FieldGet(field, grid=grid, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
!
call ESMF_GridGet(grid, name=gname, distgrid=distgrid, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
!
!-----------------------------------------------------------------------
! Query distgrid to get rank and tile information
!-----------------------------------------------------------------------
!
call ESMF_DistGridGet(distgrid, dimCount=dimCount, &
tileCount=tileCount, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
!
!-----------------------------------------------------------------------
! Change grid name to be consistent with input ports of Catalyst
! NOTE: Component grids must be named as ocn_grid2d, ocn_grid3d, ...
!-----------------------------------------------------------------------
!
if (dimCount == 2) then
gname = replace_str(gname, "_grid2d", "_input2d")
else
gname = replace_str(gname, "_grid3d", "_input3d")
end if
!
!-----------------------------------------------------------------------
! allocate minIndexPTile, maxIndexPTile and connectionList
!-----------------------------------------------------------------------
!
if (.not. allocated(minIndexPTile)) then
allocate(minIndexPTile(dimCount, tileCount))
end if
!
if (.not. allocated(maxIndexPTile)) then
allocate(maxIndexPTile(dimCount, tileCount))
end if
!
!-----------------------------------------------------------------------
! Get minIndex and maxIndex arrays
!-----------------------------------------------------------------------
!
call ESMF_GridGetCoord(grid, coordDim=1, array=arrX, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
!
call ESMF_ArrayGet(arrX, minIndexPTile=minIndexPTile, &
maxIndexPTile=maxIndexPTile, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
!
!-----------------------------------------------------------------------
! Define grid in co-processor side if it is not already defined
!-----------------------------------------------------------------------
!
if (.not. check_grid(gname)) then
!
!-----------------------------------------------------------------------
! Collect grid coordinates to define in co-processing module
!-----------------------------------------------------------------------
!
if (dimCount == 2) then ! 2d
!
if (enablePerfCheck) then
call ESMF_VMWtime(stime, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
end if
!
call ESMF_GridGetCoord(grid, coordDim=1, farrayPtr=ptr2X, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
!
call ESMF_GridGetCoord(grid, coordDim=1, array=arrX, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
!
if (.not. allocated(lon2d)) then
allocate(lon2d(minIndexPTile(1,1):maxIndexPTile(1,1), &
minIndexPTile(2,1):maxIndexPTile(2,1)))
end if
!
do k = 1, models(Icopro)%nPets
call ESMF_ArrayGather(arrX, farray=lon2d, &
rootPet=k-1, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
end do
!
call ESMF_GridGetCoord(grid, coordDim=2, farrayPtr=ptr2Y, &
computationalCount=cc2d, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
!
call ESMF_GridGetCoord(grid, coordDim=2, array=arrY, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
!
if (.not. allocated(lat2d)) then
allocate(lat2d(minIndexPTile(1,1):maxIndexPTile(1,1), &
minIndexPTile(2,1):maxIndexPTile(2,1)))
end if
!
do k = 1, models(Icopro)%nPets
call ESMF_ArrayGather(arrY, farray=lat2d, &
rootPet=k-1, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=__FILE__)) return
end do
!
!-----------------------------------------------------------------------
! Calculate total number of 2d points in each MPI process
!-----------------------------------------------------------------------
!
nPoints2D = 1
if (hasTop) cc2d(1) = cc2d(1)+tuw(1)-1
if (hasRight) cc2d(2) = cc2d(2)+tuw(2)-1
if (hasBottom) cc2d(1) = cc2d(1)+tlw(1)-1
if (hasLeft) cc2d(2) = cc2d(2)+tlw(2)-1
!
do k = 1, 2
nPoints2D = nPoints2D*cc2d(k)