Test ESMF_GridComp creation performance

CHANGELOG.md

@@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [v3.0.0 - Development]
+- Added benchmark to test creation of ESMF_GridComp objects
 
 ### Removed
 
@@ -36,6 +37,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added capability for HistoryCollectionGridComp to extract field names from expressions
 - Added ability for HistoryCollectionGridComp to extract multiple field names from expressions
 - Added vertical and ungridded dimensions to output for History3G
+- Added benchmark to test the performance of gridcomp creation
 
 ### Changed
 

benchmarks/esmf/CMakeLists.txt

@@ -1,5 +1,6 @@
 set(exe gc_run.x)
 
+add_subdirectory(gridcomp_creation)
 ecbuild_add_executable (
   TARGET ${exe}
   SOURCES gc_run.F90)

benchmarks/esmf/gridcomp_creation/CMakeLists.txt

@@ -0,0 +1,16 @@
+set(exe gridcomp_create.x)
+set(MODULE_DIRECTORY ${esma_include}/benchmarks/esmf/gridcomp_creation)
+
+ecbuild_add_executable (
+  TARGET ${exe}
+  SOURCES GridCompCreationTester.F90 GridCompCreator.F90 GridCompCreationShared.F90 GridCompCreatorMemoryProfile.F90
+)
+
+target_link_libraries (${exe} PRIVATE MAPL.shared MAPL.base ESMF::ESMF )
+target_include_directories (${exe} PUBLIC $<BUILD_INTERFACE:${MAPL_SOURCE_DIR}/include>)
+set_target_properties (${exe} PROPERTIES Fortran_MODULE_DIRECTORY ${MODULE_DIRECTORY})
+
+# CMake has an OpenMP issue with NAG Fortran: https://gitlab.kitware.com/cmake/cmake/-/issues/21280
+if (NOT CMAKE_Fortran_COMPILER_ID MATCHES "NAG")
+   target_link_libraries(${exe} PRIVATE OpenMP::OpenMP_Fortran)
+endif ()

benchmarks/esmf/gridcomp_creation/GridCompCreationShared.F90

@@ -0,0 +1,56 @@
+module grid_comp_creation_shared
+
+   use, intrinsic :: iso_fortran_env, only: R64 => real64
+
+   implicit none
+   private
+   public :: to_characters
+   public :: MAXSTR
+   public :: JOIN
+
+   integer, parameter :: MAXSTR = 256
+   character(len=*), parameter :: JOIN = ', '
+
+   interface to_characters
+      module procedure :: real_to_characters
+      module procedure :: integer_to_characters
+   end interface to_characters
+
+contains
+
+   function real_to_characters(t, fixed, rc) result(chars)
+      character(len=:), allocatable :: chars
+      real(R64), intent(in) :: t
+      logical, optional, intent(in) :: fixed
+      integer, optional, intent(out) :: rc
+      integer :: status
+      integer, parameter :: TW = 12
+      character(len=TW), parameter :: SF = '(  ES24.16 )'
+      character(len=TW), parameter :: FD = '(     F8.4 )'
+      character(len=TW) :: FMT_
+      character(len=MAXSTR) :: raw
+
+      FMT_ = SF
+      if(present(fixed)) then
+         if(fixed) FMT_ = FD
+      end if
+      write(raw, fmt=FMT_, iostat=status) t
+      if(present(rc)) rc = status
+      chars = trim(adjustl(raw))
+
+   end function real_to_characters
+
+   function integer_to_characters(n, rc) result(chars)
+      character(len=:), allocatable :: chars
+      integer, intent(in) :: n
+      integer, optional, intent(out) :: rc
+      integer :: status
+      character(len=MAXSTR) :: raw
+
+      write(raw, fmt='(I0)', iostat=status) n
+      if(present(rc)) rc = status
+      chars = trim(adjustl(raw))
+
+   end function integer_to_characters
+
+end module grid_comp_creation_shared

benchmarks/esmf/gridcomp_creation/GridCompCreationTester.F90

@@ -0,0 +1,49 @@
+program grid_comp_creation_tester
+
+   use grid_comp_creation_shared
+   use grid_comp_creator
+   use grid_comp_creator_memory_profiler
+
+   implicit none
+
+   integer, parameter :: SUCCESS = 0
+   integer, parameter :: GENERAL_ERROR = 1
+   integer, parameter :: NGC_NOT_SET = 2*GENERAL_ERROR
+   integer, parameter :: RUN_FAILED  = 2*NGC_NOT_SET
+
+   character(len=*), parameter :: OPTION_USE_OWN_VM = '--use-own-vm'
+
+   integer :: rc, status
+   integer :: ngc
+   character(len=MAXSTR) :: raw
+   integer :: i, n
+   logical :: is_silent = .TRUE.
+   logical :: use_own_vm = .FALSE.
+
+   rc = SUCCESS
+   ngc = -1
+   do i = 1, command_argument_count()
+      call get_command_argument(i, value=raw, status=status)
+      if(status /= SUCCESS) cycle
+      raw = adjustl(raw)
+      if(raw == OPTION_USE_OWN_VM) then
+         use_own_vm = .TRUE.
+         cycle
+      end if
+      read(raw, fmt='(I32)', iostat=status) n
+      if(status == SUCCESS) ngc = n
+   end do
+
+   if(ngc < 0) then
+      rc = rc + NGC_NOT_SET
+      error stop rc, QUIET=is_silent
+   end if
+
+   call run(ngc, use_own_vm, status)
+
+   if(status /= SUCCESS) rc = rc + RUN_FAILED
+   rc = finalize()
+   if(rc == SUCCESS) stop rc, QUIET=is_silent
+   error stop rc, QUIET=is_silent
+
+end program grid_comp_creation_tester