modelConventions
Conventions
Extends from Modelica.Icons.Information (Icon for general information packages).
Information
The team behind OpenIPSL strives to achieve a harmonized development of the library to facilitate its usability and integration into other services.
Here are some naming conventions that we try to obey:
- Names of the parameters and variables should correspond to those found in the respective documentation.
- Subscript should be denoted in Modelica with underscore, e.g.,
T_rorK_1. Note: some parameter names have first upper case letters and others lower case. - Deviation signals such as Δω, should be written as
domegain Modelica. - Parameters which are not to be entered by user and variables which are not to be seen by users should be protected.
- Parameters and variables should be declared as their specific type such as
Types.ApparentPowerfor variables that are declared in MVA. Note: if the proper unit is not represented in Types, units available in Modelica's SI (Systeme Internationale) should be used.