Orb grid comp mod refactor rc #4332

aoloso · 2026-01-24T00:36:51Z

Types of change(s)

Bug fix (non-breaking change which fixes an issue)
[ X] New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Trivial change (affects only documentation or cleanup)
Refactor (no functional changes, no api changes)

Checklist

Tested this change with a run of GEOSgcm
Ran the Unit Tests (make tests)

Description

Changed MAPL 2 to MAPL 3

Related Issue

4274

tclune · 2026-01-25T23:19:22Z

Note that I played around a bit with refactoring the develop branch of this component over the weekend. In the end, the main thing that I wanted to accomplish appears to be too risky. Namely, I wanted to make the logic "grid agnostic" rather than special cases for latlon and CS. (And then I was going to fix the haloing issue.)

gridcomps/Orbit/MAPL_OrbGridCompMod.F90

tclune

I made several specific suggestions, but did not flag all of the commented lines that should be deleted.

…sed string vector for deferred length string vectores for Instrument and Satellite derived type members

aoloso · 2026-01-31T01:45:53Z

@tclune All the changes have been made.

tclune · 2026-02-02T12:51:18Z

geom/GridGet.F90


-   subroutine grid_get(grid, unusable, name, dimCount, coordDimCount, im, jm, rc)
+   subroutine grid_get(grid, unusable, name, dimCount, coordDimCount, &
+                       im, jm, globalCellCountPerDim, rc)


I'll need to look into this. Our thinking is that we don't want user code to be getting global cell counts. Too much danger.

Near as I can tell this is only being used to determine whether this is latlon vs cubed sphere. We want a better way to do that.

However, that fix should not be part of this PR. So I may end up approving and require you to go back and clean all this up when the other feature is available.

Am thinking something like

call mapl_GridGet(grid, class=class, _RC)

Where class is either a string {"latlon", "cubedsphere", ...) or possibly a simple derived type for type safety. (akin to ESMF_TypeKind_Flag).

imsize depends on IM_World, so in addition to knowing what type of grid this is, it looks like we actually need to know the global cell counts.

@tclune We keep bumping into this. There are several places where IM_WORLD is queried for. In FV3, we get around that by reading it from the config file.

gridcomps/Orbit/MAPL_OrbGridCompMod.F90

tclune

Only a few things to fix (for now). See inline comments for details.

A few commented out lines to remove.
Check whether comp_name is still needed - I think it was just fore use with "Iam"
We need to redo some of this once GridGet can return the grid class.
- please open a new issue for that. And make fixing here a sub-issue.

aoloso · 2026-02-03T17:33:40Z

Issue 4360 has been created to note the need to implement the GRID class feature. A sub issue to the issue has Las been created to note to use this feature in MAPL_OrbGridCompMod.F90 once it is available. From: Tom Clune ***@***.***> Date: Monday, February 2, 2026 at 8:01 AM To: GEOS-ESM/MAPL ***@***.***> Cc: Oloso, Amidu O. (GSFC-610.1)[SCIENCE SYSTEMS AND APPLICATIONS INC] ***@***.***>, Author ***@***.***> Subject: [EXTERNAL] [BULK] Re: [GEOS-ESM/MAPL] Orb grid comp mod refactor rc (PR #4332) CAUTION: This email originated from outside of NASA. Please take care when clicking links or opening attachments. Use the "Report Message" button to report suspicious messages to the NASA SOC. @tclune requested changes on this pull request. Only a few things to fix (for now). See inline comments for details. 1. A few commented out lines to remove. 2. Check whether comp_name is still needed - I think it was just fore use with "Iam" 3. We need to redo some of this once GridGet can return the grid class. * please open a new issue for that. And make fixing here a sub-issue. — Reply to this email directly, view it on GitHub<#4332 (review)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AB6NU7T2OY4ARH5ESO2766T4J5DB7AVCNFSM6AAAAACSXHU2NCVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZTOMZZGI2TIOBUG4>. You are receiving this because you authored the thread.

pchakraborty · 2026-02-05T15:46:57Z

gridcomps/Orbit/MAPL_OrbGridCompMod.F90

-   Use MAPL_BaseMod
-   Use MAPL_GenericMod
-   Use MAPL_Constants
+   Use MAPL_BaseMod, only: MAPL_PI,MAPL_DEGREES_TO_RADIANS_R8, &


For the constants, try

use MAPL_Constants, only: MAPL_PI, MAPL_DEGREES_TO_RADIANS_R8 etc.

Sorry - responded to this in main conversation. We certainly don't want to reference Base at all. As much as possible I think we just want use MAPL3 [, only: ...] Constants might be an important exception, but then it should be use MAPL_Constants [, only: ...]

pchakraborty · 2026-02-05T15:48:22Z

gridcomps/Orbit/MAPL_OrbGridCompMod.F90

-   Use MAPL_Constants
+   Use MAPL_BaseMod, only: MAPL_PI,MAPL_DEGREES_TO_RADIANS_R8, &
+       MAPL_RADIANS_TO_DEGREES, MAPL_UNDEF, MAPL_DimsHorzOnly, &
+       MAPL_R4, MAPL_VLocationCenter, MAPL_FieldCreateEmpty, &


MAPL_VLocationCenter can be replaced with VERTICAL_STAGGER_CENTER from mapl3g_VerticalStaggerLoc`

pchakraborty · 2026-02-05T15:53:24Z

gridcomps/Orbit/MAPL_OrbGridCompMod.F90

+   Use MAPL_BaseMod, only: MAPL_PI,MAPL_DEGREES_TO_RADIANS_R8, &
+       MAPL_RADIANS_TO_DEGREES, MAPL_UNDEF, MAPL_DimsHorzOnly, &
+       MAPL_R4, MAPL_VLocationCenter, MAPL_FieldCreateEmpty, &
+       MAPL_GridGetCorners, MAPL_FieldAllocCommit, MAPL_FieldBundleAdd, &


There is a new MAPL_FieldBundleAdd in module mapl3g_FieldBundle_API

@tclune geom/VectorBasis.F90 has a GridGetCorners routine, but it is not included in geom/API.F90. Should we add it to API.F90?

Grr. For now I suppose. I really want to consolidate things in GridGet where possible.

pchakraborty · 2026-02-05T16:32:16Z

gridcomps/Orbit/MAPL_OrbGridCompMod.F90

+       MAPL_R4, MAPL_VLocationCenter, MAPL_FieldCreateEmpty, &
+       MAPL_GridGetCorners, MAPL_FieldAllocCommit, MAPL_FieldBundleAdd, &
+       MAPL_PackTime
   Use MAPL_CommsMod, only: MAPL_AM_I_ROOT


Try MAPL_Am_I_Root from module mapl3g_Utilities_Comms_API

tclune · 2026-02-05T20:14:51Z

@pchakraborty Do we really want users to be so aware of internal module structure of MAPL?

I think we want to aim for use MAPL3, only: ...

But there may be exceptions for specific cases such as constants. (Indeed, we may yet move constants into a separate repo.)

pchakraborty · 2026-02-06T18:59:56Z

@pchakraborty Do we really want users to be so aware of internal module structure of MAPL?

I think we want to aim for use MAPL3, only: ...

But there may be exceptions for specific cases such as constants. (Indeed, we may yet move constants into a separate repo.)

We’ll have to do another pass closer to release where we replace the use statements with use mapl3, only:…, but for now, I think it’s best to be as specific as possible.

tclune · 2026-02-06T19:04:30Z

We’ll have to do another pass closer to release where we replace the use statements with use mapl3, only:…, but for now, I think it’s best to be as specific as possible.

Not sure I agree. It ties our hands if we want to move something into a different module. Won't be much of that, but I'm not seeing much advantage to naming the specific module.

aoloso added 11 commits December 23, 2025 13:49

Started macro replacement of _VERIFY(STATUS)

898c415

Use macro for internal state

e933fc0

Merge branch 'release/MAPL-v3' into OrbGridCompMod_refactor_RC

ec1a73c

Started adding MAPL3 features

90d599f

Merge branch 'release/MAPL-v3' into OrbGridCompMod_refactor_RC

236f109

Added MAPL3 version of AddSpec

aae4850

Using v3 setentrypoint

21650e2

Use v3 getpointer

4000a3d

Merge branch 'release/MAPL-v3' into OrbGridCompMod_refactor_RC

4678b52

Replaced ESMFL get pointer for Bundle with MAPL3

bfc42ff

Switch to MAPL3 approach to ESMF_Config

0e6de1d

aoloso assigned tclune Jan 24, 2026

aoloso requested a review from a team as a code owner January 24, 2026 00:36

aoloso added the 📈 MAPL3 MAPL 3 Related label Jan 24, 2026

tclune added 0 Diff The changes in this pull request have verified to be zero-diff with the target branch. Changelog Skip Skips the Changelog Enforcer labels Jan 25, 2026

tclune approved these changes Jan 25, 2026

View reviewed changes

tclune reviewed Jan 27, 2026

View reviewed changes

gridcomps/Orbit/MAPL_OrbGridCompMod.F90 Outdated Show resolved Hide resolved

tclune reviewed Jan 27, 2026

View reviewed changes

gridcomps/Orbit/MAPL_OrbGridCompMod.F90 Outdated Show resolved Hide resolved

tclune reviewed Jan 27, 2026

View reviewed changes

gridcomps/Orbit/MAPL_OrbGridCompMod.F90 Show resolved Hide resolved

tclune reviewed Jan 27, 2026

View reviewed changes

gridcomps/Orbit/MAPL_OrbGridCompMod.F90 Outdated Show resolved Hide resolved

tclune reviewed Jan 27, 2026

View reviewed changes

gridcomps/Orbit/MAPL_OrbGridCompMod.F90 Outdated Show resolved Hide resolved

tclune reviewed Jan 27, 2026

View reviewed changes

gridcomps/Orbit/MAPL_OrbGridCompMod.F90 Outdated Show resolved Hide resolved

tclune reviewed Jan 27, 2026

View reviewed changes

gridcomps/Orbit/MAPL_OrbGridCompMod.F90 Outdated Show resolved Hide resolved

tclune requested changes Jan 27, 2026

View reviewed changes

aoloso added 4 commits January 28, 2026 15:12

Merge branch 'release/MAPL-v3' into OrbGridCompMod_refactor_RC

3573ff3

Remove unwanted comment lines

929358b

Addedd option to obtain global grid dimension and to v3 MAPL_GridGetu…

d035b4b

…sed string vector for deferred length string vectores for Instrument and Satellite derived type members

Replaced nested "if" with "case"

0f601fa

tclune reviewed Feb 2, 2026

View reviewed changes

gridcomps/Orbit/MAPL_OrbGridCompMod.F90 Outdated Show resolved Hide resolved

tclune reviewed Feb 2, 2026

View reviewed changes

gridcomps/Orbit/MAPL_OrbGridCompMod.F90 Outdated Show resolved Hide resolved

tclune reviewed Feb 2, 2026

View reviewed changes

gridcomps/Orbit/MAPL_OrbGridCompMod.F90 Outdated Show resolved Hide resolved

tclune reviewed Feb 2, 2026

View reviewed changes

gridcomps/Orbit/MAPL_OrbGridCompMod.F90 Outdated Show resolved Hide resolved

tclune reviewed Feb 2, 2026

View reviewed changes

gridcomps/Orbit/MAPL_OrbGridCompMod.F90 Outdated Show resolved Hide resolved

tclune requested changes Feb 2, 2026

View reviewed changes

aoloso added 2 commits February 2, 2026 23:09

Merge branch 'release/MAPL-v3' into OrbGridCompMod_refactor_RC

8c41a46

Removed unused/commented code related to 'Iam and comp_name'

8fd1d67

pchakraborty requested changes Feb 5, 2026

View reviewed changes

pchakraborty reviewed Feb 5, 2026

View reviewed changes

aoloso added 2 commits February 7, 2026 13:19

Merged with release/MAPL-v3

1c8fbc7

Replaced more v2 with v3

b7de479

Orb grid comp mod refactor rc #4332

Are you sure you want to change the base?

Orb grid comp mod refactor rc #4332

Uh oh!

Conversation

aoloso commented Jan 24, 2026

Types of change(s)

Checklist

Description

Related Issue

Uh oh!

tclune commented Jan 25, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tclune left a comment

Choose a reason for hiding this comment

Uh oh!

aoloso commented Jan 31, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tclune left a comment

Choose a reason for hiding this comment

Uh oh!

aoloso commented Feb 3, 2026 via email

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tclune commented Feb 5, 2026

Uh oh!

pchakraborty commented Feb 6, 2026

Uh oh!

tclune commented Feb 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants