Merge pull request ECCO-GROUP#192 from owang01/v4r5_extension

Add configuration for V4r5 extension

ECCOv4 Release 5/README

@@ -5,8 +5,11 @@ ECCO Version 4: Fifth Release       [ECCO V4r5]
 
 - This directory contains the 'ECCO version 4, release 5' state estimate files:
   README                              This file
+  doc                                 documentation
   namelist                            namelist files (run-time parameters) needed to re-run the state estimate
   code                                updated and/or new fortran codes and header files that are required to compile the MITgcm in the ECCOv4 configuration
+  metadata                            meta data for model diagnostics
+  extension                           configuration for extending V4r5 beyond 2019; forward simulation only, without optimization
 
 - References:
   Fukumori, I., O. Wang, I. Fenty, G. Forget, P. Heimbach, and R. M. Ponte, 2017: 
@@ -31,4 +34,5 @@ ECCO Version 4: Fifth Release       [ECCO V4r5]
 README file revision history:
 -----------------------------
 
+- Extension configuration added                    [Ou Wang] [2024/04/04]
 - README file creation                             [Ou Wang] [2022/05/09]

ECCOv4 Release 5/extension/code/SLR_CORR_FIELDS.h

@@ -0,0 +1,33 @@
+C------------------------------------------------------------------------------|
+C                           SLR_CORR_FIELDS.h
+C------------------------------------------------------------------------------|
+
+#ifdef ALLOW_SLR_CORR
+
+#include "SLR_CORR_SIZE.h"
+
+CBOP
+C     !ROUTINE: SLRC_CORR.h
+C     !INTERFACE:
+C     #include "SLR_CORR.h"
+
+C     !DESCRIPTION:
+C     *==========================================================*
+C     | SLR_CORR_FIELDS.h
+C     | o Header file containing fields to provide adjustments
+C     |   to the precip field to balance EtaN online
+C     *==========================================================*
+CEOP
+
+
+C------------------------------------------------------------------------------|
+C     Create COMMON blocks for the diagnostics_vec variables
+C------------------------------------------------------------------------------|
+
+      COMMON /SLR_CORR_FIELDS_R/
+     & slrc_obs_timeseries, slr_average_etans,
+     & volumes_above_zero
+      _RL slrc_obs_timeseries(slrc_n_obs)
+      _RL slr_average_etans(slrc_max_average_recs)
+      _RL volumes_above_zero(slrc_est_order+1)
+#endif /* ALLOW_SLR_CORR */

ECCOv4 Release 5/extension/code/SLR_CORR_OPTIONS.h

@@ -0,0 +1,27 @@
+C CPP options file for SLR_CORR package
+C Use this file for selecting options within the SLR_CORR package
+
+#ifndef SLR_CORR_OPTIONS_H
+#define SLR_CORR_OPTIONS_H
+#include "PACKAGES_CONFIG.h"
+#include "CPP_OPTIONS.h"
+
+#ifdef ALLOW_SLR_CORR
+
+C balance sea level rise (each time step by default)
+#define ALLOW_SLR_CORR_BALANCE
+
+C When adjusting GMSL, only adjust precipitation
+C where precipitation is positive
+#define MODIDY_POSITIVE_PRECIP_ONLY
+
+C Instead of using a spatially-invariant precipitation
+C adjustment, apply a scaling factor to precipitation 
+#define SCALE_PRECIP_TO_ADJUST
+
+#endif /* ALLOW_SLR_CORR */
+#endif /* ALLOW_SLR_OPTIONS_H */
+
+CEH3 ;;; Local Variables: ***
+CEH3 ;;; mode:fortran ***
+CEH3 ;;; End: ***

ECCOv4 Release 5/extension/code/SLR_CORR_PARAM.h

@@ -0,0 +1,73 @@
+C------------------------------------------------------------------------------|
+C                           SLR_CORR_PARAM.h
+C------------------------------------------------------------------------------|
+
+#ifdef ALLOW_SLR_CORR
+
+CBOP
+C     !ROUTINE: SLRC_CORR.h
+C     !INTERFACE:
+C     #include "SLR_CORR.h"
+
+C     !DESCRIPTION:
+C     *==========================================================*
+C     | SLR_CORR_FIELDS.h
+C     | o Header file containing fields to provide adjustments
+C     |   to the precip field to balance EtaN online
+C     *==========================================================*
+CEOP
+
+C------------------------------------------------------------------------------|
+C     Define the global slr_corr variables
+C------------------------------------------------------------------------------|
+
+C     These are the dates that correspond to the input file
+      INTEGER slrc_obs_startdate_1
+      INTEGER slrc_obs_startdate_2
+
+C     This is the interval between obs in the input file
+      _RL slrc_obs_period
+
+C     This is the time interval over which the running average is computed
+      _RL slrc_balancePeriod
+      _RL slrc_obs_start_time
+
+C     This is the precip adjustment, updated at each time step
+      _RL slrc_precip_adjustment
+
+C     This is the scaling factor to adjust precip, updated at each time step
+      _RL slrc_precip_adjustment_fac
+
+C     This is the reference to be added to obs to account for bias btw obs and md 
+      _RL slrc_obs_ref
+
+C     These are some i/o parameters
+      INTEGER slrc_filePrec
+
+C     Input file names
+      CHARACTER*(128) slrc_obs_filename
+      CHARACTER*(128) slrc_output_filename
+
+C------------------------------------------------------------------------------|
+C     Create COMMON blocks for the slr_corr variables
+C------------------------------------------------------------------------------|
+
+      COMMON /SLR_CORR_PARAM_I/
+     & slrc_obs_startdate_1,
+     & slrc_obs_startdate_2,
+     & slrc_filePrec
+
+      COMMON /SLR_CORR_PARAM_C/
+     & slrc_obs_filename,
+     & slrc_output_filename
+
+      COMMON /SLR_CORR_PARAM_R/
+     & slrc_obs_period,
+     & slrc_balancePeriod,
+     & slrc_obs_start_time,
+     & slrc_precip_adjustment,
+     & slrc_obs_ref
+
+      COMMON /SLR_CORR_PARAM_R2/
+     & slrc_precip_adjustment_fac
+#endif /* ALLOW_SLR_CORR */