This library follows the conventions of the Modelica Standard
Library, which are as follows:
Note, in the html documentation of any Modelica library, the
headings "h1, h2, h3" should not be used, because they are utilized
from the automatically generated documentation and headings.
Additional headings in the html documentation should start with
"h4".
In the Modelica package the following conventions are used:
- 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".
- Class names start always with an upper case letter.
- 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).
- 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.
- 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.
- The instance name of a component is always displayed in
its icon (= text string "%name") in blue color. A connector
class has the instance name definition in the diagram layer and not
in the icon layer. 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.
- A main package has usually the following subpackages:
- UsersGuide containing an overall description of the
library and how to use it.
- Examples containing models demonstrating the usage of
the library.
- Interfaces containing connectors and partial
models.
- Types containing type, enumeration and choice
definitions.
The Buildings
library uses the following
conventions in addition to the ones of the Modelica Standard
Library:
- The nomenclature used in the package Buildings.Utilities.Psychrometrics
is as follows,
- Uppercase
X
denotes mass fraction per total
mass.
- Lowercase
x
denotes mass fraction per mass of dry
air.
- The notation
z_xy
denotes that the function or
block has output z
and inputs x
and
y
.
- The symbol
pW
denotes water vapor pressure,
TDewPoi
denotes dew point temperature,
TWetBul
denotes wet bulb temperature, and
TDryBul
(or simply T
) denotes dry bulb
temperature.
- Names of models, blocks and packages should start with an
upper-case letter and be a noun or a noun with a combination of
adjectives and nouns. Use camel-case notation to combine multiple
words, such as
HeatTransfer
.
- Parameter and variables names are usually a character, such as
T
for temperature and p
for pressure, or
a combination of the first three characters of a word, such as
higPreSetPoi
for high pressure set point.
- Comments should be added to each class (package, model,
function etc.). The first character should be upper case. For
one-line comments of parameters, variables and classes, no period
should be used at the end of the comment.
- Where applicable, all variable must have units, also if the
variable is protected.
- To indicate that a class (i.e., a package, model, block etc.)
has not been extensively tested or validated, its class name ends
with the string
Beta
.
Generated at 2021-03-05T02:00:49Z by OpenModelicaOpenModelica
1.18.0~dev-116-gde4b0c0 using GenerateDoc.mos