New inputs DA:total_steps and DA:tstartcycle

Option to set `total_steps` and `tstartcycle` directly.

Before / by default, they are set through `PF:simtime` and
`PF:starttime`, respectively.

Author: jjokella

bldsva/intf_DA/pdaf/model/common/read_enkfpar.c

@@ -96,6 +96,8 @@ void read_enkfpar(char *parname)
   strcpy(outdir,string);
   nreal                 = iniparser_getint(pardict,"DA:nreal",0);
   startreal             = iniparser_getint(pardict,"DA:startreal",0);
+  total_steps           = iniparser_getint(pardict,"DA:total_steps",-1);
+  tstartcycle           = iniparser_getint(pardict,"DA:tstartcycle",-1);
   da_interval           = iniparser_getdouble(pardict,"DA:da_interval",1);
   da_interval_final     = iniparser_getdouble(pardict,"DA:da_interval_final",1);
   flexible_da_interval  = iniparser_getint(pardict,"DA:flexible_da_interval",0);
@@ -107,15 +109,38 @@ void read_enkfpar(char *parname)
   da_crns_depth_tol     = iniparser_getdouble(pardict,"DA:da_crns_depth_tol",0.01);
   clmcrns_bd            = iniparser_getdouble(pardict, "DA:crns_bd", -1.0);
   da_print_obs_index    = iniparser_getint(pardict,"DA:print_obs_index",0);
-  total_steps = (int) (t_sim/da_interval);
-  tstartcycle = (int) (t_start/da_interval);
 
-  /* print inputs / debug output for data assimilation settings */
+  /* Debug output */
   if (mype_world == 0) {
     if (screen_wrapper > 0) {
       printf("TSMP-PDAF-WRAPPER mype(w)=%5d read_enkfpar: [DA]\n",mype_world);
       printf("TSMP-PDAF-WRAPPER mype(w)=%5d ------------------\n",mype_world);
-      printf("TSMP-PDAF-WRAPPER mype(w)=%5d t_sim = %lf | da_interval = %lf | total_steps = %d\n",mype_world,t_sim,da_interval,total_steps);
+    }
+  }
+
+  /* Set total_steps from PF:simtime if it has not been set
+     directly */
+  if (total_steps == -1) {
+    total_steps = (int) (t_sim/da_interval);
+
+    /* Debug output */
+    if (mype_world == 0) {
+      if (screen_wrapper > 0) {
+	printf("TSMP-PDAF-WRAPPER mype(w)=%5d total_steps set based on t_sim = %lf\n",mype_world,t_sim);
+      }
+    }
+  }
+
+  /* Set tstartcycle from PF:starttime if it has not been set
+     directly */
+  if (tstartcycle == -1) {
+    tstartcycle = (int) (t_start/da_interval);
+  }
+
+  /* Debug output */
+  if (mype_world == 0) {
+    if (screen_wrapper > 0) {
+      printf("TSMP-PDAF-WRAPPER mype(w)=%5d da_interval = %lf | total_steps = %d\n",mype_world,da_interval,total_steps);
       printf("TSMP-PDAF-WRAPPER mype(w)=%5d nreal = %d | n_modeltasks = %d\n",mype_world,nreal,n_modeltasks);
     }
   }

doc/content/setup_tsmp/input_enkfpf.md

@@ -70,6 +70,8 @@ dtmult      =
 outdir = ""
 nreal =
 startreal =
+total_steps =
+tstartcycle =
 da_interval       =
 da_interval_final =
 flexible_da_interval =
@@ -99,8 +101,12 @@ available in a single `COMM_model`. Each `COMM_model` contains
 
 ### PF:starttime ###
 
-`PF:starttime`: (real) ParFlow start time. Must match with the
-specifications in the `*.pfidb` input (`TimingInfo.StartTime`).
+`PF:starttime`: (real) ParFlow start time.
+
+Not used if `DA:tstartcycle` is set.
+
+If used: Must match with the specifications in the `*.pfidb` input
+(`TimingInfo.StartTime`).
 
 ### PF:dt ###
 
@@ -167,11 +173,14 @@ Deprecated. Sets `PF:simtime`.
 `PF:simtime`: (real) Total simulation time (in terms of ParFlow
 timing). 
 
-For all simulations (including CLMSA): `PF:simtime` is used in
-conjunction with `DA:da_interval` to determine `total_steps`, the
-total number of iterations of the main data assimilation loop. Each
-iteration of the main data assimilation loop consists of one forward
-simulation and one data assimilation step.
+Not used if `DA:total_steps` is set.
+
+If `DA:total_steps` is not set, the following holds for all
+simulations (including CLMSA): `PF:simtime` is used in conjunction
+with `DA:da_interval` to determine `total_steps`, the total number of
+iterations of the main data assimilation loop. Each iteration of the
+main data assimilation loop consists of one forward simulation and one
+data assimilation step.
 
 \begin{align*}
 \mathtt{total\_steps} &= \frac{\mathtt{PF:simtime}}{\mathtt{DA:da\_interval}}
@@ -619,6 +628,32 @@ errors. Recommendation: Use at least an ensemble size of 4.
 `DA:startreal`: (integer) Added to suffix-numbers for input file
 creation.
 
+### DA:total_steps ###
+
+`DA:total_steps`: (integer) Number of observation Intervals.
+
+Together with `DA:da_interval` and `DA:startcycle`, `DA:total_steps`
+determines the simulation time.
+
+If not set directly, `DA:total_steps` is determined from `PF:simtime`.
+
+`DA:total_steps` must be in sync with timing information from
+component models.
+
+- ParFlow: `DA:total_steps` times `DA:da_interval` should be
+  `TimingInfo.StopTime` minus `TimingInfo.StartTime` (from `*.pfidb`).
+
+- CLM: `DA:total_steps` times `DA:da_interval` should be the number of
+  CLM time steps in `stop_ymd` minus `start_ymd start_tod`. To be
+  safe, CLM's stoptime can be chosen later, such that it will be
+  stopped by the TSMP-PDAF stop alarm.
+
+### DA:tstartcycle ###
+
+`DA:tstartcycle`: (integer) First observation cycle (file) to use.
+
+This should be zero. Other values are currently not supported.
+
 ### DA:da_interval ###
 
 `DA:da_interval`: (double) Time interval (units of ParFlow timing,
@@ -637,7 +672,9 @@ assimilation.
 
 For CLM simulations, `DA:da_interval` determines the number of
 CLM-time-steps between two assimilations together with `PF:dt`. See
-the section of `PF:dt` for more detail.
+the section of `PF:dt` for more detail. In particular, for CLM
+simulations and `PF:dt==1.0`, `DA:da_interval` is in units of CLM time
+steps.
 
 One exception is that the observation file is empty at a data
 assimilation step. Then, no data assimilation takes place and the next