Skip to content

Namespaces

Jonas Reuter-Schniete edited this page May 21, 2024 · 16 revisions

For naming, follow the conventions of the Buildings.UsersGuide. Further details or deviations are explained below.

General

Class, instance and constant names may contain numbers.

Constant Names

Constant names, i.e., names of variables declared with the constant prefix, usually start with an upper case letter with only a few exceptions if this is common sense e.g. pi, cp.

Sensor Names

Sensors are named in the following format: Sen<Measurement><FlowDirection>. Measurement and flow direction are used as explained above. The resulting sensor names for instances of temperature sensors in both flow directions (supply and return) would be senTSup and senTRet

Frequently used strings

  • Start variables: e.g. T_start, p_start ...
  • Indices of ports: e.g. port_a, port_b, heatPort_x1, heatPort_x2, radiationPort_in, radiationPort_out ...
  • Constant variables: e.g. x_const ...

Bus Connector

For further guidelines concerning expandable connectors refer to bus connector conventions.

Exceptions

The following table contains variable names that do not conform to the naming conventions in the Buildings.UsersGuide. A distinction is made between existing naming(s), for example due to old models, and desired naming as chosen exceptions from the convention. It is not (yet) a complete list of all exceptions to the naming conventions.

Meaning Existing naming(s) Desired naming SI unit Modelica type
Absolute humidity X, hum absHum kg/kg Modelica.Units.SI.MassFraction
Air path flow exponent m 1 Real
Area A, area A m2 Modelica.Units.SI.Area
Convective heat transfer coeff. hCon hCon W/(m2.K) Modelica.Units.SI.SurfaceCoefficientOfHeatTransfer
Current I I A Modelica.Units.SI.Current
Density rho in .Movers but d in .Sensors and .Media rho kg/m3 Modelica.Units.SI.Density
Diameter diameter, d, D, diam d m Modelica.Units.SI.Diameter
Efficiency eta, eff eta 1 Modelica.Units.SI.Efficiency
Electrical resistance R R Ohm Modelica.Units.SI.Resistance * *
Heat capacity C C J/K Modelica.Units.SI.HeatCapacity
Heat conductivity lambda, k lambda W/(m.K) Modelica.Units.SI.ThermalConductivity
Height height, h height m Modelica.Units.SI.Length
Internal energy U U J Modelica.Units.SI.Energy
Kinematic viscosity nu nu m2/s Real
Latitude of the location lat, Latitude, latitude lat deg Modelica.Units.SI.Angle
Length length len m Modelica.Units.SI.Length
Longitude of the location Longitude lon deg BuildingSystems.Types.Angle_deg
Long-wave emittance eps, a, emissivity eps 1 Modelica.Units.SI.Emissivity
Mass m m kg Modelica.Units.SI.Mass
Number of something (1,2,3,...) n, N n 1 Real
Prandtl number Pr Pr 1 Modelica.Units.SI.PrandtlNumber
Relative humidity relHum, phi relHum 1 Real
Reynolds number Re Re 1 Modelica.Units.SI.ReynoldsNumber
Short-wave absorptance solar_absorptance solabs 1 BuildingSystems.Types.Absorptance
Solar irradiation H, I H W/m2 Modelica.Units.SI.RadiantEnergyFluenceRate
Spec. heat capacity (const. p) cp cp J/(kg.K) Modelica.Units.SI.SpecificHeatCapacityAtConstantPressure
Specific enthalpy h h J/kg Modelica.Units.SI.SpecificEnthalpy
Specific heat capacity c c J/(kg.K) Modelica.Units.SI.SpecificHeatCapacity
Thermal conductance UA, C UA W/K Modelica.Units.SI.ThermalConductance
Thickness thickness, d, s s m Modelica.Units.SI.Thickness
Time time time s Modelica.Units.SI.Time
Transmittance tau tau 1 Real
Velocity v, velocity vel m/s Modelica.Units.SI.Velocity
Voltage V V V Modelica.Units.SI.Voltage
Volume V, vol, volume V m3 Modelica.Units.SI.Volume
Width width width m Modelica.Units.SI.Length

Architecture

Clone this wiki locally