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

Rename parameters of Modelica.Mechanics.MultiBody.Visualizers.Plane #2485

Open
beutlich opened this issue Mar 6, 2018 · 5 comments
Open
Assignees
Labels
L: Mechanics.MultiBody Issue addresses Modelica.Mechanics.MultiBody task General work that is not related to a bug or feature
Milestone

Comments

@beutlich
Copy link
Member

beutlich commented Mar 6, 2018

Parameters of Modelica.Mechanics.MultiBody.Visualizers.Plane are labeled axis_[xy], length_[xy] and n[xy]. Setting axis_x to {0,1,0} and axis_y to {1,0,0} might cause some confusion. I rather would like to use the same naming convention as Modelica.Mechanics.MultiBody.Visualizers.FixedShape do, e.g., rename

  • axis_x -> lengthDirection
  • axis_y -> widthDirection
  • length_x -> length
  • length_y -> width

For the discretization parameters I am not that sure and simply propose

  • nx -> n
  • ny -> m

See #2424.

@beutlich beutlich added enhancement New feature or enhancement L: Mechanics.MultiBody Issue addresses Modelica.Mechanics.MultiBody labels Mar 6, 2018
@beutlich beutlich added this to the maintenance milestone Mar 6, 2018
@tobolar
Copy link
Contributor

tobolar commented Mar 6, 2018

You are right.
For surfaces, there are generally used directions u and v. So what about to simply change

  • [xy] -> [uv]?

Then:

  • axis_x -> direction_u
  • axis_y -> direction_v
  • length_x -> length_u
  • length_y -> length_v
  • nx -> nu
  • ny -> nv

@MartinOtter
Copy link
Member

Please do not make such changes without larger discussion.
It was a mistake to introduce "length", "width" etc. in the MultiBody library, because it is not clear whether this is a distance in x,y, or z direction. It is much clearer, if "x", "y", "z" are appended in the name, because it is then completely clear, without reading the documentation, which coordinate axis is meant.

Therefore, if you make changes, do it the other way round, so replace lengthDirection by direction_x or something like that.

@beutlich
Copy link
Member Author

beutlich commented Mar 6, 2018

I feel more comfortable with the names I proposed above. But let us discuss it in larger group.

@beutlich
Copy link
Member Author

beutlich commented Mar 6, 2018

t was a mistake to introduce "length", "width" etc. in the MultiBody library

If you consider it now as a mistake, we really should have a GitHub issue for such kind of issues. Otherwise, we will never find out or remember.

tobolar added a commit that referenced this issue Apr 10, 2018
…mponent 'Plane' to 'Rectangle'; and B) refs #2485: In Modelica.Mechanics.MultiBody.Visualizers.Rectangle renamed components parameters
@beutlich beutlich modified the milestones: maintenance, MSL4.0.0 Jul 13, 2019
@beutlich beutlich added task General work that is not related to a bug or feature and removed enhancement New feature or enhancement labels Jul 13, 2019
@beutlich
Copy link
Member Author

@tobolar I set the milestone to MSL4.0.0 in case we want to do some renaming. Can you please propose your changes fixing the "mistakes" in the MultiBody lib?

@beutlich beutlich removed this from the MSL4.0.0 milestone Jan 24, 2020
@tobolar tobolar added this to the MSL5.0.0 milestone Sep 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
L: Mechanics.MultiBody Issue addresses Modelica.Mechanics.MultiBody task General work that is not related to a bug or feature
Projects
None yet
Development

No branches or pull requests

3 participants