@ferscloud/fers-calculation-web 0.2.41 → 0.2.43

package/README.md

@@ -165,6 +165,26 @@ import type { FERS, ResultsBundle } from "@ferscloud/fers-calculation-web/fers-m
 
 `FERS` is the input model; `ResultsBundle` is the `result` payload of a successful envelope. Both are generated from the engine's OpenAPI schema, so they track the published version.
 
+## Deflected shape (optional)
+
+Set `include_member_deflected_shape` in the model's analysis options to get a
+ready-to-plot, **load-exact** deflected shape per member — the member's global
+displacement sampled along its length — instead of reconstructing the curve yourself:
+
+```ts
+const model = {
+  /* … model + load cases … */
+  analysis: { /* … */ options: { /* … */ include_member_deflected_shape: true } },
+};
+
+const res = JSON.parse(calculate_from_json(JSON.stringify(model)));
+const mr = res.result.results.loadcases["…"].member_results["1"];
+// mr.member_displacements: [{ x_frac, displacement: [dx, dy, dz] }, …]
+//   x_frac 0→1 along the member; displacement in the global input frame.
+```
+
+Off by default to keep the payload lean; omitted from `member_results` when not requested.
+
 ## Links
 
 - [Full documentation & getting started](https://ferscloud.com/getting-started)

package/fers-models.d.ts

@@ -312,7 +312,16 @@ export interface components {
          * @enum {string}
          */
         DeflectionComponent: "LocalY" | "LocalZ" | "Magnitude";
-        /** @enum {string} */
+        /**
+         * @description Unit of mass density used by every `Material.density` in the model.
+         *
+         *     Chosen **independently** of `lengthUnit` — a mm/N model may still declare
+         *     `kg/m3` and pass raw values like structural steel's `7850`. Accepted JSON
+         *     tokens are the ASCII strings `"kg/m3"` and `"kg/mm3"` (digit `3`, not the
+         *     superscript `³`); both normalise to SI (kg/m³) internally regardless of the
+         *     length unit. Default: `"kg/m3"`.
+         * @enum {string}
+         */
         DensityUnit: "kg/m3" | "kg/mm3";
         /**
          * @description Python:
@@ -1198,6 +1207,12 @@ export interface components {
             member_sets: components["schemas"]["MemberSet"][];
             /** @description Single source of truth for member objects. Member sets reference these by id. */
             members: components["schemas"]["Member"][];
+            /**
+             * @description Concentrated (lumped) nodal masses for modal & seismic analysis. Optional;
+             *     SI units (kg, kg·m²). See [`NodalMass`].
+             * @default []
+             */
+            nodal_masses: components["schemas"]["NodalMass"][];
             nodal_supports: components["schemas"]["NodalSupport"][];
             nodes: components["schemas"]["Node"][];
             /** @default [] */
@@ -1228,6 +1243,44 @@ export interface components {
             /** Format: int32 */
             node: number;
         };
+        /**
+         * @description A concentrated (lumped) mass attached to a node, for modal and seismic
+         *     analysis (equipment, added / non-structural mass, floor mass, …).
+         *
+         *     `mass` is an isotropic translational mass added to the node's three
+         *     translational DOFs; the optional rotary inertias are added to the three
+         *     rotational DOFs (absent ⇒ 0). **Units are SI regardless of the model's unit
+         *     system — `mass` in kg, inertias in kg·m²** (the same convention as
+         *     `gravity_factor`), so a nodal mass reads consistently with the structural
+         *     self-mass (`density·area`, which is kg after unit normalization).
+         */
+        NodalMass: {
+            /**
+             * Format: double
+             * @description Optional rotary inertia [kg·m²] about global X, added to the θx DOF.
+             */
+            inertia_x?: number | null;
+            /**
+             * Format: double
+             * @description Optional rotary inertia [kg·m²] about global Y, added to the θy DOF.
+             */
+            inertia_y?: number | null;
+            /**
+             * Format: double
+             * @description Optional rotary inertia [kg·m²] about global Z, added to the θz DOF.
+             */
+            inertia_z?: number | null;
+            /**
+             * Format: double
+             * @description Translational (isotropic) mass [kg], added to the ux, uy, uz DOFs.
+             */
+            mass: number;
+            /**
+             * Format: int32
+             * @description Id of the node the mass is attached to.
+             */
+            node: number;
+        };
         /** @description A concentrated moment applied at a node. */
         NodalMoment: {
             direction: components["schemas"]["Vector3"];
@@ -2347,6 +2400,10 @@ export interface components {
         };
         /** @description The model's unit system (length, force, density, pressure) for input and results. */
         UnitSettings: {
+            /**
+             * @description Unit of every `Material.density`; independent of `lengthUnit`
+             *     (a mm/N model may still declare `"kg/m3"`). See [`DensityUnit`].
+             */
             densityUnit?: components["schemas"]["DensityUnit"];
             forceUnit?: components["schemas"]["ForceUnit"];
             lengthUnit?: components["schemas"]["LengthUnit"];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ferscloud/fers-calculation-web",
   "type": "module",
-  "version": "0.2.41",
+  "version": "0.2.43",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Jeroen124/FERS_calculations.git"