{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Unit objects are used to establish a unit system within a project. A project can have one or more unit systems. If no Unit object is defined, the entire project is assumed to be in a single unit system.","type":"text"}]},{"type":"paragraph","content":[{"text":"The first Unit object must be named 'Internal' and is used to define the internal unit system of the project. Having a consistent internal unit system makes it easier to write parametric expressions.","type":"text"}]},{"type":"paragraph","content":[{"text":"Once an internal unit system is defined, it's possible to create additional unit systems to make input easier for the end user. For example, the author of the project can create multiple unit systems named 'Section', 'Coordinate', 'Displacement' etc. Any parameter that has a unit category that matches the name of the Unit object will use that particular Unit system for end-user input. The Unit object named 'Internal' will be used for internal computation.","type":"text"}]},{"type":"paragraph","content":[{"text":"If a Unit object named 'Default' exists in the project, all parameters that do not have a defined unit category are assumed to be in the 'Default' unit category.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Example Syntax","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"...\n\n...\n...\n","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"b9210f32-4c7a-4efc-aa2b-fb14e9d67a3f"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[340.0,340.0]},"content":[{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n \n ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[340.0,340.0]},"content":[{"type":"paragraph","content":[{"text":"Once three \"Unit\" objects have been created in the project as described above, we can assign a specific parameter to a created parameter by specifying its Unit Category (UC) and Unit Type (UT). ","type":"text"}]},{"type":"paragraph","content":[{"text":"The Unit Category (UC) specifies the name that the parameter will be assigned to, while the Unit Type (UT) indicates what the parameter represents. ","type":"text"}]},{"type":"paragraph","content":[{"text":"If the Unit Category (UC) matches the name of one of the \"Unit\" objects, the parameter will use the unit system that it matches.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[340.0,340.0]},"content":[{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n \n \n \n

\n \n","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter A will specify a length (UT) and its unit will be centimeters.","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"The B parameter will also specify a length (UT) and its unit will be meters.","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"The C parameter will also specify an angle (UT) and its unit will be radians.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":483,"id":"7e86bc7e-9555-4d4d-94f1-b42540c2c6fd","collection":"contentId-2155806721","type":"file","height":353}},{"type":"caption","content":[{"text":"Debug Trace","type":"text"}]}]},{"type":"paragraph"}]}]}]},{"type":"paragraph","content":[{"text":"To view this example in the library, see (","type":"text"},{"type":"inlineCard","attrs":{"url":"https://openbrim.org/platform/?application=inc&author=ParamML_Examples_OpenBrIM+Platform&obj=objidaapg7ixwv54fcui4dieivp"}},{"text":")","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"b374908c-6df5-42d2-8644-257482a2be49"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[340.0,340.0]},"content":[{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n \n \n \n \n \n

\n \n

\n \n","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[340.0,340.0]},"content":[{"type":"paragraph","content":[{"text":"The internal unit system, also known as the working unit system or modeling unit system, is a standardized set of units that the object uses for performing calculations, simulations, and other internal processes. The internal unit system is primarily used for accurate and efficient computation within the library. It helps avoid rounding errors, improves precision, and ensures consistency in calculations across various operations.","type":"text"}]},{"type":"paragraph","content":[{"text":"The display unit system, on the other hand, is the system of units in which measurements are presented and visualized to the user. These units are familiar and relatable to the user's real-world context. For instance, in a CAD, the display unit for length might be set to feet or centimeters. However for the above object, the internal calculations will always be in inches. ","type":"text"}]},{"type":"paragraph","content":[{"text":"The purpose of the display unit system is to provide a user-friendly interface that aligns with users' expectations and makes it easier for them to interpret and communicate measurements. It allows users to work in units they are comfortable with, even if the internal calculations are being done in a different unit system.","type":"text"}]},{"type":"paragraph","content":[{"text":"In summary, the internal unit system is the behind-the-scenes system used for calculations within the software, optimizing accuracy and efficiency, while the display unit system is the user-facing representation that ensures measurements are presented in a way that is meaningful and intuitive to users.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"As stated above, the unit systems for the two parameters X1 and X2 are different. The end user sees this as X1=1000 yards and X2=1 mile, and inputs these values accordingly.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":2,"colwidth":[340.0]},"content":[{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":575,"id":"e3a0bbaf-a67a-4748-9a5f-ec0d9a9e36d9","collection":"contentId-2155806721","type":"file","height":225}},{"type":"caption","content":[{"text":"Debug Traced named “Check”","type":"text"}]}]},{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"The entire process is carried out using the Internal unit category. In this example, since the Internal unit system, with a Unit Type of Length, uses millimeters, X1=36000 inches and X2=63360 inches are converted to the units that the user wants to view.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"To view this example in the library, see (","type":"text"},{"type":"inlineCard","attrs":{"url":"https://openbrim.org/platform/?application=inc&author=ParamML_Examples_OpenBrIM+Platform&obj=objidglgw5fxfrq5ojunf8ebkw"}},{"text":")","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"22df36ac-f202-4220-bd6b-a867790b8f7d"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[340.0,340.0]},"content":[{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n \n

\n \n \n

\n \n

\n","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"By defining the internal unit system, user-defined unit systems, and the parameter unit information, the end user can input parameter values and view design and analysis results in the units of their choice.","type":"text"},{"type":"hardBreak"},{"text":"Internally, however, all calculations and results are kept in the uniform units of the unit system specified by the author in the ParamML document.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Redline= 100 inch → 2540 mm","type":"text"}]},{"type":"paragraph","content":[{"text":"Greenline= 100 inch → 8.3333 feet ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":624,"id":"ea3e5c47-81d1-447a-8e24-d1b0315afd90","collection":"contentId-2155806721","type":"file","height":291}},{"type":"caption","content":[{"text":"Debug Trace","type":"text"}]}]},{"type":"paragraph"}]}]}]},{"type":"paragraph","content":[{"text":"To view this example in the library, see (","type":"text"},{"type":"inlineCard","attrs":{"url":"https://openbrim.org/platform/?application=inc&author=ParamML_Examples_OpenBrIM+Platform&obj=objidtrc9xswpf7859xhqiao4nv&folder=Core+Objects"}},{"text":")","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Parameters of Unit Objects","type":"text"}]},{"type":"paragraph"},{"type":"table","attrs":{"layout":"wide","isNumberColumnEnabled":true,"width":960.0,"localId":"a12b095b-7e3b-43bf-8274-8d3466a51699"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[142.0]},"content":[{"type":"paragraph","content":[{"text":"Label","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[129.0]},"content":[{"type":"paragraph","content":[{"text":"Mandatory","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[186.0]},"content":[{"type":"paragraph","content":[{"text":"Name and Type Attributes","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[327.0]},"content":[{"type":"paragraph","content":[{"text":"Default Description and Value Attributes","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Other Attributes","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[142.0]},"content":[{"type":"paragraph","content":[{"text":"Length","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[129.0]},"content":[{"type":"paragraph","content":[{"text":"Yes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[186.0]},"content":[{"type":"paragraph","content":[{"text":"N=\"Length\"","type":"text"},{"type":"hardBreak"},{"text":"T=\"Text\"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[327.0]},"content":[{"type":"paragraph","content":[{"text":"D=\"[INCH/FEET/YARD/MILLIMETER/","type":"text"}]},{"type":"paragraph","content":[{"text":"CENTIMETER/METER]\"","type":"text"}]},{"type":"paragraph","content":[{"text":"V=\"INCH\"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Role=\"Input\"","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[142.0]},"content":[{"type":"paragraph","content":[{"text":"Force","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[129.0]},"content":[{"type":"paragraph","content":[{"text":"Yes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[186.0]},"content":[{"type":"paragraph","content":[{"text":"N=\"Force\"","type":"text"},{"type":"hardBreak"},{"text":"T=\"Text\"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[327.0]},"content":[{"type":"paragraph","content":[{"text":"D=\"[POUND/KIPS/NEWTON/KILONEWTON/","type":"text"}]},{"type":"paragraph","content":[{"text":"MEGANEWTON/TON/MT/KGF ]\"","type":"text"}]},{"type":"paragraph","content":[{"text":"V=\"KIPS\"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Role=\"Input\"","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[142.0]},"content":[{"type":"paragraph","content":[{"text":"Angle","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[129.0]},"content":[{"type":"paragraph","content":[{"text":"Yes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[186.0]},"content":[{"type":"paragraph","content":[{"text":"N=\"Angle\"","type":"text"},{"type":"hardBreak"},{"text":"T=\"Text\"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[327.0]},"content":[{"type":"paragraph","content":[{"text":"D=\"[DEGREES/RADIANS]\"","type":"text"}]},{"type":"paragraph","content":[{"text":"V=\"DEGREES\"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Role=\"Input\"","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[142.0]},"content":[{"type":"paragraph","content":[{"text":"Temperature","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[129.0]},"content":[{"type":"paragraph","content":[{"text":"Yes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[186.0]},"content":[{"type":"paragraph","content":[{"text":"N=\"Temperature\"","type":"text"},{"type":"hardBreak"},{"text":"T=\"Text\"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[327.0]},"content":[{"type":"paragraph","content":[{"text":"D=\"[FAHRENHEIT/CELSIUS]\"","type":"text"}]},{"type":"paragraph","content":[{"text":"V=\"FAHRENHEIT\"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Role=\"Input\"","type":"text"}]}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Unit Types","type":"text"}]},{"type":"codeBlock","content":[{"text":"Length // in\nArea // in^2 \nVolume // in^3\nInertia // in^4\nWarp // in^6\nFrequency //Hz \nCurvature // 1/in\nForce // kips\nMoment // kip-in\nStress: // kip/in^2\nDensity: // kip/in³ \nForcePerLength //kip/in\nRadianPerLength // rad/in\nMomentPerLength // kip-in/in\nMomentPerAngle // kip-in/rad \nMomentPerCurvature // kip-in/in⁻¹\nForcePerAngle // kip/rad\nMassRotation // kip-in²\nAngle // rad\nTemperature // °F\nPerTemperature // 1/°F\nVelocity // ft/sec \nAcceleration // ft/sec\nTime //sec ","type":"text"}]}],"version":1}

Browser not supported