Solid-Liquid Separator Base Model

docs/reference_guides/model_libraries/generic/unit_models/index.rst

@@ -2,7 +2,7 @@ Unit Models
 ===========
 
 .. toctree::
-    :maxdepth: 1
+    :maxdepth: 2
 
     compressor
     cstr
@@ -30,3 +30,5 @@ Unit Models
     translator
     turbine
     valve
+
+    solid_liquid/index

docs/reference_guides/model_libraries/generic/unit_models/solid_liquid/index.rst

@@ -0,0 +1,9 @@
+Solid-Liquid Unit Models
+========================
+
+This library contains models specific for solid-liquid processing operations (although some of them may also be applicable in other circumstances). Models in this library assume streams consist of separate solid and liquid phases (with separate property packages) and thus all stream are represented by separate solid and liquid ports. Separation of solids and liquids is generally assume to result in a concentrated solid-liquid stream and a clarified liquid stream.
+
+.. toctree::
+    :maxdepth: 1
+
+    sl_separator

docs/reference_guides/model_libraries/generic/unit_models/solid_liquid/sl_separator.rst

@@ -0,0 +1,52 @@
+Generic Solid-Liquid Separator
+===============================
+
+The ``SLSeparator`` unit model is a general purpose model for representing the separation of mixed streams containing solids and liquids, such as filtration and thickening. The model assumes that the mixed stream is separated into a concentrated solid-liquid stream and a stream of clarified liquid.
+
+Degrees of Freedom
+------------------
+
+The ``SLSeparator`` model has 1 degree of freedom, which is generally the liquid recovery fraction. Note that due to the assumption that all solids report to the concentrated outlet, the solid inlet and outlet Ports link to the same variables (and thus cannot be fixed independently).
+
+Model Structure
+---------------
+
+The model consists of two parts. The solid phase is represented by a single StateBlock as all solids in the inlet are assumed to report to the concentrated outlet. The liquid phase is represented by a standard :ref:`Separator <reference_guides/model_libraries/generic/unit_models/separator:Separator>` block which splits the incoming liquid between the concentrated and clarified outlets.
+
+The ``SLSeparator`` unit model has a total of 5 ports:
+
+* ``solid_inlet`` representing the solids in the incoming stream,
+* ``liquid_inlet`` representing the liquid in the incoming stream,
+* ``solid_outlet`` representing the solids in the concentrated stream,
+* ``retained_liquid_outlet`` representing the liquid in the concentrated stream, and,
+* ``recovered_liquid_outlet`` representing the liquid in the clarified stream.
+
+Additional Constraints
+----------------------
+
+The ``SLSeparator`` model adds no additional constraints beyond those written by the :ref:`Separator <reference_guides/model_libraries/generic/unit_models/separator:Separator>` and StateBlocks.
+
+Variables
+---------
+
+The ``SLSeparator`` adds one Reference to a variable in the :ref:`Separator <reference_guides/model_libraries/generic/unit_models/separator:Separator>`.
+
+============ ================ ================================================================================================
+Variable     Name             Notes
+============ ================ ================================================================================================
+:math:`R_t`  liquid_recovery  Fraction of liquid which reports to the clarified stream, reference to ``split.split_fraction``
+============ ================ ================================================================================================
+
+.. module:: idaes.models.unit_models.solid_liquid.sl_separator
+
+SLSeparator Class
+-----------------
+
+.. autoclass:: SLSeparator
+  :members:
+
+SLSeparatorData Class
+---------------------
+
+.. autoclass:: SLSeparatorData
+  :members:

idaes/models/unit_models/flash.py

@@ -140,7 +140,7 @@ class FlashData(UnitModelBlockData):
 **default** - EnergySplittingType.equal_temperature.
 **Valid values:** {
 **EnergySplittingType.equal_temperature** - outlet temperatures equal inlet
-**EnergySplittingType.equal_molar_enthalpy** - oulet molar enthalpies equal
+**EnergySplittingType.equal_molar_enthalpy** - outlet molar enthalpies equal
 inlet,
 **EnergySplittingType.enthalpy_split** - apply split fractions to enthalpy
 flows.}""",

idaes/models/unit_models/mscontactor.py

@@ -15,6 +15,8 @@
 """
 from functools import partial
 
+from pandas import DataFrame
+
 # Import Pyomo libraries
 from pyomo.environ import Block, Constraint, RangeSet, Reals, Set, units, Var
 from pyomo.common.config import ConfigDict, ConfigValue, Bool, In
@@ -42,6 +44,7 @@
 from idaes.core.solvers import get_solver
 from idaes.core.util.model_serializer import to_json, from_json
 import idaes.logger as idaeslog
+from idaes.core.util.units_of_measurement import report_quantity
 
 __author__ = "Andrew Lee"
 
@@ -902,7 +905,47 @@
         )
 
     def _get_performance_contents(self, time_point=0):
-        raise NotImplementedError()
+        # Due to the flexibility of the MSContactor and the number of possible terms
+        # that could be included here, we will leave this up to the user to define.
+        return {}
+
+    def _get_stream_table_contents(self, time_point=0):
+        stream_attributes = {}
+        stream_attributes["Units"] = {}
+
+        sblocks = {}
+        for stream, pconfig in self.config.streams.items():
+            sblock = getattr(self, stream)
+            flow_dir = pconfig.flow_direction
+
+            if pconfig.has_feed:
+                inlet_state = getattr(self, stream + "_inlet_state")
+                sblocks[stream + " Inlet"] = inlet_state[time_point]
+
+            if flow_dir == FlowDirection.forward:
+                outlet = self.elements.last()
+            elif flow_dir == FlowDirection.backward:
+                outlet = self.elements.first()
+            else:
+                raise BurntToast("If/else overrun when constructing stream table")
+
+            sblocks[stream + " Outlet"] = sblock[time_point, outlet]
+
+        for n, v in sblocks.items():
+            dvars = v.define_display_vars()
+
+            stream_attributes[n] = {}
+
+            for k in dvars:
+                for i in dvars[k].keys():
+                    stream_key = k if i is None else f"{k} {i}"
+
+                    quant = report_quantity(dvars[k][i])
+
+                    stream_attributes[n][stream_key] = quant.m
+                    stream_attributes["Units"][stream_key] = quant.u
+
+        return DataFrame.from_dict(stream_attributes, orient="columns")
 
 
 def _get_state_blocks(blk, t, s, stream):

idaes/models/unit_models/solid_liquid/__init__.py

@@ -0,0 +1,13 @@
+#################################################################################
+# The Institute for the Design of Advanced Energy Systems Integrated Platform
+# Framework (IDAES IP) was produced under the DOE Institute for the
+# Design of Advanced Energy Systems (IDAES).
+#
+# Copyright (c) 2018-2023 by the software owners: The Regents of the
+# University of California, through Lawrence Berkeley National Laboratory,
+# National Technology & Engineering Solutions of Sandia, LLC, Carnegie Mellon
+# University, West Virginia University Research Corporation, et al.
+# All rights reserved.  Please see the files COPYRIGHT.md and LICENSE.md
+# for full copyright and license information.
+#################################################################################
+from .sl_separator import SLSeparator