Towards setting restart mode as 'internal' info, rather than 'private'

Author: pchakraborty

field/FieldInfo.F90

@@ -19,9 +19,8 @@ module mapl3g_FieldInfo
    public :: FieldInfoSetShared
    public :: FieldInfoSetInternal
    public :: FieldInfoGetInternal
-   public :: FieldInfoSetPrivate
-   public :: FieldInfoGetPrivate
    public :: FieldInfoCopyShared
+   public :: RestartModePlusAliasId
 
    interface FieldInfoSetShared
       procedure info_field_set_shared_i4
@@ -41,14 +40,6 @@ module mapl3g_FieldInfo
       module procedure field_info_get_internal
    end interface FieldInfoGetInternal
 
-   interface FieldInfoSetPrivate
-      module procedure field_info_set_private
-   end interface FieldInfoSetPrivate
-
-   interface FieldInfoGetPrivate
-      module procedure field_info_get_private
-   end interface FieldInfoGetPrivate
-
    interface FieldInfoCopyShared
       procedure :: field_info_copy_shared
    end interface FieldInfoCopyShared
@@ -68,6 +59,11 @@ module mapl3g_FieldInfo
    character(*), parameter :: KEY_SPEC_HANDLE = "/spec_handle"
    character(*), parameter :: KEY_RESTART_MODE = "/restart_mode"
 
+   type RestartModePlusAliasId
+      integer(kind=kind(MAPL_RESTART_MODE)) :: restart_mode = MAPL_RESTART_REQUIRED
+      integer :: alias_id = -1
+   end type RestartModePlusAliasId
+
 contains
 
    subroutine field_info_set_internal(info, unusable, &
@@ -77,6 +73,7 @@ subroutine field_info_set_internal(info, unusable, &
         units, long_name, standard_name, &
         allocation_status, &
         spec_handle, &
+        restart_mode_plus_alias_id, &
         rc)
       type(ESMF_Info), intent(inout) :: info
       class(KeywordEnforcer), optional, intent(in) :: unusable
@@ -89,11 +86,13 @@ subroutine field_info_set_internal(info, unusable, &
       character(*), optional, intent(in) :: standard_name
       type(StateItemAllocation), optional, intent(in) :: allocation_status
       integer, optional, intent(in) :: spec_handle(:)
+      type(RestartModePlusAliasId), optional, intent(in) :: restart_mode_plus_alias_id
       integer, optional, intent(out) :: rc
 
-      integer :: status
       type(ESMF_Info) :: ungridded_info
-      character(:), allocatable :: namespace_
+      character(:), allocatable :: id_str, namespace_
+      integer(kind=kind(MAPL_RESTART_MODE)) :: restart_mode
+      integer :: alias_id, status
 
       namespace_ = INFO_INTERNAL_NAMESPACE
       if (present(namespace)) then
@@ -151,6 +150,15 @@ subroutine field_info_set_internal(info, unusable, &
          call MAPL_InfoSet(info, namespace_ // KEY_SPEC_HANDLE, spec_handle, _RC)
       end if
 
+      if (present(restart_mode_plus_alias_id)) then
+         alias_id = restart_mode_plus_alias_id%alias_id
+         restart_mode = restart_mode_plus_alias_id%restart_mode
+         _ASSERT(alias_id >= 0, "alias_id is not set")
+         id_str = ESMF_UtilStringInt2String(alias_id, _RC)
+         ! NOTE: the 'x' is to keep ESMF_Info from getting confused
+         call MAPL_InfoSet(info, namespace_ // "/x" // trim(id_str) // "/restart_mode", restart_mode, _RC)
+      end if
+
       _RETURN(_SUCCESS)
       _UNUSED_DUMMY(unusable)
    end subroutine field_info_set_internal
@@ -162,6 +170,7 @@ subroutine field_info_get_internal(info, unusable, &
         ungridded_dims, &
         allocation_status, &
         spec_handle, &
+        restart_mode_plus_alias_id, &
         rc)
       type(ESMF_Info), intent(in) :: info
       class(KeywordEnforcer), optional, intent(in) :: unusable
@@ -175,15 +184,16 @@ subroutine field_info_get_internal(info, unusable, &
       type(UngriddedDims), optional, intent(out) :: ungridded_dims
       type(StateItemAllocation), optional, intent(out) :: allocation_status
       integer, optional, allocatable, intent(out) :: spec_handle(:)
+      type(RestartModePlusAliasId), optional, intent(inout) :: restart_mode_plus_alias_id
       integer, optional, intent(out) :: rc
 
-      integer :: status
-      integer :: num_levels_
       type(ESMF_Info) :: ungridded_info
       character(:), allocatable :: vert_staggerloc_str, allocation_status_str
       type(VerticalStaggerLoc) :: vert_staggerloc_
-      character(:), allocatable :: namespace_ 
+      character(:), allocatable :: namespace_, id_str, key
       logical :: key_is_present
+      integer(kind=kind(MAPL_RESTART_MODE)) :: restart_mode
+      integer :: status, num_levels_, alias_id
 
       namespace_ = INFO_INTERNAL_NAMESPACE
       if (present(namespace)) then
@@ -243,59 +253,23 @@ subroutine field_info_get_internal(info, unusable, &
          call MAPL_InfoGet(info, namespace_ // KEY_SPEC_HANDLE, spec_handle, _RC)
       end if
 
-      _RETURN(_SUCCESS)
-      _UNUSED_DUMMY(unusable)
-   end subroutine field_info_get_internal
-
-   subroutine field_info_set_private(info, named_alias_id, unusable, restart_mode, rc)
-      type(ESMF_Info), intent(inout) :: info
-      integer, intent(in) :: named_alias_id
-      class(KeywordEnforcer), optional, intent(in) :: unusable
-      integer(kind=kind(MAPL_RESTART_MODE)), optional, intent(in) :: restart_mode
-      integer, optional, intent(out) :: rc
-
-      integer :: status
-      character(:), allocatable :: id_str, namespace
-
-      id_str = ESMF_UtilStringInt2String(named_alias_id, _RC)
-      ! NOTE: the 'x' is to keep ESMF_Info from getting confused
-      namespace = INFO_PRIVATE_NAMESPACE // "/x" // trim(id_str)
-
-      if (present(restart_mode)) then
-         call MAPL_InfoSet(info, namespace // KEY_RESTART_MODE, restart_mode, _RC)
-      end if
-
-      _RETURN(_SUCCESS)
-      _UNUSED_DUMMY(unusable)
-   end subroutine field_info_set_private
-
-   subroutine field_info_get_private(info, named_alias_id, unusable, restart_mode, rc)
-      type(ESMF_Info), intent(in) :: info
-      integer, intent(in) :: named_alias_id
-      class(KeywordEnforcer), optional, intent(in) :: unusable
-      integer(kind=kind(MAPL_RESTART_MODE)), optional, intent(out) :: restart_mode
-      integer, optional, intent(out) :: rc
-
-      integer :: status
-      character(:), allocatable :: id_str, namespace, key
-      logical :: key_is_present
-
-      id_str = ESMF_UtilStringInt2String(named_alias_id, _RC)
-      ! NOTE: the 'x' is to keep ESMF_Info from getting confused
-      namespace = INFO_PRIVATE_NAMESPACE // "/x" // trim(id_str)
-
-      if (present(restart_mode)) then
-         key = namespace // KEY_RESTART_MODE
+      if (present(restart_mode_plus_alias_id)) then
+         alias_id = restart_mode_plus_alias_id%alias_id
+         _ASSERT(alias_id >= 0, "alias_id is not set")
+         id_str = ESMF_UtilStringInt2String(alias_id, _RC)
+         ! NOTE: the 'x' is to keep ESMF_Info from getting confused
+         key = namespace_ // "/x" // trim(id_str) // "/restart_mode"
          key_is_present = ESMF_InfoIsPresent(info, key=key, _RC)
          restart_mode = MAPL_RESTART_REQUIRED
          if (key_is_present) then
             call MAPL_InfoGet(info, key, restart_mode, _RC)
          end if
+         restart_mode_plus_alias_id%restart_mode = restart_mode
       end if
 
       _RETURN(_SUCCESS)
       _UNUSED_DUMMY(unusable)
-   end subroutine field_info_get_private
+   end subroutine field_info_get_internal
 
    subroutine info_field_get_shared_i4(field, key, value, unusable, rc)
       type(ESMF_Field), intent(in) :: field

generic3g/RestartHandler.F90

@@ -7,7 +7,7 @@ module mapl3g_RestartHandler
    use mapl3g_Geom_API, only: MaplGeom
    use mapl_ErrorHandling, only: MAPL_Verify, MAPL_Return, MAPL_Assert
    use mapl3g_geomio, only: bundle_to_metadata, GeomPFIO, make_geom_pfio, get_mapl_geom
-   use mapl3g_FieldInfo, only: FieldInfoGetPrivate
+   use mapl3g_FieldInfo, only: FieldInfoGetInternal, RestartModePlusAliasId
    use mapl3g_RestartModes, only: MAPL_RESTART_MODE, MAPL_RESTART_SKIP
    use pFIO, only: PFIO_READ, FileMetaData, NetCDF4_FileFormatter
    use pFIO, only: i_Clients, o_Clients
@@ -155,8 +155,9 @@ function filter_fields_create_bundle_(this, state, rc) result(bundle)
       character(len=ESMF_MAXSTR), allocatable :: names(:)
       type (ESMF_StateItem_Flag), allocatable  :: types(:)
       type(ESMF_Info) :: info
-      integer :: named_alias_id
+      integer :: alias_id
       integer(kind=kind(MAPL_RESTART_MODE)) :: restart_mode
+      type(RestartModePlusAliasId) :: tmp
       integer :: idx, num_fields, status
 
       call ESMF_StateGet(state, itemCount=num_fields, _RC)
@@ -171,8 +172,11 @@ function filter_fields_create_bundle_(this, state, rc) result(bundle)
          end if
          call ESMF_StateGet(state, names(idx), field, _RC)
          call ESMF_InfoGetFromHost(field, info, _RC)
-         call ESMF_NamedAliasGet(field, id=named_alias_id, _RC)
-         call FieldInfoGetPrivate(info, named_alias_id, restart_mode=restart_mode, _RC)
+         call ESMF_NamedAliasGet(field, id=alias_id, _RC)
+         tmp = RestartModePlusAliasId()
+         tmp%alias_id = alias_id
+         call FieldInfoGetInternal(info, restart_mode_plus_alias_id=tmp, _RC)
+         restart_mode = tmp%restart_mode
          if (restart_mode==MAPL_RESTART_SKIP) cycle
          call ESMF_FieldBundleAdd(bundle, [field], _RC)
       end do

generic3g/specs/FieldClassAspect.F90

@@ -24,7 +24,7 @@ module mapl3g_FieldClassAspect
    use mapl3g_ESMF_Utilities, only: get_substate
 
    use mapl3g_Field_API
-   use mapl3g_FieldInfo, only: FieldInfoSetInternal, FieldInfoSetPrivate
+   use mapl3g_FieldInfo, only: FieldInfoSetInternal, RestartModePlusAliasId
    use mapl3g_RestartModes, only: MAPL_RESTART_MODE
 
    use mapl_FieldUtilities
@@ -428,7 +428,7 @@ subroutine add_to_state(this, multi_state, actual_pt, rc)
       if (allocated(this%restart_mode)) then
          call ESMF_NamedAliasGet(alias, id=alias_id, _RC)
          call ESMF_InfoGetFromHost(alias, info, _RC)
-         call FieldInfoSetPrivate(info, alias_id, restart_mode=this%restart_mode, _RC)
+         call FieldInfoSetInternal(info, restart_mode_plus_alias_id=RestartModePlusAliasId(this%restart_mode, alias_id), _RC)
       end if
 
       _RETURN(_SUCCESS)