fix(sfr ic option): made ic optional and updated description (#1020)

modflowpy · Nov 27, 2020 · 0ab929e · 0ab929e
1 parent de4f43d
commit 0ab929e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/flopy/mf6/data/dfn/gwf-sfr.dfn b/flopy/mf6/data/dfn/gwf-sfr.dfn
@@ -472,8 +472,9 @@ shape (ncon(rno))
 tagged false
 in_record true
 reader urword
+optional true
 longname connected reach numbers
-description integer value that defines the reach number of the reach connected to the current reach and whether it is connected to the upstream or downstream end of the reach. Negative IC numbers indicate connected reaches are connected to the downstream end of the current reach. Positive IC numbers indicate connected reaches are connected to the upstream end of the current reach. The absolute value of IC must be greater than zero and less than or equal to NREACHES.
+description integer value that defines the reach number of the reach connected to the current reach and whether it is connected to the upstream or downstream end of the reach. Negative IC numbers indicate connected reaches are connected to the downstream end of the current reach. Positive IC numbers indicate connected reaches are connected to the upstream end of the current reach. The absolute value of IC must be greater than zero and less than or equal to NREACHES. IC should not be specified when NCON is zero but must be specified otherwise.
 numeric_index true
 support_negative_index true
 

diff --git a/flopy/mf6/modflow/mfgwfsfr.py b/flopy/mf6/modflow/mfgwfsfr.py
@@ -186,10 +186,11 @@ class ModflowGwfsfr(mfpackage.MFPackage):
           current reach. Positive IC numbers indicate connected reaches are
           connected to the upstream end of the current reach. The absolute
           value of IC must be greater than zero and less than or equal to
-          NREACHES. This argument is an index variable, which means that it
-          should be treated as zero-based when working with FloPy and Python.
-          Flopy will automatically subtract one when loading index variables
-          and add one when writing index variables.
+          NREACHES. IC should not be specified when NCON is zero but must be
+          specified otherwise. This argument is an index variable, which means
+          that it should be treated as zero-based when working with FloPy and
+          Python. Flopy will automatically subtract one when loading index
+          variables and add one when writing index variables.
     diversions : [rno, idv, iconr, cprior]
         * rno (integer) integer value that defines the reach number associated
           with the specified DIVERSIONS data on the line. RNO must be greater
@@ -832,6 +833,7 @@ class ModflowGwfsfr(mfpackage.MFPackage):
             "tagged false",
             "in_record true",
             "reader urword",
+            "optional true",
             "numeric_index true",
             "support_negative_index true",
         ],