Add FCI on Meteosat-12 varobs and CX namelists and test files (#235)

* Add varobs files for FCI. FCIASR and FCIClr in the UKV and FCIClr in the global.

* Add CX files for FCI. FCIASR and FCIClr for the UKV and FCIClr only for the global.

* Add FCI to default CX fields file

* Add FCI (Meteosat12) to OPS FORTRAN routines

* Add missing entries to OPS routines for FCI

* Update generate_unittest python script to add FCI, and update netCDF files for CX and Varobs tests

* Re-add IRS which was accidentally deleted

Author: PJLevensMO

deps/ops/stubs/OpsMod_CXGenerate/Ops_GetDefaultCxFields.inc

@@ -120,6 +120,12 @@ SELECT CASE (ObsGroup)
                        StashItem_SeaIce,StashItem_orog,StashItem_qcl,            &
                        StashItem_p,StashItem_p_Surface,StashCode_u10,            &
                        StashCode_v10,StashCode_t2,StashCode_rh2,StashCode_pmsl/)
+  CASE (ObsGroupFCIASR, ObsGroupFCIClr)
+    CxFields(1:15) = (/StashItem_theta,StashItem_q,StashItem_qcf,StashItem_SST,  &
+                       StashItem_SeaIce,StashItem_orog,StashItem_qcl,            &
+                       StashItem_p,StashItem_p_Surface,StashCode_u10,            &
+                       StashCode_v10,StashCode_t2,StashCode_rh2,StashCode_pmsl,  &
+                       StashItem_Cloud_Bulk/)
   CASE (ObsGroupMWRI)
     CxFields(1:14) = (/StashItem_theta,StashItem_q,StashItem_qcf,StashItem_SST, &
                        StashItem_SeaIce,StashItem_orog,StashItem_qcl,           &

deps/ops/stubs/OpsMod_Control/Ops_ReadObsGroupSwitches.inc

@@ -67,6 +67,8 @@ Using(ObsGroupAIRS) = ops_env_is_true ("OPS_AIRS")
 Using(ObsGroupIASI) = ops_env_is_true ("OPS_IASI")
 Using(ObsGroupSEVIRIClr) = ops_env_is_true ("OPS_SEVIRICLR")
 Using(ObsGroupSEVIRIASR) = ops_env_is_true ("OPS_SEVIRIASR")
+Using(ObsGroupFCIClr) = ops_env_is_true ("OPS_FCICLR")
+Using(ObsGroupFCIASR) = ops_env_is_true ("OPS_FCIASR")
 Using(ObsGroupMVIRIClr) = ops_env_is_true ("OPS_MVIRICLR")
 Using(ObsGroupGOESImClr) = ops_env_is_true ("OPS_GOESIMCLR")
 Using(ObsGroupCOMSMIClr) = ops_env_is_true ("OPS_COMSMICLR")

deps/ops/stubs/OpsMod_ODB/OpsFn_ObsToReportType.inc

@@ -105,6 +105,7 @@ USE OpsMod_Satids, ONLY:    &
   SatId_Meteosat9,          &
   SatId_Meteosat10,         &
   SatId_Meteosat11,         &
+  SatId_Meteosat12,         &
   SatId_MetopA,             &
   SatId_MetopB,             &
   SatId_MetopC,             &
@@ -419,6 +420,25 @@ SELECT CASE (Obs % Header % ObsGroup)
     END IF
   CASE (ObsGroupCOMSMIClr)
     report_types = rep_type_kma_geos_rad
+  CASE (ObsGroupFCIClr, ObsGroupFCIASR)
+    IF (Obs % Header % Satid % Present) THEN
+      DO i = ob_start, ob_end
+        IF (Obs % Satid(i) == SatId_Meteosat12) THEN
+          report_types(i - ob_start + 1) = rep_type_meteosat_12_geos_rad
+        ELSE
+          found_report_type = .FALSE.
+          DO j = 1, SIZE (map, DIM = 1)
+            IF ((map(j,1) == ObsGroupFCIClr .AND. map(j,2) == Obs % Satid(i)) .OR. &
+                (map(j,1) == ObsGroupFCIASR .AND. map(j,2) == Obs % Satid(i))) THEN
+              report_types(i - ob_start + 1) = map(j,3)
+              found_report_type = .TRUE.
+              EXIT
+            END IF
+          END DO
+          CALL update_unrecognized_satids (Obs % Satid(i))
+        END IF
+      END DO
+    END IF
   CASE (ObsGroupMWSFY3B)
     report_types = rep_type_fy3b
   CASE (ObsGroupGeoCloud)
@@ -436,6 +456,8 @@ SELECT CASE (Obs % Header % ObsGroup)
           report_types(i - ob_start + 1) = rep_type_meteosat_10_geos_rad
         ELSE IF (Obs % Satid(i) == SatId_METEOSAT11) THEN
           report_types(i - ob_start + 1) = rep_type_meteosat_11_geos_rad
+        ELSE IF (Obs % Satid(i) == SatId_METEOSAT12) THEN
+          report_types(i - ob_start + 1) = rep_type_meteosat_12_geos_rad
         ELSE
           found_report_type = .FALSE.
           DO j = 1, SIZE (map, DIM = 1)

deps/ops/stubs/OpsMod_ODB/OpsODB_InitODBElemDesp_Body.inc

@@ -53,6 +53,7 @@ USE OpsMod_ObsGroupInfo, ONLY: &
     ObsGroupSurfaceCloud,      &
     ObsGroupTOVS,              &
     OpsFn_IsAHIGroup,          &
+    OpsFn_IsFCIGroup,          &
     OpsFn_IsSEVIRIGroup
 
 USE OpsMod_Index
@@ -590,6 +591,28 @@ IF (OpsFn_IsAHIGroup(ObsGroup) .OR. &
   ElemDesp2ODBDesp(IndexAHIBrightnessTemp) % also_do_levels(1:5)  = (/1,43,43,1,1/)
 END IF
 
+ElemDesp2ODBDesp(IndexFCICloudTopT) % TableName            = 'body'
+ElemDesp2ODBDesp(IndexFCICloudTopT) % ColName              = 'initial_obsvalue'
+ElemDesp2ODBDesp(IndexFCICloudTopT) % Varno                = ops_odb_getval (h, "$cloud_top_temp")
+
+IF (OpsFn_IsFCIGroup(ObsGroup) .OR. &
+    (ObsGroup == ObsGroupGeoCloud .AND. OpsFn_IsFCIGroup (SrcObsGroupGeoCloud))) THEN
+  ElemDesp2ODBDesp(IndexFCIBrightnessTemp) % TableName     = 'body'
+  ElemDesp2ODBDesp(IndexFCIBrightnessTemp) % ColName       = 'initial_obsvalue'
+  ElemDesp2ODBDesp(IndexFCIBrightnessTemp) % Varno         = ops_odb_getval (h, "$rawbt")  ! brightness temperature
+
+  ElemDesp2ODBDesp(IndexFCICloudFree) % TableName          = 'body'
+  ElemDesp2ODBDesp(IndexFCICloudFree) % ColName            = 'initial_obsvalue'
+  ElemDesp2ODBDesp(IndexFCICloudFree) % Varno              = ops_odb_getval (h, "$cloud_frac_clear")
+
+  ElemDesp2ODBDesp(IndexFCIBrightnessTemp) % also_do(1:5)  = (/IndexSkinTemperature, &
+                                                                  IndexRH,              &
+                                                                  IndexTemp,            &
+                                                                  IndexRH2,             &
+                                                                  IndexT2/)
+  ElemDesp2ODBDesp(IndexFCIBrightnessTemp) % also_do_levels(1:5)  = (/1,43,43,1,1/)
+END IF
+
 IF (ObsGroup == ObsGroupMTSATImClr) THEN
   ElemDesp2ODBDesp(IndexMTSATImBrightnessTemp) % TableName     = 'body'
   ElemDesp2ODBDesp(IndexMTSATImBrightnessTemp) % ColName       = 'initial_obsvalue'

deps/ops/stubs/OpsMod_Varobs/Ops_GetDefaultVarfields.inc

@@ -108,6 +108,11 @@ SELECT CASE (ObsGroup)
     IF (.NOT. RTTOV_CloudSwitch) THEN
       Varfields(13:14) = (/Varfield_cloudtopp, Varfield_cloudfrac/)
     END IF
+  CASE (ObsGroupFCIASR, ObsGroupFCIClr)
+    Varfields(1:12) = (/Varfield_britemp,Varfield_satid,Varfield_satzenith, &
+                        Varfield_solzenith,Varfield_tskin,Varfield_tcozone, &
+                        Varfield_surface,Varfield_numchans,Varfield_channum, &
+                        Varfield_stratt,Varfield_iremiss,Varfield_qcinfo/)
   CASE (ObsGroupHIRAS)
     Varfields(1:12) = (/Varfield_tskin,Varfield_tcozone,Varfield_satzenith, &
                         Varfield_surface,Varfield_stratt,Varfield_satid, &

deps/ops/stubs/OpsMod_Varobs/Ops_SetupVarobsLevDepC.inc

@@ -48,6 +48,8 @@ USE OpsMod_ObsGroupInfo, ONLY: &
     ObsGroupGPSRO,             &
     ObsGroupSEVIRIClr,         &
     ObsGroupSEVIRIASR,         &
+    ObsGroupFCIClr,            &
+    ObsGroupFCIASR,            &
     ObsGroupMVIRIClr,          &
     ObsGroupGOESImClr,         &
     ObsGroupMTSATImClr,        &
@@ -187,6 +189,11 @@ SELECT CASE (Observations % header % ObsGroup)
     ObsLevelType = 0.0
     NumLevelLevs = 1
 
+  CASE (ObsGroupFCIClr, ObsGroupFCIASR)
+
+    ObsLevelType = 0.0
+    NumLevelLevs = 1
+
   CASE (ObsGroupSAPHIR)
 
     ObsLevelType = 0.0

deps/ops/stubs/Ops_Constants/OpsFn_ASRToClrGeoGroup.inc

@@ -16,6 +16,8 @@ INTEGER             :: OpsFn_ASRToClrGeoGroup
 SELECT CASE (obsgroup)
   CASE (ObsGroupAHIASR)
     OpsFn_ASRToClrGeoGroup = ObsGroupAHIClr
+  CASE (ObsGroupFCIASR)
+    OpsFn_ASRToClrGeoGroup = ObsGroupFCIClr
   CASE (ObsGroupSEVIRIASR)
     OpsFn_ASRToClrGeoGroup = ObsGroupSEVIRIClr
   CASE DEFAULT

deps/ops/stubs/Ops_Constants/OpsFn_IsASRGeoGroup.inc

@@ -14,6 +14,7 @@ INTEGER, INTENT(IN) :: obsgroup
 LOGICAL             :: OpsFn_IsASRGeoGroup
 
 IF (obsgroup == ObsGroupAHIASR .OR. &
+    obsgroup == ObsGroupFCIASR .OR. &
     obsgroup == ObsGroupSEVIRIASR) THEN
   OpsFn_IsASRGeoGroup = .TRUE.
 ELSE

deps/ops/stubs/Ops_Constants/OpsFn_IsClrGeoGroup.inc

@@ -16,6 +16,7 @@ LOGICAL             :: OpsFn_IsClrGeoGroup
 IF (obsgroup == ObsGroupABIClr .OR. &
     obsgroup == ObsGroupAHIClr .OR. &
     obsgroup == ObsGroupCOMSMIClr .OR. &
+    obsgroup == ObsGroupFCIClr .OR. &
     obsgroup == ObsGroupGOESImClr .OR. &
     obsgroup == ObsGroupIN3DIClr .OR. &
     obsgroup == ObsGroupMTSATImClr .OR. &

deps/ops/stubs/Ops_Constants/OpsFn_IsFCIGroup.inc

@@ -0,0 +1,23 @@
+!-------------------------------------------------------------------------------
+! (C) Crown copyright Met Office. All rights reserved.
+!-------------------------------------------------------------------------------
+! Function that returns .TRUE. if given obs group is a FCI obs group, false
+! if not.
+!-------------------------------------------------------------------------------
+
+ELEMENTAL FUNCTION OpsFn_IsFCIGroup (obsgroup)
+
+! Function arguments:
+INTEGER, INTENT(IN) :: obsgroup
+
+! Function result:
+LOGICAL             :: OpsFn_IsFCIGroup
+
+IF (obsgroup == ObsGroupFCIClr .OR. &
+    obsgroup == ObsGroupFCIASR) THEN
+  OpsFn_IsFCIGroup = .TRUE.
+ELSE
+  OpsFn_IsFCIGroup = .FALSE.
+END IF
+
+END FUNCTION OpsFn_IsFCIGroup