-
Notifications
You must be signed in to change notification settings - Fork 9
/
carmastate_mod.F90
1627 lines (1389 loc) · 64 KB
/
carmastate_mod.F90
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
!! The CARMA state module contains the atmospheric data for use with the CARMA
!! module. This implementation has been customized to work within other model
!! frameworks. CARMA adds a lot of extra state information (atmospheric
!! properties, fall velocities, coagulation kernels, growth kernels, ...) and
!! thus has a large memory footprint. Because only one column will be operated
!! upon at a time per thread, only one cstate object needs to be instantiated
!! at a time and each cstate object only represents one column. This keeps
!! the memory requirements of CARMA to a minimum.
!!
!! @version Feb-2009
!! @author Chuck Bardeen, Pete Colarco, Jamie Smith
!
! NOTE: Documentation for this code can be generated automatically using f90doc,
! which is freely available from:
! http://erikdemaine.org/software/f90doc/
! Comment lines with double comment characters are processed by f90doc, and there are
! some special characters added to the comments to control the documentation process.
! In addition to the special characters mentioned in the f990doc documentation, html
! formatting tags (e.g. <i></i>, <sup></sup>, ...) can also be added to the f90doc
! comments.
module carmastate_mod
! This module maps the parents models constants into the constants need by CARMA.
! NOTE: CARMA constants are in CGS units, while the parent models are typically in
! MKS units.
use carma_precision_mod
use carma_enums_mod
use carma_constants_mod
use carma_types_mod
! cstate explicitly declares all variables.
implicit none
! All cstate variables and procedures are private except those explicitly
! declared to be public.
private
! Declare the public methods.
public CARMASTATE_Create
public CARMASTATE_CreateFromReference
public CARMASTATE_Destroy
public CARMASTATE_Get
public CARMASTATE_GetBin
public CARMASTATE_GetDetrain
public CARMASTATE_GetGas
public CARMASTATE_GetState
public CARMASTATE_SetBin
public CARMASTATE_SetDetrain
public CARMASTATE_SetGas
public CARMASTATE_SetState
public CARMASTATE_Step
contains
! These are the methods that provide the interface between the parent model and
! the atmospheric state data of the CARMA microphysical model. There are many other
! methods that are not in this file that are used to implement the microphysical
! calculations needed by the CARMA model. These other methods are in effect private
! methods of the CARMA module, but are in individual files since that is the way that
! CARMA has traditionally been structured and where users may want to extend or
! replace code to affect the microphysics.
!! Create the CARMASTATE object, which contains information about the
!! atmospheric state. Internally, CARMA uses CGS units, but this interface uses
!! MKS units which are more commonly used in parent models. The units and grid
!! orientation depend on the grid type:
!!
!! - igridv
!! - I_CART : Cartesian coordinates, units in [m], bottom at NZ=1
!! - I_SIG : Sigma coordinates, unitless [P/P0], top at NZ=1
!! - I_HYBRID : Hybrid coordinates, unitless [~P/P0], top at NZ=1
!!
!! NOTE: The supplied CARMA object should already have been created, configured,
!! and initialized.
!!
!! NOTE: The relative humidity is optional, but needs to be supplied if particles
!! are subject to swelling based upon relative humidity. The specific humdity can
!! can be specified instead. If both are specified, then the realtive humidity is
!! used.
!!
!! @author Chuck Bardeen
!! @version Feb-2009
!! @see CARMA_Create
!! @see CARMA_Initialize
!! @see CARMASTATE_Destroy
subroutine CARMASTATE_Create(cstate, carma_ptr, time, dtime, NZ, igridv, &
xc, yc, zc, zl, p, pl, t, rc, qh2o, relhum, told, radint)
type(carmastate_type), intent(inout) :: cstate !! the carma state object
type(carma_type), pointer, intent(in) :: carma_ptr !! (in) the carma object
real(kind=f), intent(in) :: time !! the model time [s]
real(kind=f), intent(in) :: dtime !! the timestep size [s]
integer, intent(in) :: NZ !! the number of vertical grid points
integer, intent(in) :: igridv !! vertical grid type
real(kind=f), intent(in) :: xc !! x at center
real(kind=f), intent(in) :: yc !! y at center
real(kind=f), intent(in) :: zc(NZ) !! z at center
real(kind=f), intent(in) :: zl(NZ+1) !! z at edge
real(kind=f), intent(in) :: p(NZ) !! pressure at center [Pa]
real(kind=f), intent(in) :: pl(NZ+1) !! presssure at edge [Pa]
real(kind=f), intent(in) :: t(NZ) !! temperature at center [K]
integer, intent(out) :: rc !! return code, negative indicates failure
real(kind=f), intent(in) , optional :: qh2o(NZ) !! specific humidity at center [mmr]
real(kind=f), intent(in) , optional :: relhum(NZ) !! relative humidity at center [fraction]
real(kind=f), intent(in) , optional :: told(NZ) !! previous temperature at center [K]
real(kind=f), intent(in) , optional :: radint(NZ,carma_ptr%f_NWAVE) !! radiative intensity [W/m2/sr/cm]
integer :: iz
real(kind=f) :: rvap
real(kind=f) :: pvap_liq
real(kind=f) :: pvap_ice
real(kind=f) :: gc_cgs
! Assume success.
rc = RC_OK
! Save the defintion of the number of comonents involved in the microphysics.
cstate%f_carma => carma_ptr
! Save the model timing.
cstate%f_time = time
cstate%f_dtime_orig = dtime
cstate%f_dtime = dtime
cstate%f_nretries = 0
! Save the grid dimensions.
cstate%f_NZ = NZ
cstate%f_NZP1 = NZ+1
! Save the grid definition.
cstate%f_igridv = igridv
! Store away the grid location information.
cstate%f_yc = yc
cstate%f_xc = yc
! Allocate all the dynamic variables related to state.
call CARMASTATE_Allocate(cstate, rc)
if (rc < 0) return
cstate%f_zc(:) = zc(:)
cstate%f_zl(:) = zl(:)
! Store away the grid state, doing any necessary unit conversions from MKS to CGS.
cstate%f_p(:) = p(:) * RPA2CGS
cstate%f_pl(:) = pl(:) * RPA2CGS
cstate%f_t(:) = t(:)
cstate%f_pcd(:,:,:) = 0._f
if (carma_ptr%f_do_substep) then
if (present(told)) then
cstate%f_told(:) = told
else
if (carma_ptr%f_do_print) write(carma_ptr%f_LUNOPRT,*) "CARMASTATE_Create: Error - Need to specify told when substepping."
rc = RC_ERROR
return
end if
end if
! Calculate the metrics, ...
! if Cartesian coordinates were specifed, then the units need to be converted
! from MKS to CGS.
if (cstate%f_igridv == I_CART) then
cstate%f_zc = cstate%f_zc * RM2CGS
cstate%f_zl = cstate%f_zl * RM2CGS
end if
! Initialize the state of the atmosphere.
call setupatm(carma_ptr, cstate, carma_ptr%f_do_fixedinit, rc)
if (rc < 0) return
! Set the realtive humidity. If necessary, it will be calculated from
! the specific humidity.
if (present(relhum)) then
cstate%f_relhum(:) = relhum(:)
else if (present(qh2o)) then
! Define gas constant for this gas
rvap = RGAS/WTMOL_H2O
! Calculate relative humidity
do iz = 1, NZ
call vaporp_h2o_murphy2005(carma_ptr, cstate, iz, rc, pvap_liq, pvap_ice)
if (rc < 0) return
gc_cgs = qh2o(iz)*cstate%f_rhoa_wet(iz) / cstate%f_zmet(iz)
cstate%f_relhum(iz) = ( gc_cgs * rvap * t(iz)) / pvap_liq
enddo
end if
! Need for vertical transport.
!
! NOTE: How should these be set? Optional parameters?
if (carma_ptr%f_do_vtran) then
cstate%f_ftoppart(:,:) = 0._f
cstate%f_fbotpart(:,:) = 0._f
cstate%f_pc_topbnd(:,:) = 0._f
cstate%f_pc_botbnd(:,:) = 0._f
end if
! Radiative intensity for particle heating.
!
! W/m2/sr/cm -> erg/s/cm2/sr/cm
if (carma_ptr%f_do_grow) then
if (present(radint)) cstate%f_radint(:,:) = radint(:,:) * 1e7_f / 1e4_f
end if
return
end subroutine CARMASTATE_Create
!! Create the CARMASTATE object, which contains information about the
!! atmospheric state.
!!
!! This call is similar to CARMASTATE_Create, but differs in that all the
!! initialization happens here based on the the fixed state information provided rather
!! than occurring in CARMASTATE_Step.
!!
!! This call should be done before CARMASTATE_Create when do_fixedinit has been
!! specified. The temperatures and pressures specified here should be the reference
!! state used for all columns, not an actual column from the model.
!!
!! A water vapor profile is optional, but is used whenever either qh2o (preferred)
!! or relhum have been provided. If this is not provided, then initialization will
!! be done on a dry profile. If particle swelling occurs, initialization will be
!! done on the wet radius; however, most of the initialized values will not get
!! recalculated as the wet radius changes.
!!
!! CARMASTATE_Create should still be called again after this call with the actual
!! column of state information from the model. The initialization will be done once
!! from the reference state, but the microphysical calculations will be done on the
!! model state. Multiple CARMASTATE_Create ... CARMASTATE_Step calls can be done
!! before a CARMASTATE_Destroy. This reduces the amount of memory allocations and
!! when used with do_fixedinit, reduces the amount of time spent initializing.
!!
!! @author Chuck Bardeen
!! @version June-2010
!! @see CARMA_Create
!! @see CARMA_Initialize
!! @see CARMASTATE_Destroy
subroutine CARMASTATE_CreateFromReference(cstate, carma_ptr, time, dtime, NZ, igridv, &
xc, yc, zc, zl, p, pl, t, rc, qh2o, relhum, qh2so4)
type(carmastate_type), intent(inout) :: cstate !! the carma state object
type(carma_type), pointer, intent(in) :: carma_ptr !! (in) the carma object
real(kind=f), intent(in) :: time !! the model time [s]
real(kind=f), intent(in) :: dtime !! the timestep size [s]
integer, intent(in) :: NZ !! the number of vertical grid points
integer, intent(in) :: igridv !! vertical grid type
real(kind=f), intent(in) :: xc !! x at center
real(kind=f), intent(in) :: yc !! y at center
real(kind=f), intent(in) :: zc(NZ) !! z at center
real(kind=f), intent(in) :: zl(NZ+1) !! z at edge
real(kind=f), intent(in) :: p(NZ) !! pressure at center [Pa]
real(kind=f), intent(in) :: pl(NZ+1) !! presssure at edge [Pa]
real(kind=f), intent(in) :: t(NZ) !! temperature at center [K]
integer, intent(out) :: rc !! return code, negative indicates failure
real(kind=f), intent(in) , optional :: qh2o(NZ) !! specific humidity at center [mmr]
real(kind=f), intent(in) , optional :: relhum(NZ) !! relative humidity at center [fraction]
real(kind=f), intent(in) , optional :: qh2so4(NZ) !! H2SO4 mass mixing ratio at center [mmr]
integer :: iz
integer :: igas
real(kind=f) :: rvap
real(kind=f) :: pvap_liq
real(kind=f) :: pvap_ice
real(kind=f) :: gc_cgs
! Assume success.
rc = RC_OK
! Save the defintion of the number of comonents involved in the microphysics.
cstate%f_carma => carma_ptr
! Save the model timing.
cstate%f_time = time
cstate%f_dtime_orig = dtime
cstate%f_dtime = dtime
cstate%f_nretries = 0
! Save the grid dimensions.
cstate%f_NZ = NZ
cstate%f_NZP1 = NZ+1
! Save the grid definition.
cstate%f_igridv = igridv
! Store away the grid location information.
cstate%f_xc = xc
cstate%f_yc = yc
! Allocate all the dynamic variables related to state.
call CARMASTATE_Allocate(cstate, rc)
if (rc < 0) return
cstate%f_zc(:) = zc(:)
cstate%f_zl(:) = zl(:)
! Store away the grid state, doing any necessary unit conversions from MKS to CGS.
cstate%f_p(:) = p(:) * RPA2CGS
cstate%f_pl(:) = pl(:) * RPA2CGS
cstate%f_t(:) = t(:)
cstate%f_pcd(:,:,:) = 0._f
! Calculate the metrics, ...
! if Cartesian coordinates were specifed, then the units need to be converted
! from MKS to CGS.
if (cstate%f_igridv == I_CART) then
cstate%f_zc = cstate%f_zc * RM2CGS
cstate%f_zl = cstate%f_zl * RM2CGS
end if
! Initialize the state of the atmosphere.
call setupatm(carma_ptr, cstate, .false., rc)
if (rc < 0) return
! If the model uses a gas, then set the relative and
! specific humidities.
if (carma_ptr%f_igash2o /= 0) then
if (present(qh2o)) then
cstate%f_gc(:, carma_ptr%f_igash2o) = qh2o(:) * cstate%f_rhoa_wet(:)
! Define gas constant for this gas
rvap = RGAS/WTMOL_H2O
! Calculate relative humidity
do iz = 1, NZ
call vaporp_h2o_murphy2005(carma_ptr, cstate, iz, rc, pvap_liq, pvap_ice)
if (rc < 0) return
gc_cgs = qh2o(iz) * cstate%f_rhoa_wet(iz) / cstate%f_zmet(iz)
cstate%f_relhum(iz) = (gc_cgs * rvap * t(iz)) / pvap_liq
enddo
else if (present(relhum)) then
cstate%f_relhum(:) = relhum
! Define gas constant for this gas
rvap = RGAS/WTMOL_H2O
! Calculate specific humidity
do iz = 1, NZ
call vaporp_h2o_murphy2005(carma_ptr, cstate, iz, rc, pvap_liq, pvap_ice)
if (rc < 0) return
gc_cgs = (rvap * t(iz)) / (pvap_liq * relhum(iz))
cstate%f_gc(iz, carma_ptr%f_igash2o) = gc_cgs * &
cstate%f_zmet(iz) / &
cstate%f_rhoa_wet(iz)
enddo
end if
end if
! If the model uses sulfuric acid, then set that gas concentration.
if (carma_ptr%f_igash2so4 /= 0) then
if (present(qh2so4)) then
cstate%f_gc(:, carma_ptr%f_igash2so4) = qh2so4(:) * cstate%f_rhoa_wet(:)
end if
end if
! Determine the gas supersaturations.
do iz = 1, cstate%f_NZ
do igas = 1, cstate%f_carma%f_NGAS
call supersat(cstate%f_carma, cstate, iz, igas, rc)
if (rc < 0) return
end do
end do
! Need for vertical transport.
!
! NOTE: How should these be set? Optional parameters?
if (carma_ptr%f_do_vtran) then
cstate%f_ftoppart(:,:) = 0._f
cstate%f_fbotpart(:,:) = 0._f
cstate%f_pc_topbnd(:,:) = 0._f
cstate%f_pc_botbnd(:,:) = 0._f
end if
! Now do the initialization that is normally done in CARMASTATE_Step. However
! here it is done using the reference atmosphere.
! Determine the particle densities.
call rhopart(cstate%f_carma, cstate, rc)
if (rc < 0) return
! Save off the wet radius and wet density as reference values to be used
! later to scale process rates based upon changes to the wet radius and
! wet density when particle swelling is used.
cstate%f_r_ref(:,:,:) = cstate%f_r_wet(:,:,:)
cstate%f_rhop_ref(:,:,:) = cstate%f_rhop_wet(:,:,:)
! If configured for fixed initialization, then we will lose some accuracy
! in the calculation of the fall velocities, growth kernels, ... and in return
! will gain a significant performance by not having to initialize as often.
! Initialize the vertical transport.
if (cstate%f_carma%f_do_vtran .or. cstate%f_carma%f_do_coag .or. cstate%f_carma%f_do_grow) then
call setupvf(cstate%f_carma, cstate, rc)
if (cstate%f_carma%f_do_vdiff) then
call setupbdif(cstate%f_carma, cstate, rc)
end if
end if
! Intialize the nucleation, growth and evaporation.
if (cstate%f_carma%f_do_grow) then
call setupgrow(cstate%f_carma, cstate, rc)
if (rc < 0) return
call setupgkern(cstate%f_carma, cstate, rc)
if (rc < 0) return
call setupnuc(cstate%f_carma, cstate, rc)
if (rc < 0) return
end if
! Initialize the coagulation.
if (cstate%f_carma%f_do_coag) then
call setupckern(cstate%f_carma, cstate, rc)
if (rc < 0) return
end if
return
end subroutine CARMASTATE_CreateFromReference
subroutine CARMASTATE_Allocate(cstate, rc)
type(carmastate_type), intent(inout) :: cstate
integer, intent(out) :: rc
! Local Variables
integer :: ier
integer :: NZ
integer :: NZP1
integer :: NGROUP
integer :: NELEM
integer :: NBIN
integer :: NGAS
integer :: NWAVE
! Assume success.
rc = RC_OK
! Check to see if the arrays are already allocated. If so, just reuse the
! existing allocations.
! Allocate the variables needed for setupatm.
if (.not. (allocated(cstate%f_zmet))) then
NZ = cstate%f_NZ
NZP1 = cstate%f_NZP1
NGROUP = cstate%f_carma%f_NGROUP
NELEM = cstate%f_carma%f_NELEM
NBIN = cstate%f_carma%f_NBIN
NGAS = cstate%f_carma%f_NGAS
NWAVE = cstate%f_carma%f_NWAVE
allocate( &
cstate%f_zmet(NZ), &
cstate%f_zmetl(NZP1), &
cstate%f_zc(NZ), &
cstate%f_dz(NZ), &
cstate%f_zl(NZP1), &
cstate%f_pc(NZ,NBIN,NELEM), &
cstate%f_pcd(NZ,NBIN,NELEM), &
cstate%f_pc_surf(NBIN,NELEM), &
cstate%f_sedimentationflux(NBIN,NELEM), &
cstate%f_gc(NZ,NGAS), &
cstate%f_cldfrc(NZ), &
cstate%f_rhcrit(NZ), &
cstate%f_rhop(NZ,NBIN,NGROUP), &
cstate%f_r_wet(NZ,NBIN,NGROUP), &
cstate%f_rlow_wet(NZ,NBIN,NGROUP), &
cstate%f_rup_wet(NZ,NBIN,NGROUP), &
cstate%f_rhop_wet(NZ,NBIN,NGROUP), &
cstate%f_r_ref(NZ,NBIN,NGROUP), &
cstate%f_rhop_ref(NZ,NBIN,NGROUP), &
cstate%f_rhoa(NZ), &
cstate%f_rhoa_wet(NZ), &
cstate%f_t(NZ), &
cstate%f_p(NZ), &
cstate%f_pl(NZP1), &
cstate%f_relhum(NZ), &
cstate%f_wtpct(NZ), &
cstate%f_rmu(NZ), &
cstate%f_thcond(NZ), &
cstate%f_thcondnc(NZ,NBIN,NGROUP), &
cstate%f_dpc_sed(NBIN,NELEM), &
cstate%f_pconmax(NZ,NGROUP), &
cstate%f_pcl(NZ,NBIN,NELEM), &
cstate%f_kappahygro(NZ,NBIN,NGROUP), &
stat=ier)
if (ier /= 0) then
if (cstate%f_carma%f_do_print) then
write(cstate%f_carma%f_LUNOPRT, *) "CARMASTATE_Allocate::&
&ERROR allocating atmosphere arrays, status=", ier
end if
rc = RC_ERROR
return
end if
cstate%f_relhum(:) = 0._f
cstate%f_pc(:,:,:) = 0._f
cstate%f_pcd(:,:,:) = 0._f
cstate%f_pc_surf(:,:) = 0._f
cstate%f_sedimentationflux(:,:) = 0._f
cstate%f_cldfrc(:) = 1._f
cstate%f_rhcrit(:) = 1._f
! Allocate the last fields if they are needed for substepping.
if (cstate%f_carma%f_do_substep) then
allocate( &
cstate%f_gcl(NZ,NGAS), &
cstate%f_d_gc(NZ,NGAS), &
cstate%f_told(NZ), &
cstate%f_d_t(NZ), &
cstate%f_zsubsteps(NZ), &
stat=ier)
if (ier /= 0) then
if (cstate%f_carma%f_do_print) then
write(cstate%f_carma%f_LUNOPRT, *) "CARMASTATE_Allocate::&
&ERROR allocating stepping arrays, status=", ier
end if
rc = RC_ERROR
return
endif
! Initialize
cstate%f_gcl(:,:) = 0._f
cstate%f_d_gc(:,:) = 0._f
cstate%f_told(:) = 0._f
cstate%f_d_t(:) = 0._f
cstate%f_zsubsteps(:) = 0._f
! When substepping is enabled, we want to initialize these statistics once for
! the life of the object.
cstate%f_max_nsubstep = 0
cstate%f_max_nretry = 0._f
cstate%f_nstep = 0._f
cstate%f_nsubstep = 0
cstate%f_nretry = 0._f
endif
! Allocate the variables needed for setupvf.
!
! NOTE: Coagulation and dry deposition also need bpm, vf and re.
if (cstate%f_carma%f_do_vtran .or. cstate%f_carma%f_do_coag .or. &
cstate%f_carma%f_do_grow .or. cstate%f_carma%f_do_drydep) then
allocate( &
cstate%f_bpm(NZ,NBIN,NGROUP), &
cstate%f_vf(NZP1,NBIN,NGROUP), &
cstate%f_re(NZ,NBIN,NGROUP), &
cstate%f_dkz(NZP1,NBIN,NGROUP), &
cstate%f_ftoppart(NBIN,NELEM), &
cstate%f_fbotpart(NBIN,NELEM), &
cstate%f_pc_topbnd(NBIN,NELEM), &
cstate%f_pc_botbnd(NBIN,NELEM), &
cstate%f_vd(NBIN, NGROUP), &
stat=ier)
if (ier /= 0) then
if (cstate%f_carma%f_do_print) then
write(cstate%f_carma%f_LUNOPRT, *) "CARMASTATE_Allocate::&
&ERROR allocating vertical transport arrays, status=", ier
end if
rc = RC_ERROR
return
endif
! Initialize
cstate%f_bpm(:,:,:) = 0._f
cstate%f_vf(:,:,:) = 0._f
cstate%f_re(:,:,:) = 0._f
cstate%f_dkz(:,:,:) = 0._f
cstate%f_ftoppart(:,:) = 0._f
cstate%f_fbotpart(:,:) = 0._f
cstate%f_pc_topbnd(:,:) = 0._f
cstate%f_pc_botbnd(:,:) = 0._f
cstate%f_vd(:, :) = 0._f
end if
if (cstate%f_carma%f_NGAS > 0) then
allocate( &
cstate%f_pvapl(NZ,NGAS), &
cstate%f_pvapi(NZ,NGAS), &
cstate%f_supsatl(NZ,NGAS), &
cstate%f_supsati(NZ,NGAS), &
cstate%f_supsatlold(NZ,NGAS), &
cstate%f_supsatiold(NZ,NGAS), &
stat=ier)
if (ier /= 0) then
if (cstate%f_carma%f_do_print) then
write(cstate%f_carma%f_LUNOPRT, *) "CARMASTATE_Allocate:: "&
//"ERROR allocating gas arrays, status=", ier
end if
rc = RC_ERROR
return
endif
end if
if (cstate%f_carma%f_do_grow) then
allocate( &
cstate%f_diffus(NZ,NGAS), &
cstate%f_rlhe(NZ,NGAS), &
cstate%f_rlhm(NZ,NGAS), &
cstate%f_surfctwa(NZ), &
cstate%f_surfctiw(NZ), &
cstate%f_surfctia(NZ), &
cstate%f_akelvin(NZ,NGAS), &
cstate%f_akelvini(NZ,NGAS), &
cstate%f_ft(NZ,NBIN,NGROUP), &
cstate%f_gro(NZ,NBIN,NGROUP), &
cstate%f_gro1(NZ,NBIN,NGROUP), &
cstate%f_gro2(NZ,NGROUP), &
cstate%f_scrit(NZ,NBIN,NGROUP), &
cstate%f_rnuclg(NBIN,NGROUP,NGROUP),&
cstate%f_rhompe(NBIN,NELEM), &
cstate%f_rnucpe(NBIN,NELEM), &
cstate%f_pc_nucl(NZ,NBIN,NELEM), &
cstate%f_growpe(NBIN,NELEM), &
cstate%f_evappe(NBIN,NELEM), &
cstate%f_evcore(NELEM), &
cstate%f_growlg(NBIN,NGROUP), &
cstate%f_evaplg(NBIN,NGROUP), &
cstate%f_gasprod(NGAS), &
cstate%f_rlheat(NZ), &
cstate%f_radint(NZ,NWAVE), &
cstate%f_partheat(NZ), &
cstate%f_dtpart(NZ,NBIN,NGROUP), &
cstate%f_cmf(NBIN,NGROUP), &
cstate%f_totevap(NBIN,NGROUP), &
stat=ier)
if (ier /= 0) then
if (cstate%f_carma%f_do_print) then
write(cstate%f_carma%f_LUNOPRT, *) "CARMASTATE_Allocate::&
&ERROR allocating growth arrays, status=", ier
end if
rc = RC_ERROR
return
endif
cstate%f_radint(:,:) = 0._f
end if
if (cstate%f_carma%f_do_coag) then
allocate( &
cstate%f_coaglg(NZ,NBIN,NGROUP), &
cstate%f_coagpe(NZ,NBIN,NELEM), &
cstate%f_ckernel(NZ,NBIN,NBIN,NGROUP,NGROUP), &
stat = ier)
if (ier /= 0) then
if (cstate%f_carma%f_do_print) then
write(cstate%f_carma%f_LUNOPRT, *) "CARMASTATE_Allocate::&
&ERROR allocating coag arrays, status=", ier
end if
rc = RC_ERROR
return
end if
! Initialize
cstate%f_coaglg(:,:,:) = 0._f
cstate%f_coagpe(:,:,:) = 0._f
cstate%f_ckernel(:,:,:,:,:) = 0._f
end if
end if
return
end subroutine CARMASTATE_Allocate
!! The routine should be called when the carma state object is no longer needed.
!! It deallocates any memory allocations made by CARMA during CARMASTATE_Create(),
!! and failure to call this routine could result in memory leaks.
!!
!! @author Chuck Bardeen
!! @version Feb-2009
!! @see CARMASTATE_Create
subroutine CARMASTATE_Destroy(cstate, rc)
type(carmastate_type), intent(inout) :: cstate
integer, intent(out) :: rc
! Local variables
integer :: ier
! Assume success.
rc = RC_OK
! Check to see if the arrays are already allocated. If so, deallocate them.
! Allocate the variables needed for setupatm.
if (allocated(cstate%f_zmet)) then
deallocate( &
cstate%f_zmet, &
cstate%f_zmetl, &
cstate%f_zc, &
cstate%f_dz, &
cstate%f_zl, &
cstate%f_pc, &
cstate%f_pcd, &
cstate%f_pc_surf, &
cstate%f_sedimentationflux, &
cstate%f_gc, &
cstate%f_cldfrc, &
cstate%f_rhcrit, &
cstate%f_rhop, &
cstate%f_r_wet, &
cstate%f_rlow_wet, &
cstate%f_rup_wet, &
cstate%f_rhop_wet, &
cstate%f_r_ref, &
cstate%f_rhop_ref, &
cstate%f_rhoa, &
cstate%f_rhoa_wet, &
cstate%f_t, &
cstate%f_p, &
cstate%f_pl, &
cstate%f_relhum, &
cstate%f_wtpct, &
cstate%f_rmu, &
cstate%f_thcond, &
cstate%f_thcondnc, &
cstate%f_dpc_sed, &
cstate%f_pconmax, &
cstate%f_pcl, &
cstate%f_kappahygro, &
stat=ier)
if (ier /= 0) then
if (cstate%f_carma%f_do_print) then
write(cstate%f_carma%f_LUNOPRT, *) "CARMASTATE_Destroy::&
&ERROR deallocating atmosphere arrays, status=", ier
end if
rc = RC_ERROR
return
end if
! Allocate the last fields if they are needed for substepping stepping.
if (allocated(cstate%f_gcl)) then
deallocate( &
cstate%f_gcl, &
cstate%f_d_gc, &
cstate%f_told, &
cstate%f_d_t, &
cstate%f_zsubsteps, &
stat=ier)
if (ier /= 0) then
if (cstate%f_carma%f_do_print) then
write(cstate%f_carma%f_LUNOPRT, *) "CARMASTATE_Destroy::&
&ERROR deallocating stepping arrays, status=", ier
end if
rc = RC_ERROR
return
endif
endif
! Allocate the variables needed for setupvf.
!
! NOTE: Coagulation also needs bpm, vf and re.
if (allocated(cstate%f_bpm)) then
deallocate( &
cstate%f_bpm, &
cstate%f_vf, &
cstate%f_re, &
cstate%f_dkz, &
cstate%f_ftoppart, &
cstate%f_fbotpart, &
cstate%f_pc_topbnd, &
cstate%f_pc_botbnd, &
cstate%f_vd, &
stat=ier)
if (ier /= 0) then
if (cstate%f_carma%f_do_print) then
write(cstate%f_carma%f_LUNOPRT, *) "CARMASTATE_Destroy::&
&ERROR deallocating vertical transport arrays, status=", ier
end if
rc = RC_ERROR
return
endif
end if
if (allocated(cstate%f_diffus)) then
deallocate( &
cstate%f_diffus, &
cstate%f_rlhe, &
cstate%f_rlhm, &
cstate%f_surfctwa, &
cstate%f_surfctiw, &
cstate%f_surfctia, &
cstate%f_akelvin, &
cstate%f_akelvini, &
cstate%f_ft, &
cstate%f_gro, &
cstate%f_gro1, &
cstate%f_gro2, &
cstate%f_scrit, &
cstate%f_rnuclg,&
cstate%f_rnucpe, &
cstate%f_rhompe, &
cstate%f_pc_nucl, &
cstate%f_growpe, &
cstate%f_evappe, &
cstate%f_evcore, &
cstate%f_growlg, &
cstate%f_evaplg, &
cstate%f_gasprod, &
cstate%f_rlheat, &
cstate%f_radint, &
cstate%f_partheat, &
cstate%f_dtpart, &
cstate%f_cmf, &
cstate%f_totevap, &
stat=ier)
if (ier /= 0) then
if (cstate%f_carma%f_do_print) then
write(cstate%f_carma%f_LUNOPRT, *) "CARMASTATE_Destroy::&
&ERROR deallocating growth arrays, status=", ier
end if
rc = RC_ERROR
return
endif
end if
if (allocated(cstate%f_pvapl)) then
deallocate( &
cstate%f_pvapl, &
cstate%f_pvapi, &
cstate%f_supsatl, &
cstate%f_supsati, &
cstate%f_supsatlold, &
cstate%f_supsatiold, &
stat=ier)
if (ier /= 0) then
if (cstate%f_carma%f_do_print) then
write(cstate%f_carma%f_LUNOPRT, *) "CARMASTATE_Destroy::&
&ERROR deallocating gas arrays, status=", ier
end if
rc = RC_ERROR
return
endif
end if
if (allocated(cstate%f_coaglg)) then
deallocate( &
cstate%f_coaglg, &
cstate%f_coagpe, &
cstate%f_ckernel, &
stat = ier)
if (ier /= 0) then
if (cstate%f_carma%f_do_print) then
write(cstate%f_carma%f_LUNOPRT, *) "CARMASTATE_Destroy::&
&ERROR deallocating coag arrays, status=", ier
end if
rc = RC_ERROR
return
end if
end if
end if
return
end subroutine CARMASTATE_Destroy
!! The routine performs the main CARMA processing for one timestep of
!! the parent model. The state variables should have all been set before
!! calling CARMASTATE_Step(). When this routine returns, the state will
!! have been updated to reflect the changes from the CARMA microphysics.
!! If tendencies are desired, then the difference between the final and
!! initial state will need to be computed by the caller.
!!
!! NIOTE: xxxfv, xxxram and xxxfrac need to be specified for dry deposition.
!!
!! @author Chuck Bardeen
!! @version Feb-2009
subroutine CARMASTATE_Step(cstate, rc, cldfrc, rhcrit, lndfv, ocnfv, icefv, lndram, ocnram, iceram, lndfrac, ocnfrac, icefrac)
type(carmastate_type), intent(inout) :: cstate
integer, intent(out) :: rc
real(kind=f), intent(in), optional :: cldfrc(cstate%f_NZ) !! cloud fraction [fraction]
real(kind=f), intent(in), optional :: rhcrit(cstate%f_NZ) !! relative humidity for onset of liquid clouds [fraction]
real(kind=f), intent(in), optional :: lndfv !! the surface friction velocity over land [m/s]
real(kind=f), intent(in), optional :: ocnfv !! the surface friction velocity over ocean [m/s]
real(kind=f), intent(in), optional :: icefv !! the surface friction velocity over ice [m/s]
real(kind=f), intent(in), optional :: lndram !! the aerodynamic resistance over land [s/m]
real(kind=f), intent(in), optional :: ocnram !! the aerodynamic resistance over ocean [s/m]
real(kind=f), intent(in), optional :: iceram !! the aerodynamic resistance over ice [s/m]
real(kind=f), intent(in), optional :: lndfrac !! land fraction
real(kind=f), intent(in), optional :: ocnfrac !! ocn fraction
real(kind=f), intent(in), optional :: icefrac !! ice fraction
integer :: iz ! vertical index
integer :: igas ! gas index
! Assume success.
rc = RC_OK
! Store the cloud fraction if specified
cstate%f_cldfrc(:) = 1._f
cstate%f_rhcrit(:) = 1._f
if (present(cldfrc)) cstate%f_cldfrc(:) = cldfrc(:)
if (present(rhcrit)) cstate%f_rhcrit(:) = rhcrit(:)
! Determine the gas supersaturations.
do iz = 1, cstate%f_NZ
do igas = 1, cstate%f_carma%f_NGAS
call supersat(cstate%f_carma, cstate, iz, igas, rc)
if (rc < 0) return
end do
end do
! Determine the particle densities.
call rhopart(cstate%f_carma, cstate, rc)
if (rc < 0) return
! We have to hold off initialization until now, because the particle density
! (rhop) can not be determined until the particle masses are known (i.e. after
! CARMASTATE_SetBin), because rhop is used to determine the fall velocity.
!
! NOTE: If configured for fixed initialization, then we will lose some accuracy
! in the calculation of the fall velocities, growth kernels, ... and in return
! will gain a significant performance by not having to initialize as often.
!
! NOTE: If configured for partial initialized in conjunction with fixed
! initialization, then do the fall velocity (and growth) initialization which
! is relatively quick, but skip the recalculation of the coagulation kernels
! which is relatively expensive. This could be useful for particles that have
! a wet radius that is different from the dry radius or where there are large
! changes from the average conditions (temperature, water vapor, ...) used in
! the fixed initialization.
if ((.not. cstate%f_carma%f_do_fixedinit) .or. &
(cstate%f_carma%f_do_partialinit)) then
! Initialize the vertical transport.
if (cstate%f_carma%f_do_vtran .or. cstate%f_carma%f_do_coag .or. cstate%f_carma%f_do_grow) then
call setupvf(cstate%f_carma, cstate, rc)
if (cstate%f_carma%f_do_vdiff) then
call setupbdif(cstate%f_carma, cstate, rc)
end if
end if
! Initialize the nucleation, growth and evaporation.
if (cstate%f_carma%f_do_grow) then
call setupgrow(cstate%f_carma, cstate, rc)
if (rc < RC_OK) return
call setupgkern(cstate%f_carma, cstate, rc)
if (rc < RC_OK) return
call setupnuc(cstate%f_carma, cstate, rc)
if (rc < RC_OK) return
end if
! Initialize the coagulation.
if (cstate%f_carma%f_do_coag .and. &
(.not. cstate%f_carma%f_do_fixedinit)) then
call setupckern(cstate%f_carma, cstate, rc)
if (rc < RC_OK) return
end if
end if
! Initialize the dry deposition
!
! NOTE: This is tied to the surface fields that vary from column to column,
! so it needs to get calculated here whether using fixed or full initialization.
if (cstate%f_carma%f_do_drydep) then
if (present(lndfv) .and. present(lndram) .and. present(lndfrac) .and. &
present(ocnfv) .and. present(ocnram) .and. present(ocnfrac) .and. &
present(icefv) .and. present(iceram) .and. present(icefrac)) then
! NOTE: Need to convert surfric and ram from mks to cgs units.
call setupvdry(cstate%f_carma, cstate, &
lndfv * 100._f, ocnfv * 100._f, icefv * 100._f, &
lndram / 100._f, ocnram / 100._f, iceram / 100._f, &
lndfrac, ocnfrac, icefrac, rc)
if (rc < RC_OK) return
else
write(cstate%f_carma%f_LUNOPRT, *) "CARMASTATE_Step: &
&do_drydep requires that the optional inputs xxxfv, xxxram &
&and xxxfrac be provided."
rc = RC_ERROR
return
end if
end if
call fixcorecol(cstate%f_carma, cstate, rc)
! Calculate the impact of microphysics upon the state.
call step(cstate%f_carma, cstate, rc)
call fixcorecol(cstate%f_carma, cstate, rc)
return
end subroutine CARMASTATE_Step