Merge pull request #1687 from jiandewang/DEV-EMC-candidate-20260128

dev/emc candidate 20260128

Author: jiandewang

config_src/drivers/nuopc_cap/mom_cap.F90

@@ -31,11 +31,13 @@ module MOM_cap_mod
 use MOM_ensemble_manager,     only: ensemble_manager_init
 use MOM_coms,                 only: sum_across_PEs
 
+! stub routines for CESMCOUPLED
+use mom_cap_outputlog,       only: outputlog_init, outputlog_run, outputlog_restart
 #ifdef CESMCOUPLED
 use shr_log_mod,             only: shr_log_setLogUnit
 use nuopc_shr_methods,       only: get_component_instance
 #endif
-use time_utils_mod,           only: esmf2fms_time
+use time_utils_mod,          only: esmf2fms_time
 
 use, intrinsic :: iso_fortran_env, only: output_unit
 
@@ -91,9 +93,11 @@ module MOM_cap_mod
 use NUOPC_Model, only: model_label_Finalize       => label_Finalize
 use NUOPC_Model, only: SetVM
 
+use mom_inline_mod, only : mom_inline_init, mom_inline_run
 #ifndef CESMCOUPLED
-  use shr_is_restart_fh_mod, only : init_is_restart_fh, is_restart_fh, is_restart_fh_type
+use shr_is_restart_fh_mod, only : init_is_restart_fh, is_restart_fh, is_restart_fh_type
 #endif
+use mom_cap_profiling, only: cap_profiling_init, cap_profiling
 
 implicit none; private
 
@@ -142,6 +146,7 @@ module MOM_cap_mod
 logical              :: use_mommesh = .true.
 logical              :: set_missing_stks_to_zero = .false.
 logical              :: restart_eor = .false.
+logical              :: use_cdeps_inline = .false.
 character(len=128)   :: scalar_field_name = ''
 integer              :: scalar_field_count = 0
 integer              :: scalar_field_idx_grid_nx = 0
@@ -161,6 +166,7 @@ module MOM_cap_mod
 character(len=16) :: inst_suffix = ''
 logical           :: pointer_date = .true. ! append date to rpointer
 real(8) :: timere
+integer :: localPet = -1
 
 contains
 
@@ -178,8 +184,18 @@ subroutine SetServices(gcomp, rc)
   ! local variables
   character(len=*),parameter  :: subname='(MOM_cap:SetServices)'
 
+  type(ESMF_VM)               :: vm
+
   rc = ESMF_SUCCESS
 
+  call ESMF_GridCompGet(gcomp, vm=vm, rc=rc)
+  if (ChkErr(rc,__LINE__,u_FILE_u)) return
+  call ESMF_VMGet(vm, localpet=localPet, rc=rc)
+  if (ChkErr(rc,__LINE__,u_FILE_u)) return
+
+  if (localPet == 0) call cap_profiling_init()
+  if (localPet == 0) call cap_profiling("mom", "SetServices", "B")
+
   ! the NUOPC model component will register the generic methods
   call NUOPC_CompDerive(gcomp, model_routine_SS, rc=rc)
   if (ChkErr(rc,__LINE__,u_FILE_u)) return
@@ -219,6 +235,8 @@ subroutine SetServices(gcomp, rc)
        specRoutine=ocean_model_finalize, rc=rc)
   if (ChkErr(rc,__LINE__,u_FILE_u)) return
 
+  if (localPet == 0) call cap_profiling("mom", "SetServices", "E")
+
 end subroutine SetServices
 
 !> First initialize subroutine called by NUOPC.  The purpose
@@ -245,10 +263,11 @@ subroutine InitializeP0(gcomp, importState, exportState, clock, rc)
   character(len=64)           :: value, logmsg
   character(len=*),parameter  :: subname='(MOM_cap:InitializeP0)'
   type(ESMF_VM)               :: vm
-  integer                     :: mype
 
   rc = ESMF_SUCCESS
 
+  if (localPet == 0) call cap_profiling("mom", "InitializeP0", "B")
+
   ! Switch to IPDv03 by filtering all other phaseMap entries
   call NUOPC_CompFilterPhaseMap(gcomp, ESMF_METHOD_INITIALIZE, &
        acceptStringList=(/"IPDv03p"/), rc=rc)
@@ -395,6 +414,13 @@ subroutine InitializeP0(gcomp, importState, exportState, clock, rc)
     geomtype = ESMF_GEOMTYPE_GRID
   endif
 
+  call NUOPC_CompAttributeGet(gcomp, name="use_cdeps_inline", value=value, &
+       isPresent=isPresent, isSet=isSet, rc=rc)
+  if (ChkErr(rc,__LINE__,u_FILE_u)) return
+  if (isPresent .and. isSet) use_cdeps_inline=(trim(value)=="true")
+  write(logmsg,*) use_cdeps_inline
+  call ESMF_LogWrite('MOM_cap:use_cdeps_inline = '//trim(logmsg), ESMF_LOGMSG_INFO)
+
   ! Read end of run restart config option
   call NUOPC_CompAttributeGet(gcomp, name="write_restart_at_endofrun", value=value, &
                               isPresent=isPresent, isSet=isSet, rc=rc)
@@ -403,6 +429,8 @@ subroutine InitializeP0(gcomp, importState, exportState, clock, rc)
      if (trim(value) .eq. '.true.') restart_eor = .true.
   end if
 
+  if (localPet == 0) call cap_profiling("mom", "InitializeP0", "E")
+
 end subroutine
 
 !> Called by NUOPC to advertise import and export fields.  "Advertise"
@@ -454,7 +482,6 @@ subroutine InitializeAdvertise(gcomp, importState, exportState, clock, rc)
   character(len=40)                      :: wave_method ! Wave coupling method.
   logical                                :: use_MARBL  ! If true, MARBL tracers are being used.
   integer                                :: userRc
-  integer                                :: localPet
   integer                                :: localPeCount
   integer                                :: iostat
   integer                                :: readunit
@@ -472,6 +499,9 @@ subroutine InitializeAdvertise(gcomp, importState, exportState, clock, rc)
 !--------------------------------
 
   rc = ESMF_SUCCESS
+
+  if (localPet == 0) call cap_profiling("mom", "InitializeAdvertise", "B")
+
   if(write_runtimelog) timeiads = MPI_Wtime()
 
   call ESMF_LogWrite(subname//' enter', ESMF_LOGMSG_INFO)
@@ -487,7 +517,7 @@ subroutine InitializeAdvertise(gcomp, importState, exportState, clock, rc)
   call ESMF_VMGetCurrent(vm, rc=rc)
   if (ChkErr(rc,__LINE__,u_FILE_u)) return
 
-  call ESMF_VMGet(VM, mpiCommunicator=mpi_comm_mom, localPet=localPet, rc=rc)
+  call ESMF_VMGet(VM, mpiCommunicator=mpi_comm_mom, rc=rc)
   if (ChkErr(rc,__LINE__,u_FILE_u)) return
 
   call ESMF_ClockGet(CLOCK, currTIME=MyTime, TimeStep=TINT,  RC=rc)
@@ -512,7 +542,7 @@ subroutine InitializeAdvertise(gcomp, importState, exportState, clock, rc)
 
   rpointer_filename = 'rpointer.ocn'//trim(inst_suffix)
   if (pointer_date) then
-    write(timestamp,'(".",i4.4,"-",i2.2,"-",i2.2,"-",i5.5)'),year,month,day,hour*3600+minute*60+second
+    write(timestamp,'(".",i4.4,"-",i2.2,"-",i2.2,"-",i5.5)')year,month,day,hour*3600+minute*60+second
     inquire(file=trim(rpointer_filename//timestamp), exist=found)
     ! for backward compatibility
     if (found) then
@@ -677,8 +707,6 @@ subroutine InitializeAdvertise(gcomp, importState, exportState, clock, rc)
       call ESMF_LogWrite('MOM_cap: restart requested, using '//trim(rpointer_filename), ESMF_LOGMSG_WARNING)
       call ESMF_GridCompGet(gcomp, vm=vm, rc=rc)
       if (ChkErr(rc,__LINE__,u_FILE_u)) return
-      call ESMF_VMGet(vm, localPet=localPet, rc=rc)
-      if (ChkErr(rc,__LINE__,u_FILE_u)) return
 
       if (localPet == 0) then
         open(newunit=readunit, file=rpointer_filename, form='formatted', status='old', iostat=iostat)
@@ -915,6 +943,8 @@ subroutine InitializeAdvertise(gcomp, importState, exportState, clock, rc)
   enddo
   if(write_runtimelog .and. is_root_pe()) write(stdout,*) 'In ',trim(subname),' time ', MPI_Wtime()-timeiads
 
+  if (localPet == 0) call cap_profiling("mom", "InitializeAdvertise", "E")
+
 end subroutine InitializeAdvertise
 
 !> Called by NUOPC to realize import and export fields.  "Realizing" a field
@@ -969,7 +999,6 @@ subroutine InitializeRealize(gcomp, importState, exportState, clock, rc)
   real(ESMF_KIND_R8), pointer                :: dataPtr_xcor(:,:)
   real(ESMF_KIND_R8), pointer                :: dataPtr_ycor(:,:)
   integer                                    :: mpicom
-  integer                                    :: localPet
   integer                                    :: localPeCount
   integer                                    :: lsize
   integer                                    :: ig,jg, ni,nj,k
@@ -1008,6 +1037,9 @@ subroutine InitializeRealize(gcomp, importState, exportState, clock, rc)
   !--------------------------------
 
   rc = ESMF_SUCCESS
+
+  if (localPet == 0) call cap_profiling("mom", "InitializeRealize", "B")
+
   if(write_runtimelog) timeirls = MPI_Wtime()
 
   call shr_log_setLogUnit (stdout)
@@ -1030,7 +1062,7 @@ subroutine InitializeRealize(gcomp, importState, exportState, clock, rc)
   call ESMF_VMGetCurrent(vm, rc=rc)
   if (ChkErr(rc,__LINE__,u_FILE_u)) return
 
-  call ESMF_VMGet(vm, petCount=npet, mpiCommunicator=mpicom, localPet=localPet, rc=rc)
+  call ESMF_VMGet(vm, petCount=npet, mpiCommunicator=mpicom, rc=rc)
   if (ChkErr(rc,__LINE__,u_FILE_u)) return
 
   !---------------------------------
@@ -1582,6 +1614,11 @@ subroutine InitializeRealize(gcomp, importState, exportState, clock, rc)
   !---------------------------------
   call mom_set_geomtype(geomtype)
 
+  if (use_cdeps_inline) then
+     call mom_inline_init(gcomp, clock, eMesh, localPet, rc=rc)
+     if (ChkErr(rc,__LINE__,u_FILE_u)) return
+  end if
+
   !---------------------------------
   ! write out diagnostics
   !---------------------------------
@@ -1593,6 +1630,8 @@ subroutine InitializeRealize(gcomp, importState, exportState, clock, rc)
   timere = 0.
   if(write_runtimelog .and. is_root_pe()) write(stdout,*) 'In ',trim(subname),' time ', MPI_Wtime()-timeirls
 
+  if (localPet == 0) call cap_profiling("mom", "InitializeRealize", "E")
+
 end subroutine InitializeRealize
 
 !> TODO
@@ -1624,6 +1663,8 @@ subroutine DataInitialize(gcomp, rc)
   real(8)                                :: MPI_Wtime, timedis
   !--------------------------------
 
+  if (localPet == 0) call cap_profiling("mom", "DataInitialize", "B")
+
   if(write_runtimelog) timedis = MPI_Wtime()
 
   ! query the Component for its clock, importState and exportState
@@ -1688,6 +1729,8 @@ subroutine DataInitialize(gcomp, rc)
 
   if(write_runtimelog .and. is_root_pe()) write(stdout,*) 'In ',trim(subname),' time ', MPI_Wtime()-timedis
 
+  if (localPet == 0) call cap_profiling("mom", "DataInitialize", "E")
+
 end subroutine DataInitialize
 
 !> Called by NUOPC to advance the model a single timestep.
@@ -1729,7 +1772,6 @@ subroutine ModelAdvance(gcomp, rc)
   character(ESMF_MAXSTR)                 :: casename
   integer                                :: iostat
   integer                                :: writeunit
-  integer                                :: localPet
   type(ESMF_VM)                          :: vm
   integer                                :: n, i
   character(240)                         :: import_timestr, export_timestr
@@ -1744,6 +1786,9 @@ subroutine ModelAdvance(gcomp, rc)
   logical                                :: write_restart_eor
 
   rc = ESMF_SUCCESS
+
+  if (localPet == 0) call cap_profiling("mom", "ModelAdvance", "B")
+
   if(profile_memory) call ESMF_VMLogMemInfo("Entering MOM Model_ADVANCE: ")
   if(write_runtimelog) then
      timers = MPI_Wtime()
@@ -1774,7 +1819,9 @@ subroutine ModelAdvance(gcomp, rc)
   call ESMF_LogWrite(trim(msgString), ESMF_LOGMSG_INFO)
 
   call ESMF_TimeGet(currTime,          timestring=import_timestr, rc=rc)
+  if (ChkErr(rc,__LINE__,u_FILE_u)) return
   call ESMF_TimeGet(currTime+timestep, timestring=export_timestr, rc=rc)
+  if (ChkErr(rc,__LINE__,u_FILE_u)) return
 
   Time_step_coupled = esmf2fms_time(timeStep)
   Time = esmf2fms_time(currTime)
@@ -1857,6 +1904,11 @@ subroutine ModelAdvance(gcomp, rc)
                     set_missing_stks_to_zero, rc=rc)
     if (ChkErr(rc,__LINE__,u_FILE_u)) return
 
+    if (use_cdeps_inline) then
+      call mom_inline_run(clock, ocean_public, ocean_grid, ice_ocean_boundary, dbug, rc=rc)
+      if (ChkErr(rc,__LINE__,u_FILE_u)) return
+    end if
+
     !---------------
     ! Update MOM6
     !---------------
@@ -1877,7 +1929,7 @@ subroutine ModelAdvance(gcomp, rc)
       call state_diagnose(exportState,subname//':ES ',rc=rc)
       if (ChkErr(rc,__LINE__,u_FILE_u)) return
     endif
-  endif
+  endif ! do_advance
 
   !---------------
   ! Get the stop alarm
@@ -1905,12 +1957,12 @@ subroutine ModelAdvance(gcomp, rc)
     write_restart_eor = .false.
     if (restart_eor) then
       if (ESMF_AlarmIsRinging(stop_alarm, rc=rc)) then
-         if (ChkErr(rc,__LINE__,u_FILE_u)) return
-         write_restart_eor = .true.
-         ! turn off the alarm
-         call ESMF_AlarmRingerOff(stop_alarm, rc=rc )
-         if (ChkErr(rc,__LINE__,u_FILE_u)) return
-       end if
+        if (ChkErr(rc,__LINE__,u_FILE_u)) return
+        write_restart_eor = .true.
+        ! turn off the alarm
+        call ESMF_AlarmRingerOff(stop_alarm, rc=rc )
+        if (ChkErr(rc,__LINE__,u_FILE_u)) return
+      end if
     end if
 
 #ifndef CESMCOUPLED
@@ -1930,10 +1982,8 @@ subroutine ModelAdvance(gcomp, rc)
         if (ChkErr(rc,__LINE__,u_FILE_u)) return
         call ESMF_GridCompGet(gcomp, vm=vm, rc=rc)
         if (ChkErr(rc,__LINE__,u_FILE_u)) return
-        call ESMF_VMGet(vm, localPet=localPet, rc=rc)
-        if (ChkErr(rc,__LINE__,u_FILE_u)) return
 
-        write(timestamp,'(".",i4.4,"-",i2.2,"-",i2.2,"-",i5.5)'),year,month,day,hour*3600+minute*60+seconds
+        write(timestamp,'(".",i4.4,"-",i2.2,"-",i2.2,"-",i5.5)')year,month,day,hour*3600+minute*60+seconds
 
         rpointer_filename = 'rpointer.ocn'//trim(inst_suffix)
         if (pointer_date) then
@@ -1981,8 +2031,10 @@ subroutine ModelAdvance(gcomp, rc)
 
         ! write restart file(s)
         call ocean_model_restart(ocean_state, restartname=restartname, &
-                                stoch_restartname=stoch_restartname)
+                                stoch_restartname=stoch_restartname, num_rest_files=num_rest_files)
 
+        call outputlog_restart(clock, num_rest_files, rc=rc)
+        if (ChkErr(rc,__LINE__,u_FILE_u)) return
       endif
 
       if (is_root_pe()) then
@@ -1991,6 +2043,9 @@ subroutine ModelAdvance(gcomp, rc)
     endif
   endif ! restart_mode
 
+  call outputlog_run(clock, rc=rc)
+  if (ChkErr(rc,__LINE__,u_FILE_u)) return
+
   !---------------
   ! Write diagnostics
   !---------------
@@ -2019,6 +2074,8 @@ subroutine ModelAdvance(gcomp, rc)
 
   if(profile_memory) call ESMF_VMLogMemInfo("Leaving MOM Model_ADVANCE: ")
 
+  if (localPet == 0) call cap_profiling("mom", "ModelAdvance", "E")
+
 end subroutine ModelAdvance
 
 
@@ -2047,6 +2104,8 @@ subroutine ModelSetRunClock(gcomp, rc)
 
   rc = ESMF_SUCCESS
 
+  if (localPet == 0) call cap_profiling("mom", "ModelSetRunClock", "B")
+
   ! query the Component for its clock, importState and exportState
   call NUOPC_ModelGet(gcomp, driverClock=dclock, modelClock=mclock, rc=rc)
   if (ChkErr(rc,__LINE__,u_FILE_u)) return
@@ -2186,6 +2245,8 @@ subroutine ModelSetRunClock(gcomp, rc)
     call ESMF_TimeGet(dstoptime, timestring=timestr, rc=rc)
     call ESMF_LogWrite("Stop Alarm will ring at : "//trim(timestr), ESMF_LOGMSG_INFO)
 
+    call outputlog_init(gcomp, mclock, rc)
+    if (ChkErr(rc,__LINE__,u_FILE_u)) return
     first_time = .false.
 
   endif
@@ -2200,6 +2261,8 @@ subroutine ModelSetRunClock(gcomp, rc)
   call ESMF_ClockSet(mclock, currTime=dcurrtime, timeStep=dtimestep, stopTime=mstoptime, rc=rc)
   if (ChkErr(rc,__LINE__,u_FILE_u)) return
 
+  if (localPet == 0) call cap_profiling("mom", "ModelSetRunClock", "E")
+
 end subroutine ModelSetRunClock
 
 !===============================================================================
@@ -2226,6 +2289,8 @@ subroutine ocean_model_finalize(gcomp, rc)
   character(len=*),parameter  :: subname='(MOM_cap:ocean_model_finalize)'
   real(8)                                :: MPI_Wtime, timefs
 
+  if (localPet == 0) call cap_profiling("mom", "ocean_model_finalize", "B")
+
   if (is_root_pe()) then
     write(stdout,*) 'MOM: --- finalize called ---'
   endif
@@ -2259,8 +2324,16 @@ subroutine ocean_model_finalize(gcomp, rc)
   call io_infra_end()
   call MOM_infra_end()
 
+  ! need to call twice to force logging of last output file
+  call outputlog_run(clock, rc=rc)
+  if (ChkErr(rc,__LINE__,u_FILE_u)) return
+  call outputlog_run(clock, .true., rc=rc)
+  if (ChkErr(rc,__LINE__,u_FILE_u)) return
+
   if(write_runtimelog .and. is_root_pe()) write(stdout,*) 'In ',trim(subname),' time ', MPI_Wtime()-timefs
 
+  if (localPet == 0) call cap_profiling("mom", "ocean_model_finalize", "E")
+
 end subroutine ocean_model_finalize