search

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
481 stars 169 forks source link

Quantity name "Relative magnetization" doesn't follow upper camel case convention #4110

Open henrikt-ma opened 1 year ago

henrikt-ma commented 1 year ago

This quantity does not follow the MSL convention of using upper camel case names: https://github.com/modelica/ModelicaStandardLibrary/blob/70510914bbf626136352a25b1192a9b3f2e6ce81/Modelica/Magnetic/FluxTubes/BaseClasses/GenericHysteresis.mo#L19

A more suitable name would be "RelativeMagnetization".

Ideally, the quantity should also be defined in a place like Modelica.Units.SI, where others can find it, to avoid ending up with multiple strings for the same quantity.

henrikt-ma commented 1 year ago

I suppose one could also define quantities on the sub-library level if they are considered too narrow for Modelica.Units, similar to Fluid, for example: https://github.com/modelica/ModelicaStandardLibrary/blob/70510914bbf626136352a25b1192a9b3f2e6ce81/Modelica/Fluid/Types.mo#L6

In addition to "RelativeMagnetization", also "MagneticFluxDensitySlope" should be defined in a central location to avoid ending up with many strings for the same quantity.