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

Unify spelling of controllers #3814

Closed
christiankral opened this issue May 22, 2021 · 13 comments · Fixed by #4136
Closed

Unify spelling of controllers #3814

christiankral opened this issue May 22, 2021 · 13 comments · Fixed by #4136
Assignees
Labels
discussion Discussion issue that it not necessarily related to a concrete bug or feature needsinput Issue lacks enough information to make progress on it
Milestone

Comments

@christiankral
Copy link
Contributor

In Modelica.Blocks.Continuous the controllers are spelled, for example, the following way:

  • PI-controller
  • PID-controller

In Electropedia the following spelling is used:

  • PI element or proportional plus integral element
  • PID element or proportional plus integral plus derivative element

From my understanding it would thus also makes sense to omit the dash when using the term controller instead of element:

  • PI controller or proportional plus integral controller
  • PID controller or proportional plus integral plus derivative controller

A comment from a native English speaking person is highly appreciated here. Possibly @mtiller or @harmanpa could comment here.

Once decided, this shall be documented in Modelica.UsersGuide.Conventions.Terms.Electrical.

@christiankral christiankral added the discussion Discussion issue that it not necessarily related to a concrete bug or feature label May 22, 2021
@christiankral christiankral self-assigned this May 22, 2021
@AHaumer
Copy link
Contributor

AHaumer commented May 26, 2021

Personally, I dislike the term "PI element", as well as "proportional plus integral controller".
What's the difference between "PI-controller" and "PI controller"?
For me, "PI-controller" is somehow easier to read. Maybe we shouldn't look at Wikipedia, but into a textbook about control theory written by a native speaker.

@christiankral
Copy link
Contributor Author

I do not focus in the term element. To me this ticket is simply a matter of using the dash or not: PI-controller or PI controller. I somehow guess that the dash is not correct and I base my suspicion on Electropedia.

I makes, however, sense to unify the spelling all over the MSL and add the correct spelling to Modelica.UsersGuide.Conventions.Terms.Electrical.

@christiankral christiankral added the needsinput Issue lacks enough information to make progress on it label May 27, 2021
@christiankral
Copy link
Contributor Author

So this issue needs input from a native English speaker please.

@christiankral
Copy link
Contributor Author

@mtiller Could you possibly help here?

@christiankral
Copy link
Contributor Author

@harmanpa @mtiller Could you please comment on this spelling issue?

@harmanpa
Copy link
Member

harmanpa commented Jul 4, 2022

I would write "PI controller" / "PID controller"

@christiankral
Copy link
Contributor Author

Thanks @harmanpa, this makes sense. We shall omit the dash then.

@dietmarw
Copy link
Member

Grammerly agrees with @harmanpa on this. So we should implement it.

@TManikantan
Copy link
Contributor

TManikantan commented May 5, 2023

I have short listed the instances to which changes have to be made.
1.Modelica.Mechanics.MultiBody.Examples.Systems.RobotR3.Utilities.Controller (changes in documentation).
2.Modelica.Electrical.Machines.Utilities.DQCurrentController (changes in documentation).
3.Modelica.Electrical.Machines.Examples.ControlledDCDrives.Utilities.LimitedPI (changes in class description).
4.Modelica.Blocks.Continuous.PID (changes in Documentation and class Description).

Other than these i noticed that some documentation also carry the spelling "P-controller" .

1.Modelica.Mechanics.MultiBody.Examples.Systems.RobotR3.Utilities.Controller (Documentation).
2.Modelica.Electrical.Machines.Examples.ControlledDCDrives.Utilities.LimitedPI (Documentation).
3. Modelica.Blocks.Continuous.LimPID (Documentation) .
4. Modelica.Clocked.Examples.Systems.ControlledMixingUnit (Documentation).

Should i go ahead and make changes to above mentioned instances? If yes, Should i also change P-controller to P controller ?

@christiankral
Copy link
Contributor Author

Should i go ahead and make changes to above mentioned instances? If yes, Should i also change P-controller to P controller ?

So I am in favor of applying these changes.

@tobolar
Copy link
Contributor

tobolar commented May 23, 2023

I have short listed the instances to which changes have to be made. ...

What about

  • "OnOff-controller" in Thermal.HeatTransfer.Examples.ControlledTemperature and
  • "Voltage-Frequency-Controller" in Electrical.Machines.Utilities.VfController and Magnetic.QuasiStatic.FundamentalWave.Utilities.VfController?

(Btw. do we need both "VfControllers"? They seem to be quite similar!)

@christiankral
Copy link
Contributor Author

(Btw. do we need both "VfControllers"? They seem to be quite similar!)

Yes we do, as they have different connectors.

@christiankral
Copy link
Contributor Author

What about

  • "OnOff-controller" in Thermal.HeatTransfer.Examples.ControlledTemperature and
  • "Voltage-Frequency-Controller" in Electrical.Machines.Utilities.VfController and Magnetic.QuasiStatic.FundamentalWave.Utilities.VfController?

They also need different spelling.

@beutlich beutlich added this to the MSL4.1.0 milestone Aug 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Discussion issue that it not necessarily related to a concrete bug or feature needsinput Issue lacks enough information to make progress on it
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants