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
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
MODULE obs_fbm
!!======================================================================
!! *** MODULE obs_fbm ***
!! Observation operators : I/O + tools for feedback files
!!======================================================================
!! History :
!! ! 08-11 (K. Mogensen) Initial version
!!----------------------------------------------------------------------
!!----------------------------------------------------------------------
!! init_obfbdata : Initialize sizes in obfbdata structure
!! alloc_obfbdata : Allocate data in an obfbdata structure
!! dealloc_obfbdata : Dellocate data in an obfbdata structure
!! copy_obfbdata : Copy an obfbdata structure
!! subsamp_obfbdata : Sumsample an obfbdata structure
!! merge_obfbdata : Merge multiple obfbdata structures into an one.
!! write_obfbdata : Write an obfbdata structure into a netCDF file.
!! read_obfbdata : Read an obfbdata structure from a netCDF file.
!!----------------------------------------------------------------------
USE netcdf
USE obs_utils ! Various utilities for observation operators
IMPLICIT NONE
PUBLIC
! Type kinds for feedback data.
INTEGER, PARAMETER :: fbsp = SELECTED_REAL_KIND( 6, 37) !: single precision
INTEGER, PARAMETER :: fbdp = SELECTED_REAL_KIND(12,307) !: double precision
! Parameters for string lengths.
INTEGER, PARAMETER :: ilenwmo = 8 !: Length of station identifier
INTEGER, PARAMETER :: ilentyp = 4 !: Length of type
INTEGER, PARAMETER :: ilenname = 8 !: Length of variable names
INTEGER, PARAMETER :: ilengrid = 1 !: Grid (e.g. 'T') length
INTEGER, PARAMETER :: ilenjuld = 14 !: Lenght of reference julian date
INTEGER, PARAMETER :: idefnqcf = 2 !: Default number of words in QC
! flags
INTEGER, PARAMETER :: ilenlong = 128 !: Length of long name
INTEGER, PARAMETER :: ilenunit = 32 !: Length of units
! Missinge data indicators
INTEGER, PARAMETER :: fbimdi = -99999 !: Integers
REAL(fbsp), PARAMETER :: fbrmdi = 99999 !: Reals
! Main data structure for observation feedback data.
TYPE obfbdata
LOGICAL :: lalloc !: Allocation status for data
LOGICAL :: lgrid !: Include grid search info
INTEGER :: nvar !: Number of variables
INTEGER :: nobs !: Number of observations
INTEGER :: nlev !: Number of levels
INTEGER :: nadd !: Number of additional entries
INTEGER :: next !: Number of extra variables
INTEGER :: nqcf !: Number of words per qc flag
CHARACTER(LEN=ilenwmo), DIMENSION(:), POINTER :: &
& cdwmo !: Identifier
CHARACTER(LEN=ilentyp), DIMENSION(:), POINTER :: &
& cdtyp !: Instrument type
CHARACTER(LEN=ilenjuld) :: &
& cdjuldref !: Julian date reference
INTEGER, DIMENSION(:), POINTER :: &
& kindex !: Index of observations in the original file
INTEGER, DIMENSION(:), POINTER :: &
& ioqc, & !: Observation QC
& ipqc, & !: Position QC
& itqc !: Time QC
INTEGER, DIMENSION(:,:), POINTER :: &
& ioqcf, & !: Observation QC flags
& ipqcf, & !: Position QC flags
& itqcf !: Time QC flags
INTEGER, DIMENSION(:,:), POINTER :: &
& idqc !: Depth QC
INTEGER, DIMENSION(:,:,:), POINTER :: &
& idqcf !: Depth QC flags
REAL(KIND=fbdp), DIMENSION(:), POINTER :: &
& plam, & !: Longitude
& pphi, & !: Latitude
& ptim !: Time
REAL(KIND=fbsp), DIMENSION(:,:), POINTER :: &
& pdep !: Depth
CHARACTER(LEN=ilenname), DIMENSION(:), POINTER :: &
& cname !: Name of variable
REAL(fbsp), DIMENSION(:,:,:), POINTER :: &
& pob !: Observation
CHARACTER(LEN=ilenlong), DIMENSION(:), POINTER :: &
& coblong !: Observation long name (for output)
CHARACTER(LEN=ilenunit), DIMENSION(:), POINTER :: &
& cobunit !: Observation units (for output)
INTEGER, DIMENSION(:,:), POINTER :: &
& ivqc !: Variable QC
INTEGER, DIMENSION(:,:,:), POINTER :: &
& ivqcf !: Variable QC flags
INTEGER, DIMENSION(:,:,:), POINTER :: &
& ivlqc !: Variable level QC
INTEGER, DIMENSION(:,:,:,:), POINTER :: &
& ivlqcf !: Variable level QC flags
INTEGER, DIMENSION(:,:), POINTER :: &
& iproc, & !: Processor of obs (no I/O for this variable).
& iobsi, & !: Global i index
& iobsj !: Global j index
INTEGER, DIMENSION(:,:,:), POINTER :: &
& iobsk !: k index
CHARACTER(LEN=ilengrid), DIMENSION(:), POINTER :: &
& cgrid !: Grid for this variable
CHARACTER(LEN=ilenname), DIMENSION(:), POINTER :: &
& caddname !: Additional entries names
CHARACTER(LEN=ilenlong), DIMENSION(:,:), POINTER :: &
& caddlong !: Additional entries long name (for output)
CHARACTER(LEN=ilenunit), DIMENSION(:,:), POINTER :: &
& caddunit !: Additional entries units (for output)
REAL(fbsp), DIMENSION(:,:,:,:) , POINTER :: &
& padd !: Additional entries
CHARACTER(LEN=ilenname), DIMENSION(:), POINTER :: &
& cextname !: Extra variables names
CHARACTER(LEN=ilenlong), DIMENSION(:), POINTER :: &
& cextlong !: Extra variables long name (for output)
CHARACTER(LEN=ilenunit), DIMENSION(:), POINTER :: &
& cextunit !: Extra variables units (for output)
REAL(fbsp), DIMENSION(:,:,:) , POINTER :: &
& pext !: Extra variables
END TYPE obfbdata
PRIVATE putvaratt_obfbdata
!!----------------------------------------------------------------------
!! NEMO/OCE 4.0 , NEMO Consortium (2018)
!! $Id: obs_fbm.F90 10068 2018-08-28 14:09:04Z nicolasmartin $
!! Software governed by the CeCILL license (see ./LICENSE)
!!----------------------------------------------------------------------
CONTAINS
SUBROUTINE init_obfbdata( fbdata )
!!----------------------------------------------------------------------
!! *** ROUTINE init_obfbdata ***
!!
!! ** Purpose : Initialize sizes in obfbdata structure
!!
!! ** Method :
!!
!! ** Action :
!!
!!----------------------------------------------------------------------
!! * Arguments
TYPE(obfbdata) :: fbdata ! obsfbdata structure
fbdata%nvar = 0
fbdata%nobs = 0
fbdata%nlev = 0
fbdata%nadd = 0
fbdata%next = 0
fbdata%nqcf = idefnqcf
fbdata%lalloc = .FALSE.
fbdata%lgrid = .FALSE.
END SUBROUTINE init_obfbdata
SUBROUTINE alloc_obfbdata( fbdata, kvar, kobs, klev, kadd, kext, lgrid, &
& kqcf)
!!----------------------------------------------------------------------
!! *** ROUTINE alloc_obfbdata ***
!!
!! ** Purpose : Allocate data in an obfbdata structure
!!
!! ** Method :
!!
!! ** Action :
!!
!!----------------------------------------------------------------------
!! * Arguments
TYPE(obfbdata) :: fbdata ! obsfbdata structure to be allocated
INTEGER, INTENT(IN) :: kvar ! Number of variables
INTEGER, INTENT(IN) :: kobs ! Number of observations
INTEGER, INTENT(IN) :: klev ! Number of levels
INTEGER, INTENT(IN) :: kadd ! Number of additional entries
INTEGER, INTENT(IN) :: kext ! Number of extra variables
LOGICAL, INTENT(IN) :: lgrid ! Include grid search information
INTEGER, OPTIONAL :: kqcf ! Number of words for QC flags
!! * Local variables
INTEGER :: ji
INTEGER :: jv
! Check allocation status and deallocate previous allocated structures
IF ( fbdata%lalloc ) THEN
CALL dealloc_obfbdata( fbdata )
ENDIF
! Set dimensions
fbdata%lalloc = .TRUE.
fbdata%nvar = kvar
fbdata%nobs = kobs
fbdata%nlev = MAX( klev, 1 )
fbdata%nadd = kadd
fbdata%next = kext
IF ( PRESENT(kqcf) ) THEN
fbdata%nqcf = kqcf
ELSE
fbdata%nqcf = idefnqcf
ENDIF
! Set data not depending on number of observations
fbdata%cdjuldref = REPEAT( 'X', ilenjuld )
! Allocate and initialize standard data
ALLOCATE( &
& fbdata%cname(fbdata%nvar), &
& fbdata%coblong(fbdata%nvar), &
& fbdata%cobunit(fbdata%nvar) &
& )
DO ji = 1, fbdata%nvar
WRITE(fbdata%cname(ji),'(A,I2.2)')'V_',ji
fbdata%coblong(ji) = REPEAT( ' ', ilenlong )
fbdata%cobunit(ji) = REPEAT( ' ', ilenunit )
END DO
! Optionally also store grid search information
IF ( lgrid ) THEN
ALLOCATE ( &
& fbdata%cgrid(fbdata%nvar) &
& )
fbdata%cgrid(:) = REPEAT( 'X', ilengrid )
fbdata%lgrid = .TRUE.
ENDIF
! Allocate and initialize additional entries if present
IF ( fbdata%nadd > 0 ) THEN
ALLOCATE( &
& fbdata%caddname(fbdata%nadd), &
& fbdata%caddlong(fbdata%nadd, fbdata%nvar), &
& fbdata%caddunit(fbdata%nadd, fbdata%nvar) &
& )
DO ji = 1, fbdata%nadd
WRITE(fbdata%caddname(ji),'(A,I2.2)')'A',ji
END DO
DO jv = 1, fbdata%nvar
DO ji = 1, fbdata%nadd
fbdata%caddlong(ji,jv) = REPEAT( ' ', ilenlong )
fbdata%caddunit(ji,jv) = REPEAT( ' ', ilenunit )
END DO
END DO
ENDIF
! Allocate and initialize additional variables if present
IF ( fbdata%next > 0 ) THEN
ALLOCATE( &
& fbdata%cextname(fbdata%next), &
& fbdata%cextlong(fbdata%next), &
& fbdata%cextunit(fbdata%next) &
& )
DO ji = 1, fbdata%next
WRITE(fbdata%cextname(ji),'(A,I2.2)')'E_',ji
fbdata%cextlong(ji) = REPEAT( ' ', ilenlong )
fbdata%cextunit(ji) = REPEAT( ' ', ilenunit )
END DO
ENDIF
! Data depending on number of observations is only allocated if nobs>0
IF ( fbdata%nobs > 0 ) THEN
ALLOCATE( &
& fbdata%cdwmo(fbdata%nobs), &
& fbdata%cdtyp(fbdata%nobs), &
& fbdata%ioqc(fbdata%nobs), &
& fbdata%ioqcf(fbdata%nqcf,fbdata%nobs), &
& fbdata%ipqc(fbdata%nobs), &
& fbdata%ipqcf(fbdata%nqcf,fbdata%nobs), &
& fbdata%itqc(fbdata%nobs), &
& fbdata%itqcf(fbdata%nqcf,fbdata%nobs), &
& fbdata%idqc(fbdata%nlev,fbdata%nobs), &
& fbdata%idqcf(fbdata%nqcf,fbdata%nlev,fbdata%nobs), &
& fbdata%plam(fbdata%nobs), &
& fbdata%pphi(fbdata%nobs), &
& fbdata%pdep(fbdata%nlev,fbdata%nobs), &
& fbdata%ptim(fbdata%nobs), &
& fbdata%kindex(fbdata%nobs), &
& fbdata%ivqc(fbdata%nobs,fbdata%nvar), &
& fbdata%ivqcf(fbdata%nqcf,fbdata%nobs,fbdata%nvar), &
& fbdata%ivlqc(fbdata%nlev,fbdata%nobs,fbdata%nvar), &
& fbdata%ivlqcf(fbdata%nqcf,fbdata%nlev,fbdata%nobs,fbdata%nvar), &
& fbdata%pob(fbdata%nlev,fbdata%nobs,fbdata%nvar) &
& )
fbdata%kindex(:) = fbimdi
fbdata%cdwmo(:) = REPEAT( 'X', ilenwmo )
fbdata%cdtyp(:) = REPEAT( 'X', ilentyp )
fbdata%ioqc(:) = fbimdi
fbdata%ioqcf(:,:) = fbimdi
fbdata%ipqc(:) = fbimdi
fbdata%ipqcf(:,:) = fbimdi
fbdata%itqc(:) = fbimdi
fbdata%itqcf(:,:) = fbimdi
fbdata%idqc(:,:) = fbimdi
fbdata%idqcf(:,:,:) = fbimdi
fbdata%plam(:) = fbrmdi
fbdata%pphi(:) = fbrmdi
fbdata%pdep(:,:) = fbrmdi
fbdata%ptim(:) = fbrmdi
fbdata%ivqc(:,:) = fbimdi
fbdata%ivqcf(:,:,:) = fbimdi
fbdata%ivlqc(:,:,:) = fbimdi
fbdata%ivlqcf(:,:,:,:) = fbimdi
fbdata%pob(:,:,:) = fbrmdi
! Optionally also store grid search information
IF ( lgrid ) THEN
ALLOCATE ( &
& fbdata%iproc(fbdata%nobs,fbdata%nvar), &
& fbdata%iobsi(fbdata%nobs,fbdata%nvar), &
& fbdata%iobsj(fbdata%nobs,fbdata%nvar), &
& fbdata%iobsk(fbdata%nlev,fbdata%nobs,fbdata%nvar) &
& )
fbdata%iproc(:,:) = fbimdi
fbdata%iobsi(:,:) = fbimdi
fbdata%iobsj(:,:) = fbimdi
fbdata%iobsk(:,:,:) = fbimdi
fbdata%lgrid = .TRUE.
ENDIF
! Allocate and initialize additional entries if present
IF ( fbdata%nadd > 0 ) THEN
ALLOCATE( &
& fbdata%padd(fbdata%nlev,fbdata%nobs,fbdata%nadd,fbdata%nvar) &
& )
fbdata%padd(:,:,:,:) = fbrmdi
ENDIF
! Allocate and initialize additional variables if present
IF ( fbdata%next > 0 ) THEN
ALLOCATE( &
& fbdata%pext(fbdata%nlev,fbdata%nobs,fbdata%next) &
& )
fbdata%pext(:,:,:) = fbrmdi
ENDIF
ENDIF
END SUBROUTINE alloc_obfbdata
SUBROUTINE dealloc_obfbdata( fbdata )
!!----------------------------------------------------------------------
!! *** ROUTINE dealloc_obfbdata ***
!!
!! ** Purpose : Deallocate data in an obfbdata strucure
!!
!! ** Method :
!!
!! ** Action :
!!
!!----------------------------------------------------------------------
!! * Arguments
TYPE(obfbdata) :: fbdata ! obsfbdata structure
! Deallocate data
DEALLOCATE( &
& fbdata%cname, &
& fbdata%coblong,&
& fbdata%cobunit &
& )
! Deallocate optional grid search information
IF ( fbdata%lgrid ) THEN
DEALLOCATE ( &
& fbdata%cgrid &
& )
ENDIF
! Deallocate additional entries
IF ( fbdata%nadd > 0 ) THEN
DEALLOCATE( &
& fbdata%caddname, &
& fbdata%caddlong, &
& fbdata%caddunit &
& )
ENDIF
! Deallocate extra variables
IF ( fbdata%next > 0 ) THEN
DEALLOCATE( &
& fbdata%cextname, &
& fbdata%cextlong, &
& fbdata%cextunit &
& )
ENDIF
! Deallocate arrays depending on number of obs (if nobs>0 only).
IF ( fbdata%nobs > 0 ) THEN
DEALLOCATE( &
& fbdata%cdwmo, &
& fbdata%cdtyp, &
& fbdata%ioqc, &
& fbdata%ioqcf, &
& fbdata%ipqc, &
& fbdata%ipqcf, &
& fbdata%itqc, &
& fbdata%itqcf, &
& fbdata%idqc, &
& fbdata%idqcf, &
& fbdata%plam, &
& fbdata%pphi, &
& fbdata%pdep, &
& fbdata%ptim, &
& fbdata%kindex, &
& fbdata%ivqc, &
& fbdata%ivqcf, &
& fbdata%ivlqc, &
& fbdata%ivlqcf, &
& fbdata%pob &
& )
! Deallocate optional grid search information
IF ( fbdata%lgrid ) THEN
DEALLOCATE ( &
& fbdata%iproc, &
& fbdata%iobsi, &
& fbdata%iobsj, &
& fbdata%iobsk &
& )
ENDIF
! Deallocate additional entries
IF ( fbdata%nadd > 0 ) THEN
DEALLOCATE( &
& fbdata%padd &
& )
ENDIF
! Deallocate extra variables
IF ( fbdata%next > 0 ) THEN
DEALLOCATE( &
& fbdata%pext &
& )
ENDIF
ENDIF
! Reset arrays sizes
fbdata%lalloc = .FALSE.
fbdata%lgrid = .FALSE.
fbdata%nvar = 0
fbdata%nobs = 0
fbdata%nlev = 0
fbdata%nadd = 0
fbdata%next = 0
END SUBROUTINE dealloc_obfbdata
SUBROUTINE copy_obfbdata( fbdata1, fbdata2, kadd, kext, lgrid, kqcf )
!!----------------------------------------------------------------------
!! *** ROUTINE copy_obfbdata ***
!!
!! ** Purpose : Copy an obfbdata structure
!!
!! ** Method : Copy all data from fbdata1 to fbdata2
!! If fbdata2 is allocated it needs to be compliant
!! with fbdata1.
!! Additional entries can be added by setting nadd
!! Additional extra fields can be added by setting next
!! Grid information can be included with lgrid=.true.
!!
!! ** Action :
!!
!!----------------------------------------------------------------------
!! * Arguments
TYPE(obfbdata) :: fbdata1 ! Input obsfbdata structure
TYPE(obfbdata) :: fbdata2 ! Output obsfbdata structure
INTEGER, INTENT(IN), OPTIONAL :: kadd ! Number of additional entries
INTEGER, INTENT(IN), OPTIONAL :: kext ! Number of extra variables
INTEGER, INTENT(IN), OPTIONAL :: kqcf ! Number of words per qc flags
LOGICAL, OPTIONAL :: lgrid ! Grid info on output file
!! * Local variables
INTEGER :: nadd
INTEGER :: next
INTEGER :: nqcf
LOGICAL :: llgrid
INTEGER :: jv
INTEGER :: je
INTEGER :: ji
INTEGER :: jk
INTEGER :: jq
! Check allocation status of fbdata1
IF ( .NOT. fbdata1%lalloc ) THEN
CALL fatal_error( 'copy_obfbdata: input data not allocated', &
& __LINE__ )
ENDIF
! If nadd,next not specified use the ones from fbdata1
! Otherwise check that they have large than the original ones
IF ( PRESENT(kadd) ) THEN
nadd = kadd
IF ( nadd < fbdata1%nadd ) THEN
CALL warning ( 'copy_obfbdata: ' // &
& 'nadd smaller than input nadd', __LINE__ )
ENDIF
ELSE
nadd = fbdata1%nadd
ENDIF
IF ( PRESENT(kext) ) THEN
next = kext
IF ( next < fbdata1%next ) THEN
CALL fatal_error( 'copy_obfbdata: ' // &
& 'next smaller than input next', __LINE__ )
ENDIF
ELSE
next = fbdata1%next
ENDIF
IF ( PRESENT(lgrid) ) THEN
llgrid = lgrid
IF ( fbdata1%lgrid .AND. (.NOT. llgrid) ) THEN
CALL fatal_error( 'copy_obfbdata: ' // &
& 'switching off grid info not possible', &
& __LINE__ )
ENDIF
ELSE
llgrid = fbdata1%lgrid
ENDIF
IF ( PRESENT(kqcf) ) THEN
nqcf = kqcf
IF ( nqcf < fbdata1%nqcf ) THEN
CALL fatal_error( 'copy_obfbdata: ' // &
& 'nqcf smaller than input nqcf', __LINE__ )
ENDIF
ELSE
nqcf = fbdata1%nqcf
ENDIF
! Check allocation status of fbdata2 and
! a) check that it conforms in size if already allocated
! b) allocate it if not already allocated
IF ( fbdata2%lalloc ) THEN
IF ( fbdata1%nvar > fbdata2%nvar ) THEN
CALL fatal_error( 'copy_obfbdata: ' // &
& 'output kvar smaller than input kvar', __LINE__ )
ENDIF
IF ( fbdata1%nobs > fbdata2%nobs ) THEN
CALL fatal_error( 'copy_obfbdata: ' // &
& 'output kobs smaller than input kobs', __LINE__ )
ENDIF
IF ( fbdata1%nlev > fbdata2%nlev ) THEN
CALL fatal_error( 'copy_obfbdata: ' // &
& 'output klev smaller than input klev', __LINE__ )
ENDIF
IF ( fbdata1%nadd > fbdata2%nadd ) THEN
CALL warning ( 'copy_obfbdata: ' // &
& 'output nadd smaller than input nadd', __LINE__ )
ENDIF
IF ( fbdata1%next > fbdata2%next ) THEN
CALL fatal_error( 'copy_obfbdata: ' // &
& 'output next smaller than input next', __LINE__ )
ENDIF
IF ( fbdata1%lgrid .NEQV. fbdata2%lgrid ) THEN
CALL fatal_error( 'copy_obfbdata: ' // &
& 'lgrid inconsistent', __LINE__ )
ENDIF
IF ( fbdata1%next > fbdata2%next ) THEN
CALL fatal_error( 'copy_obfbdata: ' // &
& 'output next smaller than input next', __LINE__ )
ENDIF
IF ( fbdata1%nqcf > fbdata2%nqcf ) THEN
CALL fatal_error( 'copy_obfbdata: ' // &
& 'output smaller than input kext', __LINE__ )
ENDIF
ELSE
CALL alloc_obfbdata( fbdata2, fbdata1%nvar, fbdata1%nobs, &
& fbdata1%nlev, nadd, next, llgrid, kqcf = nqcf )
ENDIF
! Copy the header data
fbdata2%cdjuldref = fbdata1%cdjuldref
DO ji = 1, fbdata1%nobs
fbdata2%cdwmo(ji) = fbdata1%cdwmo(ji)
fbdata2%cdtyp(ji) = fbdata1%cdtyp(ji)
fbdata2%ioqc(ji) = fbdata1%ioqc(ji)
fbdata2%ipqc(ji) = fbdata1%ipqc(ji)
fbdata2%itqc(ji) = fbdata1%itqc(ji)
fbdata2%plam(ji) = fbdata1%plam(ji)
fbdata2%pphi(ji) = fbdata1%pphi(ji)
fbdata2%ptim(ji) = fbdata1%ptim(ji)
fbdata2%kindex(ji) = fbdata1%kindex(ji)
DO jq = 1, fbdata1%nqcf
fbdata2%ioqcf(jq,ji) = fbdata1%ioqcf(jq,ji)
fbdata2%ipqcf(jq,ji) = fbdata1%ipqcf(jq,ji)
fbdata2%itqcf(jq,ji) = fbdata1%itqcf(jq,ji)
END DO
DO jk = 1, fbdata1%nlev
fbdata2%idqc(jk,ji) = fbdata1%idqc(jk,ji)
fbdata2%pdep(jk,ji) = fbdata1%pdep(jk,ji)
DO jq = 1, fbdata1%nqcf
fbdata2%idqcf(jq,jk,ji) = fbdata1%idqcf(jq,jk,ji)
END DO
END DO
END DO
! Copy the variable data
DO jv = 1, fbdata1%nvar
fbdata2%cname(jv) = fbdata1%cname(jv)
fbdata2%coblong(jv) = fbdata1%coblong(jv)
fbdata2%cobunit(jv) = fbdata1%cobunit(jv)
DO ji = 1, fbdata1%nobs
fbdata2%ivqc(ji,jv) = fbdata1%ivqc(ji,jv)
DO jq = 1, fbdata1%nqcf
fbdata2%ivqcf(jq,ji,jv) = fbdata1%ivqcf(jq,ji,jv)
END DO
DO jk = 1, fbdata1%nlev
fbdata2%ivlqc(jk,ji,jv) = fbdata1%ivlqc(jk,ji,jv)
fbdata2%pob(jk,ji,jv) = fbdata1%pob(jk,ji,jv)
DO jq = 1, fbdata1%nqcf
fbdata2%ivlqcf(jq,jk,ji,jv) = fbdata1%ivlqcf(jq,jk,ji,jv)
END DO
END DO
END DO
END DO
! Copy grid information
IF ( fbdata1%lgrid ) THEN
DO jv = 1, fbdata1%nvar
fbdata2%cgrid(jv) = fbdata1%cgrid(jv)
DO ji = 1, fbdata1%nobs
fbdata2%iproc(ji,jv) = fbdata1%iproc(ji,jv)
fbdata2%iobsi(ji,jv) = fbdata1%iobsi(ji,jv)
fbdata2%iobsj(ji,jv) = fbdata1%iobsj(ji,jv)
DO jk = 1, fbdata1%nlev
fbdata2%iobsk(jk,ji,jv) = fbdata1%iobsk(jk,ji,jv)
END DO
END DO
END DO
ENDIF
! Copy additional information
DO je = 1, MIN( fbdata1%nadd, fbdata2%nadd )
fbdata2%caddname(je) = fbdata1%caddname(je)
END DO
DO jv = 1, fbdata1%nvar
DO je = 1, MIN( fbdata1%nadd, fbdata2%nadd )
fbdata2%caddlong(je,jv) = fbdata1%caddlong(je,jv)
fbdata2%caddunit(je,jv) = fbdata1%caddunit(je,jv)
DO ji = 1, fbdata1%nobs
DO jk = 1, fbdata1%nlev
fbdata2%padd(jk,ji,je,jv) = fbdata1%padd(jk,ji,je,jv)
END DO
END DO
END DO
END DO
! Copy extra information
DO je = 1, fbdata1%next
fbdata2%cextname(je) = fbdata1%cextname(je)
fbdata2%cextlong(je) = fbdata1%cextlong(je)
fbdata2%cextunit(je) = fbdata1%cextunit(je)
END DO
DO je = 1, fbdata1%next
DO ji = 1, fbdata1%nobs
DO jk = 1, fbdata1%nlev
fbdata2%pext(jk,ji,je) = fbdata1%pext(jk,ji,je)
END DO
END DO
END DO
END SUBROUTINE copy_obfbdata
SUBROUTINE subsamp_obfbdata( fbdata1, fbdata2, llvalid )
!!----------------------------------------------------------------------
!! *** ROUTINE susbamp_obfbdata ***
!!
!! ** Purpose : Subsample an obfbdata structure based on the
!! logical mask.
!!
!! ** Method : Copy all data from fbdata1 to fbdata2 if
!! llvalid(obs)==true
!!
!! ** Action :
!!
!!----------------------------------------------------------------------
!! * Arguments
TYPE(obfbdata) :: fbdata1 ! Input obsfbdata structure
TYPE(obfbdata) :: fbdata2 ! Output obsfbdata structure
LOGICAL, DIMENSION(fbdata1%nobs) :: llvalid ! Grid info on output file
!! * Local variables
INTEGER :: nobs
INTEGER :: jv
INTEGER :: je
INTEGER :: ji
INTEGER :: jk
INTEGER :: jq
INTEGER :: ij
! Check allocation status of fbdata1
IF ( .NOT. fbdata1%lalloc ) THEN
CALL fatal_error( 'copy_obfbdata: input data not allocated', &
& __LINE__ )
ENDIF
! Check allocation status of fbdata2 and abort if already allocated
IF ( fbdata2%lalloc ) THEN
CALL fatal_error( 'subsample_obfbdata: ' // &
& 'fbdata2 already allocated', __LINE__ )
ENDIF
! Count number of subsampled observations
nobs = COUNT(llvalid)
! Allocate new data structure
CALL alloc_obfbdata( fbdata2, fbdata1%nvar, nobs, &
& fbdata1%nlev, fbdata1%nadd, fbdata1%next, &
& fbdata1%lgrid, kqcf = fbdata1%nqcf )
! Copy the header data
fbdata2%cdjuldref = fbdata1%cdjuldref
ij = 0
DO ji = 1, fbdata1%nobs
IF ( llvalid(ji) ) THEN
ij = ij +1
fbdata2%cdwmo(ij) = fbdata1%cdwmo(ji)
fbdata2%cdtyp(ij) = fbdata1%cdtyp(ji)
fbdata2%ioqc(ij) = fbdata1%ioqc(ji)
fbdata2%ipqc(ij) = fbdata1%ipqc(ji)
fbdata2%itqc(ij) = fbdata1%itqc(ji)
fbdata2%plam(ij) = fbdata1%plam(ji)
fbdata2%pphi(ij) = fbdata1%pphi(ji)
fbdata2%ptim(ij) = fbdata1%ptim(ji)
fbdata2%kindex(ij) = fbdata1%kindex(ji)
DO jq = 1, fbdata1%nqcf
fbdata2%ioqcf(jq,ij) = fbdata1%ioqcf(jq,ji)
fbdata2%ipqcf(jq,ij) = fbdata1%ipqcf(jq,ji)
fbdata2%itqcf(jq,ij) = fbdata1%itqcf(jq,ji)
END DO
DO jk = 1, fbdata1%nlev
fbdata2%idqc(jk,ij) = fbdata1%idqc(jk,ji)
fbdata2%pdep(jk,ij) = fbdata1%pdep(jk,ji)
DO jq = 1, fbdata1%nqcf
fbdata2%idqcf(jq,jk,ij) = fbdata1%idqcf(jq,jk,ji)
END DO
END DO
ENDIF
END DO
! Copy the variable data
DO jv = 1, fbdata1%nvar
fbdata2%cname(jv) = fbdata1%cname(jv)
fbdata2%coblong(jv) = fbdata1%coblong(jv)
fbdata2%cobunit(jv) = fbdata1%cobunit(jv)
ij = 0
DO ji = 1, fbdata1%nobs
IF ( llvalid(ji) ) THEN
ij = ij + 1
fbdata2%ivqc(ij,jv) = fbdata1%ivqc(ji,jv)
DO jq = 1, fbdata1%nqcf
fbdata2%ivqcf(jq,ij,jv) = fbdata1%ivqcf(jq,ji,jv)
END DO
DO jk = 1, fbdata1%nlev
fbdata2%ivlqc(jk,ij,jv) = fbdata1%ivlqc(jk,ji,jv)
fbdata2%pob(jk,ij,jv) = fbdata1%pob(jk,ji,jv)
DO jq = 1, fbdata1%nqcf
fbdata2%ivlqcf(jq,jk,ij,jv) = fbdata1%ivlqcf(jq,jk,ji,jv)
END DO
END DO
ENDIF
END DO
END DO
! Copy grid information
IF ( fbdata1%lgrid ) THEN
DO jv = 1, fbdata1%nvar
fbdata2%cgrid(jv) = fbdata1%cgrid(jv)
ij = 0
DO ji = 1, fbdata1%nobs
IF ( llvalid(ji) ) THEN
ij = ij + 1
fbdata2%iproc(ij,jv) = fbdata1%iproc(ji,jv)
fbdata2%iobsi(ij,jv) = fbdata1%iobsi(ji,jv)
fbdata2%iobsj(ij,jv) = fbdata1%iobsj(ji,jv)
DO jk = 1, fbdata1%nlev
fbdata2%iobsk(jk,ij,jv) = fbdata1%iobsk(jk,ji,jv)
END DO
ENDIF
END DO
END DO
ENDIF
! Copy additional information
DO je = 1, fbdata1%nadd
fbdata2%caddname(je) = fbdata1%caddname(je)
END DO
DO jv = 1, fbdata1%nvar
DO je = 1, fbdata1%nadd
fbdata2%caddlong(je,jv) = fbdata1%caddlong(je,jv)
fbdata2%caddunit(je,jv) = fbdata1%caddunit(je,jv)
ij = 0
DO ji = 1, fbdata1%nobs
IF ( llvalid(ji) ) THEN
ij = ij + 1
DO jk = 1, fbdata1%nlev
fbdata2%padd(jk,ij,je,jv) = fbdata1%padd(jk,ji,je,jv)
END DO
ENDIF
END DO
END DO
END DO
! Copy extra information
DO je = 1, fbdata1%next
fbdata2%cextname(je) = fbdata1%cextname(je)
fbdata2%cextlong(je) = fbdata1%cextlong(je)
fbdata2%cextunit(je) = fbdata1%cextunit(je)
END DO
DO je = 1, fbdata1%next
ij = 0
DO ji = 1, fbdata1%nobs
IF ( llvalid(ji) ) THEN
ij = ij + 1
DO jk = 1, fbdata1%nlev
fbdata2%pext(jk,ij,je) = fbdata1%pext(jk,ji,je)
END DO
ENDIF
END DO
END DO
END SUBROUTINE subsamp_obfbdata
SUBROUTINE merge_obfbdata( nsets, fbdatain, fbdataout, iset, inum, iind )
!!----------------------------------------------------------------------
!! *** ROUTINE merge_obfbdata ***
!!
!! ** Purpose : Merge multiple obfbdata structures into an one.
!!
!! ** Method : The order of elements is based on the indices in
!! iind.
!! All input data are assumed to be consistent. This
!! is assumed to be checked before calling this routine.
!! Likewise output data is assume to be consistent as
!! well without error checking.
!!
!! ** Action :
!!
!!----------------------------------------------------------------------
!! * Arguments
INTEGER, INTENT(IN):: nsets ! Number of input data sets
TYPE(obfbdata), DIMENSION(nsets) :: fbdatain ! Input obsfbdata structure
TYPE(obfbdata) :: fbdataout ! Output obsfbdata structure
INTEGER, INTENT(IN), DIMENSION(fbdataout%nobs) :: &
& iset ! Set number for a given obs.
INTEGER, INTENT(IN), DIMENSION(fbdataout%nobs) :: &
& inum ! Number within set for an obs
INTEGER, INTENT(IN), DIMENSION(fbdataout%nobs) :: &
& iind ! Indices for copying.
!! * Local variables
INTEGER :: js
INTEGER :: jo
INTEGER :: jv
INTEGER :: je
INTEGER :: ji
INTEGER :: jk
INTEGER :: jq
! Check allocation status of fbdatain
DO js = 1, nsets
IF ( .NOT. fbdatain(js)%lalloc ) THEN
CALL fatal_error( 'merge_obfbdata: input data not allocated', &
& __LINE__ )
ENDIF
END DO
! Check allocation status of fbdataout
IF ( .NOT.fbdataout%lalloc ) THEN
CALL fatal_error( 'merge_obfbdata: output data not allocated', &
& __LINE__ )
ENDIF
! Merge various names
DO jv = 1, fbdatain(1)%nvar
fbdataout%cname(jv) = fbdatain(1)%cname(jv)
fbdataout%coblong(jv) = fbdatain(1)%coblong(jv)
fbdataout%cobunit(jv) = fbdatain(1)%cobunit(jv)
IF ( fbdatain(1)%lgrid ) THEN
fbdataout%cgrid(jv) = fbdatain(1)%cgrid(jv)
ENDIF
END DO
DO jv = 1, fbdatain(1)%nadd
fbdataout%caddname(jv) = fbdatain(1)%caddname(jv)
END DO
DO jv = 1, fbdatain(1)%nvar
DO je = 1, fbdatain(1)%nadd
fbdataout%caddlong(je,jv) = fbdatain(1)%caddlong(je,jv)
fbdataout%caddunit(je,jv) = fbdatain(1)%caddunit(je,jv)
END DO
END DO
DO jv = 1, fbdatain(1)%next
fbdataout%cextname(jv) = fbdatain(1)%cextname(jv)
fbdataout%cextlong(jv) = fbdatain(1)%cextlong(jv)
fbdataout%cextunit(jv) = fbdatain(1)%cextunit(jv)
END DO
fbdataout%cdjuldref = fbdatain(1)%cdjuldref
! Loop over total views
DO jo = 1, fbdataout%nobs
js = iset(iind(jo))
ji = inum(iind(jo))
! Merge the header data
fbdataout%cdwmo(jo) = fbdatain(js)%cdwmo(ji)
fbdataout%cdtyp(jo) = fbdatain(js)%cdtyp(ji)
fbdataout%ioqc(jo) = fbdatain(js)%ioqc(ji)
fbdataout%ipqc(jo) = fbdatain(js)%ipqc(ji)
fbdataout%itqc(jo) = fbdatain(js)%itqc(ji)
fbdataout%plam(jo) = fbdatain(js)%plam(ji)
fbdataout%pphi(jo) = fbdatain(js)%pphi(ji)
fbdataout%ptim(jo) = fbdatain(js)%ptim(ji)
fbdataout%kindex(jo) = fbdatain(js)%kindex(ji)
DO jq = 1, fbdatain(js)%nqcf
fbdataout%ioqcf(jq,jo) = fbdatain(js)%ioqcf(jq,ji)
fbdataout%ipqcf(jq,jo) = fbdatain(js)%ipqcf(jq,ji)
fbdataout%itqcf(jq,jo) = fbdatain(js)%itqcf(jq,ji)
END DO
DO jk = 1, fbdatain(js)%nlev
fbdataout%pdep(jk,jo) = fbdatain(js)%pdep(jk,ji)
fbdataout%idqc(jk,jo) = fbdatain(js)%idqc(jk,ji)
DO jq = 1, fbdatain(js)%nqcf
fbdataout%idqcf(jq,jk,jo) = fbdatain(js)%idqcf(jq,jk,ji)
END DO
END DO
! Merge the variable data
DO jv = 1, fbdatain(js)%nvar
fbdataout%ivqc(jo,jv) = fbdatain(js)%ivqc(ji,jv)
DO jq = 1, fbdatain(js)%nqcf
fbdataout%ivqcf(jq,jo,jv) = fbdatain(js)%ivqcf(jq,ji,jv)
END DO
DO jk = 1, fbdatain(js)%nlev
fbdataout%ivlqc(jk,jo,jv) = fbdatain(js)%ivlqc(jk,ji,jv)
fbdataout%pob(jk,jo,jv) = fbdatain(js)%pob(jk,ji,jv)
DO jq = 1, fbdatain(js)%nqcf
fbdataout%ivlqcf(jq,jk,jo,jv) = &
& fbdatain(js)%ivlqcf(jq,jk,ji,jv)
END DO
END DO
END DO
! Merge grid information
IF ( fbdatain(js)%lgrid ) THEN
DO jv = 1, fbdatain(js)%nvar
fbdataout%cgrid(jv) = fbdatain(js)%cgrid(jv)
fbdataout%iproc(jo,jv) = fbdatain(js)%iproc(ji,jv)
fbdataout%iobsi(jo,jv) = fbdatain(js)%iobsi(ji,jv)
fbdataout%iobsj(jo,jv) = fbdatain(js)%iobsj(ji,jv)
DO jk = 1, fbdatain(js)%nlev
fbdataout%iobsk(jk,jo,jv) = fbdatain(js)%iobsk(jk,ji,jv)