Fix nested flowsheet time domain construction #1495

NishantGiridhar · 2024-10-05T01:43:02Z

Fixes

Summary/Motivation:

In the current implementation of FlowsheetBlock, nested flowsheets with a time domain can only inherit time from the parent flowsheet.

Changes proposed in this PR:

Moved code to create a new time domain into a private method.
Create a new time domain for a nested FlowsheetBlock if time_set is provided during construction.
Added tests.

Legal Acknowledgement

By contributing to this software project, I agree to the following terms and conditions for my contribution:

I agree my contributions are submitted under the license terms described in the LICENSE.txt file at the top level of this directory.
I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

andrewlee94

This looks like a good start - I only had a few minor comments.

WE should also check the documentation to make sure that what we say there is correct.

andrewlee94 · 2024-10-09T18:45:32Z

idaes/core/base/flowsheet_model.py

@@ -342,35 +367,24 @@ def _setup_dynamics(self):
                    "{} was set as a dynamic flowsheet, but time domain "
                    "provided was not a ContinuousSet.".format(self.name)
                )
+
+            if self.config.dynamic is False and not isinstance(


Is this check actually necessary? This would appear to preclude putting steady-state flowsheets inside dynamic flowsheets.

if self.config.dynamic is False can be written as if not self.config.dynamic

That's exactly what it was checking for. Since we don't want to allow adding a nested dynamic flowsheet inside a parent steady-state flowsheet, I will remove this check from this PR.

andrewlee94 · 2024-10-09T18:48:00Z

idaes/core/base/flowsheet_model.py

-                # Set time config argument as reference to time domain
-                self.config.time = self._time
+                _create_time_domain()
+            elif self.config.time_set is not None:


I think this is enough, but just to check is there any additional validation we should do here? Also, an in-line comment to explain what this case is (sub-flowsheet with user-provided time domain).

Based on my testing I think this should be good enough. The _create_time_domain method makes sure that the specified time_set list is of the right length. So the same checks that apply for time domain construction in a parent flowsheet should apply to the nested flowsheet.

@dallan-keylogic could Are there any edge cases I am overlooking?

andrewlee94 · 2024-10-09T18:49:05Z

idaes/core/base/tests/test_flowsheet_model.py

+        m.fs.sub = FlowsheetBlock(dynamic=True, time=m.s2, time_units=units.s)
+
+        assert m.fs.sub.config.dynamic is True
+        assert isinstance(m.fs.sub.time, ContinuousSet)


Here you should do assert m.fs.time is m.s2. - i.e. check that the time domain is the correct set, not just the correct type.

idaes/core/base/tests/test_flowsheet_model.py

andrewlee94 · 2024-10-09T18:50:02Z

idaes/core/base/tests/test_flowsheet_model.py

+
+        assert m.fs.sub.config.dynamic is False
+        assert isinstance(m.fs.sub.time, Set)
+        assert m.fs.sub.time_units == units.dimensionless


andrewlee94 · 2024-10-09T18:50:48Z

idaes/core/base/tests/test_flowsheet_model.py

+    def test_dynamic_parent_time_indexed_ss_child(self):
+        m = ConcreteModel()
+        m.fs = FlowsheetBlock(dynamic=True, time_set = [1,2,3], time_units=units.s)
+        m.fs.sub = FlowsheetBlock(dynamic=False, time_set = [0, 1], time_units=units.dimensionless)


Time should not be dimensionless - it does not matter for the test, but we should not accidentally encourage people to think this is OK.

dangunter · 2024-10-17T18:23:05Z

@NishantGiridhar any update on this?

…owsheet

andrewlee94 · 2024-10-21T20:48:12Z

@NishantGiridhar You need to run black on the changes to get the tests to pass.

codecov-commenter · 2024-10-22T18:16:11Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.05%. Comparing base (c4336ba) to head (aae6730).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1495      +/-   ##
==========================================
- Coverage   77.05%   77.05%   -0.01%     
==========================================
  Files         384      384              
  Lines       62335    62341       +6     
  Branches    10222    10224       +2     
==========================================
+ Hits        48031    48034       +3     
- Misses      11875    11879       +4     
+ Partials     2429     2428       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests

idaes/core/base/tests/test_flowsheet_model.py

andrewlee94 · 2024-10-23T20:42:53Z

idaes/core/base/flowsheet_model.py

-                self.config.time = self._time
+                _create_time_domain()
+            # Creates a new time domain for a sub-flowsheet with user provided time domain
+            elif self.config.time_set not in [None, [0]]:


Why is the [0] here? I would have thought that if we are handed an argument we should use it. To put it another way, if the user provides [0] as an argument we will ignore it without saying why.

NishantGiridhar added 3 commits October 4, 2024 20:08

Allow construction of nested time domain from config.time_set

e778dc6

Added tests for different time domains in nested flowsheets

8ecc4c7

Added test to create nested time indexed SS flowsheet in dynamic parent

7855199

NishantGiridhar added the Priority:Normal Normal Priority Issue or PR label Oct 5, 2024

NishantGiridhar requested review from andrewlee94, dallan-keylogic and lbianchi-lbl as code owners October 5, 2024 01:43

NishantGiridhar changed the title ~~Fs nested dyn fix~~ Fix nested flowsheet time domain construction Oct 5, 2024

andrewlee94 requested changes Oct 9, 2024

View reviewed changes

ksbeattie assigned NishantGiridhar Oct 10, 2024

NishantGiridhar added 2 commits October 19, 2024 17:59

Add comments + remove check for dynamic sub flowsheet in SS parent fl…

71af0da

…owsheet

Updated tests

03bbc3f

NishantGiridhar requested a review from andrewlee94 October 19, 2024 22:48

NishantGiridhar and others added 3 commits October 22, 2024 11:05

update formatting with black

77c2f37

Merge branch 'IDAES:main' into fs_nested_dyn_fix

516deb9

Sub-flowsheets with unspecified time inherit time from parent

891b857

andrewlee94 reviewed Oct 22, 2024

View reviewed changes

idaes/core/base/tests/test_flowsheet_model.py Show resolved Hide resolved

NishantGiridhar and others added 2 commits October 22, 2024 15:26

Fix test to use user provided time for parent flowsheet

c322abe

Merge branch 'IDAES:main' into fs_nested_dyn_fix

1b4d02b

NishantGiridhar requested a review from andrewlee94 October 23, 2024 20:29

andrewlee94 reviewed Oct 23, 2024

View reviewed changes

Merge branch 'IDAES:main' into fs_nested_dyn_fix

65946a6

NishantGiridhar requested a review from agarciadiego as a code owner November 18, 2024 19:22

NishantGiridhar and others added 3 commits November 19, 2024 14:42

Changed default config for time_set from [0] to None

5ceb39a

Updated test_config

5cc5765

Merge branch 'IDAES:main' into fs_nested_dyn_fix

aae6730

NishantGiridhar requested a review from andrewlee94 November 19, 2024 22:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix nested flowsheet time domain construction #1495

Fix nested flowsheet time domain construction #1495

NishantGiridhar commented Oct 5, 2024

andrewlee94 left a comment

andrewlee94 Oct 9, 2024

NishantGiridhar Oct 19, 2024

andrewlee94 Oct 9, 2024

NishantGiridhar Oct 19, 2024

andrewlee94 Oct 9, 2024

andrewlee94 Oct 9, 2024

andrewlee94 Oct 9, 2024 •

edited

Loading

dangunter commented Oct 17, 2024

andrewlee94 commented Oct 21, 2024

codecov-commenter commented Oct 22, 2024 •

edited

Loading

andrewlee94 Oct 23, 2024

Fix nested flowsheet time domain construction #1495

Are you sure you want to change the base?

Fix nested flowsheet time domain construction #1495

Conversation

NishantGiridhar commented Oct 5, 2024

Fixes

Summary/Motivation:

Changes proposed in this PR:

Legal Acknowledgement

andrewlee94 left a comment

Choose a reason for hiding this comment

andrewlee94 Oct 9, 2024

Choose a reason for hiding this comment

NishantGiridhar Oct 19, 2024

Choose a reason for hiding this comment

andrewlee94 Oct 9, 2024

Choose a reason for hiding this comment

NishantGiridhar Oct 19, 2024

Choose a reason for hiding this comment

andrewlee94 Oct 9, 2024

Choose a reason for hiding this comment

andrewlee94 Oct 9, 2024

Choose a reason for hiding this comment

andrewlee94 Oct 9, 2024 • edited Loading

Choose a reason for hiding this comment

dangunter commented Oct 17, 2024

andrewlee94 commented Oct 21, 2024

codecov-commenter commented Oct 22, 2024 • edited Loading

Codecov Report

andrewlee94 Oct 23, 2024

Choose a reason for hiding this comment

andrewlee94 Oct 9, 2024 •

edited

Loading

codecov-commenter commented Oct 22, 2024 •

edited

Loading