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

Add basis to conc example on property naming conventions docs #1482

Merged
merged 4 commits into from
Sep 6, 2024
Merged

Add basis to conc example on property naming conventions docs #1482

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
545ded0
change basis in convention conc example
kurbansitterley Sep 4, 2024
f9b8bec
extend table; add basis to other properties
kurbansitterley Sep 4, 2024
8b93059
Merge branch 'main' into doc_basis_convention_change
lbianchi-lbl Sep 5, 2024
7c8ffde
Merge branch 'main' into doc_basis_convention_change
lbianchi-lbl Sep 6, 2024
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
20 changes: 10 additions & 10 deletions docs/explanations/conventions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,13 +217,13 @@ Naming Examples
^^^^^^^^^^^^^^^
Below are some examples of the IDAES naming convention in use.

============================== ===========================================================
Variable Name Meaning
============================== ===========================================================
enth Specific enthalpy of the entire mixture (across all phases)
flow_comp["H2O"] Total flow of H2O (across all phases)
entr_phase["liq"] Specific entropy of the liquid phase mixture
conc_phase_comp["liq", "H2O"] Concentration of H2O in the liquid phase
temperature_red Reduced temperature
pressure_crit Critical pressure
============================== ===========================================================
================================== =============================================================================
Variable Name Meaning
================================== =============================================================================
enth_mol Specific enthalpy of the entire mixture (across all phases) on a molar basis
flow_vol_comp["H2O"] Total flow of H2O (across all phases) on a volumetric basis
entr_mol_phase["liq"] Specific entropy of the liquid phase mixture on a molar basis
conc_mass_phase_comp["liq", "H2O"] Concentration of H2O in the liquid phase on a mass basis
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As you noted in the associated issue, there are a few others here that need to be updated with a baisis. Would you be able to update the following

enth to enth_mol
flow to flow_vol
entr_phase['Liq'] to entr_mol_phase['Liq']

(I chose a variety of bases to demonstrate their uses).

temperature_red Reduced temperature
pressure_crit Critical pressure
================================== =============================================================================
Loading