Integrating Units into Library Objects

In ParamML, all parameters may take unit type, abbreviated as UT, and unit category, abbreviated as UC, attributes.

<P N="UnitLength" V="12" UT="Length" UC="Geometry" />

<P N="UnitForce" V="10" UT="Force" UC="Geometry" />

<P N="UnitStress" V="30" UT="Stress" UC="Geometry" />

The unit type refers to what the unit represents, such as length, force, or stress. The unit category indicates the category in which the unit should belong. These categories are defined within 'Base_DesignSubUnits,' and the unit categories from this library object should be used in the library objects to be written.

<O N="Base_DesignSubUnits" T="Project" Category="Code Check Objects:Code Check Sub Objects" TransAlignRule="Right" Tags="@input,usastandard,steelIGirder,precastIGirder,splicedIGirder,concreteBoxGirder,steelTubGirder,release">
    <O N="Internal" T="Unit" Length="Inch" Force="Kip" Angle="Radian" Temperature="Fahrenheit" />
    <O N="USUnits" T="Group" Guard="UnitSystem.NE.1">
        <O N="Geometry" T="Unit" Length="Feet" Force="Kip" Angle="Degree" Temperature="Fahrenheit" />
        <O N="Property" T="Unit" Length="Inch" Force="Kip" Angle="Radian" Temperature="Fahrenheit" />
        <O N="DR_StructU" T="Unit" Length="Feet" Force="Kip" Angle="Degree" Temperature="Fahrenheit" Label="Structure Dimensions such as span lengths etc." />
        <O N="DR_PropU1" T="Unit" Length="Inch" Force="Kip" Angle="Degree" Temperature="Fahrenheit" Label="Section inertia, area, length, radius of gyration etc." />
        <O N="DR_PropU2" T="Unit" Length="Inch" Force="Kip" Angle="Degree" Temperature="Fahrenheit" Label="Material properties such as E, Fy etc." />
        <O N="DR_PropU3" T="Unit" Length="Inch" Force="Pound" Angle="Degree" Temperature="Fahrenheit" Label="Material properties such as Fc" />
        <O N="DR_PropU4" T="Unit" Length="Feet" Force="Pound" Angle="Degree" Temperature="Fahrenheit" Label="Material properties such as unit weight" />
        <O N="DR_LoadU1" T="Unit" Length="Inch" Force="Kip" Angle="Degree" Temperature="Fahrenheit" Label="Point load unit" />
        <O N="DR_LoadU2" T="Unit" Length="Feet" Force="Kip" Angle="Degree" Temperature="Fahrenheit" Label="Line load unit" />
        <O N="DR_LoadU3" T="Unit" Length="Feet" Force="Pound" Angle="Degree" Temperature="Fahrenheit" Label="Area load unit" />
        <O N="DR_ForceU" T="Unit" Length="Feet" Force="Kip" Angle="Degree" Temperature="Fahrenheit" Label="Force and moment unit" />
        <O N="DR_StressU" T="Unit" Length="Inch" Force="Kip" Angle="Degree" Temperature="Fahrenheit" Label="Stress unit" />
        <O N="DR_DispU" T="Unit" Length="Inch" Force="Kip" Angle="Degree" Temperature="Fahrenheit" Label="Displacement unit" />
        <O N="ForceUnit" T="Unit" Length="Feet" Force="Kip" Angle="Degree" Temperature="Fahrenheit" Label="Force and moment unit" />
        <O N="DR_WeighDispU" T="Unit" Length="Inch" Force="USTon" Angle="Degree" Temperature="Fahrenheit" D="Weight unit" />
    </O>
    <O N="SIUnits" T="Group" Guard="UnitSystem.EQ.1">
        <O N="Geometry" T="Unit" Length="Meter" Force="KiloNewton" Angle="Degree" Temperature="Celsius" />
        <O N="Property" T="Unit" Length="Millimeter" Force="KiloNewton" Angle="Radian" Temperature="Celsius" />
        <O N="DR_StructU" T="Unit" Length="Meter" Force="KiloNewton" Angle="Degree" Temperature="Celsius" Label="Structure Dimensions such as span lengths etc." />
        <O N="DR_PropU1" T="Unit" Length="Millimeter" Force="KiloNewton" Angle="Degree" Temperature="Celsius" Label="Section inertia, area, length, radius of gyration etc." />
        <O N="DR_PropU2" T="Unit" Length="Millimeter" Force="KiloNewton" Angle="Degree" Temperature="Celsius" Label="Material properties such as E, Fy etc." />
        <O N="DR_PropU3" T="Unit" Length="Millimeter" Force="Newton" Angle="Degree" Temperature="Celsius" Label="Material properties such as Fc" />
        <O N="DR_PropU4" T="Unit" Length="Meter" Force="Newton" Angle="Degree" Temperature="Celsius" Label="Material properties such as unit weight" />
        <O N="DR_LoadU1" T="Unit" Length="Millimeter" Force="KiloNewton" Angle="Degree" Temperature="Celsius" Label="Point load unit" />
        <O N="DR_LoadU2" T="Unit" Length="Meter" Force="KiloNewton" Angle="Degree" Temperature="Celsius" Label="Line load unit" />
        <O N="DR_LoadU3" T="Unit" Length="Meter" Force="Newton" Angle="Degree" Temperature="Celsius" Label="Area load unit" />
        <O N="DR_ForceU" T="Unit" Length="Meter" Force="KiloNewton" Angle="Degree" Temperature="Celsius" Label="Force and moment unit" />
        <O N="DR_StressU" T="Unit" Length="Millimeter" Force="Newton" Angle="Degree" Temperature="Celsius" Label="Stress unit" />
        <O N="DR_DispU" T="Unit" Length="Millimeter" Force="KiloNewton" Angle="Degree" Temperature="Celsius" Label="Displacement unit" />
        <O N="ForceUnit" T="Unit" Length="Meter" Force="KiloNewton" Angle="Degree" Temperature="Celsius" Label="Force and moment unit" />
        <O N="DR_WeighDispU" T="Unit" Length="Millimeter" Force="MetricTon" Angle="Degree" Temperature="Celsius" D="Weight unit" />
    </O>
</O>

As can be observed in the examples below, the 'Base_DesignSubUnits' object can be extended and utilized in the developed object. Thanks to this, all the unit categories present in the unit library object can be utilized.

In case of a specific scenario, new Unit Types can be added and their attributes completed by overriding. If the unit category is employed within the object without extending, the added Unit Types will be introduced. This circumstance has the potential to disrupt the architecture of the SI and US unit systems.

In OpenBrIM, calculations are performed through the 'Internal' setting. Therefore, the calculations are based on the US unit system. However, to enable the display of the SI unit system within the app or project, the 'UnitSystem' parameter has been added to projects. Thanks to the 'UnitSystem' parameter, you can convert the project to the SI unit system. For this to work accurately, every parameter with a unit in the app, which is displayed, must have a defined unit type and unit category.

To change the UnitSystem within the project, you can click on the 'Params' button and select the desired unit.

For this concept to work correctly within the project's spreadsheet, document, CADD, and criteria check units, the following considerations should be taken into account:

| | Description | Incorrect Example | Correct Example | | --- | --- | --- | | 1 | The missing UT and UC of parameters related to the units of area and section modulus. | | | | 2 | If you are using the parameters within a document and the unit is missing, in the 'where' section, it will display the values without showing the unit and will display the result in the default value.

| 3 | The assigned Unit Category to parameters must be defined within the project. Therefore, ensure that the given UC value is within 'Base_DesignSubUnits' to make sure it is valid.

| 4 | The Internal Unit Category should not be defined at the parameter. Instead, Property should be used. Because in the US unit system, Internal and Property are completely equivalent. However, in the SI unit system, Internal behaves according to the US unit system. For this reason, a different category should be used instead of Internal. | | | | 5 | Dividing by 12 is not the correct way to convert inches to feet in the US unit system. Instead, the 'convert' function should be used to accurately convert and transform to feet. | | | | 6 | Creating an interaction diagram by simply dividing by 12 without converting works correctly in the Internal category, but it is definitely incorrect in the SI unit system. To correct this, the data sent to the graph should be converted, and the axis labels of the graph should be provided using the 'unitlabel' to ensure works properly. | | | | 7 | Unit labels commonly used for headings should not be hard-coded. Instead, the 'unitlabel' function should be used.

8 | When using CADDDimensionLine to display length in CADD objects, ‘convert' or 'withunits’ functions should also be used. Within CADDDimensionLines, the Label must be defined, and the length should be displayed by converting it. | | | | 9 | Check objects can also have units. After properly defining the UT and UC of the parameters within the created 'Criteria' parameter, the UT and UC of the result parameter should be defined according to the appropriate result unit.

| 10 | In summary, all parameters containing units must have defined UT and UC. This consideration is essential in CADD representations, graph data within documents, input parameters taken using spreadsheets, and parameters within criteria objects. | | |