Make get_fptr_shape public and a bug fix

[pchakraborty]

Types of change(s)

• Bug fix (non-breaking change which fixes an issue)
• 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

• Excluding negative values of gridToFieldMap
• Making mapl3g_FieldCondensedArray::get_fptr_shape public

Related Issue

[tclune]

I would still like to see a unit test that guards against this issue. This is the 2nd bug that has been found in this interface. First was that the gridToFieldMap was not even being allocated, and the unit tests only covered the lower level procedures. (@darianboggs)

[pchakraborty]

I would still like to see a unit test that guards against this issue. This is the 2nd bug that has been found in this interface. First was that the gridToFieldMap was not even being allocated, and the unit tests only covered the lower level procedures. (@darianboggs)

Created issue #3127

[darianboggs]

It looks good.

I'm not sure what the use case for get_fptr_shape being public is, but I'm not opposed. The intention was that assign_fptr_condensed_array would get the fptr without the user needing to know the shape. get_fptr_shape is used to get the shape according to the Condensed Array convention. assign_fptr_condensed_array uses assign_fptr in FieldPointerUtilities.F90 to get the fptr. Once you have the fptr, you can get the shape with the Fortran shape function.

In other words, FieldCondensedArray.F90 depends on FieldPointerUtilities.F90, so you do not need to use both to get the fptr, and you don't need get_fptr_shape to get the shape of the fptr outside of FieldCondensedArray.F90

We could move all of FieldCondensedArray.F90 to FieldPointerUtilities.F90 with assign_fptr_condensed_array public and get_fptr_shape private.

FieldCondensedArray_private.F90 is internal to field_utils with public methods for the sake of unit testing.

Let me know if there is an unmet need.

[tclune]

I'm not sure what the use case for get_fptr_shape being public is, but I'm not opposed.

I think you are out of date. That was removed.