-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMAML_OpticsTableMod.F90
589 lines (430 loc) · 20.1 KB
/
MAML_OpticsTableMod.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
#include "MAPL_Exceptions.h"
!-------------------------------------------------------------------------
! NASA/GSFC, Global Modeling and Assimilation Office, Code 610.1 !
!-------------------------------------------------------------------------
!BOP
!
! !MODULE: MAML_OpticsTableMod --- Reader for aerosol optical properties
! lookup tables.
!
! !INTERFACE:
!
module MAML_OpticsTableMod
! !USES:
use ESMF
use MAPL
use m_die, only: die, warn
use netcdf
implicit none
! !PUBLIC TYPES:
private
public MAML_OpticsTable ! Holds Optics Lookup Tables
!
! !PUBLIC MEMBER FUNCTIONS:
!
public MAML_OpticsTableCreate ! Constructor - create a new optics table
public MAML_OpticsTableDestroy ! Destructor - release resources associated with an optics table
public MAML_OpticsTableRead ! Read optics table from a file
!
! !DESCRIPTION:
!
! This module reads optics/mie aerosol tables.
!
! !REVISION HISTORY:
!
! 01Apr2013 Darmenov - Initial code based on Chem_MieTableMod.
!
!EOP
!-------------------------------------------------------------------------
! Optics/Mie LUT table
! Will be reduced from input files to the desired channels
! --------
type MAML_OpticsTable
character(len=1024):: file ! lookup table file
! mode properties
logical :: monochromatic ! flag that indicates monochromatic or band-averaged quantities
real :: Dgs_min ! diameter of surface distribution - lower bound
real :: Dgs_max ! diameter of surface distribution - upper bound
real :: sigma ! geometric standard deviation of lognormal size distribution
real :: rh_deliq ! RH deliquescence point
real :: rh_cryst ! RH crystallization point
integer :: n_aerosol_components ! number of aerosol components
character(len=80), pointer &
:: component(:) => null() ! aerosol components
real, pointer :: component_refractive_index_re(:,:) ! real part of aerosol component refractive index
real, pointer :: component_refractive_index_im(:,:) ! imaginary part of aerosol component refractive index
! mie
integer :: n_cheb ! number of terms used in truncated Chebyshev series expansion
integer :: n_bands ! number of monochromatic (narrow-band) or heterochromatic (wideband) bands
integer :: n_refractive_index_re ! number of refractive indexes - real part
integer :: n_refractive_index_im ! number of refractive indexes - imaginary part
real, pointer :: wavelength(:,:) => null() ! band range, lower- and upper-bound wavelengths
real, pointer :: refractive_index_re(:,:) => null() ! real part of refractive index
real, pointer :: refractive_index_im(:,:) => null() ! imaginary part of refractive index
real, pointer :: c_ext(:,:,:,:) => null() ! chebyshev polynomial coefficients of specific extinction
real, pointer :: c_sca(:,:,:,:) => null() ! chebyshev polynomial coefficients of specific scattering
real, pointer :: c_asy(:,:,:,:) => null() ! chebyshev polynomial coefficients of asymmetry parameter
! TODO...
! integer :: n_mom ! number of moments of phase function
! integer :: n_pol ! number of elements of scattering phase matrix
! real, pointer :: pback(:,:,:,:) => null() ! backscatter phase function
! real, pointer :: pmom(:,:,:,:,:) => null() ! moments of phase function
end type MAML_OpticsTable
contains
!-------------------------------------------------------------------------
! NASA/GSFC, Global Modeling and Assimilation Office, Code 610.1 !
!-------------------------------------------------------------------------
!BOP
!
! !IROUTINE: MAML_OpticsTableCreate --- Construct Chemistry Registry
!
! !INTERFACE:
!
function MAML_OpticsTableCreate(file, rc) result (this)
implicit none
type(MAML_OpticsTable) :: this
! !INPUT/OUTPUT PARAMETERS:
! !INPUT PARAMETERS:
character(len=*), intent(in) :: file
! !OUTPUT PARAMETERS:
integer, intent(out) :: rc ! Error return code:
! 0 - all is well
! 1 -
! !DESCRIPTION:
!
!
! !REVISION HISTORY:
!
! 01Apr2013 Darmenov API.
!
!EOP
!-------------------------------------------------------------------------
__Iam__("Chem_MieTableCreate")
type(MAML_OpticsTable) :: lut
lut%file = trim(file)
lut%monochromatic = .false.
lut%Dgs_min = -1.0
lut%Dgs_max = -1.0
lut%sigma = -1.0
lut%rh_deliq = -1.0
lut%rh_cryst = -1.0
lut%n_aerosol_components = -1
lut%n_cheb = -1
lut%n_bands = -1
lut%n_refractive_index_re = -1
lut%n_refractive_index_im = -1
! lut%n_mom = -1
! lut%n_pol = -1
this = lut
RETURN_(ESMF_SUCCESS)
end function MAML_OpticsTableCreate
!-------------------------------------------------------------------------
! NASA/GSFC, Global Modeling and Assimilation Office, Code 610.1 !
!-------------------------------------------------------------------------
!BOP
!
! !IROUTINE: MAML_OpticsTableDestroy --- Release resources associated with the table
!
! !INTERFACE:
!
subroutine MAML_OpticsTableDestroy(this, rc)
! !USES:
implicit none
! !INPUT/OUTPUT PARAMETERS:
type(MAML_OpticsTable), intent(inout) :: this
! !INPUT PARAMETERS:
! !OUTPUT PARAMETERS:
integer, intent(out) :: rc ! Error return code:
! 0 - all is well
! 1 -
! !DESCRIPTION: Destructor for MAML_OpticsTable object.
!
! !REVISION HISTORY:
!
! 01Apr2013 Darmenov API.
!
!EOP
!-------------------------------------------------------------------------
__Iam__("MAML_OpticsTableDestroy")
! Set these to invalid values
! ---------------------------
this%file = ''
this%monochromatic = .false.
this%Dgs_min = -1.0
this%Dgs_max = -1.0
this%sigma = -1.0
this%rh_deliq = -1.0
this%rh_cryst = -1.0
this%n_aerosol_components = -1
this%n_cheb = -1
this%n_bands = -1
this%n_refractive_index_re = -1
this%n_refractive_index_im = -1
! this%n_mom = -1
! this%n_pol = -1
! Deallocate whatever has been allocated
! --------------------------------------
if (associated(this%component)) &
deallocate(this%component, __STAT__)
if (associated(this%component_refractive_index_re)) &
deallocate(this%component_refractive_index_re, __STAT__)
if (associated(this%component_refractive_index_im)) &
deallocate(this%component_refractive_index_im, __STAT__)
if (associated(this%refractive_index_re)) &
deallocate(this%refractive_index_re, __STAT__)
if (associated(this%refractive_index_im)) &
deallocate(this%refractive_index_im, __STAT__)
if (associated(this%wavelength)) &
deallocate(this%wavelength, __STAT__)
if (associated(this%c_ext)) &
deallocate(this%c_ext, __STAT__)
if (associated(this%c_sca)) &
deallocate(this%c_sca, __STAT__)
if (associated(this%c_asy)) &
deallocate(this%c_asy, __STAT__)
! if (associated(this%bbck)) deallocate(this%bbck, __STAT__)
! if (associated(this%pmom)) deallocate(this%pmom, __STAT__)
! All done
! --------
RETURN_(ESMF_SUCCESS)
end subroutine MAML_OpticsTableDestroy
!-------------------------------------------------------------------------
! NASA/GSFC, Global Modeling and Assimilation Office, Code 610.1 !
!-------------------------------------------------------------------------
!BOP
!
! !IROUTINE: MAML_OpticsTableRead --- Read and fill in the Optics/Mie table
!
! !INTERFACE:
!
subroutine MAML_OpticsTableRead(this, rc)
implicit none
! !INPUT/OUTPUT PARAMETERS:
type(MAML_OpticsTable), intent(inout) :: this
! !INPUT PARAMETERS:
! !OUTPUT PARAMETERS:
integer, intent(out) :: rc ! return code
! !DESCRIPTION: Fills in the Optics/Mie table
!
! !REVISION HISTORY:
!
! 01Mar2013 Darmenov API.
!
!EOP
!-------------------------------------------------------------------------
integer :: id_nc, id_dim, id_var ! IDs for NetCDF objects
integer :: id_dim_band, len_dim_band ! length of the wavelength dimension
integer :: id_dim_range, len_dim_range ! length of the range dimension
integer :: id_dim_component, len_dim_component ! length of the aerosol components dimension
integer :: id_dim_chars, len_dim_chars ! length of the characters dimension
integer :: id_dim_n_re, len_dim_n_re ! length of the real part of refractive index dimension
integer :: id_dim_n_im, len_dim_n_im ! length of the imaginary part of refractive index dimension
integer :: id_dim_k, len_dim_k ! length of the truncated Chebyshev series dimension
integer, dimension(nf90_max_var_dims) :: var_dim_ids
integer, dimension(nf90_max_var_dims) :: var_dim_len
integer :: dim_len
integer :: n_dims
character(len=80) :: buff_str
__Iam__("MAML_OpticsTableRead")
! Open the lookup table file
! --------------------------
rc = nf90_open(trim(this%file), NF90_NOWRITE, id_nc); VERIFY_(rc)
! Read ID and size of dimensions
! -------------------------------
call get_dim_info_(id_nc, 'band', id_dim_band, len_dim_band, __RC__)
call get_dim_info_(id_nc, 'range', id_dim_range, len_dim_range, __RC__)
call get_dim_info_(id_nc, 'nchars', id_dim_chars, len_dim_chars, __RC__)
call get_dim_info_(id_nc, 'component', id_dim_component, len_dim_component, __RC__)
call get_dim_info_(id_nc, 'n_re', id_dim_n_re, len_dim_n_re, __RC__)
call get_dim_info_(id_nc, 'n_im', id_dim_n_im, len_dim_n_im, __RC__)
call get_dim_info_(id_nc, 'k', id_dim_k, len_dim_k, __RC__)
_ASSERT(len_dim_range == 2,'needs informative message')
this%n_bands = len_dim_band
this%n_aerosol_components = len_dim_component
this%n_cheb = len_dim_k
this%n_refractive_index_re = len_dim_n_re
this%n_refractive_index_im = len_dim_n_im
! Read lookup table attributes
! ----------------------------
rc = nf90_get_att(id_nc, NF90_GLOBAL, 'aerosol_method', buff_str); VERIFY_(rc)
_ASSERT(buff_str == 'modal','needs informative message')
rc = nf90_get_att(id_nc, NF90_GLOBAL, 'optics', buff_str); VERIFY_(rc)
_ASSERT(buff_str == 'monochromatic' .or. buff_str == 'band averaged','needs informative message')
if (buff_str == 'monochromatic') then
this%monochromatic = .true.
else
this%monochromatic = .false.
end if
rc = nf90_get_att(id_nc, NF90_GLOBAL, 'Dgs_min', this%Dgs_min)
VERIFY_(rc)
rc = nf90_get_att(id_nc, NF90_GLOBAL, 'Dgs_max', this%Dgs_max)
VERIFY_(rc)
rc = nf90_get_att(id_nc, NF90_GLOBAL, 'mode_width', this%sigma)
VERIFY_(rc)
rc = nf90_get_att(id_nc, NF90_GLOBAL, 'mode_deliq', this%rh_deliq)
VERIFY_(rc)
rc = nf90_get_att(id_nc, NF90_GLOBAL, 'mode_cryst', this%rh_cryst)
VERIFY_(rc)
! Read data - aerosol components
! -----------------------------------------------------------
var_dim_ids = 0
var_dim_len = 0
rc = nf90_inq_varid(id_nc, 'component', id_var); VERIFY_(rc)
rc = nf90_inquire_variable(id_nc, id_var, ndims=n_dims); VERIFY_(rc)
rc = nf90_inquire_variable(id_nc, id_var, dimids=var_dim_ids(:n_dims)); VERIFY_(rc)
_ASSERT(n_dims == 2,'needs informative message')
_ASSERT(var_dim_ids(1) == id_dim_chars .and. var_dim_ids(2) == id_dim_component,'needs informative message')
allocate(this%component(len_dim_component), __STAT__)
rc = nf90_get_var(id_nc, id_var, this%component); VERIFY_(rc)
! Read data - real part of aerosol component refractive index
! -----------------------------------------------------------
var_dim_ids = 0
var_dim_len = 0
rc = nf90_inq_varid(id_nc, 'component_n_re', id_var); VERIFY_(rc)
rc = nf90_inquire_variable(id_nc, id_var, ndims=n_dims); VERIFY_(rc)
rc = nf90_inquire_variable(id_nc, id_var, dimids=var_dim_ids(:n_dims)); VERIFY_(rc)
_ASSERT(n_dims == 2,'needs informative message')
_ASSERT(var_dim_ids(1) == id_dim_band .and. var_dim_ids(2) == id_dim_component,'needs informative message')
allocate(this%component_refractive_index_re(len_dim_band, len_dim_component), __STAT__)
rc = nf90_get_var(id_nc, id_var, this%component_refractive_index_re); VERIFY_(rc)
! Read data - imaginary part of aerosol component refractive index
! -----------------------------------------------------------
var_dim_ids = 0
var_dim_len = 0
rc = nf90_inq_varid(id_nc, 'component_n_im', id_var); VERIFY_(rc)
rc = nf90_inquire_variable(id_nc, id_var, ndims=n_dims); VERIFY_(rc)
rc = nf90_inquire_variable(id_nc, id_var, dimids=var_dim_ids(:n_dims)); VERIFY_(rc)
_ASSERT(n_dims == 2,'needs informative message')
_ASSERT(var_dim_ids(1) == id_dim_band .and. var_dim_ids(2) == id_dim_component,'needs informative message')
allocate(this%component_refractive_index_im(len_dim_band, len_dim_component), __STAT__)
rc = nf90_get_var(id_nc, id_var, this%component_refractive_index_im); VERIFY_(rc)
! Read data - band range
! ----------------------
var_dim_ids = 0
var_dim_len = 0
rc = nf90_inq_varid(id_nc, 'wavelength', id_var); VERIFY_(rc)
rc = nf90_inquire_variable(id_nc, id_var, ndims=n_dims); VERIFY_(rc)
rc = nf90_inquire_variable(id_nc, id_var, dimids=var_dim_ids(:n_dims)); VERIFY_(rc)
_ASSERT(n_dims == 2,'needs informative message')
_ASSERT(var_dim_ids(1) == id_dim_band .and. var_dim_ids(2) == id_dim_range,'needs informative message')
allocate(this%wavelength(len_dim_band, len_dim_range), __STAT__)
rc = nf90_get_var(id_nc, id_var, this%wavelength); VERIFY_(rc)
if (this%monochromatic) then
_ASSERT(maxval(abs(this%wavelength(:,1) - this%wavelength(:,2))) < 1e2*tiny(0.0),'needs informative message')
end if
! Read data - real part of refractive index
! -----------------------------------------
var_dim_ids = 0
var_dim_len = 0
rc = nf90_inq_varid(id_nc, 'n_re', id_var); VERIFY_(rc)
rc = nf90_inquire_variable(id_nc, id_var, ndims=n_dims); VERIFY_(rc)
rc = nf90_inquire_variable(id_nc, id_var, dimids=var_dim_ids(:n_dims)); VERIFY_(rc)
_ASSERT(n_dims == 2,'needs informative message')
_ASSERT(var_dim_ids(1) == id_dim_band .and. var_dim_ids(2) == id_dim_n_re,'needs informative message')
allocate(this%refractive_index_re(len_dim_band, len_dim_n_re), __STAT__)
rc = nf90_get_var(id_nc, id_var, this%refractive_index_re); VERIFY_(rc)
! Read data - imaginary part of refractive index
! ----------------------------------------------
var_dim_ids = 0
var_dim_len = 0
rc = nf90_inq_varid(id_nc, 'n_im', id_var); VERIFY_(rc)
rc = nf90_inquire_variable(id_nc, id_var, ndims=n_dims); VERIFY_(rc)
rc = nf90_inquire_variable(id_nc, id_var, dimids=var_dim_ids(:n_dims)); VERIFY_(rc)
_ASSERT(n_dims == 2,'needs informative message')
_ASSERT(var_dim_ids(1) == id_dim_band .and. var_dim_ids(2) == id_dim_n_im,'needs informative message')
allocate(this%refractive_index_im(len_dim_band, len_dim_n_im), __STAT__)
rc = nf90_get_var(id_nc, id_var, this%refractive_index_im); VERIFY_(rc)
! Read data - chebyshev polynomial coefficients of specific extinction
! --------------------------------------------------------------------
var_dim_ids = 0
var_dim_len = 0
rc = nf90_inq_varid(id_nc, 'c_ext', id_var); VERIFY_(rc)
rc = nf90_inquire_variable(id_nc, id_var, ndims=n_dims); VERIFY_(rc)
rc = nf90_inquire_variable(id_nc, id_var, dimids=var_dim_ids(:n_dims)); VERIFY_(rc)
_ASSERT(n_dims == 4,'needs informative message')
_ASSERT(all(var_dim_ids(:4) .eq. (/id_dim_band, id_dim_n_im, id_dim_n_re, id_dim_k/)),'needs informative message')
allocate(this%c_ext(len_dim_band, len_dim_n_im, len_dim_n_re, len_dim_k), __STAT__)
rc = nf90_get_var(id_nc, id_var, this%c_ext); VERIFY_(rc)
! Read data - chebyshev polynomial coefficients of specific scattering
! --------------------------------------------------------------------
var_dim_ids = 0
var_dim_len = 0
rc = nf90_inq_varid(id_nc, 'c_sca', id_var); VERIFY_(rc)
rc = nf90_inquire_variable(id_nc, id_var, ndims=n_dims); VERIFY_(rc)
rc = nf90_inquire_variable(id_nc, id_var, dimids=var_dim_ids(:n_dims)); VERIFY_(rc)
_ASSERT(n_dims == 4,'needs informative message')
_ASSERT(all(var_dim_ids(:4) .eq. (/id_dim_band, id_dim_n_im, id_dim_n_re, id_dim_k/)),'needs informative message')
allocate(this%c_sca(len_dim_band, len_dim_n_im, len_dim_n_re, len_dim_k), __STAT__)
rc = nf90_get_var(id_nc, id_var, this%c_sca); VERIFY_(rc)
! Read data - chebyshev polynomial coefficients of asymmetry parameter
! --------------------------------------------------------------------
var_dim_ids = 0
var_dim_len = 0
rc = nf90_inq_varid(id_nc, 'c_asy', id_var); VERIFY_(rc)
rc = nf90_inquire_variable(id_nc, id_var, ndims=n_dims); VERIFY_(rc)
rc = nf90_inquire_variable(id_nc, id_var, dimids=var_dim_ids(:n_dims)); VERIFY_(rc)
_ASSERT(n_dims == 4,'needs informative message')
_ASSERT(all(var_dim_ids(:4) .eq. (/id_dim_band, id_dim_n_im, id_dim_n_re, id_dim_k/)),'needs informative message')
allocate(this%c_asy(len_dim_band, len_dim_n_im, len_dim_n_re, len_dim_k), __STAT__)
rc = nf90_get_var(id_nc, id_var, this%c_asy); VERIFY_(rc)
! Get the backscatter phase function values
! TODO...
! Close the table file
! -------------------------------------
rc = nf90_close(id_nc); VERIFY_(rc)
RETURN_(ESMF_SUCCESS)
contains
subroutine get_dim_info_(id_nc, dim_name, dim_id, dim_len, rc)
implicit none
integer, intent(in) :: id_nc
character(len=*), intent(in) :: dim_name
integer, intent(out) :: dim_id
integer, intent(out) :: dim_len
integer, intent(out) :: rc
rc = nf90_inq_dimid(id_nc, trim(dim_name), dim_id); VERIFY_(rc)
rc = nf90_inquire_dimension(id_nc, dim_id, len=dim_len); VERIFY_(rc)
RETURN_(ESMF_SUCCESS)
end subroutine get_dim_info_
end subroutine MAML_OpticsTableRead
subroutine polint(x, y, n, xWant, yWant, yErr, myname)
implicit none
integer :: n
real(kind=8) :: x(n), y(n)
real :: xWant, yWant, yErr
character(len=*) :: myname
! given array x(n) of independent variables and array y(n) of dependent
! variables, compute the linear interpolated result yWant at xWant and return
! with a dummy error estimate yErr. Hacked up from Numerical Recipes Chapter 3
integer :: i, j
real :: dx, slope
character(len=255) :: msg
! on out of bounds, set i to lower or upper limit
i = 0
if(xWant < x(1)) then
write(msg,*) "in polint, wanted: ", xWant, ", got lower bound: ", x(1)
call warn(myname, msg)
i = 1
endif
if(xWant > x(n)) then
write(msg,*) "in polint, wanted: ", xWant, ", got upper bound: ", x(n)
call warn(myname, msg)
i = n
endif
! if i is still zero find i less than xWant
if(i == 0) then
do j = 1, n
if(xWant >= x(j)) i = j
enddo
endif
! slope
if(i == n) then
slope = 0.0
else
slope = (y(i+1)-y(i)) / (x(i+1)-x(i))
endif
dx = xWant - x(i)
yWant = y(i) + slope*dx
yErr = 0.0
return
end subroutine polint
end module MAML_OpticsTableMod