v2.59: Backport ESMF v9 support from 2.61.0

Author: mathomp4

CHANGELOG.md

@@ -17,6 +17,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Deprecated
 
+## [2.59.1] - 2025-09-19
+
+### Changed
+
+- Added support for ESMF 9
+  - Requires `#ifdef` to support changes in deprecated `ESMF_Attribute` API in ESMF 9
+- Improved some error statements
+
+
 ## [2.59.0] - 2025-08-06
 
 ### Fixed

CMakeLists.txt

@@ -8,7 +8,7 @@ endif ()
 
 project (
   MAPL
-  VERSION 2.59.0
+  VERSION 2.59.1
   LANGUAGES Fortran CXX C)  # Note - CXX is required for ESMF
 
 # Set the possible values of build type for cmake-gui

generic/CMakeLists.txt

@@ -71,6 +71,15 @@ target_include_directories (${this} PUBLIC
 target_link_libraries (${this} PUBLIC ESMF::ESMF NetCDF::NetCDF_Fortran
   PRIVATE OpenMP::OpenMP_Fortran)
 
+# ESMF 9 made internal changes to the Info object that underlies the (now deprecated)
+# Attribute API. So, to get attributes by index, we need to specify
+# the convention and purpose arguments. Once MAPL requires ESMF 9, remove this
+# ifdef. (Not applicable to MAPL3 which uses Info natively.)
+if (ESMF_VERSION VERSION_GREATER_EQUAL 9.0.0)
+  message(STATUS "ESMF 9 detected. Setting -DESMF_VER_GE_9")
+  target_compile_definitions(${this} PRIVATE ESMF_VER_GE_9)
+endif ()
+
 if (PFUNIT_FOUND)
   add_subdirectory(tests EXCLUDE_FROM_ALL)
 endif ()

generic/MAPL_Generic.F90

@@ -448,7 +448,7 @@ end subroutine i_Run
       integer                        , pointer :: phase_coldstart(:)=> null()
       integer                        , pointer :: phase_refresh(:)=> null()
       procedure(i_run), public, nopass, pointer :: customRefresh => null()
-      
+
       ! Make accessors?
       type(ESMF_GridComp)                      :: RootGC
       type(ESMF_GridComp)            , pointer :: parentGC         => null()
@@ -6060,7 +6060,7 @@ subroutine MAPL_ESMFStateReadFromFile(STATE,CLOCK,FILENAME,MPL,HDR,RC)
 
       nwrgt1 = (mpl%grid%num_readers > 1)
 
-      isNC4 = MAPL_FILETYPE_UNK 
+      isNC4 = MAPL_FILETYPE_UNK
       if (on_tiles) mpl%grid%split_restart = .false.
       if(INDEX(FNAME,'*') == 0) then
          if (AmIRoot) then
@@ -7855,18 +7855,26 @@ subroutine MAPL_CopyFriendlinessInField(FIELDOUT,FIELDIN,RC)
       character(len=ESMF_MAXSTR)            :: NAME
       logical                               :: VALUE
 
-      call ESMF_AttributeGet(FIELDIN, count=NF, RC=status)
-      _VERIFY(status)
+      ! ESMF 9 made internal changes to the Info object that underlies the (now deprecated)
+      ! Attribute API. So, to get attributes by index, we need to specify
+      ! the convention and purpose arguments. Once MAPL requires ESMF 9, remove this
+      ! ifdef. (Not applicable to MAPL3 which uses Info natively.)
+#ifdef ESMF_VER_GE_9
+      call ESMF_AttributeGet(FIELDIN, count=NF, convention="ESMF", purpose="General", _RC)
+#else
+      call ESMF_AttributeGet(FIELDIN, count=NF, _RC)
+#endif
 
       do I=1,NF
-         call ESMF_AttributeGet(FIELDIN,attributeIndex=I,NAME=NAME,RC=status)
-         _VERIFY(status)
+#ifdef ESMF_VER_GE_9
+         call ESMF_AttributeGet(FIELDIN,attributeIndex=I,NAME=NAME,convention="ESMF", purpose="General",_RC)
+#else
+         call ESMF_AttributeGet(FIELDIN,attributeIndex=I,NAME=NAME,_RC)
+#endif
          NAME = trim(NAME)
          if(NAME(1:10)=='FriendlyTo') then
-            call ESMF_AttributeGet(FIELDIN , NAME=NAME, VALUE=VALUE, RC=status)
-            _VERIFY(status)
-            call ESMF_AttributeSet(FIELDOUT, NAME=NAME, VALUE=VALUE, RC=status)
-            _VERIFY(status)
+            call ESMF_AttributeGet(FIELDIN , NAME=NAME, VALUE=VALUE, _RC)
+            call ESMF_AttributeSet(FIELDOUT, NAME=NAME, VALUE=VALUE, _RC)
          end if
       end do