Merge branch 'transpose_regrid_rh' into develop

esmf-org · Nov 4, 2024 · 929b538 · 929b538
2 parents 9313a45 + 3e33d87
commit 929b538
Show file tree

Hide file tree

Showing 8 changed files with 754 additions and 29 deletions.
diff --git a/src/Infrastructure/Field/src/ESMF_FieldRegrid.F90 b/src/Infrastructure/Field/src/ESMF_FieldRegrid.F90
@@ -379,6 +379,7 @@ subroutine ESMF_FieldRegridStoreNX(srcField, dstField, keywordEnforcer, &
                     routehandle, &
                     factorList, factorIndexList, & 
                     weights, indices, &  ! DEPRECATED ARGUMENTS
+                    transposeRoutehandle, &
                     srcFracField, dstFracField, &
                     dstStatusField, &
                     unmappedDstList, &
@@ -410,6 +411,7 @@ subroutine ESMF_FieldRegridStoreNX(srcField, dstField, keywordEnforcer, &
       integer(ESMF_KIND_I4),          pointer,       optional :: factorIndexList(:,:)
       real(ESMF_KIND_R8),    pointer, optional :: weights(:)   ! DEPRECATED ARG
       integer(ESMF_KIND_I4), pointer, optional :: indices(:,:) ! DEPRECATED ARG
+      type(ESMF_RouteHandle),         intent(inout), optional :: transposeRoutehandle
       type(ESMF_Field),               intent(inout), optional :: srcFracField
       type(ESMF_Field),               intent(inout), optional :: dstFracField
       type(ESMF_Field),               intent(inout), optional :: dstStatusField
@@ -463,7 +465,10 @@ subroutine ESMF_FieldRegridStoreNX(srcField, dstField, keywordEnforcer, &
 ! \item[8.6.0] Added argument {\tt vectorRegrid} to enable the user to turn on vector regridding. This
 !              functionality treats an undistributed dimension of the input Fields as the components of a vector and
 !              maps it through 3D Cartesian space to give more consistent results (especially near the pole) than
-!              just regridding the components individually. 
+!              just regridding the components individually.
+!
+! \item[8.8.0] Added argument {\tt transposeRoutehandle} to enable the user to retrieve
+!              a routeHandle containing the transpose of the regrid sparse matrix.  
 !              
 ! \end{description}
 ! \end{itemize}
@@ -660,8 +665,11 @@ subroutine ESMF_FieldRegridStoreNX(srcField, dstField, keywordEnforcer, &
 !           The {\tt factorIndexList} array is allocated by the method and the user is responsible for deallocating it. 
 !     \item [{[weights]}] 
 !           \apiDeprecatedArgWithReplacement{factorList}
-!     \item [{[indices]}] 
+!     \item [{[indices]}]
 !           \apiDeprecatedArgWithReplacement{factorIndexList}
+!     \item [transposeRoutehandle]
+!           A routeHandle for the transpose of the regrid sparse matrix. The
+!           transposed operation goes from {\tt dstField} to {\tt srcField}.
 !     \item [{[srcFracField]}] 
 !           The fraction of each source cell participating in the regridding. Only 
 !           valid when regridmethod is {\tt ESMF\_REGRIDMETHOD\_CONSERVE} or  {\tt regridmethod=ESMF\_REGRIDMETHOD\_CONSERVE\_2ND}.
@@ -1207,6 +1215,7 @@ subroutine ESMF_FieldRegridStoreNX(srcField, dstField, keywordEnforcer, &
                                   unmappedaction, localIgnoreDegenerate, &
                                   srcTermProcessing, pipeLineDepth, &
                                   routehandle, tmp_indices, tmp_weights, &
+                                  transposeRoutehandle, &                                  
                                   unmappedDstList, &
                                   localCheckFlag, &
                                   localrc)
@@ -1239,6 +1248,7 @@ subroutine ESMF_FieldRegridStoreNX(srcField, dstField, keywordEnforcer, &
                                   unmappedaction, localIgnoreDegenerate, &
                                   srcTermProcessing, pipeLineDepth, &
                                   routehandle, &
+                                  transposeRoutehandle=transposeRoutehandle, &
                                   unmappedDstList=unmappedDstList, &
                                   checkFlag=localCheckFlag, &
                                   rc=localrc)