From 067b1f816e1bc9e54272a4885199361a8f2300d7 Mon Sep 17 00:00:00 2001
From: Lizzie Lundgren <elundgren@seas.harvard.edu>
Date: Mon, 17 Jul 2023 16:19:54 -0400
Subject: [PATCH] Add GCHP config file for ESMF logging; turn off ESMF logging
 by default

This update has an accompanying update in MAPL to read config file ESMF.rc
to retrieve the setting for ESMF_LogKind. Previously this was set at
compilation time in GCHP and was hard-coded to write an ESMF log file
for each thread upon error. There is currently a benign ESMF error
triggered sometimes when monthly diagnostics are enabled, and that is the
motivation for turning off ESMF logging by default, at least temporarily.

Signed-off-by: Lizzie Lundgren <elundgren@seas.harvard.edu>
---
 CHANGELOG.md              | 2 ++
 run/GCHP/ESMF.rc          | 7 +++++++
 run/GCHP/init_rd.sh       | 1 +
 run/shared/cleanRunDir.sh | 1 +
 4 files changed, 11 insertions(+)
 create mode 100644 run/GCHP/ESMF.rc

diff --git a/CHANGELOG.md b/CHANGELOG.md
index c28572fc4..4784e2d6c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Script `test/difference/diffTest.sh`, checks 2 different integration tests for differences
 - Added GCHP environment file and export/unset env variables in run script for NASA Pleiades cluster
 `SatDiagnEdge` collection to all GEOS-Chem Classic `HISTORY.rc` templates
+- Added new GCHP config file ESMF.rc for configuring ESMF logging
 
 ### Changed
 - Update `DiagnFreq` in GCClassic integration tests to ensure HEMCO diagnostic output
@@ -19,6 +20,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Explicitly define tagCH4 simulations in `Input_Opt` rather than basing off of number of advected species
 - The `fullchem` mechanism must now be built with KPP 3.0.0 or later
 - Changed the AEIC 2019 monthly climatology specification format in ExtData.rc to match standard convention for climatology
+- Changed default ESMF logging in GCHP to be ESMF_LOGKIND_NONE (no log)
 
 ### Fixed
 - Add missing mol wt for HgBrO in `run/shared/species_database_hg.yml`
diff --git a/run/GCHP/ESMF.rc b/run/GCHP/ESMF.rc
new file mode 100644
index 000000000..9fcfdf767
--- /dev/null
+++ b/run/GCHP/ESMF.rc
@@ -0,0 +1,7 @@
+logKindFlag: ESMF_LOGKIND_NONE
+
+# ESMF_LOGKIND options for ESMF logging. Options include:
+#    ESMF_LOGKIND_NONE           - no ESMF logging
+#    ESMF_LOGKIND_SINGLE         - one log file (ESMF_LogFile)
+#    ESMF_LOGKIND_MULTI          - one log file per core (PET#.ESMF_LogFile)
+#    ESMF_LOGKIND_MULTI_ON_ERROR - one log file per core if error (PET#.ESMF_LogFile))
diff --git a/run/GCHP/init_rd.sh b/run/GCHP/init_rd.sh
index 1cf12439e..86781c05e 100755
--- a/run/GCHP/init_rd.sh
+++ b/run/GCHP/init_rd.sh
@@ -44,6 +44,7 @@ variables=$(echo $variables | sort | uniq)
 envsubst_list="$(printf '${%s} ' $variables)"
 
 COPY_LIST="""
+ESMF.rc
 input.nml
 logging.yml
 HEMCO_Diagn.rc.templates/HEMCO_Diagn.rc.${RUNDIR_SIM_NAME}
diff --git a/run/shared/cleanRunDir.sh b/run/shared/cleanRunDir.sh
index 9bd444df8..2c2ca77e0 100755
--- a/run/shared/cleanRunDir.sh
+++ b/run/shared/cleanRunDir.sh
@@ -10,6 +10,7 @@ rm -fv gchp.log
 rm -fv gchp.*.log
 rm -fv HEMCO.log
 rm -fv PET*.log
+rm -fv ESMF_LogFile
 rm -fv multirun.log
 rm -fv warnings_and_errors.log
 rm -fv GC*.log