Merge pull request #3171 from GEOS-ESM/feature/tclune/#3163-refactor-…

…sharedio

Fixes #3163  refactor sharedio

GeomIO/SharedIO.F90

@@ -1,7 +1,6 @@
 #include "MAPL_Generic.h"
 module mapl3g_SharedIO
    use mapl_ErrorHandlingMod
-   use mapl3g_InfoUtilities
    use mapl3g_FieldBundleGet
    use mapl3g_FieldGet
    use mapl3g_VerticalStaggerLoc
@@ -25,7 +24,6 @@ module mapl3g_SharedIO
    public esmf_to_pfio_type
 
    public :: add_vertical_dimensions
-   public :: get_vertical_dimension_num_levels
    public :: get_vertical_dimension_name_from_field
    public :: add_ungridded_dimensions
    public :: ungridded_dim_names
@@ -46,8 +44,10 @@ function bundle_to_metadata(bundle, geom, rc) result(metadata)
 
       mapl_geom => get_mapl_geom(geom, _RC)
       metadata = mapl_geom%get_file_metadata()
+
       ! Add metadata for vertical geom, note could be both center and edge
       call add_vertical_dimensions(bundle, metadata, _RC)
+
       ! Add metadata for all unique ungridded dimensions the set of fields has
       call add_ungridded_dimensions(bundle, metadata, _RC)
 
@@ -73,53 +73,80 @@ subroutine add_variables(metadata, bundle, rc)
       type(ESMF_Field), allocatable :: fieldList(:)
 
       call MAPL_FieldBundleGet(bundle, fieldList=fieldList, _RC)
-      do i=1,size(fieldList)
+      do i = 1, size(fieldList)
          call add_variable(metadata, fieldList(i), _RC)
       enddo
-      _RETURN(_SUCCESS)
 
+      _RETURN(_SUCCESS)
    end subroutine add_variables
 
    subroutine add_variable(metadata, field,  rc)
       type(ESMF_Field), intent(in) :: field
       type(FileMetaData), intent(inout) :: metadata
       integer, intent(out), optional :: rc
 
-      type(Variable) :: v
       integer :: status
-      character(len=:), allocatable :: dims
+      type(Variable) :: v
+      character(len=:), allocatable :: variable_dim_names
       type(ESMF_TYPEKIND_FLAG) :: typekind
+      character(len=:), allocatable :: short_name
+      character(len=:), allocatable :: units
+      character(len=:), allocatable :: long_name
+      character(len=:), allocatable :: standard_name
+
+      type(ESMF_Geom) :: geom
       integer :: pfio_type
-      character(len=:), allocatable :: char
-      character(len=ESMF_MAXSTR) :: fname
+
+      variable_dim_names = get_variable_dim_names(field, geom, _RC)
+      call MAPL_FieldGet(field, short_name=short_name, typekind=typekind, _RC)
+      pfio_type = esmf_to_pfio_type(typekind ,_RC)
+      v = Variable(type=pfio_type, dimensions=variable_dim_names)
+
+      ! Attributes
+      call MAPL_FieldGet(field, units=units, long_name=long_name, standard_name=standard_name, _RC)
+      if (allocated(units))then
+         call v%add_attribute('units', units)
+      end if
+      if (allocated(long_name)) then
+         call v%add_attribute('long_name', long_name)
+      end if
+      if (allocated(standard_name)) then
+         call v%add_attribute('standard_name', standard_name)
+      end if
+
+      call metadata%add_variable(short_name, v, _RC)
+
+      _RETURN(_SUCCESS)
+   end subroutine add_variable
+
+   function get_variable_dim_names(field, geom, rc) result(dim_names)
+      character(len=:), allocatable :: dim_names
+      type(ESMF_Field), intent(in) :: field
+      type(ESMF_Geom), intent(in) :: geom
+      integer, optional, intent(out) :: rc
+
       type(MAPLGeom), pointer :: mapl_geom
       type(StringVector) :: grid_variables
       type(ESMF_Geom) :: esmfgeom
       character(len=:), allocatable :: vert_dim_name, ungridded_names
-
+      integer :: status
+
       call ESMF_FieldGet(field, geom=esmfgeom, _RC)
       mapl_geom => get_mapl_geom(esmfgeom, _RC)
       grid_variables = mapl_geom%get_gridded_dims()
-      dims = string_vec_to_comma_sep(grid_variables)
-      call ESMF_FieldGet(field, name=fname, typekind=typekind, _RC)
+      dim_names = string_vec_to_comma_sep(grid_variables)
       ! add vertical dimension
       vert_dim_name = get_vertical_dimension_name_from_field(field, _RC)
-      if(vert_dim_name /= EMPTY) dims = dims//","//vert_dim_name
+      if(vert_dim_name /= EMPTY) dim_names = dim_names // "," // vert_dim_name
       ! add any ungridded dimensions
       ungridded_names = ungridded_dim_names(field, _RC)
-      if(ungridded_names /= EMPTY) dims = dims // ungridded_names
+      if(ungridded_names /= EMPTY) dim_names = dim_names // ungridded_names
       ! add time dimension
-      dims = dims//",time"
-      pfio_type = esmf_to_pfio_type(typekind ,_RC)
-      v = Variable(type=pfio_type, dimensions=dims)
-      call MAPL_FieldGet(field, units=char, _RC)
-      call v%add_attribute('units',char)
-      call MAPL_FieldGet(field, standard_name=char, _RC)
-      call v%add_attribute('long_name',char)
-      call metadata%add_variable(trim(fname), v, _RC)
+      dim_names = dim_names // ",time"
+
       _RETURN(_SUCCESS)
+   end function get_variable_dim_names
 
-   end subroutine add_variable
 
    function get_mapl_geom(geom, rc) result(mapl_geom)
       type(MAPLGeom), pointer :: mapl_geom
@@ -140,13 +167,15 @@ function esmf_to_pfio_type(esmf_type, rc) result(pfio_type)
       integer :: pfio_type
       type(ESMF_TYPEKIND_FLAG), intent(in) :: esmf_type
       integer, intent(out), optional :: rc
+
       if (esmf_type == ESMF_TYPEKIND_R4) then
          pfio_type = pFIO_REAL32
       else if (esmf_type == ESMF_TYPEKIND_R8) then
          pfio_type = pFIO_REAL64
       else
          _FAIL("Unsupported ESMF field typekind for output")
       end if
+
       _RETURN(_SUCCESS)
    end function
 
@@ -162,9 +191,10 @@ function string_vec_to_comma_sep(string_vec) result(comma_sep)
       call iter%next()
       do while (iter /= string_vec%end())
          var => iter%of()
-         comma_sep = comma_sep//","//var
+         comma_sep = comma_sep // "," // var
          call iter%next()
       enddo
+
    end function  
 
    function create_time_variable(current_time, rc) result(time_var)
@@ -191,7 +221,6 @@ subroutine add_vertical_dimensions(bundle, metadata, rc)
 
       integer :: status
       integer :: num_levels
-      type(StringVector) :: vertical_names
       type(StringVectorIterator) :: iter
       character(len=:), allocatable :: dim_name
       type(VerticalStaggerLoc) :: vert_staggerloc
@@ -202,7 +231,6 @@ subroutine add_vertical_dimensions(bundle, metadata, rc)
       call MAPL_FieldBundleGet(bundle, fieldList=fieldList, _RC)
       num_vgrid_levels = 0
 
-      vertical_names = StringVector()
       do i = 1, size(fieldList)
          call MAPL_FieldGet(fieldList(i), vert_staggerloc=vert_staggerloc, _RC)
          if (vert_staggerloc == VERTICAL_STAGGER_NONE) cycle
@@ -216,34 +244,14 @@ subroutine add_vertical_dimensions(bundle, metadata, rc)
          end if
 
          dim_name = vert_staggerloc%get_dimension_name()
-         call vertical_names%push_back(dim_name)
+         call metadata%add_dimension(dim_name, num_levels)
 
       end do
 
-      associate (e => vertical_names%ftn_end())
-        iter = vertical_names%ftn_begin()
-        do while(iter /= e)
-           call iter%next()
-           dim_name = iter%of()
-           num_levels = vert_staggerloc%get_num_levels(num_vgrid_levels)
-           call metadata%add_dimension(dim_name, num_levels)
-        end do
-      end associate
-
       _RETURN(_SUCCESS)
-
    end subroutine add_vertical_dimensions
 
 
-   integer function get_vertical_dimension_num_levels(dim_spec_name, num_levels) result(num)
-      character(len=*), intent(in) :: dim_spec_name
-      integer, intent(in) :: num_levels
-
-      num = num_levels
-      if(dim_spec_name == 'VERTICAL_DIM_EDGE') num = num_levels + 1
-
-   end function get_vertical_dimension_num_levels
-
    function get_vertical_dimension_name_from_field(field, rc) result(dim_name)
       character(len=:), allocatable :: dim_name
       type(ESMF_Field), intent(in) :: field
@@ -298,22 +306,25 @@ function ungridded_dim_names(field, rc) result(dim_names)
 
       call MAPL_FieldGet(field, ungridded_dims=ungridded_dims, _RC)
       dim_names = cat_ungridded_dim_names(ungridded_dims)
+
       _RETURN(_SUCCESS)
-
    end function ungridded_dim_names
 
+
    function cat_ungridded_dim_names(dims) result(dim_names)
       character(len=:), allocatable :: dim_names
       class(UngriddedDims), intent(in) :: dims
-      type(UngriddedDim) :: u
+
       integer :: i
-      character, parameter :: JOIN = ','
 
+#define JOIN(a,b) a // ',' // b
       dim_names = EMPTY
       do i = 1, dims%get_num_ungridded()
-         u = dims%get_ith_dim_spec(i)
-         dim_names = JOIN // u%get_name()
+         associate (u => dims%get_ith_dim_spec(i))
+           dim_names = JOIN(dim_names, u%get_name())
+         end associate
       end do
+#undef JOIN
 
    end function cat_ungridded_dim_names
 

GeomIO/tests/Test_SharedIO.pf

@@ -35,25 +35,6 @@ contains
    end subroutine assign_character_from_string
 
 
-    @Test
-    subroutine test_get_vertical_dimension_num_levels()
-      integer, parameter :: NUMLEVELS = 3
-      character(:), allocatable :: vertical_dim
-      integer :: num_levels
-      character(len=:), allocatable :: message
-
-      vertical_dim = DIM_CENTER
-      num_levels = NUMLEVELS
-      message = make_message('Num_levels does not match for', vertical_dim)
-      @assertEqual(num_levels, get_vertical_dimension_num_levels(vertical_dim, NUMLEVELS), message)
-
-      vertical_dim = DIM_EDGE
-      num_levels = NUMLEVELS+1
-      message = make_message('Num_levels does not match for', vertical_dim)
-      @assertEqual(num_levels, get_vertical_dimension_num_levels(vertical_dim, NUMLEVELS), message)
-
-    end subroutine test_get_vertical_dimension_num_levels
-
     @Test
     subroutine test_cat_ungridded_dim_names()
        type(UngriddedDims) :: dims

field/FieldGet.F90

@@ -24,33 +24,46 @@ module mapl3g_FieldGet
 contains
 
    subroutine field_get(field, unusable, &
+        short_name, typekind, &
         num_levels, vert_staggerloc, num_vgrid_levels, &
         ungridded_dims, &
-        units, standard_name, &
+        units, standard_name, long_name,  &
         rc)
 
       type(ESMF_Field), intent(in) :: field
       class(KeywordEnforcer), optional, intent(in) :: unusable
+      character(len=:), optional, allocatable, intent(out) :: short_name
+      type(ESMF_TypeKind_Flag), optional, intent(out) :: typekind
       integer, optional, intent(out) :: num_levels
       type(VerticalStaggerLoc), optional, intent(out) :: vert_staggerloc
       integer, optional, intent(out) :: num_vgrid_levels
       type(UngriddedDims), optional, intent(out) :: ungridded_dims
       character(len=:), optional, allocatable, intent(out) :: units
       character(len=:), optional, allocatable, intent(out) :: standard_name
+      character(len=:), optional, allocatable, intent(out) :: long_name
 
       integer, optional, intent(out) :: rc
 
       integer :: status
       type(ESMF_Info) :: field_info
+      character(len=ESMF_MAXSTR) :: fname
+
+      if (present(short_name)) then
+         call ESMF_FieldGet(field, name=fname, _RC)
+         short_name = trim(fname)
+      end if
+
+      if (present(typekind)) then
+         call ESMF_FieldGet(field, typekind=typekind, _RC)
+      end if
 
       call ESMF_InfoGetFromHost(field, field_info, _RC)
-
       call MAPL_FieldInfoGetInternal(field_info, &
            num_levels=num_levels, &
            vert_staggerloc=vert_staggerloc, &
            num_vgrid_levels=num_vgrid_levels, &
            ungridded_dims=ungridded_dims, &
-           units=units, standard_name=standard_name, _RC)
+           units=units, standard_name=standard_name, long_name=long_name, _RC)
 
       _RETURN(_SUCCESS)
    end subroutine field_get