Merge pull request #3112 from GEOS-ESM/feature/wdboggs/change_extensi…

…on_action_methods_3108 Feature/wdboggs/change extension action methods 3108
GEOS-ESM · Oct 21, 2024 · 012dd9a · 012dd9a
2 parents ba32955 + b36965b
commit 012dd9a
Show file tree

Hide file tree

Showing 11 changed files with 49 additions and 26 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -49,6 +49,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Update `Findudunits.cmake` to link with libdl and look for the `udunits2.xml` file (as some MAPL tests require it)
 - Modified `ESMF_GridComp` creation in `GenericGridComp` to use `ESMF_CONTEXT_PARENT_VM` by default.
 - Changed `get_fptr_shape` in `FieldCondensedArray*.F90`
+- Change name of ExtensionAction%run to ExtensionAction%update in the abstract type and derived types.
+- Add invalid method to ExtensionAction with a no-op implementation in the abstract type
 
 ### Fixed
 

diff --git a/generic3g/actions/ConvertUnitsAction.F90 b/generic3g/actions/ConvertUnitsAction.F90
@@ -19,7 +19,7 @@ module mapl3g_ConvertUnitsAction
       character(:), allocatable :: src_units, dst_units
    contains
       procedure :: initialize
-      procedure :: run
+      procedure :: update
    end type ConvertUnitsAction
 
 
@@ -59,7 +59,7 @@ subroutine initialize(this, importState, exportState, clock, rc)
    end subroutine initialize
 
 
-   subroutine run(this, importState, exportState, clock, rc)
+   subroutine update(this, importState, exportState, clock, rc)
       use esmf
       class(ConvertUnitsAction), intent(inout) :: this
       type(ESMF_State)      :: importState
@@ -95,6 +95,6 @@ subroutine run(this, importState, exportState, clock, rc)
 
       _FAIL('unsupported typekind')
       _UNUSED_DUMMY(clock)
-   end subroutine run
+   end subroutine update
 
 end module mapl3g_ConvertUnitsAction
diff --git a/generic3g/actions/CopyAction.F90 b/generic3g/actions/CopyAction.F90
@@ -16,7 +16,7 @@ module mapl3g_CopyAction
       type(ESMF_Field) :: f_in, f_out
    contains
       procedure :: initialize
-      procedure :: run
+      procedure :: update
    end type CopyAction
 
    interface CopyAction
@@ -65,7 +65,7 @@ subroutine initialize(this, importState, exportState, clock, rc)
       _UNUSED_DUMMY(clock)
    end subroutine initialize
 
-   subroutine run(this, importState, exportState, clock, rc)
+   subroutine update(this, importState, exportState, clock, rc)
       use esmf
       class(CopyAction), intent(inout) :: this
       type(ESMF_State)      :: importState
@@ -82,7 +82,7 @@ subroutine run(this, importState, exportState, clock, rc)
       call FieldCopy(f_in, f_out, _RC)
 
       _RETURN(_SUCCESS)
-   end subroutine run
+   end subroutine update
 
 
 end module mapl3g_CopyAction
diff --git a/generic3g/actions/ExtensionAction.F90 b/generic3g/actions/ExtensionAction.F90
@@ -1,4 +1,6 @@
+#include "MAPL_Generic.h"
 module mapl3g_ExtensionAction
+   use mapl_ErrorHandling
    implicit none
    private
 
@@ -7,7 +9,8 @@ module mapl3g_ExtensionAction
    type, abstract :: ExtensionAction
    contains
       procedure(I_run), deferred :: initialize
-      procedure(I_run), deferred :: run
+      procedure(I_run), deferred :: update
+      procedure :: invalidate
    end type ExtensionAction
 
 
@@ -23,4 +26,22 @@ subroutine I_run(this, importState, exportState, clock, rc)
       end subroutine I_run
    end interface
 
+contains
+
+   ! This is a default no-op implementation of invalidate.
+   ! Types derived from ExtensionAction should overload it
+   ! as needed.
+   subroutine invalidate(this, importState, exportState, clock, rc)
+      use ESMF
+      class(ExtensionAction), intent(inout) :: this
+      type(ESMF_State) :: importState
+      type(ESMF_State) :: exportState
+      type(ESMF_Clock) :: clock
+      integer, optional, intent(out) :: rc
+      _UNUSED_DUMMY(this)
+      _UNUSED_DUMMY(importState)
+      _UNUSED_DUMMY(exportState)
+      _UNUSED_DUMMY(clock)
+   end subroutine invalidate
+
 end module mapl3g_ExtensionAction
diff --git a/generic3g/actions/NullAction.F90 b/generic3g/actions/NullAction.F90
@@ -15,7 +15,7 @@ module mapl3g_NullAction
    type, extends(ExtensionAction) :: NullAction
    contains
       procedure :: initialize
-      procedure :: run
+      procedure :: update
    end type NullAction
 
    interface NullAction
@@ -42,7 +42,7 @@ subroutine initialize(this, importState, exportState, clock, rc)
       _UNUSED_DUMMY(clock)
    end subroutine initialize
 
-   subroutine run(this, importState, exportState, clock, rc)
+   subroutine update(this, importState, exportState, clock, rc)
       use esmf
       class(NullAction), intent(inout) :: this
       type(ESMF_State)      :: importState
@@ -54,6 +54,6 @@ subroutine run(this, importState, exportState, clock, rc)
       _UNUSED_DUMMY(importState)
       _UNUSED_DUMMY(exportState)
       _UNUSED_DUMMY(clock)
-  end subroutine run
+  end subroutine update
 
 end module mapl3g_NullAction
diff --git a/generic3g/actions/RegridAction.F90 b/generic3g/actions/RegridAction.F90
@@ -20,7 +20,7 @@ module mapl3g_RegridAction
       class(Regridder), pointer :: regrdr
    contains
       procedure :: initialize
-      procedure :: run
+      procedure :: update
    end type ScalarRegridAction
 
    interface RegridAction
@@ -67,7 +67,7 @@ subroutine initialize(this, importState, exportState, clock, rc)
    end subroutine initialize
 
 
-   subroutine run(this, importState, exportState, clock, rc)
+   subroutine update(this, importState, exportState, clock, rc)
       class(ScalarRegridAction), intent(inout) :: this
       type(ESMF_State)      :: importState
       type(ESMF_State)      :: exportState
@@ -84,6 +84,6 @@ subroutine run(this, importState, exportState, clock, rc)
 
       _RETURN(_SUCCESS)
       _UNUSED_DUMMY(clock)
-   end subroutine run
+   end subroutine update
 
 end module mapl3g_RegridAction
diff --git a/generic3g/actions/TimeInterpolateAction.F90 b/generic3g/actions/TimeInterpolateAction.F90
@@ -17,7 +17,7 @@ module mapl3g_TimeInterpolateAction
    type, extends(ExtensionAction) :: TimeInterpolateAction
    contains
       procedure :: initialize
-      procedure :: run
+      procedure :: update
    end type TimeInterpolateAction
 
    interface TimeInterpolateAction
@@ -42,7 +42,7 @@ subroutine initialize(this, importState, exportState, clock, rc)
       _RETURN(_SUCCESS)
    end subroutine initialize
 
-   subroutine run(this, importState, exportState, clock, rc)
+   subroutine update(this, importState, exportState, clock, rc)
       class(TimeInterpolateAction), intent(inout) :: this
       type(ESMF_State)      :: importState
       type(ESMF_State)      :: exportState
@@ -80,7 +80,7 @@ subroutine run(this, importState, exportState, clock, rc)
 
       _RETURN(_SUCCESS)
       _UNUSED_DUMMY(clock)
-   end subroutine run
+   end subroutine update
 
 
    subroutine run_r4(bundle_in, field_out, rc)

diff --git a/generic3g/actions/VerticalRegridAction.F90 b/generic3g/actions/VerticalRegridAction.F90
@@ -25,7 +25,7 @@ module mapl3g_VerticalRegridAction
       type(VerticalRegridMethod) :: method = VERTICAL_REGRID_UNKNOWN
    contains
       procedure :: initialize
-      procedure :: run
+      procedure :: update
    end type VerticalRegridAction
 
    interface VerticalRegridAction
@@ -72,7 +72,7 @@ subroutine initialize(this, importState, exportState, clock, rc)
       _RETURN(_SUCCESS)
    end subroutine initialize
 
-   subroutine run(this, importState, exportState, clock, rc)
+   subroutine update(this, importState, exportState, clock, rc)
       use esmf
       class(VerticalRegridAction), intent(inout) :: this
       type(ESMF_State)      :: importState
@@ -117,6 +117,6 @@ subroutine run(this, importState, exportState, clock, rc)
       end do
 
       _RETURN(_SUCCESS)
-   end subroutine run
+   end subroutine update
 
 end module mapl3g_VerticalRegridAction
diff --git a/generic3g/couplers/CouplerMetaComponent.F90 b/generic3g/couplers/CouplerMetaComponent.F90
@@ -115,7 +115,7 @@ recursive subroutine update(this, importState, exportState, clock, rc)
 !#      call this%propagate_attributes(_RC)
       call this%update_sources(_RC)
 
-      call this%action%run(importState, exportState, clock, _RC)
+      call this%action%update(importState, exportState, clock, _RC)
       call this%set_up_to_date()
 
       _RETURN(_SUCCESS)

diff --git a/generic3g/tests/MockItemSpec.F90 b/generic3g/tests/MockItemSpec.F90
@@ -41,7 +41,7 @@ module MockItemSpecMod
       character(:), allocatable :: details
    contains
       procedure :: initialize
-      procedure :: run
+      procedure :: update
    end type MockAction
 
    interface MockItemSpec
@@ -215,15 +215,15 @@ subroutine initialize(this, importState, exportState, clock, rc)
       _FAIL('This procedure should not be called.')
    end subroutine initialize
 
-   subroutine run(this, importState, exportState, clock, rc)
+   subroutine update(this, importState, exportState, clock, rc)
       use esmf
       class(MockAction), intent(inout) :: this
       type(ESMF_State)      :: importState
       type(ESMF_State)      :: exportState
       type(ESMF_Clock)      :: clock      
       integer, optional, intent(out) :: rc
       _FAIL('This procedure should not be called.')
-   end subroutine run
+   end subroutine update
 
    function make_adapters(this, goal_spec, rc) result(adapters)
       type(StateItemAdapterWrapper), allocatable :: adapters(:)

diff --git a/generic3g/tests/Test_TimeInterpolateAction.pf b/generic3g/tests/Test_TimeInterpolateAction.pf
@@ -42,7 +42,7 @@ contains
       call ESMF_FieldEmptyComplete(f, typekind=ESMF_TYPEKIND_R4, _RC)
       call ESMF_StateAdd(exportState, [f], _RC)
 
-      call action%run(importState, exportState, clock, _RC)
+      call action%update(importState, exportState, clock, _RC)
 
       call assign_fptr(f, x, _RC)
       @assert_that(x, every_item(is(equal_to(7.))))
@@ -96,7 +96,7 @@ contains
       call ESMF_FieldEmptyComplete(f, typekind=ESMF_TYPEKIND_R4, _RC)
       call ESMF_StateAdd(exportState, [f], _RC)
 
-      call action%run(importState, exportState, clock, _RC)
+      call action%update(importState, exportState, clock, _RC)
 
       call assign_fptr(f, x, _RC)
       @assert_that(x, every_item(is(equal_to(4.))))
@@ -155,7 +155,7 @@ contains
       call ESMF_FieldEmptyComplete(f, typekind=ESMF_TYPEKIND_R4, _RC)
       call ESMF_StateAdd(exportState, [f], _RC)
 
-      call action%run(importState, exportState, clock, _RC)
+      call action%update(importState, exportState, clock, _RC)
 
       call assign_fptr(f, x, _RC)
       @assert_that(x(1), is(equal_to(4.)))