fix vertical mixing when 2D

if do3D==False, vertical_mixing is now also turned to False. Otherwise it is easy to get into 2D with vertical mixing on situation.

Author: kthyng

particle_tracking_manager/models/opendrift/config_opendrift.py

@@ -188,17 +188,6 @@ def check_interpolator_filename(self) -> Self:
     #             raise ValueError("z needs to be None if seed_seafloor is True.")
     #     return self
 
-    # this is not true! For example, OpenOil has by default no vertical advection but yes vertical mixing
-    # @model_validator(mode="after")
-    # def check_config_do3D(self) -> Self:
-    #     """Check if do3D is set correctly."""
-    #     if hasattr(self, "vertical_mixing"):
-    #         if not self.do3D and self.vertical_mixing:
-    #             raise ValueError(
-    #                 "If do3D is False, vertical_mixing must also be False."
-    #             )
-    #     return self
-
     @model_validator(mode="after")
     def setup_interpolator(self) -> Self:
         """Setup interpolator."""
@@ -497,7 +486,7 @@ class OceanDriftModelConfig(OpenDriftConfig):
     )
 
     vertical_mixing_at_surface: bool = Field(
-        default=True,
+        default=False,
         description="If vertical mixing is activated, surface elements (z=0) can only be mixed (downwards) if this setting it True.",
         title="Vertical Mixing At Surface",
         json_schema_extra={
@@ -507,7 +496,7 @@ class OceanDriftModelConfig(OpenDriftConfig):
     )
 
     vertical_advection_at_surface: bool = Field(
-        default=True,
+        default=False,
         description="If vertical advection is activated, surface elements (z=0) can only be advected (downwards) if this setting it True.",
         title="Vertical Advection At Surface",
         json_schema_extra={
@@ -524,6 +513,14 @@ def check_wind_drift(self) -> Self:
             logger.debug("Setting wind_drift_factor to 0 because wind_drift is False.")
         return self
 
+    @model_validator(mode="after")
+    def check_config_do3D(self) -> Self:
+        """If do3D is False, set vertical_mixing to False."""
+        if not self.do3D:
+            self.vertical_mixing = False
+            logger.debug("Setting vertical_mixing to False because do3D is False.")
+        return self
+
 
 class OpenOilModelConfig(OceanDriftModelConfig):
     """OpenOil model configuration for OpenDrift."""
@@ -688,7 +685,7 @@ class OpenOilModelConfig(OceanDriftModelConfig):
         OceanDriftModelConfig.model_fields["wind_drift_factor"], Field(default=0.03)
     )
     vertical_mixing: bool = FieldInfo.merge_field_infos(
-        OceanDriftModelConfig.model_fields["vertical_mixing"], Field(default=True)
+        OceanDriftModelConfig.model_fields["vertical_mixing"], Field(default=False)
     )
     vertical_mixing_at_surface: bool = FieldInfo.merge_field_infos(
         OceanDriftModelConfig.model_fields["vertical_mixing_at_surface"],
@@ -928,15 +925,15 @@ def check_do3D(self) -> Self:
 
         return self
 
-    @model_validator(mode="after")
-    def check_vertical_mixing(self) -> Self:
-        """Check if vertical_mixing is set to True for LarvalFish model."""
-        if not self.vertical_mixing:
-            raise ValueError(
-                "vertical_mixing must be True with the LarvalFish drift model."
-            )
+    # @model_validator(mode="after")
+    # def check_vertical_mixing(self) -> Self:
+    #     """Check if vertical_mixing is set to True for LarvalFish model."""
+    #     if not self.vertical_mixing:
+    #         raise ValueError(
+    #             "vertical_mixing must be True with the LarvalFish drift model."
+    #         )
 
-        return self
+    #     return self
 
     # @model_validator(mode="after")
     # def check_hatched_and_stage_fraction(self) -> Self:
@@ -1077,21 +1074,21 @@ class PhytoplanktonModelConfig(OceanDriftModelConfig):
         OceanDriftModelConfig.model_fields["wind_drift_factor"], Field(default=0.0)
     )
 
-    @model_validator(mode="after")
-    def check_do3D(self) -> Self:
-        """Check if do3D is set to True for Phytoplankton model."""
-        if not self.do3D:
-            raise ValueError("do3D must be True with the Phytoplankton drift model.")
-        return self
+    # # @model_validator(mode="after")
+    # # def check_do3D(self) -> Self:
+    # #     """Check if do3D is set to True for Phytoplankton model."""
+    # #     if not self.do3D:
+    # #         raise ValueError("do3D must be True with the Phytoplankton drift model.")
+    # #     return self
 
-    @model_validator(mode="after")
-    def check_vertical_mixing(self) -> Self:
-        """Check if vertical_mixing is set to True for Phytoplankton model."""
-        if not self.vertical_mixing:
-            raise ValueError(
-                "vertical_mixing must be True with the Phytoplankton drift model."
-            )
-        return self
+    # @model_validator(mode="after")
+    # def check_vertical_mixing(self) -> Self:
+    #     """Check if vertical_mixing is set to True for Phytoplankton model."""
+    #     if not self.vertical_mixing:
+    #         raise ValueError(
+    #             "vertical_mixing must be True with the Phytoplankton drift model."
+    #         )
+    #     return self
 
     @model_validator(mode="after")
     def check_vertical_behavior_parameters(self) -> Self:

tests/test_config_opendrift.py

@@ -59,19 +59,19 @@ def test_LarvalFish_parameters():
         assert hasattr(m, param)
 
 
-def test_LarvalFish_disallowed_settings():
-    """LarvalFish is incompatible with some settings.
+# def test_LarvalFish_disallowed_settings():
+#     """LarvalFish is incompatible with some settings.
 
-    LarvalFish has to always be 3D with vertical_mixing on.
-    """
+#     LarvalFish has to always be 3D with vertical_mixing on.
+#     """
 
-    with pytest.raises(ValidationError):
-        m = LarvalFishModelConfig(
-            drift_model="LarvalFish", vertical_mixing=False, steps=1
-        )
+#     with pytest.raises(ValidationError):
+#         m = LarvalFishModelConfig(
+#             drift_model="LarvalFish", vertical_mixing=False, steps=1
+#         )
 
-    with pytest.raises(ValidationError):
-        m = LarvalFishModelConfig(drift_model="LarvalFish", do3D=False, steps=1)
+#     with pytest.raises(ValidationError):
+#         m = LarvalFishModelConfig(drift_model="LarvalFish", do3D=False, steps=1)
 
 
 def test_LarvalFish_hatched_stage_fraction():
@@ -165,6 +165,28 @@ def test_OceanDrift_wind_drift():
     assert m.wind_drift_factor == 0.02
 
 
+def test_do3D_vertical_mixing_False():
+    """If do3D is False, vertical_mixing should be set to False."""
+
+    # OceanDrift
+    m = OceanDriftModelConfig(
+        steps=1, do3D=False, start_time="2022-01-01", vertical_mixing=True
+    )
+    assert m.vertical_mixing == False
+
+    # OpenOil
+    m = OpenOilModelConfig(
+        steps=1, do3D=False, start_time="2022-01-01", vertical_mixing=True
+    )
+    assert m.vertical_mixing == False
+
+    # Phytoplankton
+    m = PhytoplanktonModelConfig(
+        steps=1, do3D=False, start_time="2022-01-01", vertical_mixing=True
+    )
+    assert m.vertical_mixing == False
+
+
 def test_OceanDrift_parameters():
     """Make sure OceanDrift-specific parameters are present."""
     m = OceanDriftModelConfig(drift_model="OceanDrift", steps=1)
@@ -310,21 +332,21 @@ def test_Phytoplankton_dvm_mode():
     assert m.z_night == -5.0
 
 
-def test_Phytoplankton_disallowed_settings():
-    """Phytoplankton requires 3D with vertical_mixing."""
-    with pytest.raises(ValidationError):
-        m = PhytoplanktonModelConfig(
-            drift_model="Phytoplankton",
-            vertical_mixing=False,
-            steps=1,
-        )
-
-    with pytest.raises(ValidationError):
-        m = PhytoplanktonModelConfig(
-            drift_model="Phytoplankton",
-            do3D=False,
-            steps=1,
-        )
+# def test_Phytoplankton_disallowed_settings():
+#     """Phytoplankton requires 3D with vertical_mixing."""
+#     with pytest.raises(ValidationError):
+#         m = PhytoplanktonModelConfig(
+#             drift_model="Phytoplankton",
+#             vertical_mixing=False,
+#             steps=1,
+#         )
+
+#     with pytest.raises(ValidationError):
+#         m = PhytoplanktonModelConfig(
+#             drift_model="Phytoplankton",
+#             do3D=False,
+#             steps=1,
+#         )
 
 
 ## Enums ##