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

Naming of analog sources #3305

Open christiankral opened 4 years ago

christiankral commented 4 years ago

The package Modelica.Electrical.Analog.Sources contains models which naming we may want to re-consider:

Two questions arise to me (certainly the same questions for voltage and current sources):

  1. Is ExponentialsVoltage correct (which sounds plural to me) or shall it be `ExponentialVoltage?
  2. Shall we change ExpSineCurrent to ExponentialSineCurrent (or ExponentialsSineCurrent?) in order to not use abbreviations. The length of the class name shall not be an issue here, as we have much longer names in this package, too:

image

In addition to the library officers, hopefully a native English speaking person wants to contribute here.

AHaumer commented 4 years ago

IMHO ExponentialSineVoltage is correct since the amplitude of the sine is exponentially damped, and yes it is a good idea to get rid of these abbreviations. ExponentialVoltage is misleading, I'd expect a voltage varyimg exponentially with respect to time. ExponentialsSineVoltage (plural) is wrong since we have only one exponential (i.e. the variation of amplitude). We shouldn't forget Modelica.Blocks.Sources.ExpSine! ExponentialsVoltage (plural) sound correct to me since we have a rising and a falling exponential with different time constants. Of course all said applies to Current sources, too.

beutlich commented 4 years ago

Removing milestone.