Skip to content

CHANGELOG.md

Latest commit

 

History

History
213 lines (183 loc) · 12.6 KB

CHANGELOG.md

File metadata and controls

213 lines (183 loc) · 12.6 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Added

  • Re-export PackedDateCreate, PackedTimeCreate, PackedDateTimeCreate (from MAPL_PackedTimeMod) and StrTemplate (from MAPL_StringTemplate) via the mapl_mp_utils API so they are accessible through USE MAPL without client code needing to reference internal submodules directly (fixes #4963).

Fixed

  • Fix NVHPC compiler build failure in superstructure/generic/OpenMP_Support.F90: replace ESMF_UserCompGetInternalState and ESMF_UserCompSetInternalState with their MAPL wrapper equivalents (MAPL_UserCompGetInternalState / MAPL_UserCompSetInternalState).

  • Relaxed the comparison standard for grid_is_ok in case a grid is r4

  • Fix mapl/MAPL.F90 to use mapl_ErrorHandling directly instead of the thin mapl_ErrorHandlingMod wrapper, resolving an ifx linker issue with bare mapl_return_ thunks in client code.

  • Fix vector component naming lifecycle in superstructure/generic/specs/VariableSpec.F90 and superstructure/generic/specs/VectorClassAspect.F90 by using resolved vector_component_names when constructing VectorClassAspect and setting component field names during create-time rather than deferring in add-to-state (PR #4946).

  • Fix client code in gridcomps/ and base3g/ broken by the Phase 9 mapl3g_ → mapl_ rename: replace all use mapl3g_* statements with use MAPL (umbrella) or use mapl_* (for symbols not yet re-exported by the umbrella). Affected files: ExtDataGridComp_private.F90, PrimaryExport.F90, ConfigurableGridComp.F90, StatisticsGridComp.F90, MAPL_OrbGridCompMod.F90, HistoryCollectionGridComp_private.F90, FileIOShared.F90, MAPL_LocStreamMod.F90, NCIO.F90, SimpleBundleMod.F90, StateItem.F90, FieldDictionaryConfig.F90, and associated test files in gridcomps/ (#4944).

  • Rename mapl3g_TimeVariance, mapl3g_AbstractCovarianceKernel, mapl3g_ShiftedCovarianceKernel, and mapl3g_WelfordCovarianceKernel to mapl_ prefix (modules added after Phase-9 branched from develop).

Added

  • Extended StatisticsGridComp to support variance of a single field.
  • Extended FieldBundleGetPointerToData interface with REAL64 pointer overloads for index/name and 2D/3D variants (PR #4948).

Changed

  • Rename all internal MAPL modules from mapl_<Name>[Mod] to mapl_<Name>_mod convention (#4958). Affects 446 module definitions across 695 source files. Three thin-wrapper duplicate modules removed (mapl_ErrorHandlingMod, mapl_KeywordEnforcerMod, MAPL_ShmemMod). Duplicate VerticalAlignment.F90 removed from superstructure/generic/specs/ (canonical copy remains in infrastructure/vertical/vertical_grid/). Legacy base3g/Comms.F90 retains MAPL_CommsMod name pending resolution of #4961. MAPL_Constants retains its name as it functions as an umbrella module.

  • Remove MAPL_GridCompsMod and enforce that gridcomps/ modules use MAPL (the umbrella module) rather than internal modules directly (#4959).

  • Resolve Intel Fortran error #6450 (case-insensitive module/alias name collision) for 13 modules in infrastructure/fields/ whose module name matched their sole public symbol when renamed via USE aliases in the layer API modules. Fix: rename the internal module declarations by appending Impl (e.g. mapl_FieldGet → mapl_FieldGetImpl, mapl_StateGet → mapl_StateGetImpl, etc.). The public API symbols (MAPL_FieldGet, MAPL_StateGet, etc.) and the API module names (mapl_Field_API, mapl_State_API, etc.) are unchanged. All internal consumers updated (#4944). Affected modules: mapl_FieldGet, mapl_FieldSet, mapl_FieldFill, mapl_FieldCreate, mapl_FieldBundleGet, mapl_FieldBundleSet, mapl_FieldBundleCopy, mapl_FieldBundleCreate, mapl_FieldBundleGetByIndex, mapl_FieldBundleGetPointer, mapl_StateGet, mapl_StateGetGeom, mapl_StateGetPointer, mapl_FieldBundleDestroy, mapl_StateDestroy, mapl_StateItem, mapl_StateAddMethod.

  • Rename mapl_GeomGet → mapl_GeomAccessors and mapl_GridGet → mapl_GridAccessors (previously named mapl_GeomQueries/mapl_GridQueries in an earlier step) to resolve Intel Fortran error #6450. Also renamed mapl_GeomGetHorzIJIndex and mapl_GridGetHorzIJIndex (deprecated stub) into mapl_GeomAccessors. The *Accessors naming is consistent with mapl_FieldAccessors and correctly describes modules that provide both read and write access to ESMF objects. All internal consumers updated. Public API symbols unchanged (#4944).

  • Merge mapl_GeomGetHorzIJIndex and mapl_GridGetHorzIJIndex (deprecated stub) into mapl_GeomGet (infrastructure/geom/geom/GeomGet.F90). All three were single-public-symbol modules causing Intel Fortran error #6450 (case-insensitive module/alias name collision in geom/API.F90). Public names are now mapl_GeomGet, mapl_GeomGetHorzIJIndex, and mapl_GridGetHorzIJIndex directly in mapl_GeomGet; unprefixed aliases retained for internal use. GeomGetHorzIJIndex.F90 and GridGetHorzIJIndex.F90 deleted (#4944).

  • Consolidate mapl_MaxMin and mapl_AreaMean (formerly in utils/arrays/) into a single module mapl_ArrayReductions in mp_utils/. Both are MPI-dependent parallel collective reductions and belong in MAPL.mp_utils rather than MAPL.utils. The public names are now MAPL_MaxMin and MAPL_AreaMean (previously MaxMin and AreaMean exposed via renaming aliases in mapl_Utilities). The old single-symbol modules caused Intel Fortran error #6450 (case-insensitive module name collision with USE rename aliases). Fixes build failure introduced in Phase 9 (#4944).

  • Introduce mp_utils/API.F90 (module mapl_mp_utils) as the canonical layer-level re-export module for MAPL.mp_utils, following the API.F90 pattern used by base3g/, infrastructure/esmf/, etc. Replaces utils/utilities.F90 (module mapl_Utilities) which was MPI-free in name but MPI-dependent in practice. The top-level MAPL umbrella now uses mapl_mp_utils instead of mapl_Utilities. Internal consumers updated.

  • Phase 9 of MAPL v3 directory restructuring (#4905, closes #4944): rename all mapl3g_ module/submodule name prefixes to mapl_ throughout the codebase (531 files, ~2400 substitutions). The mapl3g_ prefix was a transitional namespace used during the MAPL2→MAPL3 migration; the two namespaces are now unified under mapl_. Client code should access all public symbols through the top-level MAPL module rather than use-ing internal mapl_* modules directly. User-facing documentation in docs/ updated to match.

  • Dissolve esmf_utils/ stub: move comms/ (MAPL_Comms.F90, API.F90, and associated header files) into infrastructure/esmf/comms/; add sources to MAPL.esmf target; remove add_subdirectory(esmf_utils) from top-level CMakeLists.txt. Part of the MAPL v3 directory restructuring (#4905).

  • Dissolve geom/ stub: move CMakeLists.txt build logic into infrastructure/geom/geom/CMakeLists.txt; remove add_subdirectory(geom) from top-level CMakeLists.txt. MAPL.geom target is now built entirely within infrastructure/geom/. Part of the MAPL v3 directory restructuring (#4905).

  • Create infrastructure/esmf/ (MAPL.esmf, Tier 3) consolidating esmf_utils/, vm/, alarm/, hconfig/, hconfig_utils/, and ESMF-related files from generic3g/. Backward-compatibility INTERFACE aliases provided for all five former library names.

  • Phase 8 of MAPL v3 directory restructuring (#4905, closes #4942): lowercase remaining top-level directories: mapl3g/→mapl/, Python/→python/, Tests/→tests/. Install paths updated to match (lib/Python→lib/python, ${esma_include}/Tests→${esma_include}/tests). Dissolve shared/ directory entirely: DownBit.F90 moved to mp_utils/, ShaveMantissa.c/.h moved to utils/, hinterp.F90 deleted (dead code), MaplShared.F90 deleted (umbrella module replaced by direct use of underlying modules in three consumers). All shared/tests/ pFUnit sources moved to utils/tests/ and merged into its CMakeLists.txt. A backward-compatibility INTERFACE alias MAPL.shared → MAPL.mp_utils is provided pending retirement of all internal consumers (tracked in #4942).

  • Phase 7 of MAPL v3 directory restructuring (#4905, closes #4940): rename Apps/→apps/; move pfio demo executables into pfio/programs/; rename mp_utils/profiler/demo/→mp_utils/profiler/examples/.

  • Phase 6 of MAPL v3 directory restructuring (#4905, closes #4938): rename gridcomps/ subdirectories from legacy names to canonical lowercase names: cap3g/→cap/, History3G/→history/, ExtData3G/→extdata/, StatisticsGridComp/→statistics/, Orbit/→orbit/. CMake target names updated throughout: MAPL.cap3g→MAPL.cap, MAPL.history3g→MAPL.history, MAPL.extdata3g→MAPL.extdata, MAPL_StatisticsGridComp→MAPL.statistics.

  • Phase 5 of MAPL v3 directory restructuring (#4905, closes #4930): consolidate component/ and the remainder of generic3g/ (after Phase 4 extractions) into superstructure/component/ and superstructure/generic/ respectively. Old top-level directories retained as stubs for backward compatibility.

  • Phase 4 of MAPL v3 directory restructuring (#4905, closes #4925): consolidate geom/, GeomIO/, regridder_mgr/, field/, field_bundle/, state/, vertical/, vertical_grid/, and ESMF-related sources into infrastructure/ subdirectories. Several files from base3g/ moved to mp_utils/. Old top-level directories retained as stubs for backward compatibility.

  • Create utils/ directory (MAPL.utils, Tier 1) as an MPI-free library consolidating serial-only sources from shared/, utilities/, and generic3g/. MAPL.utils depends only on ESMF and OpenMP — no MPI. Part of the MAPL v3 directory restructuring (#4905, phase 2a, closes #4915).

  • Remove direct MPI dependencies from ErrorHandling.F90 and MAPL_Throw.F90 using a lazy-init procedure pointer pattern. Both modules now default to serial error stop behavior and are fully MPI-free. MPI-aware error handling (rank in error messages, MPI_Abort) is provided by the new MAPL_MpiErrorHandling.F90 module; call MAPL_initialize_error_handling() once after MPI_Init to register MPI-aware handlers. Serial and pFUnit programs require no changes. MAPL_ExceptionHandling is now an alias defined in ErrorHandling.F90 rather than a separate file. Closes #4917, part of #4905.

  • Create enums/ directory (MAPL.enums, Tier 0) and relocate 11 enum-like type definitions into it from esmf_utils/, generic3g/, and component/. No module names or interfaces changed; this is a pure file relocation. Part of the MAPL v3 directory restructuring (#4905, phase 1a, closes #4907).

  • Several files were renamed, MAPL_InfoSet was replaced with ESMF_InfoSet.

  • Update .mlc.toml to ignore directories either brought in by mepo or created by opencode

Removed

Deprecated

[v3.0.0-alpha-0] - 2026-05-15

Added

  • Add docs/mapl3/diffs-from-mapl2.md — a comprehensive overview of the architectural and user-facing differences between MAPL v3 and MAPL v2. This document covers component structure, connections, field specifications, resource files, Cap/time-loop changes, History3G, ExtData, the new Statistics component, clocks, and build system changes. It is intended as the primary migration reference for developers and users moving from MAPL2 to MAPL3.
  • Add docs/mapl3/api-changes.md — a procedure-level reference of core framework API changes: stubbed-out V2 procedures, new MAPL3 framework entry points (MAPL_initialize, MAPL_finalize, MaplFramework), and replacements for lifecycle, child management, field specs, connectivity, resource access, and timer APIs.

Previous Versions

  • Note to Developers: For MAPL v2 changes, please refer to the CHANGELOG.md for specific tags or for the [CHANGELOG.md in the release/v2 branch}(https://github.com/GEOS-ESM/MAPL/blob/release/v2/CHANGELOG.md). From now on, all MAPL v3 changes will be documented in this CHANGELOG.md file. The release/v2 branch will continue to maintain its own CHANGELOG.md for v2-specific changes until the end of support for MAPL v2.