Skip to content

Fix issue 1684: bad stream table formatting for flash #1719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Lingyan90 wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Fix issue 1684: bad stream table formatting for flash #1719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ec04969
revised the stream table content for ideal separation case
Lingyan90 Dec 22, 2025
e540ce0
black
Lingyan90 Dec 22, 2025
d0bdcf0
added comments for help understanding the value difference
Lingyan90 Dec 23, 2025
372dbf0
typos
Lingyan90 Dec 23, 2025
44eb61d
typos
Lingyan90 Feb 6, 2026
c5286c6
Merge branch 'main' into fix-issue_1684-Bad-stream-table-formatting-f…
Lingyan90 Feb 6, 2026
49624ea
Merge branch 'main' into fix-issue_1684-Bad-stream-table-formatting-f…
Lingyan90 Feb 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 29 additions & 31 deletions idaes/models/unit_models/flash.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,39 +360,15 @@ def _get_stream_table_contents(self, time_point=0):
stream_attributes = {}
stream_attributes["Units"] = {}

sblocks = {
"Inlet": self.control_volume.properties_in,
}
if not self.config.ideal_separation:
# If not using ideal separation, we can get outlet state directly
# from the state blocks
sblocks["Vapor Outlet"] = self.split.Vap_state
sblocks["Liquid Outlet"] = self.split.Liq_state

for n, v in sblocks.items():
dvars = v[time_point].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

if self.config.ideal_separation:
# If using ideal separation, get values from Ports and hope they map
# to names in Inlet
# TODO: Add a better way to map these if necessary
for n, v in {
"Vapor Outlet": "vap_outlet",
"Liquid Outlet": "liq_outlet",
# If using ideal separation, build the stream table from Ports so that
# all streams use the same naming convention (avoids mismatches with
# define_display_vars() across property packages).
for n, port_obj in {
"Inlet": self.inlet,
"Vapor Outlet": self.vap_outlet,
"Liquid Outlet": self.liq_outlet,
}.items():
port_obj = getattr(self, v)

stream_attributes[n] = {}

for k in port_obj.vars:
Expand All @@ -409,5 +385,27 @@ def _get_stream_table_contents(self, time_point=0):
quant = report_quantity(port_obj.vars[k][time_point, i[1:]])
stream_attributes[n][k + " " + kname] = quant.m
stream_attributes["Units"][k + " " + kname] = quant.u
else:
# If not using ideal separation, we can get outlet state directly
# from the state blocks
sblocks = {
"Inlet": self.control_volume.properties_in,
"Vapor Outlet": self.split.Vap_state,
"Liquid Outlet": self.split.Liq_state,
}

for n, v in sblocks.items():
dvars = v[time_point].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")
86 changes: 42 additions & 44 deletions idaes/models/unit_models/tests/test_flash.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,6 @@ def test_get_stream_table_contents(self, btx):
"pressure": pytest.approx(101325.0, rel=1e-4),
},
}

assert stable.to_dict() == expected

@pytest.mark.solver
Expand Down Expand Up @@ -406,49 +405,48 @@ def test_get_performance_contents(self, bt_modular):
}
}

# TODO the formatting for modular properties is broken (see #1684).
# This test can be fixed once that issue is fixed
# @pytest.mark.ui
# @pytest.mark.unit
# def test_get_stream_table_contents(self, bt_modular):
# stable = bt_modular.fs.unit._get_stream_table_contents()

# expected = {
# "Units": {
# "flow_mol": getattr(pyunits.pint_registry, "mole/s"),
# "mole_frac_comp benzene": getattr(
# pyunits.pint_registry, "dimensionless"
# ),
# "mole_frac_comp toluene": getattr(
# pyunits.pint_registry, "dimensionless"
# ),
# "temperature": getattr(pyunits.pint_registry, "K"),
# "pressure": getattr(pyunits.pint_registry, "Pa"),
# },
# "Inlet": {
# "flow_mol": pytest.approx(1.00, rel=1e-4),
# "mole_frac_comp benzene": pytest.approx(0.5, rel=1e-4),
# "mole_frac_comp toluene": pytest.approx(0.5, rel=1e-4),
# "temperature": pytest.approx(368, rel=1e-4),
# "pressure": pytest.approx(101325, rel=1e-4),
# },
# "Vapor Outlet": {
# "flow_mol": pytest.approx(0.5, rel=1e-4),
# "mole_frac_comp benzene": pytest.approx(0.5, rel=1e-4),
# "mole_frac_comp toluene": pytest.approx(0.5, rel=1e-4),
# "temperature": pytest.approx(298.15, rel=1e-4),
# "pressure": pytest.approx(101325.0, rel=1e-4),
# },
# "Liquid Outlet": {
# "flow_mol": pytest.approx(0.5, rel=1e-4),
# "mole_frac_comp benzene": pytest.approx(0.5, rel=1e-4),
# "mole_frac_comp toluene": pytest.approx(0.5, rel=1e-4),
# "temperature": pytest.approx(298.15, rel=1e-4),
# "pressure": pytest.approx(101325.0, rel=1e-4),
# },
# }

# assert stable.to_dict() == expected
@pytest.mark.ui
@pytest.mark.unit
def test_get_stream_table_contents(self, bt_modular):
stable = bt_modular.fs.unit._get_stream_table_contents()

expected = {
"Units": {
"flow_mol": getattr(pyunits.pint_registry, "mole/s"),
"mole_frac_comp benzene": getattr(
pyunits.pint_registry, "dimensionless"
),
"mole_frac_comp toluene": getattr(
pyunits.pint_registry, "dimensionless"
),
"temperature": getattr(pyunits.pint_registry, "K"),
"pressure": getattr(pyunits.pint_registry, "Pa"),
},
"Inlet": {
"flow_mol": pytest.approx(
1.00, rel=1e-4
), # This is different from its property package's (BT_ideal) properties_out value of 100
"mole_frac_comp benzene": pytest.approx(0.5, rel=1e-4),
"mole_frac_comp toluene": pytest.approx(0.5, rel=1e-4),
"temperature": pytest.approx(368, rel=1e-4),
"pressure": pytest.approx(101325, rel=1e-4),
},
"Vapor Outlet": {
"flow_mol": pytest.approx(50, rel=1e-4),
"mole_frac_comp benzene": pytest.approx(0.5, rel=1e-4),
"mole_frac_comp toluene": pytest.approx(0.5, rel=1e-4),
"temperature": pytest.approx(300.0, rel=1e-4),
"pressure": pytest.approx(100000.0, rel=1e-4),
},
"Liquid Outlet": {
"flow_mol": pytest.approx(50, rel=1e-4),
"mole_frac_comp benzene": pytest.approx(0.5, rel=1e-4),
"mole_frac_comp toluene": pytest.approx(0.5, rel=1e-4),
"temperature": pytest.approx(300.0, rel=1e-4),
"pressure": pytest.approx(100000.0, rel=1e-4),
},
}
assert stable.to_dict() == expected

@pytest.mark.solver
@pytest.mark.skipif(solver is None, reason="Solver not available")
Expand Down
Loading