make parameter consistent (#91)

Made sure the `vertical_mixing_at_surface` is consistent with `vertical_mixing` and `vertical_advection_at_surface` is consistent with `do3D`.

Author: kthyng

docs/whats_new.md

@@ -1,10 +1,11 @@
 # What's New
 
-## Unreleased
+## 3.0.0 (March 12, 2026)
 
 * Fixed bug so that horizontal diffusivity is now properly applied to model output.
 * Added `wind_drift` parameter which when False makes sure that `wind_drift_factor=0` so that wind drift is not on.
 * If `do3D==False`, vertical_mixing is now also turned to False. Otherwise it is easy to run 2D with vertical mixing on.
+* Made sure the `vertical_mixing_at_surface` is consistent with `vertical_mixing` and `vertical_advection_at_surface` is consistent with `do3D`.
 
 ## 2.5.0 (March 9, 2026)
 

particle_tracking_manager/models/opendrift/config_opendrift.py

@@ -476,7 +476,7 @@ class OceanDriftModelConfig(OpenDriftConfig):
     )
 
     vertical_mixing: bool = Field(
-        default=False,
+        default=True,
         description="Activate vertical mixing scheme. Vertical mixing includes movement due to buoyancy and turbulent mixing.",
         title="Vertical Mixing",
         json_schema_extra={
@@ -486,7 +486,7 @@ class OceanDriftModelConfig(OpenDriftConfig):
     )
 
     vertical_mixing_at_surface: bool = Field(
-        default=False,
+        default=True,
         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={
@@ -521,6 +521,46 @@ def check_config_do3D(self) -> Self:
             logger.debug("Setting vertical_mixing to False because do3D is False.")
         return self
 
+    @model_validator(mode="after")
+    def check_vertical_advection_at_surface_True(self) -> Self:
+        """If do3D is True, vertical_advection_at_surface is also True."""
+        if self.do3D:
+            self.vertical_advection_at_surface = True
+            logger.debug(
+                "Setting vertical_advection_at_surface to True because do3D is True."
+            )
+        return self
+
+    @model_validator(mode="after")
+    def check_vertical_advection_at_surface_False(self) -> Self:
+        """If do3D is False, vertical_advection_at_surface is also False."""
+        if not self.do3D:
+            self.vertical_advection_at_surface = False
+            logger.debug(
+                "Setting vertical_advection_at_surface to False because do3D is False."
+            )
+        return self
+
+    @model_validator(mode="after")
+    def check_vertical_mixing_at_surface_True(self) -> Self:
+        """If vertical_mixing is True, vertical_mixing_at_surface must also be True."""
+        if self.vertical_mixing:
+            self.vertical_mixing_at_surface = True
+            logger.debug(
+                "Setting vertical_mixing_at_surface to True because vertical_mixing is True."
+            )
+        return self
+
+    @model_validator(mode="after")
+    def check_vertical_mixing_at_surface_False(self) -> Self:
+        """If vertical_mixing is False, vertical_mixing_at_surface must also be False."""
+        if not self.vertical_mixing:
+            self.vertical_mixing_at_surface = False
+            logger.debug(
+                "Setting vertical_mixing_at_surface to False because vertical_mixing is False."
+            )
+        return self
+
 
 class OpenOilModelConfig(OceanDriftModelConfig):
     """OpenOil model configuration for OpenDrift."""
@@ -685,11 +725,11 @@ 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=False)
+        OceanDriftModelConfig.model_fields["vertical_mixing"], Field(default=True)
     )
     vertical_mixing_at_surface: bool = FieldInfo.merge_field_infos(
         OceanDriftModelConfig.model_fields["vertical_mixing_at_surface"],
-        Field(default=False),
+        Field(default=True),
     )
     vertical_advection_at_surface: bool = FieldInfo.merge_field_infos(
         OceanDriftModelConfig.model_fields["vertical_advection_at_surface"],

tests/test_config_opendrift.py

@@ -187,6 +187,149 @@ def test_do3D_vertical_mixing_False():
     assert m.vertical_mixing == False
 
 
+def test_vertical_advection_surface():
+    """If do3D is False, vertical_advection_at_surface should be set to False
+
+    and if True, vertical_advection_at_surface should be set to True."""
+
+    # OceanDrift
+    m = OceanDriftModelConfig(
+        steps=1,
+        do3D=False,
+        start_time="2022-01-01",
+        vertical_advection_at_surface=True,
+    )
+    assert m.vertical_advection_at_surface == False
+
+    m = OceanDriftModelConfig(
+        steps=1,
+        do3D=True,
+        start_time="2022-01-01",
+        vertical_advection_at_surface=False,
+    )
+    assert m.vertical_advection_at_surface == True
+
+    # OpenOil
+    m = OpenOilModelConfig(
+        steps=1,
+        do3D=False,
+        start_time="2022-01-01",
+        vertical_advection_at_surface=True,
+    )
+    assert m.vertical_advection_at_surface == False
+
+    m = OpenOilModelConfig(
+        steps=1,
+        do3D=True,
+        start_time="2022-01-01",
+        vertical_advection_at_surface=False,
+    )
+    assert m.vertical_advection_at_surface == True
+
+    # Phytoplankton
+    m = PhytoplanktonModelConfig(
+        steps=1,
+        do3D=False,
+        start_time="2022-01-01",
+        vertical_advection_at_surface=True,
+    )
+    assert m.vertical_advection_at_surface == False
+
+    m = PhytoplanktonModelConfig(
+        steps=1,
+        do3D=True,
+        start_time="2022-01-01",
+        vertical_advection_at_surface=False,
+    )
+    assert m.vertical_advection_at_surface == True
+
+    m = LarvalFishModelConfig(
+        steps=1,
+        do3D=True,
+        start_time="2022-01-01",
+        vertical_advection_at_surface=False,
+    )
+    assert m.vertical_advection_at_surface == True
+
+
+def test_vertical_mixing_surface():
+    """If vertical_mixing is True, vertical_mixing_at_surface should be True
+
+    and if False, vertical_mixing_at_surface should be False."""
+
+    # OceanDrift
+    m = OceanDriftModelConfig(
+        steps=1,
+        vertical_mixing=True,
+        start_time="2022-01-01",
+        vertical_mixing_at_surface=False,
+        do3D=True,
+    )
+    assert m.vertical_mixing_at_surface == True
+
+    m = OceanDriftModelConfig(
+        steps=1,
+        vertical_mixing=False,
+        start_time="2022-01-01",
+        vertical_mixing_at_surface=True,
+    )
+    assert m.vertical_mixing_at_surface == False
+
+    # OpenOil
+    m = OpenOilModelConfig(
+        steps=1,
+        vertical_mixing=True,
+        start_time="2022-01-01",
+        vertical_mixing_at_surface=False,
+        do3D=True,
+    )
+    assert m.vertical_mixing_at_surface == True
+
+    m = OpenOilModelConfig(
+        steps=1,
+        vertical_mixing=False,
+        start_time="2022-01-01",
+        vertical_mixing_at_surface=True,
+    )
+    assert m.vertical_mixing_at_surface == False
+
+    # Phytoplankton
+    m = PhytoplanktonModelConfig(
+        steps=1,
+        vertical_mixing=True,
+        start_time="2022-01-01",
+        vertical_mixing_at_surface=False,
+        do3D=True,
+    )
+    assert m.vertical_mixing_at_surface == True
+
+    m = PhytoplanktonModelConfig(
+        steps=1,
+        vertical_mixing=False,
+        start_time="2022-01-01",
+        vertical_mixing_at_surface=True,
+    )
+    assert m.vertical_mixing_at_surface == False
+
+    # LarvalFish
+    m = LarvalFishModelConfig(
+        steps=1,
+        vertical_mixing=True,
+        start_time="2022-01-01",
+        vertical_mixing_at_surface=False,
+        do3D=True,
+    )
+    assert m.vertical_mixing_at_surface == True
+
+    m = LarvalFishModelConfig(
+        steps=1,
+        vertical_mixing=False,
+        start_time="2022-01-01",
+        vertical_mixing_at_surface=True,
+    )
+    assert m.vertical_mixing_at_surface == False
+
+
 def test_OceanDrift_parameters():
     """Make sure OceanDrift-specific parameters are present."""
     m = OceanDriftModelConfig(drift_model="OceanDrift", steps=1)