Remove grid manager stack from base/ (#4707)

Deletes the legacy MAPL2 grid manager stack and all
associated grid factory files from base/. The MAPL3
geom manager supersedes this entire stack.

Files deleted:
- MAPL_GridManager.F90
- MAPL_AbstractGridFactory.F90
- MAPL_StringGridFactoryMap.F90
- MAPL_Integer64GridFactoryMap.F90
- MAPL_LatLonGridFactory.F90
- MAPL_CubedSphereGridFactory.F90
- MAPL_TripolarGridFactory.F90
- MAPL_XYGridFactory.F90
- MAPL_LlcGridFactory.F90
- MAPL_SwathGridFactory.F90
- MAPL_EASEGridFactory.F90
- MAPL_ExternalGridFactory.F90
- MAPL_ObsUtil.F90 + MAPL_ObsUtil.c
- Plain_netCDF_Time.F90
- MAPL_NetCDF.F90
- Regrid_Functions_Mod.F90
- MAPL_DefGridName.F90
- Grid_Use_Cases.txt + regridding_methods.md
- Tests for deleted modules

Files modified:
- base/Base.F90: removed grid manager use statements
- base/ESMFL_Mod.F90: removed cubed-sphere halo branch
- base/FileMetadataUtilities.F90: removed dead use statements
- generic/MAPL_Generic.F90: stubbed grid_is_consistent

Ports for EASE, LLC, Swath, External grid factories
tracked in GH #4700, #4696, #4697, #4698 respectively.

Closes #4706

Author: tclune

base/Base.F90

@@ -23,12 +23,7 @@ module MAPLBase_Mod
   use MAPL_MemUtilsMod
   use MAPL_HashMod
   use MAPL_LoadBalanceMod
-  use MAPL_AbstractGridFactoryMod
-  use MAPL_GridManagerMod
-  use MAPL_LatLonGridFactoryMod
-  use MAPL_EASEGridFactoryMod
-  use MAPL_CubedSphereGridFactoryMod
-  use MAPL_ExternalGridFactoryMod
+
   use MAPL_ShmemMod
   use MAPL_MaxMinMod
   use MAPL_SimpleBundleMod

base/CMakeLists.txt

@@ -4,38 +4,31 @@ set (srcs
   MAPL_Profiler.F90
   ESMFL_Mod.F90                         MAPL_SatVapor.F90
   FileMetadataUtilities.F90             MAPL_SimpleAlarm.F90
-  FileMetadataUtilitiesVector.F90       MAPL_GridManager.F90                MAPL_SimpleBundleMod.F90
-  MAPL_AbstractGridFactory.F90          MAPL_StringGridFactoryMap.F90
+  FileMetadataUtilitiesVector.F90       MAPL_SimpleBundleMod.F90
   MaplGrid.F90
   MAPL_stubs.F90
-  MAPL_Integer64GridFactoryMap.F90      MAPL_sun_uc.F90
+  MAPL_sun_uc.F90
   MAPL_TimeMethods.F90
   FileIOShared.F90                      BinIO.F90                           NCIO.F90
   MAPL_IO.F90
-  MAPL_LatLonGridFactory.F90
-  MAPL_Comms.F90                        MAPL_TripolarGridFactory.F90
-  MAPL_LlcGridFactory.F90               MAPL_SwathGridFactory.F90
+  MAPL_Comms.F90
   MAPL_Config.F90                       MAPL_LocStreamMod.F90
   MAPL_MaxMinMod.F90                    MAPL_VerticalInterpMod.F90
-  MAPL_CubedSphereGridFactory.F90       MAPL_MemUtils.F90                   MAPL_VerticalMethods.F90
-  MAPL_DefGridName.F90                  Base.F90
-  MAPL_ESMFTimeVectorMod.F90            Regrid_Functions_Mod.F90
+  MAPL_MemUtils.F90                     MAPL_VerticalMethods.F90
+  Base.F90
+  MAPL_ESMFTimeVectorMod.F90
   MAPL_NominalOrbitsMod.F90
   MAPL_LocStreamFactoryMod.F90          MAPL_LocstreamRegridder.F90
-  MAPL_ExternalGridFactory.F90
   ServerManager.F90 ApplicationSupport.F90
   regex_module.F90 StringTemplate.F90 MAPL_SphericalGeometry.F90
-  regex_F.c  MAPL_ObsUtil.c
+  regex_F.c
   c_mapl_locstream_F.c  getrss.c  memuse.c
   Base/Base_Base.F90 Base/Base_Base_implementation.F90
   TimeStringConversion.F90
   MAPL_ISO8601_DateTime_ESMF.F90
   MAPL_Resource.F90
-  MAPL_XYGridFactory.F90
-  MAPL_NetCDF.F90                       Plain_netCDF_Time.F90
-  MAPL_DateTime_Parsing_ESMF.F90	MAPL_ObsUtil.F90
+  MAPL_DateTime_Parsing_ESMF.F90
   MAPL_EASEConversion.F90
-  MAPL_EASEGridFactory.F90
   LDE.F90
   # Orphaned program: should not be in this library.
   # tstqsat.F90

base/ESMFL_Mod.F90

@@ -3730,10 +3730,8 @@ subroutine ESMFL_FailedRC(mype, name)
    end subroutine ESMFL_FailedRC
 
 !-------------------------------------------------------------------------
-  SUBROUTINE ESMFL_HALO_R4_2D(GRID, INPUT, RC)
+   SUBROUTINE ESMFL_HALO_R4_2D(GRID, INPUT, RC)
 !-------------------------------------------------------------------------
-     use MAPL_GridManagerMod, only: get_factory
-     use MAPL_AbstractGridFactoryMod
      TYPE(ESMF_Grid),         INTENT(INout) :: GRID
      REAL,                    INTENT(INOUT) :: INPUT(:,:)
      integer, optional,       intent(OUT)   :: RC
@@ -3761,7 +3759,6 @@ SUBROUTINE ESMFL_HALO_R4_2D(GRID, INPUT, RC)
      integer, pointer                         :: jms(:) => null()
      type (ESMF_VM)                           :: VM
      type (ESMF_DistGrid)                     :: distGrid
-     integer                                  :: IM, JM, DIMS(3)
 
 #define MAX_HALOTYPES 8
      type HaloType
@@ -3771,18 +3768,14 @@ SUBROUTINE ESMFL_HALO_R4_2D(GRID, INPUT, RC)
         integer                               :: NY = -1
         integer                               :: domainIdx = -1
         integer                               :: myId
-        logical                               :: isCube = .false.
         logical                               :: inUse = .false.
      end type HaloType
 
      type(HaloType), save                     :: myHaloTypes(MAX_HALOTYPES)
      type(HaloType)                           :: thisHaloType
      logical                                  :: found
      integer                                  :: I
-     integer                                  :: isd, ied
-     integer                                  :: jsd, jed
      character(len=ESMF_MAXSTR)               :: gridname
-     class (AbstractGridFactory), pointer :: factory
      call ESMF_GridGet    (GRID,   name=gridname, RC=STATUS)
      _VERIFY(STATUS)
 
@@ -3854,38 +3847,10 @@ SUBROUTINE ESMFL_HALO_R4_2D(GRID, INPUT, RC)
         thisHaloType%NY = NY
         thisHaloType%layout = layout
 
-        call MAPL_GridGet(grid, globalCellCountPerDim=DIMS, RC=status)
-        _VERIFY(STATUS)
-        IM = DIMS(1)
-        JM = DIMS(2)
-        if (JM == 6*IM) then
-           thisHaloType%isCube = .true.
-        else
-           thisHaloType%isCube = .false.
-        end if
-
         myHaloTypes(thisHaloType%domainIdx) = thisHaloType
 
      end if
 
-     if (thisHaloType%isCube) then
-        factory => get_factory(grid, rc=status)
-        _VERIFY(status)
-        isd = lbound(input,1)
-        ied = ubound(input,1)
-        jsd = lbound(input,2)
-        jed = ubound(input,2)
-        ! fill the corners with MAPL_UNDEF, they will be overwritten
-        ! by the CubeHalo, unless these are the actual cube corners
-        input(isd,jsd) = MAPL_UNDEF
-        input(ied,jsd) = MAPL_UNDEF
-        input(isd,jed) = MAPL_UNDEF
-        input(ied,jed) = MAPL_UNDEF
-        call factory%halo(input, rc=status)
-        _VERIFY(status)
-        _RETURN(ESMF_SUCCESS)
-     end if
-
 ! This is section of the code is valid ONLY for rectilinear grids!
 
      NX = thisHaloType%NX

base/FileMetadataUtilities.F90

@@ -2,8 +2,6 @@
 
 module MAPL_FileMetadataUtilsMod
    use pFIO
-   use MAPL_GridManagerMod
-   use MAPL_AbstractGridFactoryMod
    use Mapl_keywordenforcermod
    use gFTL2_StringIntegerMap
    use ESMF