-
Notifications
You must be signed in to change notification settings - Fork 28
/
glm_aed.F90
1757 lines (1554 loc) · 67.3 KB
/
glm_aed.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
!###############################################################################
!# #
!# glm_aed.F90 #
!# #
!# The interface between glm and libaed-xxx #
!# #
!# Developed by : #
!# AquaticEcoDynamics (AED) Group #
!# School of Agriculture and Environment #
!# The University of Western Australia #
!# #
!# http://aquatic.science.uwa.edu.au/ #
!# #
!# Copyright 2013 - 2023 - The University of Western Australia #
!# #
!# This file is part of GLM (General Lake Model) #
!# #
!# GLM is free software: you can redistribute it and/or modify #
!# it under the terms of the GNU General Public License as published by #
!# the Free Software Foundation, either version 3 of the License, or #
!# (at your option) any later version. #
!# #
!# GLM is distributed in the hope that it will be useful, #
!# but WITHOUT ANY WARRANTY; without even the implied warranty of #
!# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
!# GNU General Public License for more details. #
!# #
!# You should have received a copy of the GNU General Public License #
!# along with this program. If not, see <http://www.gnu.org/licenses/>. #
!# #
!###############################################################################
#include "aed.h"
#undef MISVAL
#ifndef _FORTRAN_SOURCE_
#define _FORTRAN_SOURCE_ 1
#endif
#include "glm.h"
#ifdef __GFORTRAN__
# if __GNUC__ < 8
# error "You will need gfortran version 8 or better"
# endif
#else
# ifndef isnan
# define isnan(x) ieee_is_nan(x)
# define HAVE_IEEE_ARITH
# endif
#endif
!-------------------------------------------------------------------------------
MODULE glm_aed
!
USE ISO_C_BINDING
USE aed_water
USE aed_common
USE glm_types
USE glm_zones
#ifdef HAVE_IEEE_ARITH
USE IEEE_ARITHMETIC
#endif
IMPLICIT NONE
PRIVATE ! By default, make everything private
!
#include "glm_globals.h"
#include "glm_plot.h"
#include "glm_ncdf.h"
#include "glm_csv.h"
#include "glm_mobl.h"
!
#if USE_DL_LOADER
# define _WQ_INIT_GLM "wq_init_glm"
# define _WQ_SET_GLM_DATA "wq_set_glm_data"
# define _WQ_DO_GLM "wq_do_glm"
# define _WQ_CLEAN_GLM "wq_clean_glm"
# define _WQ_INIT_GLM_OUTPUT "wq_init_glm_output"
# define _WQ_WRITE_GLM_ "wq_write_glm"
# define _WQ_VAR_INDEX_C "wq_var_index_c"
# define _WQ_SET_FLAGS "wq_set_flags"
# define _WQ_IS_VAR "wq_is_var"
# define _WQ_INFLOW_UPDATE "wq_inflow_update"
#else
# define _WQ_INIT_GLM "aed_init_glm"
# define _WQ_SET_GLM_DATA "aed_set_glm_data"
# define _WQ_DO_GLM "aed_do_glm"
# define _WQ_CLEAN_GLM "aed_clean_glm"
# define _WQ_INIT_GLM_OUTPUT "aed_init_glm_output"
# define _WQ_WRITE_GLM_ "aed_write_glm"
# define _WQ_VAR_INDEX_C "aed_var_index_c"
# define _WQ_SET_FLAGS "aed_set_flags"
# define _WQ_IS_VAR "aed_is_var"
# define _WQ_INFLOW_UPDATE "aed_update_inflow_wq"
#endif
!
!-------------------------------------------------------------------------------
!
!MODULE DATA
AED_REAL :: lKw !# background light attenuation (m**-1)
LOGICAL :: lIce = .FALSE.
!# Namelist variables
INTEGER :: ode_method = 1, split_factor = 1, benthic_mode
LOGICAL :: bioshade_feedback = .TRUE., repair_state = .TRUE.
LOGICAL :: mobility_off = .FALSE. !# flag to turn mobility off
LOGICAL :: do_plots = .TRUE.
AED_REAL :: par_fraction = 0.450
AED_REAL :: nir_fraction = 0.510
AED_REAL :: uva_fraction = 0.035
AED_REAL :: uvb_fraction = 0.005
!# Arrays for state and diagnostic variables
AED_REAL,ALLOCATABLE,DIMENSION(:,:) :: cc !# water quality array: nlayers, nvars
AED_REAL,ALLOCATABLE,TARGET,DIMENSION(:,:) :: cc_diag
AED_REAL,ALLOCATABLE,TARGET,DIMENSION(:) :: cc_diag_hz
AED_REAL,ALLOCATABLE,TARGET,DIMENSION(:) :: tss
AED_REAL,ALLOCATABLE,TARGET,DIMENSION(:) :: sed_zones
!# Arrays for work, vertical movement, and cross-boundary fluxes
AED_REAL,ALLOCATABLE,DIMENSION(:,:) :: ws
AED_REAL,ALLOCATABLE,DIMENSION(:) :: total
AED_REAL,ALLOCATABLE,DIMENSION(:) :: local
AED_REAL,ALLOCATABLE,TARGET,DIMENSION(:) :: dz
!# Arrays for environmental variables not supplied externally.
AED_REAL,ALLOCATABLE,TARGET,DIMENSION(:) :: par, pres
AED_REAL,ALLOCATABLE,TARGET,DIMENSION(:) :: uva, uvb, nir
!# External variables
AED_REAL :: dt, dt_eff ! External and internal time steps
! INTEGER :: w_adv_ctr ! Scheme for vertical advection (0 IF not used)
AED_REAL,POINTER,DIMENSION(:) :: rad, z, salt, temp, rho, area
AED_REAL,POINTER,DIMENSION(:) :: extc_coef, layer_stress, vel
AED_REAL,POINTER :: precip, evap, bottom_stress, air_temp, rel_hum
AED_REAL,POINTER :: I_0, wnd, air_pres
AED_REAL,ALLOCATABLE,DIMENSION(:),TARGET :: depth,layer_area
AED_REAL,POINTER :: lon, lat
AED_REAL,POINTER :: yeardayP, timestepP
CHARACTER(len=48),ALLOCATABLE :: names(:)
CHARACTER(len=48),ALLOCATABLE :: bennames(:)
! CHARACTER(len=48),ALLOCATABLE :: diagnames(:)
AED_REAL,ALLOCATABLE,DIMENSION(:) :: min_, max_
INTEGER,ALLOCATABLE,DIMENSION(:) :: externalid
INTEGER,ALLOCATABLE,DIMENSION(:) :: zexternalid
#if PLOTS
INTEGER,ALLOCATABLE,DIMENSION(:) :: plot_id_v, plot_id_sv, plot_id_d, plot_id_sd
#endif
LOGICAL :: link_rain_loss, link_solar_shade, link_bottom_drag
AED_REAL,POINTER :: rain_factor, sw_factor, friction
LOGICAL :: reinited = .FALSE.
INTEGER :: n_aed_vars, n_vars, n_vars_ben, n_vars_diag, n_vars_diag_sheet
INTEGER :: zone_var = 0
CHARACTER(len=64) :: NULCSTR = ""
!===============================================================================
CONTAINS
!###############################################################################
FUNCTION MYTRIM(str) RESULT(res)
!-------------------------------------------------------------------------------
! Useful for passing string arguments to C functions
!-------------------------------------------------------------------------------
CHARACTER(*),TARGET :: str
CHARACTER(:),POINTER :: res
INTEGER :: len
len = LEN_TRIM(str)+1
str(len:len) = achar(0)
res => str
END FUNCTION MYTRIM
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!###############################################################################
SUBROUTINE STOPIT(message)
!-------------------------------------------------------------------------------
!ARGUMENTS
CHARACTER(*) :: message
!-------------------------------------------------------------------------------
PRINT *,message
STOP
END SUBROUTINE STOPIT
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!###############################################################################
INTEGER FUNCTION f_get_lun()
!-------------------------------------------------------------------------------
! Find the first free logical unit number
!-------------------------------------------------------------------------------
!ARGUMENTS
INTEGER :: lun
LOGICAL :: opened
!
!-------------------------------------------------------------------------------
!BEGIN
DO lun = 10,99
inquire(unit=lun, opened=opened)
IF ( .not. opened ) THEN
f_get_lun = lun
RETURN
ENDIF
ENDDO
f_get_lun = -1
END FUNCTION f_get_lun
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!###############################################################################
SUBROUTINE aed_set_flags(c_split_factor, c_mobility, c_bioshade, &
c_repair_state, c_ode, c_benthic_mode, c_do_plots, &
c_link_rain_loss, c_link_solar_shade, c_link_bottom_drag) BIND(C, name=_WQ_SET_FLAGS)
!-------------------------------------------------------------------------------
!ARGUMENTS
CLOGICAL,INTENT(in) :: c_mobility, c_bioshade, c_repair_state, c_do_plots
CINTEGER,INTENT(in) :: c_split_factor, c_ode, c_benthic_mode
! CLOGICAL,OPTIONAL,INTENT(in) :: c_link_rain_loss, c_link_solar_shade, c_link_bottom_drag
CLOGICAL,INTENT(in) :: c_link_rain_loss, c_link_solar_shade, c_link_bottom_drag
!
!-------------------------------------------------------------------------------
!BEGIN
split_factor = c_split_factor
mobility_off = c_mobility
bioshade_feedback = c_bioshade
ode_method = c_ode
repair_state = c_repair_state
benthic_mode = c_benthic_mode
do_plots = c_do_plots
! IF (PRESENT(c_link_rain_loss)) link_rain_loss = c_link_rain_loss
! IF (PRESENT(c_link_solar_shade)) link_solar_shade = c_link_solar_shade
! IF (PRESENT(c_link_bottom_drag)) link_bottom_drag = c_link_bottom_drag
link_rain_loss = c_link_rain_loss
link_solar_shade = c_link_solar_shade
link_bottom_drag = c_link_bottom_drag
END SUBROUTINE aed_set_flags
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!###############################################################################
SUBROUTINE aed_init_glm(i_fname,len,MaxLayers,NumWQ_Vars,NumWQ_Ben,pKw) BIND(C, name=_WQ_INIT_GLM)
!-------------------------------------------------------------------------------
! Initialize the GLM-AED driver by reading settings from aed.nml.
!-------------------------------------------------------------------------------
!ARGUMENTS
CCHARACTER,INTENT(in) :: i_fname(*)
CSIZET,INTENT(in) :: len
CINTEGER,INTENT(in) :: MaxLayers
CINTEGER,INTENT(out) :: NumWQ_Vars, NumWQ_Ben
AED_REAL,INTENT(in) :: pKw
!
!LOCALS
INTEGER :: i,j,namlst,status
INTEGER :: rc, av, v, sv, tv
CHARACTER(len=80) :: fname
TYPE(aed_variable_t),POINTER :: tvar
CHARACTER(len=64) :: models(64)
NAMELIST /aed_models/ models
!
!-------------------------------------------------------------------------------
!BEGIN
CALL make_string(fname, i_fname, len)
lKw = pKw
#ifdef __INTEL_COMPILER
print *,' glm_aed built using intel fortran version ', __INTEL_COMPILER
#else
# ifdef __PGI
print *,' glm_aed built using pgfortran version ', __PGIC__, '.', __PGIC_MINOR__, '.', __PGIC_PATCHLEVEL__
# else
# ifdef __GNUC__
print *,' glm_aed built using gfortran version ', __GNUC__, '.', __GNUC_MINOR__, '.', __GNUC_PATCHLEVEL__
# else
# ifdef __clang__
print*," glm_aed built using flang version ", __clang_major__, '.', __clang_minor__, '.', __clang_patchlevel__
# else
print*," glm_aed built using unknow fortran"
# endif
# endif
# endif
#endif
print *,' libaed enabled.... init_glm_aed processing: ', TRIM(fname)
namlst = f_get_lun()
write(*,"(/,5X,'---------- AED config : start ----------')")
IF ( aed_init_core('.') /= 0 ) STOP " ERROR: Initialisation of aed_core failed"
CALL aed_print_version
tv = aed_provide_global( 'temperature', 'temperature' , 'celsius' )
tv = aed_provide_global( 'salinity', 'salinity' , 'g/Kg' )
tv = aed_provide_global( 'density', 'density' , '' )
tv = aed_provide_global( 'layer_ht', 'layer heights' , 'meters' )
tv = aed_provide_global( 'layer_area', 'layer area' , 'm2' )
tv = aed_provide_sheet_global( 'rain', 'rainfall' , 'm/s' )
!rainloss
!material
!bathy
tv = aed_provide_global( 'extc_coef', 'extinction coefficient' , '' )
tv = aed_provide_global( 'tss', 'tss' , '' )
!ss1, ss2, ss3, ss4
tv = aed_provide_global( 'cell_vel', 'layer velocity' , 'm/s' )
tv = aed_provide_global( 'nir', 'nir' , 'W/m2' )
tv = aed_provide_global( 'par', 'par' , 'W/m2' )
tv = aed_provide_global( 'uva', 'uva' , 'W/m2' )
tv = aed_provide_global( 'uvb', 'uvb' , 'W/m2' )
tv = aed_provide_global( 'pressure', 'pressure' , '' )
tv = aed_provide_global( 'depth', 'depth' , 'm' )
tv = aed_provide_sheet_global( 'sed_zone', 'sediment zone' , '' )
tv = aed_provide_sheet_global( 'wind_speed', 'wind speed' , 'm/s' )
tv = aed_provide_sheet_global( 'par_sf', 'par_sf' , '' )
tv = aed_provide_sheet_global( 'taub', 'layer stress' , 'N/m2' )
tv = aed_provide_sheet_global( 'air_temp', 'air temperature', 'celsius' )
tv = aed_provide_sheet_global( 'humidity', 'relative humidity', '-' )
!longwave
!col_num
!col_depth
tv = aed_provide_sheet_global( 'col_depth', 'lake depth', 'meters' )
! added for oasim
tv = aed_provide_sheet_global( 'longitude', 'longitude', 'radians' )
tv = aed_provide_sheet_global( 'latitude', 'latitude', 'radians' )
tv = aed_provide_sheet_global( 'yearday', 'yearday', 'day' )
tv = aed_provide_sheet_global( 'timestep', 'timestep', 'seconds' )
! new var air_pressure
tv = aed_provide_sheet_global( 'air_pres', 'air_pressure', 'Pa' )
!# Create model tree
print *," Processing aed_models config from ",TRIM(fname)
OPEN(namlst,file=fname,action='read',status='old',iostat=status)
IF ( status /= 0 ) CALL STOPIT("Cannot open file " // TRIM(fname))
models = ''
READ(namlst, nml=aed_models, iostat=status)
IF ( status /= 0 ) STOP "Cannot read namelist entry aed_models"
DO i=1,size(models)
IF ( models(i) == '' ) EXIT
IF ( benthic_mode .GT. 1 ) models(i) = TRIM(models(i)) // ':za' ! make all models zone averaged
CALL aed_define_model(models(i), namlst)
ENDDO
!# should be finished with this file
CLOSE(namlst)
print *," ... nml file parsing completed."
n_aed_vars = aed_core_status(n_vars, n_vars_ben, n_vars_diag, n_vars_diag_sheet)
#if DEBUG
DO i=1,n_aed_vars
IF ( aed_get_var(i, tvar) ) THEN
print *,"AED var ", i, tvar%sheet, tvar%diag, tvar%extern, TRIM(tvar%name)
ELSE
print *,"AED var ", i, " is empty"
ENDIF
ENDDO
#endif
print "(/,5X,'AED : n_aed_vars = ',I3,' ; MaxLayers = ',I4)",n_aed_vars,MaxLayers
print "( 5X,'AED : n_vars = ',I3,' ; n_vars_ben = ',I3)",n_vars,n_vars_ben
print "( 5X,'AED : n_vars_diag = ',I3,' ; n_vars_diag_sheet = ',I3,/)",n_vars_diag,n_vars_diag_sheet
CALL check_data
!# names = grab the names from info
ALLOCATE(names(n_vars),stat=status)
IF (status /= 0) STOP 'allocate_memory(): Error allocating (names)'
ALLOCATE(bennames(n_vars_ben),stat=status)
IF (status /= 0) STOP 'allocate_memory(): Error allocating (bennames)'
#if PLOTS
ALLOCATE(plot_id_v(n_vars))
ALLOCATE(plot_id_sv(n_vars_ben))
ALLOCATE(plot_id_d(n_vars_diag))
ALLOCATE(plot_id_sd(n_vars_diag_sheet))
plot_id_v = -1; plot_id_sv = -1; plot_id_d = -1; plot_id_sd = -1
#endif
NumWQ_Vars = n_vars
NumWQ_Ben = n_vars_ben
!# Now that we know how many vars we need, we can allocate space for them
ALLOCATE(cc(MaxLayers, (n_vars + n_vars_ben)),stat=status)
IF (status /= 0) STOP 'allocate_memory(): Error allocating (CC)'
cc = 0. !# initialise to zero
CALL set_c_wqvars_ptr(cc)
ALLOCATE(min_((n_vars + n_vars_ben))) ; ALLOCATE(max_((n_vars + n_vars_ben)))
print "(5X,'Configured AED variables to simulate:')"
j = 0
DO i=1,n_aed_vars
IF ( aed_get_var(i, tvar) ) THEN
IF ( .NOT. (tvar%sheet .OR. tvar%diag .OR. tvar%extern) ) THEN
j = j + 1
names(j) = TRIM(tvar%name)
min_(j) = tvar%minimum
max_(j) = tvar%maximum
!print *," S(",j,") AED pelagic(3D) variable: ", TRIM(names(j))
print "(7X,'S(',I4,') water column variable : ',A)",j , TRIM(names(j))
ENDIF
ENDIF
ENDDO
j = 0
DO i=1,n_aed_vars
IF ( aed_get_var(i, tvar) ) THEN
IF ( tvar%sheet .AND. .NOT. (tvar%diag .OR. tvar%extern) ) THEN
j = j + 1
bennames(j) = TRIM(tvar%name)
min_(n_vars+j) = tvar%minimum
max_(n_vars+j) = tvar%maximum
!print *," B(",j,") AED benthic(2D) variable: ", TRIM(bennames(j))
print "(7X,'B(',I4,') bottom variable + ',A)",j , TRIM(bennames(j))
ENDIF
ENDIF
ENDDO
j = 0
DO i=1,n_aed_vars
IF ( aed_get_var(i, tvar) ) THEN
IF ( tvar%diag ) THEN
IF ( .NOT. tvar%sheet ) THEN
j = j + 1
print "(7X,'D(',I4,') water column diagnostic > ',A)",j , TRIM(tvar%name)
!print *," D(",j,") AED diagnostic 3Dvariable: ", TRIM(tvar%name)
ENDIF
ENDIF
ENDIF
ENDDO
j = 0
DO i=1,n_aed_vars
IF ( aed_get_var(i, tvar) ) THEN
IF ( tvar%diag ) THEN
IF (tvar%sheet ) THEN
j = j + 1
!print *," D(",j,") AED diagnostic 2Dvariable: ", TRIM(tvar%name)
print "(7X,'D(',I4,') bottom/surface diagnostic ~ ',A)",j , TRIM(tvar%name)
ENDIF
ENDIF
ENDIF
ENDDO
! ALLOCATE(column(n_aed_vars))
ALLOCATE(externalid(n_aed_vars))
! IF ( n_zones .GT. 0 ) &
ALLOCATE(zexternalid(n_aed_vars))
!----------------------------------------------------------------------------
!# Now set initial values
v = 0 ; sv = 0;
DO av=1,n_aed_vars
IF ( .NOT. aed_get_var(av, tvar) ) STOP " ERROR getting variable info"
IF ( .NOT. ( tvar%extern .OR. tvar%diag) ) THEN !# neither global nor diagnostic variable
IF ( tvar%sheet ) THEN
sv = sv + 1
cc(:, n_vars+sv) = tvar%initial
ELSE
v = v + 1
cc(:, v) = tvar%initial
ENDIF
ENDIF
ENDDO
!# Allocate diagnostic variable array and set all values to zero.
!# (needed because time-integrated/averaged variables will increment rather than set the array)
ALLOCATE(cc_diag(MaxLayers, n_vars_diag),stat=rc)
IF (rc /= 0) STOP 'allocate_memory(): Error allocating (cc_diag)'
cc_diag = zero_
!# Allocate diagnostic variable array and set all values to zero.
!# (needed because time-integrated/averaged variables will increment rather than set the array)
ALLOCATE(cc_diag_hz(n_vars_diag_sheet),stat=rc)
IF (rc /= 0) STOP 'allocate_memory(): Error allocating (cc_diag_hz)'
cc_diag_hz = zero_
!# Allocate array with vertical movement rates (m/s, positive for upwards),
!# and set these to the values provided by the model.
!# allocated for all vars even though only state vars entries will be used
ALLOCATE(ws(MaxLayers, n_aed_vars),stat=rc)
IF (rc /= 0) STOP 'allocate_memory(): Error allocating (ws)'
ws = zero_
!# Allocate array for photosynthetically active radiation (PAR).
!# This will be calculated internally during each time step.
ALLOCATE(par(MaxLayers),stat=rc)
IF (rc /= 0) STOP 'allocate_memory(): Error allocating (par)'
par = zero_
ALLOCATE(nir(MaxLayers),stat=rc)
IF (rc /= 0) STOP 'allocate_memory(): Error allocating (nir)'
nir = zero_
ALLOCATE(uva(MaxLayers),stat=rc)
IF (rc /= 0) STOP 'allocate_memory(): Error allocating (uva)'
uva = zero_
ALLOCATE(uvb(MaxLayers),stat=rc)
IF (rc /= 0) STOP 'allocate_memory(): Error allocating (uvb)'
uvb = zero_
ALLOCATE(dz(MaxLayers),stat=rc)
dz = zero_
!# Allocate array for local pressure.
!# This will be calculated [approximated] from layer depths internally
!# during each time step.
ALLOCATE(pres(MaxLayers),stat=rc)
IF (rc /= 0) STOP 'allocate_memory(): Error allocating (pres)'
pres = zero_
ALLOCATE(tss(MaxLayers),stat=rc)
IF (rc /= 0) STOP 'allocate_memory(): Error allocating (tss)'
tss = zero_
write(*,"(/,5X,'---------- AED config : end ----------',/)")
END SUBROUTINE aed_init_glm
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!###############################################################################
CINTEGER FUNCTION aed_is_var(id,i_vname,len) BIND(C, name=_WQ_IS_VAR)
!-------------------------------------------------------------------------------
!ARGUMENTS
CINTEGER,INTENT(in) :: id
CCHARACTER,INTENT(in) :: i_vname(*)
CSIZET,INTENT(in) :: len
!LOCALS
CHARACTER(len=45) :: vname
TYPE(aed_variable_t),POINTER :: tvar
INTEGER :: i, v, sv, d, sd
!-------------------------------------------------------------------------------
!BEGIN
CALL make_string(vname, i_vname, len)
v = 0; sv = 0; d = 0; sd = 0
DO i=1,n_aed_vars
IF ( aed_get_var(i, tvar) ) THEN
IF ( .NOT. (tvar%diag .OR. tvar%extern) ) THEN
IF ( tvar%sheet ) THEN ; sv=sv+1; ELSE ; v=v+1 ; ENDIF
IF ( TRIM(tvar%name) == vname ) THEN
IF (tvar%sheet) THEN
aed_is_var=-sv
#ifdef PLOTS
plot_id_sv(sv) = id;
#endif
ELSE
aed_is_var=v
#ifdef PLOTS
plot_id_v(v) = id;
#endif
ENDIF
RETURN
ENDIF
ELSEIF ( tvar%diag ) THEN
IF ( tvar%sheet ) THEN ; sd=sd+1; ELSE ; d=d+1 ; ENDIF
IF ( TRIM(tvar%name) == vname ) THEN
IF (tvar%sheet) THEN
aed_is_var=-sd
#ifdef PLOTS
plot_id_sd(sd) = id;
#endif
ELSE
aed_is_var=d
#ifdef PLOTS
plot_id_d(d) = id;
#endif
ENDIF
RETURN
ENDIF
ENDIF
ENDIF
ENDDO
aed_is_var = 0
END FUNCTION aed_is_var
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!###############################################################################
SUBROUTINE aed_set_glm_data(Lake, MaxLayers, MetData, SurfData, dt_, &
c_rain_factor, c_sw_factor, c_friction) &
BIND(C, name=_WQ_SET_GLM_DATA)
!-------------------------------------------------------------------------------
!ARGUMENTS
CINTEGER, INTENT(in) :: MaxLayers
TYPE(C_PTR),VALUE :: Lake
TYPE(MetDataType),TARGET :: MetData !# Meteorological data
TYPE(SurfaceDataType),TARGET :: SurfData !# Surface Data
AED_REAL,INTENT(in) :: dt_
! AED_REAL,OPTIONAL,TARGET :: c_rain_factor, c_sw_factor, c_friction
AED_REAL,TARGET :: c_rain_factor, c_sw_factor, c_friction
!LOCALS
INTEGER :: i
!
!-------------------------------------------------------------------------------
!BEGIN
CALL C_F_POINTER(Lake, theLake, [MaxLayers])
!# Save pointers to external dynamic variables that we need later (in do_glm_wq)
z => theLake%Height
temp => theLake%Temp
salt => theLake%Salinity
rho => theLake%Density
area => theLake%LayerArea
rad => theLake%Light
vel => theLake%Umean
extc_coef => theLake%ExtcCoefSW
layer_stress => theLake%LayerStress
IF (benthic_mode .GT. 1) zz => z
ALLOCATE(depth(MaxLayers))
ALLOCATE(layer_area(MaxLayers))
ALLOCATE(sed_zones(MaxLayers))
sed_zones = 0.
IF (benthic_mode .GT. 1) THEN
ALLOCATE(z_diag(n_zones, n_vars_diag)) ; z_diag = zero_
ALLOCATE(z_diag_hz(n_zones+1, n_vars_diag_sheet)) ; z_diag_hz = zero_
!# At this point we have z_cc allocated, so now we can copy the initial values
!# from cc benthic vars to it
DO i=1,n_zones
z_cc(i, n_vars+1:n_vars+n_vars_ben) = cc(1, n_vars+1:n_vars+n_vars_ben)
ENDDO
ENDIF
precip => MetData%Rain
air_temp => MetData%AirTemp
rel_hum => MetData%RelHum
air_pres => MetData%AirPres
evap => SurfData%Evap
bottom_stress => layer_stress(botmLayer)
!# Copy scalars that will not change during simulation, and are needed in do_glm_wq)
dt = dt_
!# Provide pointers to arrays with environmental variables to aed.
wnd => MetData%WindSpeed
I_0 => MetData%ShortWave
!# Calculate and save internal time step.
dt_eff = dt/FLOAT(split_factor)
! IF (PRESENT(c_rain_factor)) rain_factor => c_rain_factor
! IF (PRESENT(c_sw_factor)) sw_factor => c_sw_factor
! IF (PRESENT(c_friction)) friction => c_friction
rain_factor => c_rain_factor
sw_factor => c_sw_factor
friction => c_friction
!# Trigger an error if WQ hasn't got all it needs from us.
CALL check_data
END SUBROUTINE aed_set_glm_data
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!###############################################################################
SUBROUTINE aed_set_glm_where(Longitude, Latitude, yearday, timestep) &
BIND(C, name="aed_set_glm_where")
!-------------------------------------------------------------------------------
!ARGUMENTS
AED_REAL,TARGET :: Longitude, Latitude, yearday, timestep
!LOCALS
!
!-------------------------------------------------------------------------------
!BEGIN
lon => Longitude
lat => Latitude
yeardayP => yearday
timestepP => timestep
END SUBROUTINE aed_set_glm_where
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!###############################################################################
SUBROUTINE check_data
!-------------------------------------------------------------------------------
! Check that all variable dependencies have been met
!-------------------------------------------------------------------------------
!ARGUMENTS
!
!LOCALS
INTEGER :: av !, i
INTEGER :: v, d, sv, sd, ev, err_count
TYPE(aed_variable_t),POINTER :: tvar
!-------------------------------------------------------------------------------
!BEGIN
v = 0 ; d = 0; sv = 0; sd = 0 ; ev = 0
err_count = 0
DO av=1,n_aed_vars
IF ( .NOT. aed_get_var(av, tvar) ) STOP "Error getting variable info"
IF ( tvar%extern ) THEN !# global variable
ev = ev + 1
SELECT CASE (tvar%name)
CASE ( 'temperature' ) ; tvar%found = .true.
CASE ( 'salinity' ) ; tvar%found = .true.
CASE ( 'density' ) ; tvar%found = .true.
CASE ( 'layer_ht' ) ; tvar%found = .true.
CASE ( 'extc_coef' ) ; tvar%found = .true.
CASE ( 'tss' ) ; tvar%found = .true.
CASE ( 'cell_vel' ) ; tvar%found = .true.
CASE ( 'par' ) ; tvar%found = .true.
CASE ( 'nir' ) ; tvar%found = .true.
CASE ( 'uva' ) ; tvar%found = .true.
CASE ( 'uvb' ) ; tvar%found = .true.
CASE ( 'pressure' ) ; tvar%found = .true.
CASE ( 'depth' ) ; tvar%found = .true.
CASE ( 'sed_zone' ) ; tvar%found = .true.
CASE ( 'wind_speed' ) ; tvar%found = .true.
CASE ( 'par_sf' ) ; tvar%found = .true.
CASE ( 'taub' ) ; tvar%found = .true.
CASE ( 'col_depth' ) ; tvar%found = .true.
CASE ( 'layer_area' ) ; tvar%found = .true.
CASE ( 'rain' ) ; tvar%found = .true.
CASE ( 'air_temp' ) ; tvar%found = .true.
CASE ( 'air_pres' ) ; tvar%found = .true.
CASE ( 'humidity' ) ; tvar%found = .true.
CASE ( 'longitude' ) ; tvar%found = .true.
CASE ( 'latitude' ) ; tvar%found = .true.
CASE ( 'yearday' ) ; tvar%found = .true.
CASE ( 'timestep' ) ; tvar%found = .true.
CASE DEFAULT ; CALL STOPIT("ERROR: external variable "//TRIM(tvar%name)//" not found.")
END SELECT
ELSEIF ( tvar%diag ) THEN !# Diagnostic variable
IF ( tvar%sheet ) THEN
sd = sd + 1
ELSE
d = d + 1
ENDIF
ELSE !# state variable
IF ( tvar%sheet ) THEN
sv = sv + 1
ELSE
v = v + 1
ENDIF
ENDIF
IF ( .NOT. tvar%found ) THEN
print *, "ERROR: Undefined variable ", TRIM(tvar%name)
err_count = err_count + 1
ENDIF
ENDDO
IF ( n_vars < v ) print *,"More vars than expected",v,n_vars
IF ( n_vars_ben < sv ) print *,"More sheet vars than expected"
IF ( n_vars_diag < d ) print *,"More diag vars than expected"
IF ( n_vars_diag_sheet < sd ) print *,"More sheet diag vars than expected"
IF ( err_count > 0 ) CALL STOPIT("*** Errors in configuration")
END SUBROUTINE check_data
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!###############################################################################
SUBROUTINE define_column(column, top, cc, cc_diag, flux_pel, flux_atm, flux_ben)
!-------------------------------------------------------------------------------
! Set up the current column pointers
!-------------------------------------------------------------------------------
!ARGUMENTS
TYPE (aed_column_t), INTENT(inout) :: column(:)
INTEGER, INTENT(in) :: top
AED_REAL, TARGET, INTENT(in) :: cc(:,:) !# (n_layers, n_vars)
AED_REAL, TARGET, INTENT(in) :: cc_diag(:,:) !# (n_layers, n_vars)
AED_REAL, TARGET, INTENT(inout) :: flux_pel(:,:) !# (n_layers, n_vars)
AED_REAL, TARGET, INTENT(inout) :: flux_atm(:) !# (n_vars)
AED_REAL, TARGET, INTENT(inout) :: flux_ben(:) !# (n_vars)
!
!LOCALS
INTEGER :: av !, i
INTEGER :: v, d, sv, sd, ev
TYPE(aed_variable_t),POINTER :: tvar
!-------------------------------------------------------------------------------
!BEGIN
v = 0 ; d = 0; sv = 0; sd = 0 ; ev = 0
DO av=1,n_aed_vars
IF ( .NOT. aed_get_var(av, tvar) ) STOP "Error getting variable info"
IF ( tvar%extern ) THEN !# global variable
ev = ev + 1
SELECT CASE (tvar%name)
CASE ( 'temperature' ) ; column(av)%cell => temp(:)
CASE ( 'salinity' ) ; column(av)%cell => salt(:)
CASE ( 'density' ) ; column(av)%cell => rho(:)
CASE ( 'layer_ht' ) ; column(av)%cell => dz(:)
CASE ( 'extc_coef' ) ; column(av)%cell => extc_coef(:)
CASE ( 'tss' ) ; column(av)%cell => tss(:)
CASE ( 'cell_vel' ) ; column(av)%cell => vel(:)
CASE ( 'par' ) ; column(av)%cell => par(:)
CASE ( 'nir' ) ; column(av)%cell => nir(:)
CASE ( 'uva' ) ; column(av)%cell => uva(:)
CASE ( 'uvb' ) ; column(av)%cell => uvb(:)
CASE ( 'pressure' ) ; column(av)%cell => pres(:)
CASE ( 'depth' ) ; column(av)%cell => depth(:)
CASE ( 'sed_zone' ) ; column(av)%cell_sheet => sed_zones(1)
CASE ( 'wind_speed' ) ; column(av)%cell_sheet => wnd
CASE ( 'par_sf' ) ; column(av)%cell_sheet => I_0
CASE ( 'taub' ) ; column(av)%cell_sheet => bottom_stress
CASE ( 'col_depth' ) ; column(av)%cell_sheet => depth(1)
CASE ( 'layer_area' ) ; column(av)%cell => layer_area(:)
CASE ( 'rain' ) ; column(av)%cell_sheet => precip
CASE ( 'air_temp' ) ; column(av)%cell_sheet => air_temp
CASE ( 'air_pres' ) ; column(av)%cell_sheet => air_pres
CASE ( 'humidity' ) ; column(av)%cell_sheet => rel_hum
CASE ( 'longitude' ) ; column(av)%cell_sheet => lon
CASE ( 'latitude' ) ; column(av)%cell_sheet => lat
CASE ( 'yearday' ) ; column(av)%cell_sheet => yeardayP
CASE ( 'timestep' ) ; column(av)%cell_sheet => timestepP
CASE DEFAULT ; CALL STOPIT("ERROR: external variable "//TRIM(tvar%name)//" not found.")
END SELECT
ELSEIF ( tvar%diag ) THEN !# Diagnostic variable
IF ( tvar%sheet ) THEN
sd = sd + 1
column(av)%cell_sheet => cc_diag_hz(sd)
ELSE
d = d + 1
column(av)%cell => cc_diag(:, d)
ENDIF
ELSE !# state variable
IF ( tvar%sheet ) THEN
sv = sv + 1
IF ( tvar%bot ) THEN
column(av)%cell_sheet => cc(1, n_vars+sv)
! print *,'av',av,sv
ELSEIF ( tvar%top ) THEN
column(av)%cell_sheet => cc(top, n_vars+sv)
ENDIF
column(av)%flux_ben => flux_ben(n_vars+sv)
column(av)%flux_atm => flux_atm(n_vars+sv)
ELSE
v = v + 1
column(av)%cell => cc(:, v)
column(av)%flux_atm => flux_atm(v)
column(av)%flux_pel => flux_pel(:, v)
column(av)%flux_ben => flux_ben(v)
ENDIF
ENDIF
ENDDO
END SUBROUTINE define_column
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!###############################################################################
SUBROUTINE check_states(column, wlev)
!-------------------------------------------------------------------------------
!ARGUMENTS
TYPE (aed_column_t),INTENT(inout) :: column(:)
INTEGER,INTENT(in) :: wlev
!
!LOCALS
TYPE(aed_variable_t),POINTER :: tv
INTEGER :: i,v,lev
#if DEBUG
INTEGER :: last_naned
#endif
!
!-------------------------------------------------------------------------------
!BEGIN
#if DEBUG
last_naned = -1
#endif
DO lev=1, wlev
CALL aed_equilibrate(column, lev) !MH this should be in the main do_glm routine ????!!!
v = 0
DO i=1,n_aed_vars
IF ( aed_get_var(i, tv) ) THEN
IF ( .NOT. (tv%diag .OR. tv%extern) ) THEN
v = v + 1
IF ( repair_state ) THEN
#if DEBUG
IF ( isnan(cc(lev, v)) ) last_naned = i
#endif
IF ( .NOT. isnan(min_(v)) ) THEN
IF ( cc(lev, v) < min_(v) ) cc(lev, v) = min_(v)
ENDIF
IF ( .NOT. isnan(max_(v)) ) THEN
IF ( cc(lev, v) > max_(v) ) cc(lev, v) = max_(v)
ENDIF
ENDIF
ENDIF
ENDIF
ENDDO
ENDDO
#if DEBUG
IF ( last_naned > -1 ) THEN
print*
IF ( aed_get_var(last_naned, tv) ) THEN
print*,"NaNs detected in CC in var ", TRIM(tv%name)
ELSE
print*,"NaNs detected in CC unidentified var"
ENDIF
! STOP
ENDIF
#endif
END SUBROUTINE check_states
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!###############################################################################
SUBROUTINE aed_do_glm(wlev, pIce) BIND(C, name=_WQ_DO_GLM)
!-------------------------------------------------------------------------------
! wlev is the number of levels used;
!-------------------------------------------------------------------------------
!ARGUMENTS
CINTEGER,INTENT(in) :: wlev
CLOGICAL,INTENT(in) :: pIce
!
!LOCALS
TYPE(aed_variable_t),POINTER :: tv
AED_REAL :: min_C, surf
INTEGER :: i, j, v, lev, split
TYPE (aed_column_t) :: column(n_aed_vars)
TYPE (aed_column_t) :: column_sed(n_aed_vars)
AED_REAL,TARGET :: flux_ben(n_vars+n_vars_ben), flux_atm(n_vars+n_vars_ben)
! AED_REAL,TARGET :: flux_pel(wlev, n_vars+n_vars_ben)
AED_REAL,TARGET,ALLOCATABLE :: flux_pel(:, :)
AED_REAL,TARGET :: flux_zon(n_zones, n_vars+n_vars_ben)
!
!-------------------------------------------------------------------------------
!BEGIN
lIce = pIce
ALLOCATE(flux_pel(MAX(wlev,n_zones),n_vars+n_vars_ben))
surf = z(wlev)
!# re-compute the layer heights and depths
dz(1) = z(1)
depth(1) = surf - z(1)
layer_area(1) = 1
DO i=2,wlev
dz(i) = z(i) - z(i-1)
depth(i) = surf - z(i)
layer_area(i) = (area(i)-area(i-1))/area(i)
ENDDO
IF ( benthic_mode .GT. 1 ) THEN
j = 1
DO i=1,wlev
! print *,'j',i,j
! print *,'zone_heights',z(i),zone_heights(j),theZones(1)%zheight,theZones(2)%zheight
IF (z(i) .GT. zone_heights(j)) THEN
sed_zones(i) = j * area(i)
j = j+1
ELSE
sed_zones(i) = j
ENDIF
ENDDO
ENDIF
!# Calculate local pressure
pres(1:wlev) = -z(1:wlev)
CALL define_column(column, wlev, cc, cc_diag, flux_pel, flux_atm, flux_ben)
IF ( .NOT. reinited ) CALL re_initialize
cc_diag = 0.
cc_diag_hz = 0.
IF ( .NOT. mobility_off ) THEN
v = 0
DO i=1,n_aed_vars
IF ( aed_get_var(i, tv) ) THEN
IF ( .NOT. (tv%sheet .OR. tv%diag .OR. tv%extern) ) THEN
v = v + 1
ws(:,i) = zero_
! only for state_vars that are not sheet
IF ( .NOT. isnan(tv%mobility) ) THEN
! default to ws that was set during initialisation
ws(1:wlev,i) = tv%mobility
ENDIF
ENDIF
ENDIF
ENDDO
DO i = 1, wlev
! update ws for modules that use the mobility method
CALL aed_mobility(column, i, ws(i,:))
ENDDO
!# (3) Calculate source/sink terms due to the settling or rising of