fix(mvr): added documentation explaining the difference between the t…

…wo flopy mvr classes (#950)
modflowpy · Jul 31, 2020 · 49b4aa2 · 49b4aa2
1 parent cd81a09
commit 49b4aa2
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 6 deletions.
diff --git a/flopy/mf6/modflow/mfgwfmvr.py b/flopy/mf6/modflow/mfgwfmvr.py
@@ -6,7 +6,9 @@
 
 class ModflowGwfmvr(mfpackage.MFPackage):
     """
-    ModflowGwfmvr defines a mvr package within a gwf6 model.
+    ModflowGwfmvr defines a mvr package within a gwf6 model. This package
+    can only be used to move water between packages within a single model.
+    To move water between models use ModflowMvr.
 
     Parameters
     ----------

diff --git a/flopy/mf6/modflow/mfmvr.py b/flopy/mf6/modflow/mfmvr.py
@@ -6,7 +6,9 @@
 
 class ModflowMvr(mfpackage.MFPackage):
     """
-    ModflowMvr defines a mvr package.
+    ModflowMvr defines a mvr package. This package can only be used to move
+    water between two different models. To move water between two packages
+    in the same model use the "model level" mover package (ex. ModflowGwfmvr).
 
     Parameters
     ----------

diff --git a/flopy/mf6/utils/createpackages.py b/flopy/mf6/utils/createpackages.py
@@ -369,11 +369,25 @@ def create_packages():
                     package[2])
             else:
                 package_container_text = ''
-            doc_string = mfdatautil.MFDocString(
-                'Modflow{} defines a {} package'
-                '{}.'.format(package_name.title(),
+            ds = 'Modflow{} defines a {} package' \
+                 '{}.'.format(package_name.title(),
                              package[0].file_type,
-                             package_container_text))
+                             package_container_text)
+            if package[0].file_type == 'mvr':
+                # mvr package warning
+                if package[2]:
+                    ds = '{} This package\n    can only be used to move ' \
+                         'water between packages within a single model.' \
+                         '\n    To move water between models use ModflowMvr' \
+                         '.'.format(ds)
+                else:
+                    ds = '{} This package can only be used to move\n    ' \
+                         'water between two different models. To move ' \
+                         'water between two packages\n    in the same ' \
+                         'model use the "model level" mover package (ex. ' \
+                         'ModflowGwfmvr).'.format(ds)
+
+            doc_string = mfdatautil.MFDocString(ds)
 
         if package[0].dfn_type == mfstructure.DfnType.exch_file:
             add_var(init_vars, None, init_param_list, package_properties,