STY: make code CI compliant

Author: OmarDuran

src/porepy/models/compositional_flow.py

@@ -399,14 +399,10 @@ class EnthalpyBasedEnergyBalanceEquations(
     ]
     """See :class:`~porepy.models.fluid_property_library.FluidMobility`."""
 
-    enthalpy_buoyancy: Callable[
-        [pp.Subdomains], pp.ad.Operator
-    ]
+    enthalpy_buoyancy: Callable[[pp.SubdomainsOrBoundaries], pp.ad.Operator]
     """See :class:`~porepy.models.fluid_property_library.FluidBuoyancy`."""
 
-    enthalpy_buoyancy_jump: Callable[
-        [pp.Subdomains], pp.ad.Operator
-    ]
+    enthalpy_buoyancy_jump: Callable[[pp.SubdomainsOrBoundaries], pp.ad.Operator]
     """See :class:`~porepy.models.fluid_property_library.FluidBuoyancy`."""
 
     bc_data_fractional_flow_energy_key: str
@@ -483,14 +479,16 @@ def enthalpy_flux(self, subdomains: pp.SubdomainsOrBoundaries) -> pp.ad.Operator
             )
         else:
             flux = super().enthalpy_flux(subdomains)
-        buoyancy_condition: bool = self.params.get("buoyancy_on", True) and not all([isinstance(g, pp.BoundaryGrid) for g in subdomains])
+        buoyancy_condition: bool = self.params.get(
+            "enable_buoyancy_effects", False
+        ) and not all([isinstance(g, pp.BoundaryGrid) for g in subdomains])
         if buoyancy_condition:
             flux += self.enthalpy_buoyancy(subdomains)
         return flux
 
     def energy_source(self, subdomains: list[pp.Grid]) -> pp.ad.Operator:
         source = super().energy_source(subdomains)
-        buoyancy_condition: bool = self.params.get("buoyancy_on", True)
+        buoyancy_condition: bool = self.params.get("enable_buoyancy_effects", False)
         if buoyancy_condition:
             source += self.enthalpy_buoyancy_jump(subdomains)
         return source
@@ -635,7 +633,7 @@ def component_mass_balance_equation(
             self.component_mass(component, subdomains), subdomains, dim=1
         )
         flux = self.component_flux(component, subdomains)
-        if self.params.get("buoyancy_on", True):
+        if self.params.get("enable_buoyancy_effects", False):
             flux += self.component_buoyancy(component, subdomains)
         source = self.component_source(component, subdomains)
 
@@ -908,7 +906,7 @@ def component_source(
         source = projection.mortar_to_secondary_int() @ self.interface_component_flux(
             component, interfaces
         )
-        if self.params.get("buoyancy_on", True):
+        if self.params.get("enable_buoyancy_effects", False):
             source += self.component_buoyancy_jump(component, subdomains)
 
         source.set_name(f"interface_component_flux_source_{component.name}")

src/porepy/models/fluid_property_library.py

@@ -137,7 +137,10 @@ def newton_step() -> None:
                 if not is_diverged:
                     solver_progressbar.update(n=1)
                     # Ignore the long line; fixing it would require an extra variable.
-                    if len(model.nonlinear_solver_statistics.nonlinear_increment_norms) != 0:
+                    if (
+                        len(model.nonlinear_solver_statistics.nonlinear_increment_norms)
+                        != 0
+                    ):
                         solver_progressbar.set_postfix_str(
                             f"Increment {model.nonlinear_solver_statistics.nonlinear_increment_norms[-1]:.2e}"  # noqa: E501
                         )

src/porepy/numerics/nonlinear/nonlinear_solvers.py

@@ -6,8 +6,10 @@
 - 2-phase, 2-component systems (e.g., water and methane)
 - 3-phase, 3-component systems (e.g., water, oil, and methane)
 
-The module defines 2D and 3D geometry setup, equations of state, initial and boundary conditions,
-and solution procedures for compositional fluid flow problems with gravitational effects.
+The module defines 2D and 3D geometry setup, equations of state, initial and boundary
+conditions, and solution procedures for compositional fluid flow problems with
+gravitational effects.
+
 Fixed- and mixed-dimensional meshes are defined on cartesian grids.
 
 """
@@ -287,15 +289,13 @@ def h(
     def rho_func(
         self, *thermodynamic_dependencies: np.ndarray
     ) -> tuple[np.ndarray, np.ndarray]:
-
         nc = len(thermodynamic_dependencies[0])
         vals = rho_w * np.ones(nc)
         return vals, np.zeros((len(thermodynamic_dependencies), nc))
 
     def mu_func(
         self, *thermodynamic_dependencies: np.ndarray
     ) -> tuple[np.ndarray, np.ndarray]:
-
         nc = len(thermodynamic_dependencies[0])
         vals = mu_w * np.ones(nc) * to_Mega
         return vals, np.zeros((len(thermodynamic_dependencies), nc))
@@ -314,7 +314,6 @@ def h(
     def rho_func(
         self, *thermodynamic_dependencies: np.ndarray
     ) -> tuple[np.ndarray, np.ndarray]:
-
         nc = len(thermodynamic_dependencies[0])
         vals = rho_o * np.ones(nc)
         diffs = np.zeros((len(thermodynamic_dependencies), nc))
@@ -341,7 +340,6 @@ def h(
     def rho_func(
         self, *thermodynamic_dependencies: np.ndarray
     ) -> tuple[np.ndarray, np.ndarray]:
-
         nc = len(thermodynamic_dependencies[0])
         vals = rho_g * np.ones(nc)
         diffs = np.zeros((len(thermodynamic_dependencies), nc))
@@ -358,7 +356,6 @@ def mu_func(
 class BaseFlowModel(
     FlowTemplate,
 ):
-
     def __init__(self, params: dict):
         """Initialize flow model."""
         super().__init__(params)
@@ -404,7 +401,6 @@ def check_convergence(
         """Check nonlinear convergence."""
 
         if self._is_nonlinear_problem():
-
             total_volume = 0.0
             for sd in self.mdg.subdomains():
                 total_volume += np.sum(
@@ -678,7 +674,6 @@ def ic_values_overall_fraction(
 class FlowModel2N(
     BaseFlowModel,
 ):
-
     def after_nonlinear_convergence(self) -> None:
         """Post-convergence diagnostics."""
         super().after_nonlinear_convergence()
@@ -1174,7 +1169,6 @@ def ic_values_overall_fraction(
 class FlowModel3N(
     BaseFlowModel,
 ):
-
     def after_nonlinear_convergence(self) -> None:
         """Post-convergence diagnostics."""
         super().after_nonlinear_convergence()

tests/functional/setups/buoyancy_flow_model.py

@@ -6,7 +6,8 @@
 
 It covers two multicomponent fluid systems:
 - N = 2: Two phases (aqueous liquid, gas) and two components (e.g., H₂O, CH₄).
-- N = 3: Three phases (aqueous liquid, oleic liquid, gas) and three components (e.g., H₂O, CO₂, CH₄).
+- N = 3: Three phases (aqueous liquid, oleic liquid, gas) and
+three components (e.g., H₂O, CO₂, CH₄).
 
 Simulations are run in 2D and 3D for several conservation tolerances, and
 the observed conservation is checked to be of the expected order. After each
@@ -88,7 +89,7 @@ def _run_buoyancy_model(
     )
     params = {
         "fractional_flow": True,
-        "buoyancy_on": True,
+        "enable_buoyancy_effects": True,
         "material_constants": {"solid": solid_constants},
         "time_manager": time_manager,
         "apply_schur_complement_reduction": False,
@@ -112,6 +113,7 @@ class Model3D(geometry3d, model_class):
         model = Model3D(params)
     pp.run_time_dependent_model(model, params)
 
+
 @pytest.mark.skipped  # reason: slow
 @pytest.mark.parametrize(
     "model_class, mesh_2d_Q, expected_order_loss", Parameterization
@@ -120,6 +122,7 @@ def test_buoyancy_fd_model(model_class, mesh_2d_Q, expected_order_loss):
     """Test buoyancy-driven flow model (FD)."""
     _run_buoyancy_model(model_class, mesh_2d_Q, expected_order_loss, md=False)
 
+
 @pytest.mark.skipped  # reason: slow
 @pytest.mark.parametrize(
     "model_class, mesh_2d_Q, expected_order_loss", Parameterization

tests/functional/test_buoyancy_flow.py

@@ -67,8 +67,6 @@ def test_buoyancy_flow_benchmark(
     rho_g = rho_l - delta_rho
     to_Mega = 1.0e-6
 
-    # --- All class and function definitions from the original script are placed here ---
-
     # geometry description
     class Geometry(pp.PorePyModel):
         @abstractmethod
@@ -503,7 +501,7 @@ def check_convergence(
     material_constants = {"solid": solid_constants}
     params = {
         "fractional_flow": True,
-        "buoyancy_on": True,
+        "enable_buoyancy_effects": True,
         "material_constants": material_constants,
         "time_manager": time_manager,
         "prepare_simulation": False,
@@ -584,7 +582,8 @@ def check_convergence(
         plt.xlabel("Distance [m]")
         plt.ylabel("Saturation [-]")
         plt.title(
-            f"Saturation Profile at $t = 5$ days for $\\Delta \\rho = {delta_rho}$ kg/m$^3$"
+            f"Saturation Profile at $t = 5$ days for "
+            f"$\\Delta \\rho = {delta_rho}$ kg/m$^3$"
         )
         plt.grid(True)
         plt.legend()

tests/functional/test_buoyancy_flow_benchmark.py

@@ -11,14 +11,16 @@
 
 
 # Test suite for FluidBuoyancy class functionality.
-# Validates buoyancy operators by instantiating models and evaluating computed operators.
+# Validates buoyancy operators by instantiating models and evaluating
+# computed operators.
 
 # Parameterization for testing both 2-component and 3-component models
 Parameterization = [
     (BuoyancyFlowModel2N),  # 2-component buoyancy flow model
     (BuoyancyFlowModel3N),  # 3-component buoyancy flow model
 ]
 
+
 def _build_buoyancy_model(
     model_class: type,
     md: bool = False,
@@ -57,7 +59,7 @@ def _build_buoyancy_model(
     )
     params = {
         "fractional_flow": True,
-        "buoyancy_on": True,
+        "enable_buoyancy_effects": True,
         "material_constants": {"solid": solid_constants},
         "time_manager": time_manager,
         "apply_schur_complement_reduction": False,
@@ -456,9 +458,7 @@ def __subdomains_assertions(model):
                 0.0,
             ]
         )
-    assert np.allclose(
-        h_buoyancy_flux, h_buoyancy_flux_expected
-    )
+    assert np.allclose(h_buoyancy_flux, h_buoyancy_flux_expected)
 
 
 def __interface_assertions(model):