Modelica.UsersGuide.Conventions.ModelicaCode Modelica.UsersGuide.Conventions.ModelicaCode




In this section the
naming conventions of class and instance names, parameters and variables are specified. Additionally some
format UsersGuide are stated.




Extends from Modelica.Icons.Information (Icon for general information packages).

Package Content




NameDescription


Modelica.UsersGuide.Conventions.ModelicaCode.Format Format
Format


Modelica.UsersGuide.Conventions.ModelicaCode.Naming Naming
Naming convention








Modelica.UsersGuide.Conventions.ModelicaCode.Format
Modelica.UsersGuide.Conventions.ModelicaCode.Format





    

  1.  In the icon of a component the instance name is displayed
     (text string %name) in blue color.
     Parameter values, e.g., resistance, mass, gear ratio, are displayed
     in the icon in black color in a smaller font size as the instance name.
    2. 

  2.  Comments and annotations always start with a capital letter, e.g.,
     parameter Real a = 1 "Arbitrary factor";
    3. 





Extends from Modelica.Icons.Information (Icon for general information packages).





Modelica.UsersGuide.Conventions.ModelicaCode.Naming
Modelica.UsersGuide.Conventions.ModelicaCode.Naming





    

  1.  Class and instance names are written in upper and lower case
     letters, e.g., ElectricCurrent. An underscore is only used
     at the end of a name to characterize a lower or upper index,
     e.g., pin_a.
    2. 


  2.  Class names start always with an upper case letter.
    3. 


  3.  Instance names, i.e., names of component instances and
     of variables (with the exception of constants),
     start usually with a lower case letter with only
     a few exceptions if this is common sense
     (such as T for a temperature variable).
    4. 


  4.  Constant names, i.e., names of variables declared with the
     "constant" prefix, follow the usual naming conventions
     (= upper and lower case letters) and start usually with an
     upper case letter, e.g., UniformGravity, SteadyState.
  5. 


  6.  The two connectors of a domain that have identical declarations
     and different icons are usually distinguished by _a, _b
     or _p, _n, e.g., Flange_a, Flange_b,
     HeatPort_a, HeatPort_b.
    7. 


  7.  A connector class has the instance
     name definition in the diagram layer and not in the icon layer.
    8. 




Variable names


In the following table typical variable names are listed. This list should be completd.




   Variables and names
   

      Variable
      Quantity
    

     

      a
      acceleration
    

    

      A
      area
    

    

      C
      Capacitance
    

    

      d
      damping, density, diameter
    

    

      dp
      pressureDrop
    

    

      e
      specificEntropy
    

    

      E
      energy, entropy
    

    

      eta
      efficiency
    

    

      f
      force, frequency
    

    

      G
      conductance
    

    

      H
      enthalpy
    

    

      h
      height, specificEnthalpy
    

    

      HFlow
      enthalpyFlow
    

    

      i
      current
    

    

      J
      inertia
    

    

      l
      length
    

    

      L
      Inductance
    

    

      m
      mass
    

    

      M
      mutualInductance
    

    

      mFlow
      massFlow
    

    

      P
      power
    

    

      p
      pressure
    

    

      Q
      heat
    

    

      Qflow
      heatFlow
    

    

      r
      radius
    

    

      R
      radius, resistance
    

    

      t
      time
    

    

      T
      temperature
    

    

      tau
      torque
    

    

      U
      internalEnergy
    

    

      v
      electricPotential, specificVolume, velocity, voltage
    

    

      V
      volume
    

    

      w
      angularVelocity
    

    

      X
      reactance
    

    

      Z
      impedance
    





Extends from Modelica.Icons.Information (Icon for general information packages).



Automatically generated Fri Nov 12 16:27:29 2010.