class Naming "Naming convention"
extends Modelica.Icons.Information;
annotation (Documentation(info = "<html>\n\n<ol>\n<li> <strong>Class and instance names</strong> are usually written in upper and lower case\n letters, e.g., \"ElectricCurrent\". An underscore may be used in names.\n However, it has to be taken into account that the last underscore in a\n name might indicate that the following characters are rendered as a subscript.\n Example: \"pin_a\" may be rendered as \"pin<sub>a</sub>\".</li>\n\n<li> <strong>Class names</strong> start always with an upper case letter,\n with the exception of functions, that start with a lower case letter.</li>\n\n<li> <strong>Instance names</strong>, i.e., names of component instances and\n of variables (with the exception of constants),\n start usually with a lower case letter with only\n a few exceptions if this is common sense\n (such as <code>T</code> for a temperature variable).</li>\n\n<li> <strong>Constant names</strong>, i.e., names of variables declared with the\n \"constant\" prefix, follow the usual naming conventions\n (= upper and lower case letters) and start usually with an\n upper case letter, e.g., UniformGravity, SteadyState.</li>\n\n<li> The two <strong>connectors</strong> of a domain that have identical declarations\n and different icons are usually distinguished by <code>_a</code>, <code>_b</code>\n or <code>_p</code>, <code>_n</code>, e.g., <code>Flange_a</code>, <code>Flange_b</code>,\n <code>HeatPort_a</code>, <code>HeatPort_b</code>.</li>\n\n<li> A <strong>connector class</strong> has the instance\n name definition in the diagram layer and not in the\n <a href=\"modelica://Modelica.UsersGuide.Conventions.Icons\">icon</a> layer.</li>\n</ol>\n\n<h4>Variable names</h4>\n<p>In the following table typical variable names are listed. This list should be completed.</p>\n\n<table border=\"1\" cellpadding=\"2\" cellspacing=\"0\" >\n <caption align=\"bottom\">Variables and names</caption>\n <tr>\n <th>Variable</th>\n <th>Quantity</th>\n </tr>\n <tr>\n <td>a</td>\n <td>acceleration</td>\n </tr>\n <tr>\n <td>A</td>\n <td>area</td>\n </tr>\n <tr>\n <td>C</td>\n <td>capacitance</td>\n </tr>\n <tr>\n <td>d</td>\n <td>damping, density, diameter</td>\n </tr>\n <tr>\n <td>dp</td>\n <td>pressureDrop</td>\n </tr>\n <tr>\n <td>e</td>\n <td>specificEntropy</td>\n </tr>\n <tr>\n <td>E</td>\n <td>energy, entropy</td>\n </tr>\n <tr>\n <td>eta</td>\n <td>efficiency</td>\n </tr>\n <tr>\n <td>f</td>\n <td>force, frequency</td>\n </tr>\n <tr>\n <td>G</td>\n <td>conductance</td>\n </tr>\n <tr>\n <td>H</td>\n <td>enthalpy</td>\n </tr>\n <tr>\n <td>h</td>\n <td>height, specificEnthalpy</td>\n </tr>\n <tr>\n <td>HFlow</td>\n <td>enthalpyFlow</td>\n </tr>\n <tr>\n <td>i</td>\n <td>current</td>\n </tr>\n <tr>\n <td>J</td>\n <td>inertia</td>\n </tr>\n <tr>\n <td>l</td>\n <td>length</td>\n </tr>\n <tr>\n <td>L</td>\n <td>Inductance</td>\n </tr>\n <tr>\n <td>m</td>\n <td>mass</td>\n </tr>\n <tr>\n <td>M</td>\n <td>mutualInductance</td>\n </tr>\n <tr>\n <td>mFlow</td>\n <td>massFlow</td>\n </tr>\n <tr>\n <td>P</td>\n <td>power</td>\n </tr>\n <tr>\n <td>p</td>\n <td>pressure</td>\n </tr>\n <tr>\n <td>Q</td>\n <td>heat</td>\n </tr>\n <tr>\n <td>Qflow</td>\n <td>heatFlow</td>\n </tr>\n <tr>\n <td>r</td>\n <td>radius</td>\n </tr>\n <tr>\n <td>R</td>\n <td>radius, resistance</td>\n </tr>\n <tr>\n <td>t</td>\n <td>time</td>\n </tr>\n <tr>\n <td>T</td>\n <td>temperature</td>\n </tr>\n <tr>\n <td>tau</td>\n <td>torque</td>\n </tr>\n <tr>\n <td>U</td>\n <td>internalEnergy</td>\n </tr>\n <tr>\n <td>v</td>\n <td>electricPotential, specificVolume, velocity, voltage</td>\n </tr>\n <tr>\n <td>V</td>\n <td>volume</td>\n </tr>\n <tr>\n <td>w</td>\n <td>angularVelocity</td>\n </tr>\n <tr>\n <td>X</td>\n <td>reactance</td>\n </tr>\n <tr>\n <td>Z</td>\n <td>impedance</td>\n </tr>\n</table>\n</html>"));
end Naming;