Feature 1968 ens_ctrl

met/docs/Users_Guide/ensemble-stat.rst

@@ -97,7 +97,7 @@ Optional arguments for ensemble_stat
 
 6. To override the simple ensemble mean value of the input ensemble members for the ECNT, SSVAR, and ORANK line types, the **-ens_mean file** option specifies an ensemble mean model data file. This option replaces the **-ssvar_mean file** option from earlier versions of MET.
 
-7. The **-ctrl file** option specifies an ensemble control member data file. The control member is included in the computation of the ensemble mean but excluded from the spread.
+7. The **-ctrl file** option specifies an ensemble control member data file. The control member is included in the computation of the ensemble mean but excluded from the spread. The control file should not appear in the list of ensemble member files.
 
 8. To filter point observations by time, use **-obs_valid_beg time** in YYYYMMDD[_HH[MMSS]] format to set the beginning of the matching observation time window.
 

met/docs/Users_Guide/gen-ens-prod.rst

@@ -67,7 +67,7 @@ Required arguments gen_ens_prod
 Optional arguments for gen_ens_prod
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-4. The **-ctrl file** option specifies the input file for the ensemble control member. Data for this member is included in the computation of the ensemble mean, but excluded from the spread.
+4. The **-ctrl file** option specifies the input file for the ensemble control member. Data for this member is included in the computation of the ensemble mean, but excluded from the spread. The control file should not appear in the **-ens** list of ensemble member files.
 
 5. The **-log** file outputs log messages to the specified file.
 

met/src/tools/core/ensemble_stat/ensemble_stat.cc

@@ -62,6 +62,7 @@
 //   031    09/13/21  Seth Linden    Changed obs_qty to obs_qty_inc.
 //                    Added code for obs_qty_exc.
 //   032    10/07/21  Halley Gotway  MET #1905 Add -ctrl option.
+//   032    11/15/21  Halley Gotway  MET #1968 Ensemble -ctrl error check.
 //
 ////////////////////////////////////////////////////////////////////////
 
@@ -295,6 +296,14 @@ void process_command_line(int argc, char **argv) {
 
    // Prepend the control member, if specified
    if(ctrl_file.nonempty()) {
+
+      if(ens_file_list.has(ctrl_file)) {
+         mlog << Error << "\nprocess_command_line() -> "
+              << "the ensemble control file should not appear in the list "
+              << "of ensemble member files:\n" << ctrl_file << "\n\n";
+         exit(1);
+      }
+
       ctrl_index = 0;
       ens_file_list.insert(ctrl_index, ctrl_file.c_str());
       n_ens++;

met/src/tools/other/gen_ens_prod/gen_ens_prod.cc

@@ -12,9 +12,10 @@
 //
 //   Description:
 //
-//   Mod#   Date      Name            Description
-//   ----   ----      ----            -----------
-//   000    09/10/21  Halley Gotway   Initial version (MET #1904).
+//   Mod#   Date      Name           Description
+//   ----   ----      ----           -----------
+//   000    09/10/21  Halley Gotway  MET #1904 Initial version.
+//   001    11/15/21  Halley Gotway  MET #1968 Ensemble -ctrl error check.
 //
 ////////////////////////////////////////////////////////////////////////
 
@@ -201,6 +202,14 @@ void process_command_line(int argc, char **argv) {
    mlog << Debug(1) << "Ensemble Control: "
         << (ctrl_file.empty() ? "None" : ctrl_file.c_str()) << "\n";
 
+   // Check for control in the list of ensemble files
+   if(ctrl_file.nonempty() && ens_files.has(ctrl_file)) {
+      mlog << Error << "\nprocess_command_line() -> "
+           << "the ensemble control file should not appear in the list "
+           << "of ensemble member files:\n" << ctrl_file << "\n\n";
+      exit(1);
+   }
+
    // Check for missing non-python ensemble files
    for(i=0; i<ens_files.n(); i++) {
       if(!file_exists(ens_files[i].c_str()) &&