CF Merger #3: Compositional Flow models

src/porepy/__init__.py

@@ -175,9 +175,11 @@
 from porepy import models
 from porepy.models.abstract_equations import (
     BalanceEquation,
+    LocalElimination,
     VariableMixin,
 )
 from porepy.models.boundary_condition import BoundaryConditionMixin
+from porepy.models.initial_condition import InitialConditionMixin
 from porepy.models.geometry import ModelGeometry
 from porepy.models.units import Units
 
@@ -199,20 +201,28 @@
 from porepy.compositional.compositional_mixins import CompositionalVariables, FluidMixin
 
 # "Primary" models
-from porepy.models import fluid_mass_balance, momentum_balance
+from porepy.models import energy_balance, fluid_mass_balance, momentum_balance
 
 # "Secondary" models inheriting from primary models
 from porepy.models import (
     poromechanics,
-    energy_balance,
     mass_and_energy_balance,
     thermoporomechanics,
 )
+
+# need to import compositional flow after mass_and_energy
+from porepy.models import compositional_flow
+
+# Full model classes.
 from porepy.models.fluid_mass_balance import SinglePhaseFlow
 from porepy.models.momentum_balance import MomentumBalance
 from porepy.models.poromechanics import Poromechanics
 from porepy.models.thermoporomechanics import Thermoporomechanics
 from porepy.models.mass_and_energy_balance import MassAndEnergyBalance
+from porepy.models.compositional_flow import (
+    CompositionalFlowTemplate,
+    CompositionalFractionalFlowTemplate,
+)
 
 
 # Visualization

src/porepy/applications/boundary_conditions/model_boundary_conditions.py

@@ -22,7 +22,7 @@ class BoundaryConditionsMassDirWestEast(pp.BoundaryConditionMixin):
     def bc_type_darcy_flux(self, sd: pp.Grid) -> pp.BoundaryCondition:
         """Boundary condition type for Darcy flux.
 
-        Dirichlet boundary conditions are defined on the north and south boundaries.
+        Dirichlet boundary conditions are defined on the west and east boundaries.
 
         Parameters:
             sd: Subdomain for which to define boundary conditions.

src/porepy/compositional/base.py

@@ -65,6 +65,8 @@
     "EquationOfState",
     "Phase",
     "Fluid",
+    "ComponentLike",
+    "PhaseLike",
 ]
 
 
@@ -127,8 +129,8 @@ class Compound(Component, Generic[ComponentLike]):
     """A compound is a simplified, but meaningfully generalized, set of chemical species
     inside a mixture, for which it makes sense to treat it as a single component.
 
-    It is represents one species, the solvent, and contains arbitrary many active
-    tracers (pseudo-components).
+    It represents one species, the solvent, and contains arbitrary many active tracers
+    (pseudo-components).
 
     A compound can appear in multiple phases and its thermodynamic properties are
     determined by the tracers present.
@@ -540,7 +542,7 @@ def __init__(
 
         """
 
-        self.fugacity_coefficient_of: dict[ComponentLike, ExtendedDomainFunctionType]
+        self.fugacity_coefficient_of: dict[Component, ExtendedDomainFunctionType]
         """Fugacitiy coefficients per component in this phase.
 
         Dimensionless, scalar field.
@@ -579,7 +581,7 @@ def __init__(
 
         """
 
-        self.extended_fraction_of: dict[ComponentLike, DomainFunctionType]
+        self.extended_fraction_of: dict[Component, DomainFunctionType]
         """Extended molar fractions per component in a phase, used in the unified
         phase equilibrium formulation (see :attr:`partial_fraction_of`).
 
@@ -591,7 +593,7 @@ def __init__(
 
         """
 
-        self.partial_fraction_of: dict[ComponentLike, DomainFunctionType]
+        self.partial_fraction_of: dict[Component, DomainFunctionType]
         """Partial (physical) fraction of a component, relative to the phase fraction.
 
         Dimensionless, scalar field bound to the interval ``[0, 1]``.