modelica / ModelicaStandardLibrary

Free (standard conforming) library to model mechanical (1D/3D), electrical (analog, digital, machines), magnetic, thermal, fluid, control systems and hierarchical state machines. Also numerical functions and functions for strings, files and streams are included.
https://doc.modelica.org
BSD 3-Clause "New" or "Revised" License
472 stars 168 forks source link

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

Open beutlich opened 6 years ago

beutlich commented 6 years ago

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

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

See #2424.

tobolar commented 6 years ago

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

Then:

MartinOtter commented 6 years ago

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 commented 6 years ago

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

beutlich commented 6 years ago

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.

beutlich commented 5 years ago

@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?