Unify spelling of controllers

[christiankral]

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.

[AHaumer]

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]

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]

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

[christiankral]

@mtiller Could you possibly help here?

[christiankral]

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

[harmanpa]

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

[christiankral]

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

[dietmarw]

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

[TManikantan]

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]

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]

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]

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

Yes we do, as they have different connectors.

[christiankral]

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.