Newer
Older
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
MODULE obs_prep
!!=====================================================================
!! *** MODULE obs_prep ***
!! Observation diagnostics: Prepare observation arrays: screening,
!! sorting, coordinate search
!!=====================================================================
!!---------------------------------------------------------------------
!! obs_pre_prof : First level check and screening of profile observations
!! obs_pre_surf : First level check and screening of surface observations
!! obs_scr : Basic screening of the observations
!! obs_coo_tim : Compute number of time steps to the observation time
!! obs_sor : Sort the observation arrays
!!---------------------------------------------------------------------
USE par_kind, ONLY : wp ! Precision variables
USE in_out_manager ! I/O manager
USE obs_profiles_def ! Definitions for storage arrays for profiles
USE obs_surf_def ! Definitions for storage arrays for surface data
USE obs_mpp, ONLY : & ! MPP support routines for observation diagnostics
& obs_mpp_sum_integer, &
& obs_mpp_sum_integers
USE obs_inter_sup ! Interpolation support
USE obs_oper ! Observation operators
USE lib_mpp, ONLY : ctl_warn, ctl_stop
USE bdy_oce, ONLY : & ! Boundary information
idx_bdy, nb_bdy, ln_bdy
IMPLICIT NONE
PRIVATE
PUBLIC obs_pre_prof ! First level check and screening of profile obs
PUBLIC obs_pre_surf ! First level check and screening of surface obs
PUBLIC calc_month_len ! Calculate the number of days in the months of a year
# include "domzgr_substitute.h90"
!!----------------------------------------------------------------------
!! NEMO/OCE 4.0 , NEMO Consortium (2018)
!! $Id: obs_prep.F90 15062 2021-06-28 11:19:48Z jchanut $
!! Software governed by the CeCILL license (see ./LICENSE)
!!----------------------------------------------------------------------
CONTAINS
SUBROUTINE obs_pre_surf( surfdata, surfdataqc, ld_nea, ld_bound_reject, &
kqc_cutoff )
!!----------------------------------------------------------------------
!! *** ROUTINE obs_pre_sla ***
!!
!! ** Purpose : First level check and screening of surface observations
!!
!! ** Method : First level check and screening of surface observations
!!
!! ** Action :
!!
!! References :
!!
!! History :
!! ! 2007-03 (A. Weaver, K. Mogensen) Original
!! ! 2007-06 (K. Mogensen et al) Reject obs. near land.
!! ! 2015-02 (M. Martin) Combined routine for surface types.
!!----------------------------------------------------------------------
!! * Modules used
USE par_oce ! Ocean parameters
USE dom_oce, ONLY : glamt, gphit, tmask ! Geographical information
!! * Arguments
TYPE(obs_surf), INTENT(INOUT) :: surfdata ! Full set of surface data
TYPE(obs_surf), INTENT(INOUT) :: surfdataqc ! Subset of surface data not failing screening
LOGICAL, INTENT(IN) :: ld_nea ! Switch for rejecting observation near land
LOGICAL, INTENT(IN) :: ld_bound_reject ! Switch for rejecting obs near the boundary
INTEGER, INTENT(IN), OPTIONAL :: kqc_cutoff ! cut off for QC value
!! * Local declarations
INTEGER :: iqc_cutoff = 255 ! cut off for QC value
INTEGER :: iyea0 ! Initial date
INTEGER :: imon0 ! - (year, month, day, hour, minute)
INTEGER :: iday0
INTEGER :: ihou0
INTEGER :: imin0
INTEGER :: icycle ! Current assimilation cycle
! Counters for observations that
INTEGER :: iotdobs ! - outside time domain
INTEGER :: iosdsobs ! - outside space domain
INTEGER :: ilansobs ! - within a model land cell
INTEGER :: inlasobs ! - close to land
INTEGER :: igrdobs ! - fail the grid search
INTEGER :: ibdysobs ! - close to open boundary
! Global counters for observations that
INTEGER :: iotdobsmpp ! - outside time domain
INTEGER :: iosdsobsmpp ! - outside space domain
INTEGER :: ilansobsmpp ! - within a model land cell
INTEGER :: inlasobsmpp ! - close to land
INTEGER :: igrdobsmpp ! - fail the grid search
INTEGER :: ibdysobsmpp ! - close to open boundary
LOGICAL, DIMENSION(:), ALLOCATABLE :: &
& llvalid ! SLA data selection
INTEGER :: jobs ! Obs. loop variable
INTEGER :: jstp ! Time loop variable
INTEGER :: inrc ! Time index variable
!!----------------------------------------------------------------------
IF(lwp) WRITE(numout,*) 'obs_pre_surf : Preparing the surface observations...'
IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~'
! Initial date initialization (year, month, day, hour, minute)
iyea0 = ndate0 / 10000
imon0 = ( ndate0 - iyea0 * 10000 ) / 100
iday0 = ndate0 - iyea0 * 10000 - imon0 * 100
ihou0 = nn_time0 / 100
imin0 = ( nn_time0 - ihou0 * 100 )
icycle = nn_no ! Assimilation cycle
! Diagnotics counters for various failures.
iotdobs = 0
igrdobs = 0
iosdsobs = 0
ilansobs = 0
inlasobs = 0
ibdysobs = 0
! Set QC cutoff to optional value if provided
IF ( PRESENT(kqc_cutoff) ) iqc_cutoff=kqc_cutoff
! -----------------------------------------------------------------------
! Find time coordinate for surface data
! -----------------------------------------------------------------------
CALL obs_coo_tim( icycle, &
& iyea0, imon0, iday0, ihou0, imin0, &
& surfdata%nsurf, surfdata%nyea, surfdata%nmon, &
& surfdata%nday, surfdata%nhou, surfdata%nmin, &
& surfdata%nqc, surfdata%mstp, iotdobs )
CALL obs_mpp_sum_integer( iotdobs, iotdobsmpp )
! -----------------------------------------------------------------------
! Check for surface data failing the grid search
! -----------------------------------------------------------------------
CALL obs_coo_grd( surfdata%nsurf, surfdata%mi, surfdata%mj, &
& surfdata%nqc, igrdobs )
CALL obs_mpp_sum_integer( igrdobs, igrdobsmpp )
! -----------------------------------------------------------------------
! Check for land points.
! -----------------------------------------------------------------------
CALL obs_coo_spc_2d( surfdata%nsurf, &
& jpi, jpj, &
& surfdata%mi, surfdata%mj, &
& surfdata%rlam, surfdata%rphi, &
& glamt, gphit, &
& tmask(:,:,1), surfdata%nqc, &
& iosdsobs, ilansobs, &
& inlasobs, ld_nea, &
& ibdysobs, ld_bound_reject, &
& iqc_cutoff )
CALL obs_mpp_sum_integer( iosdsobs, iosdsobsmpp )
CALL obs_mpp_sum_integer( ilansobs, ilansobsmpp )
CALL obs_mpp_sum_integer( inlasobs, inlasobsmpp )
CALL obs_mpp_sum_integer( ibdysobs, ibdysobsmpp )
! -----------------------------------------------------------------------
! Copy useful data from the surfdata data structure to
! the surfdataqc data structure
! -----------------------------------------------------------------------
! Allocate the selection arrays
ALLOCATE( llvalid(surfdata%nsurf) )
! We want all data which has qc flags <= iqc_cutoff
llvalid(:) = ( surfdata%nqc(:) <= iqc_cutoff )
! The actual copying
CALL obs_surf_compress( surfdata, surfdataqc, .TRUE., numout, &
& lvalid=llvalid )
! Dellocate the selection arrays
DEALLOCATE( llvalid )
! -----------------------------------------------------------------------
! Print information about what observations are left after qc
! -----------------------------------------------------------------------
! Update the total observation counter array
IF(lwp) THEN
WRITE(numout,*)
WRITE(numout,*) ' '//surfdataqc%cvars(1)//' data outside time domain = ', &
& iotdobsmpp
WRITE(numout,*) ' Remaining '//surfdataqc%cvars(1)//' data that failed grid search = ', &
& igrdobsmpp
WRITE(numout,*) ' Remaining '//surfdataqc%cvars(1)//' data outside space domain = ', &
& iosdsobsmpp
WRITE(numout,*) ' Remaining '//surfdataqc%cvars(1)//' data at land points = ', &
& ilansobsmpp
IF (ld_nea) THEN
WRITE(numout,*) ' Remaining '//surfdataqc%cvars(1)//' data near land points (removed) = ', &
& inlasobsmpp
ELSE
WRITE(numout,*) ' Remaining '//surfdataqc%cvars(1)//' data near land points (kept) = ', &
& inlasobsmpp
ENDIF
WRITE(numout,*) ' Remaining '//surfdataqc%cvars(1)//' data near open boundary (removed) = ', &
& ibdysobsmpp
WRITE(numout,*) ' '//surfdataqc%cvars(1)//' data accepted = ', &
& surfdataqc%nsurfmpp
WRITE(numout,*)
WRITE(numout,*) ' Number of observations per time step :'
WRITE(numout,*)
WRITE(numout,'(10X,A,10X,A)')'Time step',surfdataqc%cvars(1)
WRITE(numout,'(10X,A,5X,A)')'---------','-----------------'
CALL FLUSH(numout)
ENDIF
DO jobs = 1, surfdataqc%nsurf
inrc = surfdataqc%mstp(jobs) + 2 - nit000
surfdataqc%nsstp(inrc) = surfdataqc%nsstp(inrc) + 1
END DO
CALL obs_mpp_sum_integers( surfdataqc%nsstp, surfdataqc%nsstpmpp, &
& nitend - nit000 + 2 )
IF ( lwp ) THEN
DO jstp = nit000 - 1, nitend
inrc = jstp - nit000 + 2
WRITE(numout,1999) jstp, surfdataqc%nsstpmpp(inrc)
CALL FLUSH(numout)
END DO
ENDIF
1999 FORMAT(10X,I9,5X,I17)
END SUBROUTINE obs_pre_surf
SUBROUTINE obs_pre_prof( profdata, prodatqc, ld_var, &
& kpi, kpj, kpk, &
& zmask, pglam, pgphi, &
& ld_nea, ld_bound_reject, Kmm, kdailyavtypes, kqc_cutoff )
!!----------------------------------------------------------------------
!! *** ROUTINE obs_pre_prof ***
!!
!! ** Purpose : First level check and screening of profiles
!!
!! ** Method : First level check and screening of profiles
!!
!! History :
!! ! 2007-06 (K. Mogensen) original : T and S profile data
!! ! 2008-09 (M. Valdivieso) : TAO velocity data
!! ! 2009-01 (K. Mogensen) : New feedback stricture
!! ! 2015-02 (M. Martin) : Combined profile routine.
!!
!!----------------------------------------------------------------------
!! * Modules used
USE par_oce ! Ocean parameters
USE dom_oce, ONLY : & ! Geographical information
& gdept_1d
!! * Arguments
TYPE(obs_prof), INTENT(INOUT) :: profdata ! Full set of profile data
TYPE(obs_prof), INTENT(INOUT) :: prodatqc ! Subset of profile data not failing screening
LOGICAL, DIMENSION(profdata%nvar), INTENT(IN) :: &
& ld_var ! Observed variables switches
LOGICAL, INTENT(IN) :: ld_nea ! Switch for rejecting observation near land
LOGICAL, INTENT(IN) :: ld_bound_reject ! Switch for rejecting observations near the boundary
INTEGER, INTENT(IN) :: kpi, kpj, kpk ! Local domain sizes
INTEGER, INTENT(IN) :: Kmm ! time-level index
INTEGER, DIMENSION(imaxavtypes), OPTIONAL :: &
& kdailyavtypes ! Types for daily averages
REAL(wp), INTENT(IN), DIMENSION(kpi,kpj,kpk,profdata%nvar) :: &
& zmask
REAL(wp), INTENT(IN), DIMENSION(kpi,kpj,profdata%nvar) :: &
& pglam, &
& pgphi
INTEGER, INTENT(IN), OPTIONAL :: kqc_cutoff ! cut off for QC value
!! * Local declarations
INTEGER :: iqc_cutoff = 255 ! cut off for QC value
INTEGER :: iyea0 ! Initial date
INTEGER :: imon0 ! - (year, month, day, hour, minute)
INTEGER :: iday0
INTEGER :: ihou0
INTEGER :: imin0
INTEGER :: icycle ! Current assimilation cycle
! Counters for observations that are
INTEGER :: iotdobs ! - outside time domain
INTEGER, DIMENSION(profdata%nvar) :: iosdvobs ! - outside space domain
INTEGER, DIMENSION(profdata%nvar) :: ilanvobs ! - within a model land cell
INTEGER, DIMENSION(profdata%nvar) :: inlavobs ! - close to land
INTEGER, DIMENSION(profdata%nvar) :: ibdyvobs ! - boundary
INTEGER :: igrdobs ! - fail the grid search
INTEGER :: iuvchku ! - reject UVEL if VVEL rejected
INTEGER :: iuvchkv ! - reject VVEL if UVEL rejected
! Global counters for observations that are
INTEGER :: iotdobsmpp ! - outside time domain
INTEGER, DIMENSION(profdata%nvar) :: iosdvobsmpp ! - outside space domain
INTEGER, DIMENSION(profdata%nvar) :: ilanvobsmpp ! - within a model land cell
INTEGER, DIMENSION(profdata%nvar) :: inlavobsmpp ! - close to land
INTEGER, DIMENSION(profdata%nvar) :: ibdyvobsmpp ! - boundary
INTEGER :: igrdobsmpp ! - fail the grid search
INTEGER :: iuvchkumpp ! - reject UVEL if VVEL rejected
INTEGER :: iuvchkvmpp ! - reject VVEL if UVEL rejected
TYPE(obs_prof_valid) :: llvalid ! Profile selection
TYPE(obs_prof_valid), DIMENSION(profdata%nvar) :: &
& llvvalid ! var selection
INTEGER :: jvar ! Variable loop variable
INTEGER :: jobs ! Obs. loop variable
INTEGER :: jstp ! Time loop variable
INTEGER :: inrc ! Time index variable
CHARACTER(LEN=256) :: cout1 ! Diagnostic output line
CHARACTER(LEN=256) :: cout2 ! Diagnostic output line
!!----------------------------------------------------------------------
IF(lwp) WRITE(numout,*)'obs_pre_prof: Preparing the profile data...'
IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
! Initial date initialization (year, month, day, hour, minute)
iyea0 = ndate0 / 10000
imon0 = ( ndate0 - iyea0 * 10000 ) / 100
iday0 = ndate0 - iyea0 * 10000 - imon0 * 100
ihou0 = nn_time0 / 100
imin0 = ( nn_time0 - ihou0 * 100 )
icycle = nn_no ! Assimilation cycle
! Diagnostic counters for various failures.
iotdobs = 0
igrdobs = 0
iosdvobs(:) = 0
ilanvobs(:) = 0
inlavobs(:) = 0
ibdyvobs(:) = 0
iuvchku = 0
iuvchkv = 0
! Set QC cutoff to optional value if provided
IF ( PRESENT(kqc_cutoff) ) iqc_cutoff=kqc_cutoff
! -----------------------------------------------------------------------
! Find time coordinate for profiles
! -----------------------------------------------------------------------
IF ( PRESENT(kdailyavtypes) ) THEN
CALL obs_coo_tim_prof( icycle, &
& iyea0, imon0, iday0, ihou0, imin0, &
& profdata%nprof, profdata%nyea, profdata%nmon, &
& profdata%nday, profdata%nhou, profdata%nmin, &
& profdata%ntyp, profdata%nqc, profdata%mstp, &
& iotdobs, kdailyavtypes = kdailyavtypes, &
& kqc_cutoff = iqc_cutoff )
ELSE
CALL obs_coo_tim_prof( icycle, &
& iyea0, imon0, iday0, ihou0, imin0, &
& profdata%nprof, profdata%nyea, profdata%nmon, &
& profdata%nday, profdata%nhou, profdata%nmin, &
& profdata%ntyp, profdata%nqc, profdata%mstp, &
& iotdobs, kqc_cutoff = iqc_cutoff )
ENDIF
CALL obs_mpp_sum_integer( iotdobs, iotdobsmpp )
! -----------------------------------------------------------------------
! Check for profiles failing the grid search
! -----------------------------------------------------------------------
DO jvar = 1, profdata%nvar
CALL obs_coo_grd( profdata%nprof, profdata%mi(:,jvar), profdata%mj(:,jvar), &
& profdata%nqc, igrdobs )
END DO
CALL obs_mpp_sum_integer( igrdobs, igrdobsmpp )
! -----------------------------------------------------------------------
! Reject all observations for profiles with nqc > iqc_cutoff
! -----------------------------------------------------------------------
CALL obs_pro_rej( profdata, kqc_cutoff = iqc_cutoff )
! -----------------------------------------------------------------------
! Check for land points. This includes points below the model
! bathymetry so this is done for every point in the profile
! -----------------------------------------------------------------------
DO jvar = 1, profdata%nvar
CALL obs_coo_spc_3d( profdata%nprof, profdata%nvprot(jvar), &
& profdata%npvsta(:,jvar), profdata%npvend(:,jvar), &
& jpi, jpj, &
& jpk, &
& profdata%mi, profdata%mj, &
& profdata%var(jvar)%mvk, &
& profdata%rlam, profdata%rphi, &
& profdata%var(jvar)%vdep, &
& pglam(:,:,jvar), pgphi(:,:,jvar), &
& gdept_1d, zmask(:,:,:,jvar), &
& profdata%nqc, profdata%var(jvar)%nvqc, &
& iosdvobs(jvar), ilanvobs(jvar), &
& inlavobs(jvar), ld_nea, &
& ibdyvobs(jvar), ld_bound_reject, &
& iqc_cutoff, Kmm )
CALL obs_mpp_sum_integer( iosdvobs(jvar), iosdvobsmpp(jvar) )
CALL obs_mpp_sum_integer( ilanvobs(jvar), ilanvobsmpp(jvar) )
CALL obs_mpp_sum_integer( inlavobs(jvar), inlavobsmpp(jvar) )
CALL obs_mpp_sum_integer( ibdyvobs(jvar), ibdyvobsmpp(jvar) )
END DO
! -----------------------------------------------------------------------
! Reject u if v is rejected and vice versa
! -----------------------------------------------------------------------
IF ( TRIM(profdata%cvars(1)) == 'UVEL' ) THEN
CALL obs_uv_rej( profdata, iuvchku, iuvchkv, iqc_cutoff )
CALL obs_mpp_sum_integer( iuvchku, iuvchkumpp )
CALL obs_mpp_sum_integer( iuvchkv, iuvchkvmpp )
ENDIF
! -----------------------------------------------------------------------
! Copy useful data from the profdata data structure to
! the prodatqc data structure
! -----------------------------------------------------------------------
! Allocate the selection arrays
ALLOCATE( llvalid%luse(profdata%nprof) )
DO jvar = 1,profdata%nvar
ALLOCATE( llvvalid(jvar)%luse(profdata%nvprot(jvar)) )
END DO
! We want all data which has qc flags <= iqc_cutoff
llvalid%luse(:) = ( profdata%nqc(:) <= iqc_cutoff )
DO jvar = 1,profdata%nvar
llvvalid(jvar)%luse(:) = ( profdata%var(jvar)%nvqc(:) <= iqc_cutoff )
END DO
! The actual copying
CALL obs_prof_compress( profdata, prodatqc, .TRUE., numout, &
& lvalid=llvalid, lvvalid=llvvalid )
! Dellocate the selection arrays
DEALLOCATE( llvalid%luse )
DO jvar = 1,profdata%nvar
DEALLOCATE( llvvalid(jvar)%luse )
END DO
! -----------------------------------------------------------------------
! Print information about what observations are left after qc
! -----------------------------------------------------------------------
! Update the total observation counter array
IF(lwp) THEN
WRITE(numout,*)
WRITE(numout,*) ' Profiles outside time domain = ', &
& iotdobsmpp
WRITE(numout,*) ' Remaining profiles that failed grid search = ', &
& igrdobsmpp
DO jvar = 1, profdata%nvar
WRITE(numout,*) ' Remaining '//prodatqc%cvars(jvar)//' data outside space domain = ', &
& iosdvobsmpp(jvar)
WRITE(numout,*) ' Remaining '//prodatqc%cvars(jvar)//' data at land points = ', &
& ilanvobsmpp(jvar)
IF (ld_nea) THEN
WRITE(numout,*) ' Remaining '//prodatqc%cvars(jvar)//' data near land points (removed) = ',&
& inlavobsmpp(jvar)
ELSE
WRITE(numout,*) ' Remaining '//prodatqc%cvars(jvar)//' data near land points (kept) = ',&
& inlavobsmpp(jvar)
ENDIF
IF ( TRIM(profdata%cvars(jvar)) == 'UVEL' ) THEN
WRITE(numout,*) ' U observation rejected since V rejected = ', &
& iuvchku
ELSE IF ( TRIM(profdata%cvars(jvar)) == 'VVEL' ) THEN
WRITE(numout,*) ' V observation rejected since U rejected = ', &
& iuvchkv
ENDIF
WRITE(numout,*) ' Remaining '//prodatqc%cvars(jvar)//' data near open boundary (removed) = ',&
& ibdyvobsmpp(jvar)
WRITE(numout,*) ' '//prodatqc%cvars(jvar)//' data accepted = ', &
& prodatqc%nvprotmpp(jvar)
END DO
WRITE(numout,*)
WRITE(numout,*) ' Number of observations per time step :'
WRITE(numout,*)
WRITE(cout1,'(10X,A9,5X,A8)') 'Time step', 'Profiles'
WRITE(cout2,'(10X,A9,5X,A8)') '---------', '--------'
DO jvar = 1, prodatqc%nvar
WRITE(cout1,'(A,5X,A11)') TRIM(cout1), TRIM(prodatqc%cvars(jvar))
WRITE(cout2,'(A,5X,A11)') TRIM(cout2), '-----------'
END DO
WRITE(numout,*) cout1
WRITE(numout,*) cout2
ENDIF
DO jobs = 1, prodatqc%nprof
inrc = prodatqc%mstp(jobs) + 2 - nit000
prodatqc%npstp(inrc) = prodatqc%npstp(inrc) + 1
DO jvar = 1, prodatqc%nvar
IF ( prodatqc%npvend(jobs,jvar) > 0 ) THEN
prodatqc%nvstp(inrc,jvar) = prodatqc%nvstp(inrc,jvar) + &
& ( prodatqc%npvend(jobs,jvar) - &
& prodatqc%npvsta(jobs,jvar) + 1 )
ENDIF
END DO
END DO
CALL obs_mpp_sum_integers( prodatqc%npstp, prodatqc%npstpmpp, &
& nitend - nit000 + 2 )
DO jvar = 1, prodatqc%nvar
CALL obs_mpp_sum_integers( prodatqc%nvstp(:,jvar), &
& prodatqc%nvstpmpp(:,jvar), &
& nitend - nit000 + 2 )
END DO
IF ( lwp ) THEN
DO jstp = nit000 - 1, nitend
inrc = jstp - nit000 + 2
WRITE(cout1,'(10X,I9,5X,I8)') jstp, prodatqc%npstpmpp(inrc)
DO jvar = 1, prodatqc%nvar
WRITE(cout1,'(A,5X,I11)') TRIM(cout1), prodatqc%nvstpmpp(inrc,jvar)
END DO
WRITE(numout,*) cout1
END DO
ENDIF
END SUBROUTINE obs_pre_prof
SUBROUTINE obs_coo_tim( kcycle, &
& kyea0, kmon0, kday0, khou0, kmin0, &
& kobsno, &
& kobsyea, kobsmon, kobsday, kobshou, kobsmin, &
& kobsqc, kobsstp, kotdobs )
!!----------------------------------------------------------------------
!! *** ROUTINE obs_coo_tim ***
!!
!! ** Purpose : Compute the number of time steps to the observation time.
!!
!! ** Method : For time coordinates ( yea_obs, mon_obs, day_obs,
!! hou_obs, min_obs ), this routine locates the time step
!! that is closest to this time.
!!
!! ** Action :
!!
!! References :
!!
!! History :
!! ! 1997-07 (A. Weaver) Original
!! ! 2006-08 (A. Weaver) NEMOVAR migration
!! ! 2006-10 (A. Weaver) Cleanup
!! ! 2007-01 (K. Mogensen) Rewritten with loop
!! ! 2010-05 (D. Lea) Fix in leap year calculation for NEMO vn3.2
!!----------------------------------------------------------------------
!! * Modules used
USE dom_oce, ONLY : & ! Geographical information
& rn_Dt
USE phycst, ONLY : & ! Physical constants
& rday, &
& rmmss, &
& rhhmm
!! * Arguments
INTEGER, INTENT(IN) :: kcycle ! Current cycle
INTEGER, INTENT(IN) :: kyea0 ! Initial date coordinates
INTEGER, INTENT(IN) :: kmon0
INTEGER, INTENT(IN) :: kday0
INTEGER, INTENT(IN) :: khou0
INTEGER, INTENT(IN) :: kmin0
INTEGER, INTENT(IN) :: kobsno ! Number of observations
INTEGER, INTENT(INOUT) :: kotdobs ! Number of observations failing time check
INTEGER, DIMENSION(kobsno), INTENT(IN ) :: &
& kobsyea, & ! Observation time coordinates
& kobsmon, &
& kobsday, &
& kobshou, &
& kobsmin
INTEGER, DIMENSION(kobsno), INTENT(INOUT) :: &
& kobsqc ! Quality control flag
INTEGER, DIMENSION(kobsno), INTENT(OUT) :: &
& kobsstp ! Number of time steps up to the
! observation time
!! * Local declarations
INTEGER :: jyea
INTEGER :: jmon
INTEGER :: jday
INTEGER :: jobs
INTEGER :: iyeastr
INTEGER :: iyeaend
INTEGER :: imonstr
INTEGER :: imonend
INTEGER :: idaystr
INTEGER :: idayend
INTEGER :: iskip
INTEGER :: idaystp
REAL(KIND=wp) :: zminstp
REAL(KIND=wp) :: zhoustp
REAL(KIND=wp) :: zobsstp
INTEGER, DIMENSION(12) :: imonth_len !: length in days of the months of the current year
!-----------------------------------------------------------------------
! Initialization
!-----------------------------------------------------------------------
! Intialize the number of time steps per day
idaystp = NINT( rday / rn_Dt )
!---------------------------------------------------------------------
! Locate the model time coordinates for interpolation
!---------------------------------------------------------------------
DO jobs = 1, kobsno
! Initialize the time step counter
kobsstp(jobs) = nit000 - 1
! Flag if observation date is less than the initial date
IF ( ( kobsyea(jobs) < kyea0 ) &
& .OR. ( ( kobsyea(jobs) == kyea0 ) &
& .AND. ( kobsmon(jobs) < kmon0 ) ) &
& .OR. ( ( kobsyea(jobs) == kyea0 ) &
& .AND. ( kobsmon(jobs) == kmon0 ) &
& .AND. ( kobsday(jobs) < kday0 ) ) &
& .OR. ( ( kobsyea(jobs) == kyea0 ) &
& .AND. ( kobsmon(jobs) == kmon0 ) &
& .AND. ( kobsday(jobs) == kday0 ) &
& .AND. ( kobshou(jobs) < khou0 ) ) &
& .OR. ( ( kobsyea(jobs) == kyea0 ) &
& .AND. ( kobsmon(jobs) == kmon0 ) &
& .AND. ( kobsday(jobs) == kday0 ) &
& .AND. ( kobshou(jobs) == khou0 ) &
& .AND. ( kobsmin(jobs) <= kmin0 ) ) ) THEN
kobsstp(jobs) = -1
kobsqc(jobs) = IBSET(kobsqc(jobs),13)
kotdobs = kotdobs + 1
CYCLE
ENDIF
! Compute the number of time steps to the observation day
iyeastr = kyea0
iyeaend = kobsyea(jobs)
!---------------------------------------------------------------------
! Year loop
!---------------------------------------------------------------------
DO jyea = iyeastr, iyeaend
CALL calc_month_len( jyea, imonth_len )
imonstr = 1
IF ( jyea == kyea0 ) imonstr = kmon0
imonend = 12
IF ( jyea == kobsyea(jobs) ) imonend = kobsmon(jobs)
! Month loop
DO jmon = imonstr, imonend
idaystr = 1
IF ( ( jmon == kmon0 ) &
& .AND. ( jyea == kyea0 ) ) idaystr = kday0
idayend = imonth_len(jmon)
IF ( ( jmon == kobsmon(jobs) ) &
& .AND. ( jyea == kobsyea(jobs) ) ) idayend = kobsday(jobs) - 1
! Day loop
DO jday = idaystr, idayend
kobsstp(jobs) = kobsstp(jobs) + idaystp
END DO
END DO
END DO
! Add in the number of time steps to the observation minute
zminstp = rmmss / rn_Dt
zhoustp = rhhmm * zminstp
zobsstp = REAL( kobsmin(jobs) - kmin0, KIND=wp ) * zminstp &
& + REAL( kobshou(jobs) - khou0, KIND=wp ) * zhoustp
kobsstp(jobs) = kobsstp(jobs) + NINT( zobsstp )
! Flag if observation step outside the time window
IF ( ( kobsstp(jobs) < ( nit000 - 1 ) ) &
& .OR.( kobsstp(jobs) > nitend ) ) THEN
kobsqc(jobs) = IBSET(kobsqc(jobs),13)
kotdobs = kotdobs + 1
CYCLE
ENDIF
END DO
END SUBROUTINE obs_coo_tim
SUBROUTINE calc_month_len( iyear, imonth_len )
!!----------------------------------------------------------------------
!! *** ROUTINE calc_month_len ***
!!
!! ** Purpose : Compute the number of days in a months given a year.
!!
!! ** Method :
!!
!! ** Action :
!!
!! History :
!! ! 10-05 (D. Lea) New routine based on day_init
!!----------------------------------------------------------------------
INTEGER, DIMENSION(12) :: imonth_len !: length in days of the months of the current year
INTEGER :: iyear !: year
! length of the month of the current year (from nleapy, read in namelist)
IF ( nleapy < 2 ) THEN
imonth_len(:) = (/ 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 /)
IF ( nleapy == 1 ) THEN ! we are using calendar with leap years
IF ( MOD(iyear, 4) == 0 .AND. ( MOD(iyear, 400) == 0 .OR. MOD(iyear, 100) /= 0 ) ) THEN
imonth_len(2) = 29
ENDIF
ENDIF
ELSE
imonth_len(:) = nleapy ! all months with nleapy days per year
ENDIF
sparonuz
committed
END SUBROUTINE calc_month_len
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
SUBROUTINE obs_coo_tim_prof( kcycle, &
& kyea0, kmon0, kday0, khou0, kmin0, &
& kobsno, &
& kobsyea, kobsmon, kobsday, kobshou, kobsmin, &
& ktyp, kobsqc, kobsstp, kotdobs, kdailyavtypes, &
& kqc_cutoff )
!!----------------------------------------------------------------------
!! *** ROUTINE obs_coo_tim ***
!!
!! ** Purpose : Compute the number of time steps to the observation time.
!!
!! ** Method : For time coordinates ( yea_obs, mon_obs, day_obs,
!! hou_obs, min_obs ), this routine locates the time step
!! that is closest to this time.
!!
!! ** Action :
!!
!! References :
!!
!! History :
!! ! 1997-07 (A. Weaver) Original
!! ! 2006-08 (A. Weaver) NEMOVAR migration
!! ! 2006-10 (A. Weaver) Cleanup
!! ! 2007-01 (K. Mogensen) Rewritten with loop
!!----------------------------------------------------------------------
!! * Modules used
!! * Arguments
INTEGER, INTENT(IN) :: kcycle ! Current cycle
INTEGER, INTENT(IN) :: kyea0 ! Initial date coordinates
INTEGER, INTENT(IN) :: kmon0
INTEGER, INTENT(IN) :: kday0
INTEGER, INTENT(IN) :: khou0
INTEGER, INTENT(IN) :: kmin0
INTEGER, INTENT(IN) :: kobsno ! Number of observations
INTEGER, INTENT(INOUT) :: kotdobs ! Number of observations failing time check
INTEGER, DIMENSION(kobsno), INTENT(IN ) :: &
& kobsyea, & ! Observation time coordinates
& kobsmon, &
& kobsday, &
& kobshou, &
& kobsmin, &
& ktyp ! Observation type.
INTEGER, DIMENSION(kobsno), INTENT(INOUT) :: &
& kobsqc ! Quality control flag
INTEGER, DIMENSION(kobsno), INTENT(OUT) :: &
& kobsstp ! Number of time steps up to the
! observation time
INTEGER, DIMENSION(imaxavtypes), OPTIONAL :: &
& kdailyavtypes ! Types for daily averages
INTEGER, OPTIONAL, INTENT(IN) :: kqc_cutoff ! QC cutoff value
!! * Local declarations
INTEGER :: jobs
INTEGER :: iqc_cutoff=255
!-----------------------------------------------------------------------
! Call standard obs_coo_tim
!-----------------------------------------------------------------------
CALL obs_coo_tim( kcycle, &
& kyea0, kmon0, kday0, khou0, kmin0, &
& kobsno, &
& kobsyea, kobsmon, kobsday, kobshou, kobsmin, &
& kobsqc, kobsstp, kotdobs )
!------------------------------------------------------------------------
! Always reject daily averaged data (e.g. MRB data (820)) at initial time
!------------------------------------------------------------------------
IF ( PRESENT(kdailyavtypes) ) THEN
DO jobs = 1, kobsno
IF ( kobsqc(jobs) <= iqc_cutoff ) THEN
IF ( ( kobsstp(jobs) == (nit000 - 1) ).AND.&
& ( ANY (kdailyavtypes(:) == ktyp(jobs)) ) ) THEN
kobsqc(jobs) = IBSET(kobsqc(jobs),13)
kotdobs = kotdobs + 1
CYCLE
ENDIF
ENDIF
END DO
ENDIF
END SUBROUTINE obs_coo_tim_prof
SUBROUTINE obs_coo_grd( kobsno, kobsi, kobsj, kobsqc, kgrdobs )
!!----------------------------------------------------------------------
!! *** ROUTINE obs_coo_grd ***
!!
!! ** Purpose : Verify that the grid search has not failed
!!
!! ** Method : The previously computed i,j indeces are checked
!!
!! ** Action :
!!
!! References :
!!
!! History :
!! ! 2007-01 (K. Mogensen) Original
!!----------------------------------------------------------------------
INTEGER, INTENT(IN) :: kobsno ! Number of observations
INTEGER, DIMENSION(kobsno), INTENT(IN ) :: &
& kobsi, & ! i,j indeces previously computed
& kobsj
INTEGER, INTENT(INOUT) :: kgrdobs ! Number of observations failing the check
INTEGER, DIMENSION(kobsno), INTENT(INOUT) :: &
& kobsqc ! Quality control flag
!! * Local declarations
INTEGER :: jobs ! Loop variable
! Flag if the grid search failed
DO jobs = 1, kobsno
IF ( ( kobsi(jobs) <= 0 ) .AND. ( kobsj(jobs) <= 0 ) ) THEN
kobsqc(jobs) = IBSET(kobsqc(jobs),12)
kgrdobs = kgrdobs + 1
ENDIF
END DO
END SUBROUTINE obs_coo_grd
SUBROUTINE obs_coo_spc_2d( kobsno, kpi, kpj, &
& kobsi, kobsj, pobslam, pobsphi, &
& plam, pphi, pmask, &
& kobsqc, kosdobs, klanobs, &
& knlaobs,ld_nea, &
& kbdyobs,ld_bound_reject, &
& kqc_cutoff )
!!----------------------------------------------------------------------
!! *** ROUTINE obs_coo_spc_2d ***
!!
!! ** Purpose : Check for points outside the domain and land points
!!
!! ** Method : Remove the observations that are outside the model space
!! and time domain or located within model land cells.
!!
!! ** Action :
!!
!! History : 2007-03 (A. Weaver, K. Mogensen) Original
!! ! 2007-06 (K. Mogensen et al) Reject obs. near land.
!!----------------------------------------------------------------------
INTEGER , INTENT(in ) :: kobsno ! Total number of observations
INTEGER , INTENT(in ) :: kpi , kpj ! Number of grid points in (i,j)
INTEGER , INTENT(in ), DIMENSION(kobsno) :: kobsi , kobsj ! Observation (i,j) coordinates
REAL(wp), INTENT(in ), DIMENSION(kobsno) :: pobslam, pobsphi ! Observation (lon,lat) coordinates
REAL(wp), INTENT(in ), DIMENSION(kpi,kpj) :: plam , pphi ! Model (lon,lat) coordinates
REAL(wp), INTENT(in ), DIMENSION(kpi,kpj) :: pmask ! Land mask array
INTEGER , INTENT(inout), DIMENSION(kobsno) :: kobsqc ! Observation quality control
INTEGER , INTENT(inout) :: kosdobs ! Observations outside space domain
INTEGER , INTENT(inout) :: klanobs ! Observations within a model land cell
INTEGER , INTENT(inout) :: knlaobs ! Observations near land
INTEGER , INTENT(inout) :: kbdyobs ! Observations near boundary
LOGICAL , INTENT(in ) :: ld_nea ! Flag observations near land
LOGICAL , INTENT(in ) :: ld_bound_reject ! Flag observations near open boundary
INTEGER , INTENT(in ) :: kqc_cutoff ! Cutoff QC value
!
REAL(KIND=wp), DIMENSION(2,2,kobsno) :: zgmsk ! Grid mask
REAL(KIND=wp), DIMENSION(2,2,kobsno) :: zbmsk ! Boundary mask
REAL(KIND=wp), DIMENSION(jpi,jpj) :: zbdymask
REAL(KIND=wp), DIMENSION(2,2,kobsno) :: zglam, zgphi ! Model Lon/lat at grid points
INTEGER , DIMENSION(2,2,kobsno) :: igrdi, igrdj ! Grid i,j
LOGICAL :: lgridobs ! Is observation on a model grid point.
INTEGER :: iig, ijg ! i,j of observation on model grid point.
INTEGER :: jobs, ji, jj
!!----------------------------------------------------------------------
! Get grid point indices
DO jobs = 1, kobsno
! For invalid points use 2,2
IF ( kobsqc(jobs) >= kqc_cutoff ) THEN
igrdi(1,1,jobs) = 1
igrdj(1,1,jobs) = 1
igrdi(1,2,jobs) = 1
igrdj(1,2,jobs) = 2
igrdi(2,1,jobs) = 2
igrdj(2,1,jobs) = 1
igrdi(2,2,jobs) = 2
igrdj(2,2,jobs) = 2
ELSE
igrdi(1,1,jobs) = kobsi(jobs)-1
igrdj(1,1,jobs) = kobsj(jobs)-1
igrdi(1,2,jobs) = kobsi(jobs)-1
igrdj(1,2,jobs) = kobsj(jobs)
igrdi(2,1,jobs) = kobsi(jobs)
igrdj(2,1,jobs) = kobsj(jobs)-1
igrdi(2,2,jobs) = kobsi(jobs)
igrdj(2,2,jobs) = kobsj(jobs)
ENDIF
END DO
IF (ln_bdy) THEN
! Create a mask grid points in boundary rim
IF (ld_bound_reject) THEN
zbdymask(:,:) = 1.0_wp
DO ji = 1, nb_bdy
DO jj = 1, idx_bdy(ji)%nblen(1)
zbdymask(idx_bdy(ji)%nbi(jj,1),idx_bdy(ji)%nbj(jj,1)) = 0.0_wp
ENDDO
ENDDO
CALL obs_int_comm_2d( 2, 2, kobsno, kpi, kpj, igrdi, igrdj, zbdymask, zbmsk )
ENDIF
ENDIF
CALL obs_int_comm_2d( 2, 2, kobsno, kpi, kpj, igrdi, igrdj, pmask, zgmsk )
CALL obs_int_comm_2d( 2, 2, kobsno, kpi, kpj, igrdi, igrdj, plam, zglam )
CALL obs_int_comm_2d( 2, 2, kobsno, kpi, kpj, igrdi, igrdj, pphi, zgphi )
DO jobs = 1, kobsno
! Skip bad observations
IF ( kobsqc(jobs) >= kqc_cutoff ) CYCLE
! Flag if the observation falls outside the model spatial domain
IF ( ( pobslam(jobs) < -180. ) &
& .OR. ( pobslam(jobs) > 180. ) &
& .OR. ( pobsphi(jobs) < -90. ) &
& .OR. ( pobsphi(jobs) > 90. ) ) THEN
kobsqc(jobs) = IBSET(kobsqc(jobs),11)
kosdobs = kosdobs + 1
CYCLE
ENDIF
! Flag if the observation falls with a model land cell
IF ( SUM( zgmsk(1:2,1:2,jobs) ) == 0.0_wp ) THEN
kobsqc(jobs) = IBSET(kobsqc(jobs),10)
klanobs = klanobs + 1
CYCLE
ENDIF
! Check if this observation is on a grid point
lgridobs = .FALSE.
iig = -1
ijg = -1
DO jj = 1, 2
DO ji = 1, 2
IF ( ( ABS( zgphi(ji,jj,jobs) - pobsphi(jobs) ) < 1.0e-6_wp ) &
& .AND. &
& ( ABS( MOD( zglam(ji,jj,jobs) - pobslam(jobs),360.0) ) &
& < 1.0e-6_wp ) ) THEN
lgridobs = .TRUE.
iig = ji
ijg = jj
ENDIF
END DO
END DO
! For observations on the grid reject them if their are at