Fix nested flowsheet time domain construction #1495
Conversation
NishantGiridhar
requested review from
andrewlee94,
dallan-keylogic and
lbianchi-lbl
as code owners
NishantGiridhar
changed the title
idaes/core/base/flowsheet_model.py
Outdated
| @@ -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( | |||
There was a problem hiding this comment.
- Is this check actually necessary? This would appear to preclude putting steady-state flowsheets inside dynamic flowsheets.
if self.config.dynamic is Falsecan be written asif not self.config.dynamic
There was a problem hiding this comment.
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.
idaes/core/base/flowsheet_model.py
Outdated
| # 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: |
There was a problem hiding this comment.
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).
There was a problem hiding this comment.
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?
| 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) |
There was a problem hiding this comment.
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.
|
|
||
| assert m.fs.sub.config.dynamic is False | ||
| assert isinstance(m.fs.sub.time, Set) | ||
| assert m.fs.sub.time_units == units.dimensionless |
| 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) |
There was a problem hiding this comment.
Time should not be dimensionless - it does not matter for the test, but we should not accidentally encourage people to think this is OK.
|
@NishantGiridhar any update on this? |
|
@NishantGiridhar You need to run |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1495 +/- ##
==========================================
- Coverage 76.99% 76.99% -0.01%
==========================================
Files 382 382
Lines 61993 61997 +4
Branches 10146 10147 +1
==========================================
+ Hits 47733 47734 +1
- Misses 11852 11856 +4
+ Partials 2408 2407 -1 ☔ View full report in Codecov by Sentry. |
| 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]]: |
There was a problem hiding this comment.
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.
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:
Legal Acknowledgement
By contributing to this software project, I agree to the following terms and conditions for my contribution: