Stop building esmf_wrf_timemgr for unit tests; instead use the actual ESMF library

[billsacks]

In making the changes for #2374 , I noticed that the unit test build still builds the esmf_wrf_timemgr to satisfy the ESMF dependency of clm_time_manager.F90. At some point we should probably stop doing that and instead have the unit tests link against the actual ESMF library.

See

CTSM/src/CMakeLists.txt

Line 21 in c030c23

add_subdirectory(${CLM_ROOT}/share/src/esmf_wrf_timemgr esmf_wrf_timemgr)

and some related code in that file.

I briefly started down this path but couldn't see how to get the value of ESMFMKFILE for this machine/compiler in the CMake build, so I gave up for now.

Note that we could probably also remove this block of code: I assume that was put in before we needed to include ESMF stuff in the unit test build, but now we do because of the unit tests of clm_time_manager:

CTSM/src/CMakeLists.txt

Lines 57 to 73 in c030c23

	# Remove shr_cal_mod from share_sources.
	#
	# shr_cal_mod depends on ESMF (or the lightweight esmf wrf timemgr, at
	# least). Since CTSM doesn't currently use shr_cal_mod, we're avoiding
	# the extra overhead of including esmf_wrf_timemgr sources in this
	# build.
	#
	# TODO: like above, this should be moved into a general-purpose function
	# in Sourcelist_utils. Then this block of code could be replaced with a
	# single call, like: remove_source_file(${share_sources}
	# "shr_cal_mod.F90")
	foreach (sourcefile ${share_sources})
	string(REGEX MATCH "shr_cal_mod.F90" match_found ${sourcefile})
	if(match_found)
	list(REMOVE_ITEM share_sources ${sourcefile})
	endif()
	endforeach()

[samsrabin]

Decision in SE meeting 2024-03-21: This is a good thing for post-CESM3.

[ekluzek]

@jedwards4b is recommending that we use ESMF VM constructs to replace things like shr_mpi as a more general way of doing things that allow for a move to a different distributed memory. See this comment here.

ESCOMP/MOSART#94 (comment)

The reason that relates to this is that any unit-testing that uses those ESMF VM objects doing this would be *required".

[ekluzek]

In the CSEG meeting we talked about removing the esmf_wrf_timemgr in a future cesm3_0 beta tag. Doing this would break our unit-testing unless this issue were fixed. Since the unit-testing is critical this will need to be fixed as part of the cesm3_0 release. Because of that I removed the low priority label here, and added the ctsm6.0.0 code freeze milestone.

[ekluzek]

It looks like @jedwards4b has something that should work here. It will at least require an update of cesm_share, and possibly cime. This will enable CESM to deprecate and remove the ESMF wrf timemgr code. So we can likely bring this in and make sure it works at our next externals update.

@adrifoster