Skip to content
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

Fixing incorrect doc strings in control volume methods #820

Merged
merged 2 commits into from
Apr 22, 2022
Merged

Fixing incorrect doc strings in control volume methods #820

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3db465c
Fixing incorrect doc stings
Apr 21, 2022
0de422c
Merge branch 'main' into issue_793
Apr 22, 2022
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
12 changes: 6 additions & 6 deletions idaes/core/base/control_volume0d.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1167,9 +1167,9 @@ def add_total_enthalpy_balances(
mass transfer should be included in enthalpy balance. This
should generally be the same as the has_mass_transfer
argument in the material balance methods
custom_term - a Pyomo Expression representing custom terms to
be included in enthalpy balances.
Expression must be indexed by time and phase list
custom_term - a Python method which returns Pyomo expressions representing
custom terms to be included in enthalpy balances.
Method should accept time and phase list as arguments.

Returns:
Constraint object representing enthalpy balances
Expand Down Expand Up @@ -1378,9 +1378,9 @@ def add_total_pressure_balances(self, has_pressure_change=False, custom_term=Non
Args:
has_pressure_change - whether terms for pressure change should be
included in enthalpy balances
custom_term - a Pyomo Expression representing custom terms to
be included in pressure balances.
Expression must be indexed by time
custom_term - a Python method which returns Pyomo expressions representing
custom terms to be included in enthalpy balances.
Method should accept time as an arguments.

Returns:
Constraint object representing pressure balances
Expand Down
9 changes: 6 additions & 3 deletions idaes/core/base/control_volume1d.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1483,9 +1483,9 @@ def add_total_enthalpy_balances(
mass transfer should be included in enthalpy balance. This
should generally be the same as the has_mass_transfer
argument in the material balance methods
custom_term - a Pyomo Expression representing custom terms to
be included in enthalpy balances.
Expression must be indexed by time, length and phase list
custom_term - a Python method which returns Pyomo expressions representing
custom terms to be included in enthalpy balances.
Method should accept time, length and phase list as arguments.

Returns:
Constraint object representing enthalpy balances
Expand Down Expand Up @@ -1746,6 +1746,9 @@ def add_total_pressure_balances(self, has_pressure_change=False, custom_term=Non
custom_term - a Pyomo Expression representing custom terms to
be included in pressure balances.
Expression must be indexed by time and length domain
custom_term - a Python method which returns Pyomo expressions representing
custom terms to be included in enthalpy balances.
Method should accept time and length as arguments.

Returns:
Constraint object representing pressure balances
Expand Down