forked from HYCOM/HYCOM-src
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathHYCOM_OceanComp.F90
1195 lines (848 loc) · 37.3 KB
/
HYCOM_OceanComp.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
! ESMF macros for logging
#define FILENAME "HYCOM_Ocean_Comp.F90"
!#define CONTEXT __LINE__,FILENAME,METHOD
#define CONTEXT line=__LINE__,file=__FILE__
! Define ESMF real kind to match HYCOM single/double precision
#if defined(ESPC_IMPEXP_SINGLE)
#define ESMF_KIND_RX ESMF_KIND_R4
#define ESMF_TYPEKIND_RX ESMF_TYPEKIND_R4
#else
#define ESMF_KIND_RX ESMF_KIND_R8
#define ESMF_TYPEKIND_RX ESMF_TYPEKIND_R8
#endif
!=========================================================================================
! HYCOM OCEAN ESMF Module
!=========================================================================================
#if defined ESPC_OCN
MODULE OCEAN_Mod
#else
MODULE HYCOM_Mod
#endif
! ESMF Framework module
USE ESMF
use NUOPC
use NUOPC_Model, only: &
model_routine_SS => SetServices, &
model_label_Advance => label_Advance, &
model_label_Finalize => label_Finalize
! HYCOM OCEAN forecast module
use mod_hycom, only : end_of_run_cpl, &
end_of_run, &
HYCOM_Init, &
HYCOM_Run, &
HYCOM_Final
use mod_archiv, only: archiv_exchange
use hycom_couple, only: idim_size,jdim_size,deBList, &
lon_e,lat_e,mask_e,lon_q,lat_q, &
hycom_couple_init,hycom_couple_final,set_hycom_import_flag, &
import_to_hycom_deb, export_from_hycom_deb,ocn_import_forcing
# ifdef ESPC_COUPLE
use read_impexp_config_mod
use impexpField_cdf_mod
# endif
IMPLICIT NONE
PRIVATE
SAVE
! Public member functions
PUBLIC OCEAN_SetServices
! Miscellaneous
TYPE(ESMF_VM) :: vm
! INTEGER :: mpiCommunicator
INTEGER :: nPets, lPet
INTEGER, PARAMETER :: localDE=0
TYPE(ESMF_Clock) :: intClock
TYPE(ESMF_Config) :: config
real ocean_start_dtg, ocean_end_dtg
# ifdef ESPC_COUPLE
INTEGER :: numImpFields, numExpFields
type(ESMF_Field), dimension(:), allocatable :: impField
type(ESMF_Field), dimension(:), allocatable :: expField
character(len=30), pointer :: expFieldName(:),impFieldName(:) => NULL()
character(len=60), pointer :: expStandName(:),impStandName(:) => NULL()
character(len=30), pointer :: expFieldUnit(:),impFieldUnit(:) => NULL()
logical, pointer :: expFieldEnable(:),impFieldEnable(:) => NULL()
integer cdf_impexp_freq
real cpl_time_step
logical ocn_esmf_exp_output, ocn_esmf_imp_output, hycom_arche_output
!!Alex character (len=10) :: base_dtg
character (len=15) :: base_dtg
# endif
real endtime
integer itdmx,jtdmx
logical show_minmax
# ifdef ESPC_TIMER
real(kind=ESMF_KIND_R8) :: timer_beg,timer_end
! espc_timer(1): Init Phase
! espc_timer(2): Run Phase
! espc_timer(3): Final Phase
! espc_timer(4): Run Phase import
! espc_timer(5): Run Phase Core
! espc_timer(6): Run Phase export
real(kind=ESMF_KIND_R8) :: espc_timer(6)
# endif
!=========================================================================================
! HYCOM OCEAN ESMF Module Subroutines
!=========================================================================================
CONTAINS
#undef METHOD
#define METHOD "OCEAN_SetServices"
SUBROUTINE OCEAN_SetServices(model, rc)
! Calling parameters
TYPE(ESMF_GridComp) :: model
INTEGER,INTENT(OUT) :: rc
! Assume failure
rc = ESMF_FAILURE
! the NUOPC model component will register the generic methods
call NUOPC_CompDerive(model, model_routine_SS, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, CONTEXT)) RETURN
! set entry point for methods that require specific implementation
call NUOPC_CompSetEntryPoint(model, ESMF_METHOD_INITIALIZE, &
phaseLabelList=(/"IPDv00p1"/), userRoutine=InitializeP1, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, CONTEXT)) RETURN
call NUOPC_CompSetEntryPoint(model, ESMF_METHOD_INITIALIZE, &
phaseLabelList=(/"IPDv00p2"/), userRoutine=InitializeP2, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, CONTEXT)) RETURN
! attach specializing method(s)
call NUOPC_CompSpecialize(model, specLabel=model_label_Advance, &
specRoutine=ModelAdvance, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, CONTEXT)) RETURN
call NUOPC_CompSpecialize(model, specLabel=model_label_Finalize, &
specRoutine=OCEAN_Final, rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="set final entry point failed", CONTEXT)) RETURN
! Return success
rc = ESMF_SUCCESS
END SUBROUTINE OCEAN_SetServices
!======================================================================
#undef METHOD
#define METHOD "InitializeP1"
SUBROUTINE InitializeP1(model, importState, exportState, clock, rc)
type(ESMF_GridComp) :: model
type(ESMF_State) :: importState, exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc
integer i,irc
# ifdef ESPC_COUPLE
character(len=30) :: ocn_impexp_file
# endif
INTEGER :: cpl_hour, cpl_min, cpl_sec
rc = ESMF_SUCCESS
! Get VM and Config info
CALL ESMF_GridCompGet(model,config=config, vm=vm, rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="GridCompGet failed", CONTEXT)) RETURN
CALL ESMF_VMGet(vm, petCount=nPets,localPet=lPet,rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="VMGet failed", CONTEXT)) RETURN
if(lPet.eq.0) print *,"hycom, InitializeP1 called,nPets=",nPets
# ifdef ESPC_TIMER
do i=1,6
espc_timer(i)=0.
enddo
call ESMF_VMBarrier(vm, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
call ESMF_VMWtime(timer_beg, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
# endif
# ifdef ESPC_COUPLE
CALL ESMF_ConfigGetAttribute(config, cdf_impexp_freq, &
label=TRIM("cdf_impexp_freq="), default=9999, rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="config get cdf_impexp_freq failed", &
CONTEXT, rcToReturn=rc)) RETURN
CALL ESMF_ConfigGetAttribute(config, cpl_hour, &
label=TRIM("cpl_hour="), default=0, rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="config get cpl_hour failed", &
CONTEXT, rcToReturn=rc)) RETURN
CALL ESMF_ConfigGetAttribute(config, cpl_min, &
label=TRIM("cpl_min="), default=0, rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="config get cpl_min failed", &
CONTEXT, rcToReturn=rc)) RETURN
CALL ESMF_ConfigGetAttribute(config, cpl_sec, &
label=TRIM("cpl_sec="), default=0, rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="config get cpl_sec failed", &
CONTEXT, rcToReturn=rc)) RETURN
cpl_time_step=(cpl_hour+cpl_min/60.+cpl_sec/3600.)
CALL ESMF_ConfigGetAttribute(config, base_dtg, &
label=TRIM("base_dtg="), default='9999999999', rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="config get base_dtg failed", &
CONTEXT, rcToReturn=rc)) RETURN
CALL ESMF_ConfigGetAttribute(config, hycom_arche_output, &
label=TRIM("hycom_arche_output="), default=.true., rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="config get hycom_arche_output failed", &
CONTEXT, rcToReturn=rc)) RETURN
#if defined ESPC_OCN
CALL ESMF_ConfigGetAttribute(config, ocn_esmf_exp_output, &
label=TRIM("ocn_esmf_exp_output="), default=.true., rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="config get ocn_esmf_output failed", &
CONTEXT, rcToReturn=rc)) RETURN
#else
CALL ESMF_ConfigGetAttribute(config, ocn_esmf_exp_output, &
label=TRIM("hyc_esmf_exp_output="), default=.true., rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="config get hyc_esmf_output failed", &
CONTEXT, rcToReturn=rc)) RETURN
#endif
#if defined ESPC_OCN
CALL ESMF_ConfigGetAttribute(config, ocn_esmf_imp_output, &
label=TRIM("ocn_esmf_imp_output="), default=.true., rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="config get ocn_esmf_output failed", &
CONTEXT, rcToReturn=rc)) RETURN
#else
CALL ESMF_ConfigGetAttribute(config, ocn_esmf_imp_output, &
label=TRIM("hyc_esmf_imp_output="), default=.true., rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="config get hyc_esmf_output failed", &
CONTEXT, rcToReturn=rc)) RETURN
#endif
#if defined ESPC_OCN
CALL ESMF_ConfigGetAttribute(config, ocn_impexp_file, &
label=TRIM("ocn_impexp_file="), rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="config get ocn_impexp_file failed", &
CONTEXT, rcToReturn=rc)) RETURN
#else
CALL ESMF_ConfigGetAttribute(config, ocn_impexp_file, &
label=TRIM("hyc_impexp_file="), rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="config get hyc_impexp_file failed", &
CONTEXT, rcToReturn=rc)) RETURN
#endif
ocn_impexp_file=trim(ocn_impexp_file)
if(lPet.eq.0) print *,"ocn_impexp_file=",ocn_impexp_file
call read_impexp_config(ocn_impexp_file,numExpFields,numImpFields,expFieldName,impFieldName, &
expStandName,impStandName,expFieldUnit,impFieldUnit, &
expFieldEnable,impFieldEnable,irc)
allocate(impField(numImpFields))
allocate(expField(numExpFields))
if(lPet.eq.0) print *,"hycom,expFieldName=",(expFieldName(i),i=1,numExpFields)
if(lPet.eq.0) print *,"hycom,expFieldEnable=",(expFieldEnable(i),i=1,numExpFields)
if(lPet.eq.0) print *,"hycom,impFieldName=",(impFieldName(i),i=1,numImpFields)
if(lPet.eq.0) print *,"hycom,impFieldEnable=",(impFieldEnable(i),i=1,numImpFields)
do i=1,numImpFields
if(impFieldEnable(i)) then
if(lPet.eq.0) print *,"hycom,import field advertised, name=",impFieldName(i),impStandName(i)
call NUOPC_Advertise(importState, name=impFieldName(i), &
StandardName=impStandName(i), rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, CONTEXT)) RETURN
endif
enddo
do i=1,numExpFields
if(expFieldEnable(i)) then
if(lPet.eq.0) print *,"hycom,export field advertised, name=",expFieldName(i),expStandName(i)
call NUOPC_Advertise(exportState, name=expFieldName(i), &
StandardName=expStandName(i), rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, CONTEXT)) RETURN
endif
enddo
#endif
CALL ESMF_ConfigGetAttribute(config, show_minmax, &
label=TRIM("espc_show_impexp_minmax="), default=.true., rc=rc)
!#ifdef ESPC_SHOW_IMPEXP_MINMAX
! show_minmax=.true.
!#else
! show_minmax=.false.
!#endif
# ifdef ESPC_TIMER
call ESMF_VMBarrier(vm, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
call ESMF_VMWtime(timer_end, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
espc_timer(1)=timer_end-timer_beg
! if(lPet.eq.0) print *,"hycom, InitializeP1, timer=",espc_timer(1)
call print_timer_stat('hycom, Init1:',timer_end-timer_beg,lPet,nPets,vm,rc)
# endif
if(lPet.eq.0) print *,"hycom, InitializeP1 end called..."
END SUBROUTINE InitializeP1
!======================================================================
#undef METHOD
#define METHOD "InitializeP2"
subroutine InitializeP2(model, importState, exportState, clock, rc)
type(ESMF_GridComp) :: model
type(ESMF_State) :: importState, exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc
! local variables
type(ESMF_Grid) :: gridIn
type(ESMF_Grid) :: gridOut
# ifdef ESPC_COUPLE
INTEGER :: tlb(2), tub(2)
INTEGER(ESMF_KIND_I4), POINTER :: iptr(:,:)
REAL(ESMF_KIND_R8), POINTER :: fptr(:,:)
# endif
integer :: i,j
integer decomp(2)
INTEGER :: end_hour,end_min,end_sec
INTEGER :: start_hour,start_min,start_sec
real*8 h_start_dtg,h_end_dtg
integer mpiCommunicator
type(ESMF_DistGrid) :: ocnDistGrid
type(ESMF_DistGridConnection), allocatable, dimension(:) :: connectionList
# ifdef ESPC_COUPLE
type(ESMF_Field) :: lon_field, lat_field,mask_field
real(ESMF_KIND_R8), dimension(:,:), pointer :: lon_data,lat_data,mask_data
type(ESMF_ArraySpec) :: arraySpec2Dr
real(kind=ESMF_KIND_R8), allocatable, dimension(:,:) :: tmp_e
integer status
# endif
rc = ESMF_SUCCESS
if(lPet.eq.0) print *,"hycom, InitializeP2 called"
# ifdef ESPC_TIMER
call ESMF_VMBarrier(vm, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
call ESMF_VMWtime(timer_beg, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
# endif
! HYCOM Start DTG
CALL ESMF_ConfigGetAttribute(config, ocean_start_dtg, &
label=TRIM("ocean_start_dtg="), rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="config get start_dtg failed", &
CONTEXT, rcToReturn=rc)) RETURN
CALL ESMF_ConfigGetAttribute(config, start_hour, &
label=TRIM("start_hour="), default=0, rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="config get start_hour failed", &
CONTEXT, rcToReturn=rc)) RETURN
CALL ESMF_ConfigGetAttribute(config, start_min, &
label=TRIM("start_min="), default=0, rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="config get start_min failed", &
CONTEXT, rcToReturn=rc)) RETURN
CALL ESMF_ConfigGetAttribute(config, start_sec, &
label=TRIM("start_sec="), default=0, rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="config get start_sec failed", &
CONTEXT, rcToReturn=rc)) RETURN
! End time
CALL ESMF_ConfigGetAttribute(config, end_hour, &
label=TRIM("end_hour="), default=0, rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="config get end_hour failed", &
CONTEXT, rcToReturn=rc)) RETURN
CALL ESMF_ConfigGetAttribute(config, end_min, &
label=TRIM("end_min="), default=0, rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="config get end_min failed", &
CONTEXT, rcToReturn=rc)) RETURN
CALL ESMF_ConfigGetAttribute(config, end_sec, &
label=TRIM("end_sec="), default=0, rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="config get end_sec failed", &
CONTEXT, rcToReturn=rc)) RETURN
if (ocean_start_dtg.lt.0.0) then
! start from rest
ocean_start_dtg=-ocean_start_dtg
h_start_dtg=(start_hour+start_min/60.+start_sec/3600.)/24.+ocean_start_dtg
h_end_dtg=(end_hour+end_min/60.+end_sec/3600.)/24.+ocean_start_dtg
h_start_dtg=-h_start_dtg
else
! normal start
h_start_dtg=(start_hour+start_min/60.+start_sec/3600.)/24.+ocean_start_dtg
h_end_dtg=(end_hour+end_min/60.+end_sec/3600.)/24.+ocean_start_dtg
endif
! h_end_dtg=(end_hour+end_min/60.+end_sec/3600.)/24.+ocean_start_dtg
! h_start_dtg=(start_hour+start_min/60.+start_sec/3600.)/24.+ocean_start_dtg
if(lPet.eq.0) then
print *,"HYCOM_OceanComp, HYCOM_Init called..."
print *,"end_hour,end_min,end_sec=",end_hour,end_min,end_sec
print *,"h_start_dtg,h_end_dtg=",h_start_dtg,h_end_dtg
endif
CALL ESMF_VMGet(vm, mpiCommunicator=mpiCommunicator,rc=rc)
! Call into ocean init
CALL HYCOM_Init(mpiCommunicator,h_start_dtg,h_end_dtg)
# ifdef ESPC_COUPLE
!!Alex call ocn_import_init()
do i=1,numImpFields
if(impFieldEnable(i)) then
call set_hycom_import_flag(i,impFieldName(i))
endif
enddo
# endif
call hycom_couple_init(nPets,rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="hycom_couple_init failed", CONTEXT)) RETURN
if(lPet.eq.0) print *,"hycom, InitializeP2 called 2,idim_size,jdim_size", &
idim_size,jdim_size
#if defined(ARCTIC)
itdmx=idim_size; jtdmx=jdim_size-1
#else
itdmx=idim_size; jtdmx=jdim_size
#endif
if(lPet.eq.0) print *,"hycom, itdmx,jtdmx..=",itdmx,jtdmx
# ifdef ESPC_COUPLE
if(lPet.eq.0) then
allocate(tmp_e(itdmx,jtdmx))
else
allocate(tmp_e(1,1))
endif
#endif
# ifdef ESPC_COUPLE
allocate(connectionList(1)) ! one connection
call ESMF_DistGridConnectionSet(connection=connectionList(1), &
tileIndexA=1, tileIndexB=1, positionVector=(/itdmx, 0/), rc=rc)
ocnDistGrid = ESMF_DistGridCreate(minIndex=(/1,1/), maxIndex=(/itdmx,jtdmx/), &
indexflag=ESMF_INDEX_GLOBAL, &
deBlockList=deBList,connectionList=connectionList,rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="grid create failed", CONTEXT)) RETURN
gridIn = ESMF_GridCreate(distGrid=ocnDistGrid, &
indexflag=ESMF_INDEX_GLOBAL, &
coordSys=ESMF_COORDSYS_SPH_DEG, &
name="OCEAN:grid", rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="grid create failed", CONTEXT)) RETURN
if(allocated(connectionList))deallocate(connectionList)
#else
do i=int(sqrt(real(nPets))),2,-1
if(mod(nPets,i).eq.0) exit
enddo
decomp=(/nPets/i,i/)
if(lPet.eq.0) print *,"nPets,decomp=",nPets,decomp
gridIn = ESMF_GridCreate1PeriDim(minIndex=(/1,1/), maxIndex=(/idim_size,jdim_size/), &
indexflag=ESMF_INDEX_GLOBAL, &
regDecomp=decomp, name="OCEAN:grid", rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="grid create failed", CONTEXT)) RETURN
#endif
# ifdef ESPC_COUPLE
! Add ESMF grid coordinate arrays
CALL ESMF_GridAddCoord(gridIn, staggerLoc=ESMF_STAGGERLOC_CENTER, rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="grid add coord failed", CONTEXT)) RETURN
! Add ESMF mask array
CALL ESMF_GridAddItem(gridIn, itemflag=ESMF_GRIDITEM_MASK, &
staggerLoc=ESMF_STAGGERLOC_CENTER, rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="grid add mask failed", CONTEXT)) RETURN
if((ocn_esmf_imp_output.or.ocn_esmf_exp_output).and.lPet.eq.0) then
call impexp_cdf_put_latlonmsk('hycom',itdmx,jtdmx,lat_e, &
lon_e,mask_e,status,rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="impexp_cdf_put_latlonmsk failed", CONTEXT)) RETURN
call impexp_cdf_put_latlonmsk('hycom-orig',idim_size,jdim_size,lat_e, &
lon_e,mask_e,status,rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="impexp_cdf_put_latlonmsk failed", CONTEXT)) RETURN
call impexp_cdf_put_latlonmsk_corner('hycom',idim_size,jdim_size,lat_e,lon_e,int(mask_e),lat_q, &
lon_q,status,rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="impexp_cdf_put_latlonmsk_corner failed", CONTEXT)) RETURN
endif
CALL ESMF_ArraySpecSet(arraySpec2Dr, rank=2, typekind=ESMF_TYPEKIND_R8, rc=rc)
lon_field = ESMF_FieldCreate(gridIn, arraySpec2Dr, &
indexFlag=ESMF_INDEX_GLOBAL, staggerLoc=ESMF_STAGGERLOC_CENTER, &
name=TRIM("lon_field"), rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
if(lPet.eq.0) then
do i=1,itdmx
do j=1,jtdmx
tmp_e(i,j)=lon_e(i,j)
enddo
enddo
endif
call ESMF_FieldScatter(lon_field,tmp_e,rootPet=0,rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
lat_field = ESMF_FieldCreate(gridIn, arraySpec2Dr, &
indexFlag=ESMF_INDEX_GLOBAL, staggerLoc=ESMF_STAGGERLOC_CENTER, &
name=TRIM("lat_field"), rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
if(lPet.eq.0) then
do i=1,itdmx
do j=1,jtdmx
tmp_e(i,j)=lat_e(i,j)
enddo
enddo
endif
call ESMF_FieldScatter(lat_field,tmp_e,rootPet=0,rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
mask_field = ESMF_FieldCreate(gridIn, arraySpec2Dr, &
indexFlag=ESMF_INDEX_GLOBAL, staggerLoc=ESMF_STAGGERLOC_CENTER, &
name=TRIM("mask_field"), rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
if(lPet.eq.0) then
do i=1,itdmx
do j=1,jtdmx
tmp_e(i,j)=mask_e(i,j)
enddo
enddo
endif
call ESMF_FieldScatter(mask_field,tmp_e,rootPet=0,rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
call ESMF_FieldGet(lon_field,localDE,lon_data,rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
call ESMF_FieldGet(lat_field,localDE,lat_data,rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
call ESMF_FieldGet(mask_field,localDE,mask_data,rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
! Copy in coordinate data
CALL ESMF_GridGetCoord(gridIn, localDE=localDE, coordDim=1, &
staggerLoc=ESMF_STAGGERLOC_CENTER, &
totalLBound=tlb, totalUBound=tub, farrayPtr=fptr, rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="grid get coord 1 failed", CONTEXT)) RETURN
! fptr(tlb(1):tub(1),tlb(2):tub(2)) = lon_e(tlb(1):tub(1),tlb(2):tub(2))
fptr(tlb(1):tub(1),tlb(2):tub(2)) = lon_data(tlb(1):tub(1),tlb(2):tub(2))
CALL ESMF_GridGetCoord(gridIn, localDE=localDE, coordDim=2, &
staggerLoc=ESMF_STAGGERLOC_CENTER, &
totalLBound=tlb, totalUBound=tub, farrayPtr=fptr, rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="grid get coord 2 failed", CONTEXT)) RETURN
! fptr(tlb(1):tub(1),tlb(2):tub(2)) = lat_e(tlb(1):tub(1),tlb(2):tub(2))
fptr(tlb(1):tub(1),tlb(2):tub(2)) = lat_data(tlb(1):tub(1),tlb(2):tub(2))
! Copy in land/sea mask (integer)
CALL ESMF_GridGetItem(gridIn, localDE=localDE, itemflag=ESMF_GRIDITEM_MASK, &
staggerLoc=ESMF_STAGGERLOC_CENTER, &
totalLBound=tlb, totalUBound=tub, farrayPtr=iptr, rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="grid get mask failed", CONTEXT)) RETURN
! iptr(tlb(1):tub(1),tlb(2):tub(2)) = NINT(mask_e(tlb(1):tub(1),tlb(2):tub(2)))
iptr(tlb(1):tub(1),tlb(2):tub(2)) = NINT(mask_data(tlb(1):tub(1),tlb(2):tub(2)))
call ESMF_FieldDestroy(lon_field,rc=rc)
call ESMF_FieldDestroy(lat_field,rc=rc)
call ESMF_FieldDestroy(mask_field,rc=rc)
# endif
gridOut = gridIn ! for now out same as in
# ifdef ESPC_COUPLE
do i=1,numImpFields
if(impFieldEnable(i)) then
if(lPet.eq.0) print *,"hycom, import field created, name=",impFieldName(i)
impField(i) = ESMF_FieldCreate(name=impFieldName(i), grid=gridIn, &
typekind=ESMF_TYPEKIND_RX, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
call NUOPC_Realize(importState, field=impField(i), rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
endif
enddo
do i=1,numExpFields
if(expFieldEnable(i)) then
if(lPet.eq.0) print *,"hycom, export field created, name=",expFieldName(i)
! exportable field:
expField(i) = ESMF_FieldCreate(name=expFieldName(i), grid=gridOut, &
typekind=ESMF_TYPEKIND_RX, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
call NUOPC_Realize(exportState, field=expField(i), rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
if(lPet.eq.0) print *,"hycom, export field done creating, name=",expFieldName(i)
endif
enddo
do i=1,numExpFields
if(expFieldEnable(i)) then
call do_export(i,expField(i),rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
endif
enddo
endtime=0
if(ocn_esmf_exp_output.and.(mod(endtime,float(cdf_impexp_freq)).eq.0)) then
call impexp_cdf_put_flds('hycom', base_dtg, endtime, &
itdmx,jtdmx, &
numExpFields,expFieldEnable,expFieldName,expStandName,expFieldUnit,expField, &
status,lPet,rc,'exp')
IF (ESMF_LogFoundError(rcToCheck=rc, msg="impexp_cdf_put_flds failed", CONTEXT)) RETURN
endif
deallocate(tmp_e)
#endif
call hycom_couple_final()
# ifdef ESPC_TIMER
call ESMF_VMBarrier(vm, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
call ESMF_VMWtime(timer_end, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
espc_timer(1)=espc_timer(1)+timer_end-timer_beg
! if(lPet.eq.0) print *,"hycom, InitializeP2,timer=",espc_timer(1),timer_end-timer_beg
call print_timer_stat('hycom, Init2:',timer_end-timer_beg,lPet,nPets,vm,rc)
# endif
if(lPet.eq.0) print *,"hycom, InitializeP2 end called..."
END SUBROUTINE InitializeP2
!======================================================================
#undef METHOD
#define METHOD "ModelAdvance"
SUBROUTINE ModelAdvance(model, rc)
type(ESMF_GridComp) :: model
integer, intent(out) :: rc
! local variables
type(ESMF_Clock) :: clock
type(ESMF_State) :: importState, exportState
integer i,status
!!!!
TYPE(ESMF_Time) :: extCurrTime
TYPE(ESMF_Time) :: extRefTime
Type(ESMF_TimeInterval) :: extTimeStep
character(ESMF_MAXSTR) :: currtimeString,reftimeString
TYPE(ESMF_TimeInterval) :: extTimeSinceStart
real(kind=ESMF_KIND_R8) :: extSecSinceStarti
real(kind=ESMF_KIND_R8) :: extSecTimeStep
real begtime
real*8 endtime8
real endtimex
# ifdef ESPC_TIMER
real(kind=ESMF_KIND_R8) :: timer_tmp_beg,timer_tmp_end
# endif
rc = ESMF_SUCCESS
if(lPet.eq.0) print *,"hycom, ModelAdvance called"
! return
# ifdef ESPC_TIMER
call ESMF_VMBarrier(vm, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
call ESMF_VMWtime(timer_beg, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
# endif
! query the Component for its clock, importState and exportState
call ESMF_GridCompGet(model, clock=clock, importState=importState, &
exportState=exportState, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
!!!!!!
! Compute the step count from the external clock
CALL ESMF_ClockGet(clock, currTime=extCurrTime, refTime=extRefTime, &
timeStep=extTimeStep,rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="Get extCurrTime failed", CONTEXT)) RETURN
call ESMF_TimeGet(extCurrTime,timeString=currtimeString)
call ESMF_TimeGet(extRefTime,timeString=reftimeString)
! if(lPet.eq.0) print *,"hycom,extCurrTime, extRefTime=",currtimeString,reftimeString
! Elapsed time in seconds for internal clock
extTimeSinceStart = extCurrTime - extRefTime
CALL ESMF_TimeIntervalGet(extTimeSinceStart, s_r8=extSecSinceStarti, rc=rc)
CALL ESMF_TimeIntervalGet(extTimeStep, s_r8=extSecTimeStep, rc=rc)
IF (ESMF_LogFoundError(rcToCheck=rc, msg="Get time interval failed", CONTEXT)) RETURN
if(lPet.eq.0) print *,"hycom,extSecTimeStep=",extSecTimeStep
begtime=extSecSinceStarti/3600.
endtime=(extSecSinceStarti+extSecTimeStep)/3600.
if(lPet.eq.0) print *,"hycom,begtime,endtime=",begtime,endtime
endtime=endtime+ocean_start_dtg*24
! Run atmos forward
if(lPet.eq.0) print *,"HYCOM_OceanCom, ModelAdvance, Run ocean forward...,endtime=",endtime/24
# ifdef ESPC_COUPLE
endtimex=endtime-ocean_start_dtg*24
if(ocn_esmf_imp_output.and.( (mod(endtimex,float(cdf_impexp_freq)).eq.0 .or. &
endtimex.eq.0.5) )) then
call impexp_cdf_put_flds('hycom', base_dtg, endtimex-cpl_time_step, &
itdmx,jtdmx, &
numImpFields,impFieldEnable,impFieldName,impStandName,impFieldUnit,impField,status, &
lPet,rc,'imp')
IF (ESMF_LogFoundError(rcToCheck=rc, msg="impexp_cdf_put_flds failed", CONTEXT)) RETURN
endif
# ifdef ESPC_TIMER
call ESMF_VMBarrier(vm, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
call ESMF_VMWtime(timer_tmp_beg, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
# endif
do i=1,numImpFields
if(impFieldEnable(i)) then
call do_import(i,impField(i),.false.,rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
endif
enddo
# ifdef ESPC_TIMER
call ESMF_VMBarrier(vm, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
call ESMF_VMWtime(timer_tmp_end, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
espc_timer(4)=espc_timer(4)+timer_tmp_end-timer_tmp_beg
call print_timer_stat('hycom, Run(Import):',timer_tmp_end-timer_tmp_beg,lPet,nPets,vm,rc)
# endif
! call redef_radflx()
!ajw
!move to mod_hycom.F
# ifdef ESPC_COUPLE
call ocn_import_forcing()
if(hycom_arche_output .and. begtime.eq.0) &
call archiv_exchange !arche file of fields exchanged with ice component
#endif
# endif
! HERE THE MODEL ADVANCES: currTime -> currTime + timeStep
! Because of the way that the internal Clock was set in InitializeP2()
! its timeStep is equal to the parent timeStep. As a consequence the
! currTime + timeStep is equal to the stopTime of the internal Clock
! for this call of the ModelAdvance() routine.
if(lPet.eq.0) then
call ESMF_ClockPrint(clock, options="currTime",&
preString="------>Advancing OCN from: ", rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
call ESMF_ClockPrint(clock, options="stopTime",&
preString="--------------------------------> to: ", rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
endif
endtime8=endtime
# ifdef ESPC_TIMER
call ESMF_VMBarrier(vm, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
call ESMF_VMWtime(timer_tmp_beg, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
# endif
do !until end of run
CALL HYCOM_Run(endtime8/24)
if (end_of_run .or. end_of_run_cpl ) then
exit
endif
enddo
# ifdef ESPC_TIMER
call ESMF_VMBarrier(vm, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
call ESMF_VMWtime(timer_tmp_end, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
espc_timer(5)=espc_timer(5)+timer_tmp_end-timer_tmp_beg
call print_timer_stat('hycom, Run(Core):',timer_tmp_end-timer_tmp_beg,lPet,nPets,vm,rc)
# endif
# ifdef ESPC_COUPLE
# ifdef ESPC_TIMER
call ESMF_VMBarrier(vm, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
call ESMF_VMWtime(timer_tmp_beg, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
# endif
do i=1,numExpFields
if(expFieldEnable(i)) then
call do_export(i,expField(i),rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
endif
enddo
# ifdef ESPC_TIMER
call ESMF_VMBarrier(vm, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
call ESMF_VMWtime(timer_tmp_end, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
espc_timer(6)=espc_timer(6)+timer_tmp_end-timer_tmp_beg
call print_timer_stat('hycom, Run(Export):',timer_tmp_end-timer_tmp_beg,lPet,nPets,vm,rc)
# endif
!move to mod_hycom.F
# ifdef ESPC_COUPLE
if(hycom_arche_output) call archiv_exchange !arche file of fields exchanged with ice component
# endif
if(ocn_esmf_exp_output.and.( (mod(endtimex,float(cdf_impexp_freq)).eq.0 .or. &
endtimex.eq.0.5) )) then
call impexp_cdf_put_flds('hycom', base_dtg,endtimex, &
itdmx,jtdmx, &
numExpFields,expFieldEnable,expFieldName,expStandName,expFieldUnit,expField, &
status,lPet,rc,'exp')
IF (ESMF_LogFoundError(rcToCheck=rc, msg="impexp_cdf_put_flds failed", CONTEXT)) RETURN
endif
# endif
# ifdef ESPC_TIMER
call ESMF_VMBarrier(vm, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
call ESMF_VMWtime(timer_end, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU,CONTEXT)) RETURN
espc_timer(2)=espc_timer(2)+timer_end-timer_beg
! if(lPet.eq.0) print *,"hycom, ModelAdvance,timer=",espc_timer(2), &
! timer_end-timer_beg
call print_timer_stat('hycom, Run:',timer_end-timer_beg,lPet,nPets,vm,rc)
# endif
if(lPet.eq.0) print *,"hycom, ModelAdvance end..."
if(lPet.eq.0) print *,"hycom, ModelAdvance end...",begtime,endtime
END SUBROUTINE ModelAdvance
!======================================================================
#undef METHOD
#define METHOD "OCEAN_Final"
SUBROUTINE OCEAN_Final(model, rc)
TYPE(ESMF_GridComp) :: model
INTEGER,INTENT(OUT) :: rc
! Local variables
INTEGER :: lrc, i
# ifdef ESPC_TIMER
integer j,ij
real(kind=ESMF_KIND_R8), allocatable:: espc_all_timer(:)