Merge pull request #2841 from GEOS-ESM/feature/wdboggs/get_history_co…

…llection_output_info

Get metadata for ESMF_FieldBundle for History3G

base/CMakeLists.txt

@@ -56,6 +56,7 @@ set (srcs
   MAPL_XYGridFactory.F90
   MAPL_NetCDF.F90                       Plain_netCDF_Time.F90
   MAPL_DateTime_Parsing_ESMF.F90	MAPL_ObsUtil.F90
+  MAPL_ESMF_InfoKeys.F90
   # Orphaned program: should not be in this library.
   # tstqsat.F90
   )

base/MAPL_ESMF_InfoKeys.F90

@@ -0,0 +1,76 @@
+#include "MAPL_Exceptions.h"
+module mapl3g_esmf_info_keys
+
+   use MAPL_ErrorHandling
+
+   implicit none
+
+   public :: KEY_UNGRIDDED_DIMS
+   public :: KEY_VERT_DIM
+   public :: KEY_VERT_GEOM
+   public :: KEY_UNITS
+   public :: KEY_LONG_NAME
+   public :: KEY_STANDARD_NAME
+   public :: KEY_NUM_LEVELS
+   public :: KEY_VLOC
+   public :: KEY_NUM_UNGRID_DIMS
+   public :: KEYSTUB_DIM
+   public :: KEY_UNGRIDDED_NAME
+   public :: KEY_UNGRIDDED_UNITS
+   public :: KEY_UNGRIDDED_COORD
+   public :: KEY_DIM_STRINGS
+   public :: make_dim_key
+   private
+
+   ! FieldSpec info keys
+   character(len=*), parameter :: PREFIX = 'MAPL/'
+   character(len=*), parameter :: KEY_UNGRIDDED_DIMS = PREFIX // 'ungridded_dims/'
+   character(len=*), parameter :: KEY_VERT_DIM = PREFIX // 'vertical_dim/'
+   character(len=*), parameter :: KEY_VERT_GEOM = PREFIX // 'vertical_geom/'
+   character(len=*), parameter :: KEY_UNITS = PREFIX // 'units'
+   character(len=*), parameter :: KEY_LONG_NAME = PREFIX // 'long_name'
+   character(len=*), parameter :: KEY_STANDARD_NAME = PREFIX // 'standard_name'
+
+   ! VerticalGeom info keys
+   character(len=*), parameter :: KEY_NUM_LEVELS = KEY_VERT_GEOM // 'num_levels'
+
+   ! VerticalDimSpec info keys
+   character(len=*), parameter :: KEY_VLOC = KEY_VERT_DIM // 'vloc'
+
+   ! UngriddedDims info keys
+   character(len=*), parameter :: KEY_NUM_UNGRID_DIMS = KEY_UNGRIDDED_DIMS // 'num_ungridded_dimensions'
+   character(len=*), parameter :: KEYSTUB_DIM = KEY_UNGRIDDED_DIMS // 'dim_'
+
+   ! UngriddedDim info keys
+   character(len=*), parameter :: KEY_UNGRIDDED_NAME = 'name'
+   character(len=*), parameter :: KEY_UNGRIDDED_UNITS = 'units'
+   character(len=*), parameter :: KEY_UNGRIDDED_COORD = 'coordinates'
+
+   character(len=*), parameter :: KEY_DIM_STRINGS(9) = [ &
+      KEYSTUB_DIM // '1', KEYSTUB_DIM // '2', KEYSTUB_DIM // '3', &
+      KEYSTUB_DIM // '4', KEYSTUB_DIM // '5', KEYSTUB_DIM // '6', &
+      KEYSTUB_DIM // '7', KEYSTUB_DIM // '8', KEYSTUB_DIM // '9']
+
+contains
+
+   function make_dim_key(n, rc) result(key)
+      character(len=:), allocatable :: key
+      integer, intent(in) :: n
+      integer, optional, intent(out) :: rc
+      integer :: status
+      character(len=32) :: raw
+
+      key = ''
+      _ASSERT(n > 0, 'Index must be positive.')
+      if(n <= size(KEY_DIM_STRINGS)) then
+         key = KEY_DIM_STRINGS(n)
+         _RETURN(_SUCCESS)
+      end if
+      write(raw, fmt='(I0)', iostat=status) n
+      _ASSERT(status == 0, 'Write failed')
+      key = KEYSTUB_DIM // trim(raw)
+      _RETURN(_SUCCESS)
+
+   end function make_dim_key
+
+end module mapl3g_esmf_info_keys

generic3g/specs/UngriddedDim.F90

@@ -28,6 +28,7 @@ module mapl3g_UngriddedDim
 
    interface UngriddedDim
       module procedure new_UngriddedDim_extent
+      module procedure new_UngriddedDim_name_and_extent
       module procedure new_UngriddedDim_name_and_coords
       module procedure new_UngriddedDim_name_units_and_coords
    end interface UngriddedDim
@@ -42,7 +43,6 @@ module mapl3g_UngriddedDim
 
    character(*), parameter :: UNKNOWN_DIM_NAME = 'NONE'
    character(*), parameter :: UNKNOWN_DIM_UNITS = 'NONE'
-
 
 contains
 
@@ -66,13 +66,19 @@ pure function new_UngriddedDim_name_and_coords(name, coordinates) result(spec)
    end function new_UngriddedDim_name_and_coords
 
 
+   pure function new_UngriddedDim_name_and_extent(name, extent) result(spec)
+      character(*), intent(in) :: name
+      integer, intent(in) :: extent
+      type(UngriddedDim) :: spec
+      spec = UngriddedDim(name, default_coords(extent))
+   end function new_UngriddedDim_name_and_extent
+
    pure function new_UngriddedDim_extent(extent) result(spec)
       integer, intent(in) :: extent
       type(UngriddedDim) :: spec
       spec = UngriddedDim(UNKNOWN_DIM_NAME, default_coords(extent))
    end function new_UngriddedDim_extent
 
-
    pure function default_coords(extent, lbound) result(coords)
       real, allocatable :: coords(:)
       integer, intent(in) :: extent

gridcomps/History3G/CMakeLists.txt

@@ -5,7 +5,8 @@ set(srcs
  HistoryGridComp.F90
  HistoryCollectionGridComp.F90
  HistoryCollectionGridComp_private.F90
-  )
+ OutputInfo.F90
+ )
 
 find_package (MPI REQUIRED)
 

gridcomps/History3G/HistoryCollectionGridComp_private.F90

@@ -10,6 +10,9 @@ module mapl3g_HistoryCollectionGridComp_private
    use MAPL_NewArthParserMod, only: parser_variables_in_expression
    use MAPL_TimeStringConversion
    use MAPL_BaseMod, only: MAPL_UnpackTime
+   use mapl3g_output_info, only: get_num_levels, get_vertical_dim_spec_names
+   use mapl3g_output_info, only: get_vertical_dim_spec_name, get_ungridded_dims
+   use gFTL2_StringSet
 
    implicit none
    private
@@ -62,7 +65,12 @@ subroutine register_imports(gridcomp, hconfig, rc)
       type(StringVector) :: variable_names
       integer :: status
 
-      var_list = ESMF_HConfigCreateAt(hconfig, keystring=VAR_LIST_KEY, _RC)
+      var_list = ESMF_HConfigCreateAt(hconfig, keystring=VAR_LIST_KEY, rc=status)
+      if(status==ESMF_RC_NOT_FOUND) then
+         _FAIL(VAR_LIST_KEY // ' was not found.')
+      end if
+      _VERIFY(status)
+
       iter_begin = ESMF_HConfigIterBegin(var_list,_RC)
       iter_end = ESMF_HConfigIterEnd(var_list,_RC)
       iter = iter_begin