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.

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

Clarify quantity #3634

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

HansOlsson
Copy link
Collaborator

Based on comment in #3626

Based on comment in modelica#3626
@@ -599,6 +599,10 @@ \section{Restrictions of Connections and Connectors}\label{restrictions-of-conne
\end{nonnormative}
\item\label{connect-set-quantity-rule}\index{quantity@\robustinline{quantity}!connect set rule}
In a connection set, all variables having non-empty \lstinline!quantity!-attribute must have the same \lstinline!quantity!-attribute.
\begin{nonnormative}
Note that variables with different quantities may be unit-compatible, in particular Work and Torque.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's not mix in the MSL convention of how to capitalize quantities:

Suggested change
Note that variables with different quantities may be unit-compatible, in particular Work and Torque.
Note that variables with different quantities may be unit-compatible, in particular work and torque.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe formulate as an example?

Suggested change
Note that variables with different quantities may be unit-compatible, in particular Work and Torque.
Note that variables with different quantities may be unit-compatible, as illustrated by work and torque.

or

Suggested change
Note that variables with different quantities may be unit-compatible, in particular Work and Torque.
Note that variables with different quantities may be unit-compatible, and as seen in the example of work and torque, the typical choice of units may even be identical (newton-meter).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I will take the first one, as work doesn't normally have unit newton-meter, but joule that I would more say is compatible with newton-meter and adding all of that will be too long.
I haven't heard of any other similar issues, so I think it is more the example than an example - that's why "in particular" makes the most sense to me.

Copy link
Collaborator

@henrikt-ma henrikt-ma Jan 8, 2025

Choose a reason for hiding this comment

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

Heard about angles and all dimensionless quantities? :) Then there are also all the quantities building upon work/torque and angle/dimensionless…

Copy link
Collaborator

@henrikt-ma henrikt-ma left a comment

Choose a reason for hiding this comment

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

At least, I think quantities shouldn't have upper camel case in this document.

Co-authored-by: Henrik Tidefelt <[email protected]>
@HansOlsson HansOlsson added this to the 2025-January milestone Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants