Appearance
WASM types
Generated by
scripts/gen_wasm_manifest.mjsfrom the Rust types (via schemars) - do not edit. Runnpm run docs:wasmto refresh.
The 419 JSON shapes the WASM exports read and return, alphabetically. Descriptions are the Rust doc comments. A field that is not required may be omitted and takes its default.
AnalysisReport
Used by analysis_report.
| Field | Type | Required | Description |
|---|---|---|---|
maxDisplacements | DisplacementExtreme[] | yes | |
maxReactions | ReactionExtreme[] | yes | |
memberUtilisation | MemberUtilSummary[] | yes | |
passFailRollup | PassFailRollup | yes | |
stats | ModelStats | yes |
Anchor
| Field | Type | Required | Description |
|---|---|---|---|
dia_mm | number | yes | |
head_dia_mm | number | null | Head (or nut/washer) diameter for the pull-out check; None = pull-out NotDetermined. Default: null. | |
hef_mm | number | null | Effective embedment. None = not stated = every concrete check NotDetermined. Default: null. | |
x_mm | number | yes | |
y_mm | number | yes |
AnchorCheckResult
Used by conn_anchor_check.
| Field | Type | Required | Description |
|---|---|---|---|
adequate | boolean | null | ||
bar_dev_length_mm | number | null | AS 3600 development length the claimed bars need, mm (reported; certification is the gate). | |
bars_accepted | integer[] | yes | Bars the reinforcement gate accepted / rejected, by index into reinforcement.bars. |
bars_rejected | [integer, string][] | yes | |
combinations | CombResult[] | yes | |
cone_geometry | ConeGeometry | null | ||
factors | PartialFactors | yes | |
governing | Governing | null | The worst determined utilisation. None while any determined-able check is NotDetermined on the governing side - a verdict with a hole in it is not a verdict (ADR 0003). | |
notes | string[] | yes |
AnchorForce
A solved per-anchor force (e.g. from the CBFEM contact model), N. Overrides the elastic distribution of the combination it belongs to.
| Field | Type | Required | Description |
|---|---|---|---|
shear_n | number | yes | |
tension_n | number | yes |
AnchorForce2
Force per holding-down anchor, recovered from the grounded spring.
| Field | Type | Required | Description |
|---|---|---|---|
anchor | integer | yes | Index into ConnFeaInput::anchors. |
bolt | integer | yes | Index into ConnFeaInput::bolts of the shank, so a caller can name it the way the drawing does without holding both lists. |
engaged | boolean | yes | Did the final active set have this anchor in tension? |
shear | number | yes | Transverse force on the anchor, N. Always present: an anchor in a hole bears on that hole whichever way the plate is going. |
tension | number | yes | Axial force, N, positive in TENSION. Exactly zero when the active-set solve found this anchor in compression and dropped it - which is not "no load here", it is "the CONCRETE is carrying it", and the bed's own reaction is where that went. |
uplift | number | yes | Uplift at the anchor's rim, m, positive AWAY from the concrete - the stretch the tension is derived from, so a reader can see what the spring was asked to do. |
AnchorGroupInput
Used by conn_anchor_check.
| Field | Type | Required | Description |
|---|---|---|---|
anchors | Anchor[] | yes | |
concrete | Concrete | yes | |
edges | Edges | Default: {"far_from_all":false,"x_neg":null,"x_pos":null,"y_neg":null,"y_pos":null}. | |
factors | PartialFactors | null | Default: null. | |
justification_notes | string[] | Default: []. | |
loads | Combination[] | yes | |
per_anchor_forces | AnchorForce[][] | null | Per combination, per anchor, when the joint FEA solved them. Same order as loads. Default: null. | |
phi_nt_n | number | null | Steel design capacities per anchor, N (AS 4100, phi included). None = steel NotDetermined. Default: null. | |
phi_vs_n | number | null | Default: null. | |
post_installed | boolean | Post-installed / chemical anchors are out of scope; a caller that says so gets every concrete check NotDetermined with the reason, never a cast-in number. Default: false. | |
reinforcement | AnchorReinforcement | null | Default: null. |
AnchorReinforcement
Anchor reinforcement claimed to cross the tension cone (ACI 318-19 17.8.2.2). The geometry gate is computed here; development and symmetry are the engineer's certification and are recorded.
| Field | Type | Required | Description |
|---|---|---|---|
bars | Bar[] | yes | |
cover_mm | number | null | Confining cover to the bar (mm) for the AS 3600 Cl 13.1.2.2 development length report. Default: null. | |
developed_above | boolean | Default: false. | |
developed_below | boolean | Default: false. | |
symmetric | boolean | Default: false. |
AngleWorking
The parts of the AS 4100 Cl 8.4.6 single-angle check (SI: N, N.m, m).
| Field | Type | Required | Description |
|---|---|---|---|
cos_alpha | number | yes | |
e | number | yes | Eccentricity e = ch - t/2 (m) and cos(alpha), alpha between the x and h axes. |
equal_legs | boolean | yes | |
kt | number | yes | Table 7.3.2 kt for the net-section tension check the engineer makes with the real holes. |
phi_mbx | number | yes | phi Mbx about the major principal axis (N.m). |
phi_nch | number | yes | phi Nch: Cl 6.3 about the rectangular h-axis parallel to the loaded leg, le = l (N). |
AutoSizeChange
A single member's final size + governing utilisation, for the change report.
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | yes | |
num | integer | yes | |
to | string | yes | |
toKg | number | yes | |
util | number | null |
AutoSizeReport
Used by auto_size.
Auto-size outcome. Mirrors the JS autoSizeModel return shape (camelCase fields).
| Field | Type | Required | Description |
|---|---|---|---|
changes | AutoSizeChange[] | yes | |
converged | boolean | yes | |
iterations | integer | yes | |
massAfter | number | yes | |
massBefore | number | yes | |
none | boolean | yes | |
solveError | string | null | Why an analysis inside the loop failed, when one did. A failed solve used to end the loop with changed already false, so a mechanism reported converged: true with nothing sized (SA-34). | |
target | number | yes |
Bar
| Field | Type | Required | Description |
|---|---|---|---|
dia_mm | number | yes | |
fy_mpa | number | yes | |
x_mm | number | yes | |
y_mm | number | yes |
BeamSupport
One of:
"simply_supported","cantilever""continuous_end"- Continuous beam, end span: needs M_s* stated (Cl 8.5.3.1(b) weights midspan and support I_ef)."continuous_interior"- Continuous beam, interior span: needs M_s* stated.
BedResult
What the concrete under a bearing plate did.
| Field | Type | Required | Description |
|---|---|---|---|
bed | integer | yes | Index into ConnFeaInput::beds. |
contact_fraction | number | yes | Fraction of the plate's area still in contact, 0 to 1. Below 1 the plate has lifted off, and that is the number that says the joint is in the uplift regime rather than the bearing one. |
force | number | yes | Total compression the bed delivered, N. With everything else equal this plus the anchor tensions is the joint's axial equilibrium, which is the check a reader can do by eye. |
lifted_nodes | integer | yes | Nodes that lifted off, of the plate's total. |
plate | integer | yes | Index into ConnFeaInput::plates of the plate that bears. |
pressure_max | number | yes | Peak contact pressure, Pa. Compare against 0.85 f'c phi and the confinement factor in the COMPONENT check - nothing here knows the concrete's strength. |
total_nodes | integer | yes |
BoltForce
Force per bolt, recovered from the connector. Elastic, and with no strength behind it.
| Field | Type | Required | Description |
|---|---|---|---|
bolt | integer | yes | Index into ConnFeaInput::bolts. |
plies | integer | yes | How many plies the bolt connects. 2 = single shear, 3 = double shear. |
shear | number | yes | The largest transverse force on any one SHEAR PLANE, N - which is the quantity a bolt shear check is written against. A ply in double shear hands over twice this in total. |
tension | number | yes | Axial force in the shank, N, positive in TENSION. With no contact modelled a negative value means the plies are being pushed together, which a real joint carries by bearing on each other and not through the bolt - so a compressive value here is an artefact of the missing contact, not a bolt force. |
BoltHole
Where one bolt meets one plate: the ring of mesh nodes around its hole. This is the connector's attachment. It exists in the MESH rather than being re-derived in the solve because the rim is a property of how the plate was meshed - the mesher splits rim segments during refinement, so the ring is not the ring that was handed in, and geometry is the only thing that survives a remesh.
| Field | Type | Required | Description |
|---|---|---|---|
bolt | integer | yes | Index into ConnFeaInput::bolts. |
edge_dist | number | yes | Distance from the hole centre to the nearest plate boundary, m - EN 1993-1-8's e_b. |
offset | number | yes | Signed distance of this plate's mid-surface from the bolt's pos, along the bolt axis, m. Its SIGN is what tells tension from compression at this ply. |
pitch | number | null | Centre-to-centre distance to the nearest other hole in the SAME plate, m - p_b. None when this is the only hole in the plate. | |
plate | integer | yes | Index into ConnFeaMesh::plates. |
radius | number | yes | Hole radius, m. |
rim_nodes | integer[] | yes | Mesh node indices on the hole rim, global numbering. |
rim_weights | number[] | yes | Tributary weight of each rim node, by rim arc. Sums to 1, so the coupling below is independent of how finely the rim happens to be meshed. |
BuildingSlendernessReport
Used by building_slenderness_check.
Result of a building slenderness check.
| Field | Type | Required | Description |
|---|---|---|---|
building_height_m | number | yes | |
direction | string | yes | Direction that was checked: "x", "y", or "xy" (resultant). |
governing_load_case_id | integer | yes | |
governing_node_id | integer | yes | |
limit_ratio | number | yes | |
max_displacement_m | number | yes | |
pass | boolean | yes | |
slenderness_ratio | number | null | The slenderness ratio, or None when there was NO lateral displacement at all - in which case there is no ratio to report rather than an infinite one. THIS USED TO BE f64::INFINITY, and JSON has no infinity: serde writes it as null, so the field arrived as null and the UI's truthiness guard skipped the whole line. A building that did not sway showed NOTHING - not "passes", not "no displacement", nothing - while the check had in fact passed. Making it Option says the same thing in the type and gives the panel something explicit to render. |
Check
| Field | Type | Required | Description |
|---|---|---|---|
action_n | number | null | ||
clause | string | yes | |
note | string | null | ||
resistance_n | number | null | Design resistance (N) and design action (N) behind the utilisation, when determined. | |
state | CheckState | yes | |
util | number | null |
CheckState
Whether a code check passed, failed, or could not be determined (and therefore must NEVER be counted as a pass). Shared across the concrete-design modules (pedestal, pile cap, ...) so the three-state honesty convention is a single type they all use rather than a per-module duplicate.
One of: "Ok", "NotAdequate", "NotDetermined"
Coarsen
See FePlate::coarsen. from is in the plate's own 2D frame.
| Field | Type | Required | Description |
|---|---|---|---|
from | number[][] | yes | |
h_far | number | yes | |
rate | number | yes |
CodeRef
A structured reference to a governing code provision. The reference is part of the calculation, not an annotation: standard name + edition/year + clause travel WITH the value. Recording the year makes historical calcs traceable when a standard is later revised (a 2020 result stays a 2020 result).
| Field | Type | Required | Description |
|---|---|---|---|
clause | string | yes | Clause / section / table, e.g. "Cl 5.2.1" or "Table 6.3.3(1)". |
standard | string | yes | e.g. "AS 4100". A single step may cite a DIFFERENT standard than the derivation's headline code (e.g. a load term from AS/NZS 1170 inside an AS 4100 check) - so the basis of design is exact. |
year | string | yes | Edition/year, e.g. "2020" (or "2020 Amdt 1"). Empty only for non-coded arithmetic. |
ColdFormedCombined
Used by as4600_combined.
AS/NZS 4600 cold-formed combined actions (Cl 3.5 linear interaction) for one load case.
| Field | Type | Required | Description |
|---|---|---|---|
axial_util | number | yes | Axial utilisation: |Ncomp| / min(φNcx, φNcy), or |Ntens| / φNt in tension |
util_max | number | yes | Cl 3.5 linear interaction sum = axial_util + util_mx + util_my |
util_mx | number | yes | Major-axis bending utilisation M*x / φMbx |
util_my | number | yes | Minor-axis bending utilisation M*y / φMby |
ColumnLoad
One column reaction applied to the raft, spread over its footprint as a linearly varying pressure. All SI: N, m, N.m.
| Field | Type | Required | Description |
|---|---|---|---|
bx | number | yes | |
by | number | yes | |
cx | number | yes | |
cy | number | yes | |
mx | number | yes | |
my | number | yes | |
n | number | yes | |
pedestal_bx | number | Optional PEDESTAL (column head / local thickening) plan size at this column, m. When larger than bx/by this becomes the "effective area of a support" of AS 3600 Cl 9.3.1.1 - "the area totally enclosing the actual support... for which the perimeter is a minimum" - so the punching critical perimeter is built from it instead of the bare column. Zero or smaller than the column means no pedestal. This is the cheapest real remedy for a punching overstress on a raft, and it is deliberately PUNCHING-ONLY: it does not thicken the plate in the FE, so the pressure field and the bending moments are unchanged. That is honest for a pedestal whose depth is small against the mat span (its job is to spread the column load, not to stiffen the raft), and it is why raft_design reports the pedestal alongside the check rather than silently folding it in. A genuine DROP PANEL deep enough to change the raft's stiffness needs a per-element thickness in the FE, which this does not attempt. Default: 0. | |
pedestal_by | number | Default: 0. |
Combination
One FACTORED (ULS) combination at the plate. Sign: n_n positive = tension on the group.
| Field | Type | Required | Description |
|---|---|---|---|
mx_nmm | number | Moments about the plate's x and y axes, N.mm. Distributed to anchors elastically. Default: 0. | |
my_nmm | number | Default: 0. | |
n_n | number | Default: 0. | |
name | string | yes | |
seismic | boolean | Default: false. | |
vx_n | number | Default: 0. | |
vy_n | number | Default: 0. |
CombResult
| Field | Type | Required | Description |
|---|---|---|---|
anchor_shear_n | number[] | yes | |
anchor_tension_n | number[] | yes | Per-anchor tension (N, +ve) and shear (N) this combination was checked with. |
blowout | Check | yes | |
combined_concrete | Check | yes | |
combined_steel | Check | yes | |
name | string | yes | |
pryout | Check | yes | |
rebar_credited | boolean | yes | True when the tension cone row is the reinforcement tie, not the concrete cone. |
seismic | boolean | yes | |
seismic_qualification | Check | yes | |
shear_edge | Check | yes | |
shear_steel | Check | yes | |
splitting | Check | yes | |
tension_cone | Check | yes | |
tension_pullout | Check | yes | |
tension_steel | Check | yes |
Concrete
| Field | Type | Required | Description |
|---|---|---|---|
cracked | boolean | Cracked is the default and the conservative one (k1 = 7.7 vs 11.0). Uncracked needs a justification note or the tension checks come back NotDetermined. Default: true. | |
fck_mpa | number | yes | |
thickness_mm | number | yes |
ConeGeometry
| Field | Type | Required | Description |
|---|---|---|---|
ac_n0_mm2 | number | yes | |
ac_n_mm2 | number | yes | |
hef_mm | number | yes | |
k1 | number | yes | |
n_rk_c0_n | number | yes | |
psi_ec_n | number | yes | |
psi_re_n | number | yes | |
psi_s_n | number | yes |
Connection
One derived connection at a shared node.
| Field | Type | Required | Description |
|---|---|---|---|
boltCount | integer | yes | Estimated bolt count. |
coatingArea_m2 | number | yes | Paintable / galvanisable surface area contributed by this joint (m²). |
connectionType | string | yes | Inferred connection type. |
cutCount | integer | yes | Estimated cut / prep operations. |
holeCount | integer | yes | Estimated hole count (drilled / punched holes). |
members | integer[] | yes | Member ids whose ends meet at this node. |
node_id | integer | yes | |
weldLength_m | number | yes | Estimated fillet weld length (m) for the joint. |
ConnectionConfig
Connection batch check/design configuration (from @FD) and connection design preferences (from @JS). Both sections are optional; a job with no connection data yields None.
| Field | Type | Required | Description |
|---|---|---|---|
batch_check_design_check | boolean | Default: false. | |
batch_check_design_connection_string | string | null | Default: null. | |
batch_check_design_design | boolean | Default: false. | |
batch_check_design_load_case_string | string | null | Default: null. | |
batch_check_design_use_minimum_design_actions | boolean | Default: false. | |
beam_end_clearance | number | null | Default: null. | |
bolt_category | integer | null | 0 = commercial, 1 = structural Default: null. | |
bolt_gauge | number | null | Default: null. | |
bolt_pitch | number | null | Default: null. | |
bolt_strength | integer | null | 0 = normal (4.6), 1 = high (8.8) Default: null. | |
bolt_threads | integer | null | 0 = excluded, 1 = intercepted Default: null. | |
cleat_strength | integer | null | Default: null. | |
connection_dxf_layer_bolts_name | string | null | Default: null. | |
connection_dxf_layer_centerlines_name | string | null | Default: null. | |
connection_dxf_layer_cut_offs_name | string | null | Default: null. | |
connection_dxf_layer_dimensions_name | string | null | Default: null. | |
connection_dxf_layer_footings_name | string | null | Default: null. | |
connection_dxf_layer_geometry_name | string | null | Default: null. | |
connection_dxf_layer_hidden_lines_name | string | null | Default: null. | |
connection_dxf_layer_plates_name | string | null | Default: null. | |
connection_dxf_layer_text_name | string | null | Default: null. | |
coped_flange_clearance | number | null | Default: null. | |
coping_radii | number | null | Default: null. | |
edge_distance | number | null | Edge distance multiplier x bolt diameter. Default: null. | |
flange_weld_type | integer | null | 0 = fillet, 1 = CJP Default: null. | |
member_strength | integer | null | Default: null. | |
minimum_cope_distance | number | null | Default: null. | |
moment_bolt_procedure | integer | null | Default: null. | |
plate_strength | integer | null | 0 = normal, 1 = high Default: null. | |
plate_thick_max | number | null | Default: null. | |
plate_thick_min | number | null | Default: null. | |
report_connection_calculations | boolean | Default: false. | |
report_connection_detailed_output | boolean | Default: false. | |
report_connection_input_data | boolean | Default: false. | |
report_connection_result_summary | boolean | Default: false. | |
report_connection_specifications | boolean | Default: false. | |
report_connection_string | string | null | Default: null. | |
report_connection_warnings_and_notes | boolean | Default: false. | |
report_pass_fail_criteria | string | null | Default: null. | |
simple_bolt_procedure | integer | null | Default: null. | |
snug_bolt_max | number | null | Default: null. | |
snug_bolt_min | number | null | Default: null. | |
stiffener_weld_category | integer | null | Default: null. | |
tens_bolt_max | number | null | Default: null. | |
tens_bolt_min | number | null | Default: null. | |
weld_category | integer | null | 0 = GP, 1 = structural purpose Default: null. | |
weld_max | number | null | Default: null. | |
weld_min | number | null | Default: null. | |
weld_strength | integer | null | 0 = normal, 1 = high Default: null. |
ConnectionTakeoff
Used by connection_takeoff.
Complete connection take-off report.
| Field | Type | Required | Description |
|---|---|---|---|
connections | Connection[] | yes | |
totals | ConnectionTotals | yes |
ConnectionTotals
Grand totals across all connections.
| Field | Type | Required | Description |
|---|---|---|---|
boltCount | integer | yes | |
coatingArea_m2 | number | yes | |
cutCount | integer | yes | |
holeCount | integer | yes | |
weldLength_m | number | yes |
ConnFeaInput
Used by conn_fea_mesh, conn_fea_solve.
One meshing (and, with supports/loads, one solving) run over a whole joint.
| Field | Type | Required | Description |
|---|---|---|---|
anchors | FeAnchor[] | Holding-down anchors: bolts that grip the concrete rather than a second ply. Ignored by conn_fea_mesh - an anchor's HOLE is cut by its bolt like any other. Default: []. | |
beds | FeBed[] | Elastic beds under bearing plates. Ignored by conn_fea_mesh. Default: []. | |
bolts | FeBolt[] | Default: []. | |
loads | FeLoad[] | What is applied. Ignored by conn_fea_mesh. Default: []. | |
plates | FePlate[] | yes | |
rotation_probes | FeRotationProbe[] | Cross-sections to report a rotation at, for a joint stiffness. Empty by default and free when empty: the fit runs after the solve, over nodes already computed. Default: []. | |
sizing | SizingField | yes | The mesher's own sizing field, passed through to mesh_polygon per plate. Hole rims add their own refinement on top of whatever arrives here (see plate_sizing). |
supports | FeSupport[] | Where the joint is held. Ignored by conn_fea_mesh; conn_fea_solve refuses without at least one, because an unrestrained shell assembly has six rigid-body modes and a solve that "completes" on one is meaningless. Default: []. | |
welds | FeWeld[] | Welds tying plate edges to other plates. Ignored by conn_fea_mesh - the mesh is of the plates, and a tie changes nothing about their geometry. Default: []. |
ConnFeaMesh
Used by conn_fea_mesh.
The joint mesh: plate meshes mapped into 3D, one node block per plate, NOT welded together.
| Field | Type | Required | Description |
|---|---|---|---|
bolt_holes | BoltHole[] | One entry per (bolt, plate) pair where a hole was actually CUT. A bolt with fewer than two of these connects nothing. Default: []. | |
boundary_nodes | integer[] | yes | Node indices on a plate boundary (outer edge or hole rim), global numbering. Step 2 needs these to find weld lines and hole rims without re-deriving the topology. |
nodes | number[][] | yes | |
plate_of_tri | integer[] | yes | For each triangle, the index into ConnFeaMesh::plates it belongs to. |
plates | PlateMeshInfo[] | yes | |
tris | integer[][] | yes | |
warnings | string[] | yes | Everything that was refused, skipped or clamped, in the words of the reason. Never empty silently: if a hole did not get cut, it says so here. |
ConnFeaResult
Used by conn_fea_solve.
Per-node results, aligned to ConnFeaMesh::nodes.
| Field | Type | Required | Description |
|---|---|---|---|
anchor_forces | AnchorForce2[] | One entry per holding-down anchor. The number a base plate exists to produce. Default: []. | |
applied_force | number[] | yes | Applied force resultant, N, and the reaction the supports returned - which must equal it. |
applied_moment | number[] | yes | The same for MOMENT about the origin, N.m. Reported for the same reason the forces are: a member can carry pure moment, and then the force resultants are both zero and say nothing. |
beds | BedResult[] | One entry per elastic bed that had any spring under it: how much the concrete carried, at what peak pressure, and over how much of the plate it was still in contact. Default: []. | |
bolt_forces | BoltForce[] | One entry per bolt that actually connects two or more plies. Elastic, from a linear connector with no pretension, no contact and no slip - see BoltForce. Default: []. | |
contact_passes | integer | null | How many active-set passes the bearing/anchor state took to settle. 0 when there was no contact to resolve; None when it did not settle - see the warning that says so. Default: null. | |
converged | boolean | yes | True only when the solver returned, the solution is finite, and equilibrium closes. |
elastic_stress_ratio | number | null | sigma_vm_max / fy over the plates that stated an fy. None when none did. This is an ELASTIC stress ratio, NOT a code utilisation and NOT the 5% plastic strain criterion. | |
equilibrium_error | number | yes | |applied + reaction| / |applied|. Zero for a correct solve; reported rather than only asserted, because it is the one number that catches load applied where nobody meant it. |
mesh | ConnFeaMesh | yes | |
reaction_force | number[] | yes | |
reaction_moment | number[] | yes | |
rotations | ProbeRotation[] | One entry per rotation probe, in the order they were given. Default: []. | |
sigma_vm | number[] | yes | Elastic von Mises stress at each node, Pa: the worse of the two plate SURFACES (membrane plus and minus the bending part), area-averaged from the elements meeting at that node. |
sigma_vm_max | number | yes | |
sigma_vm_max_joint | number | yes | The same peak, taken over the JOINT ONLY - every node inside a load or support region, grown by INTRO_MARGIN, is left out. A member's N/V/M are delivered as a force field over one end face, and a force field over a face is not how the member is really loaded: the face sees a local disturbance that dies away within about a section depth, which is St Venant's principle and is the whole reason the stub exists. Measured on a 360UB stub carrying 180 kN.m, the cut face itself reaches 441 MPa - 1.47 times fy - while the joint 250 mm away is a separate and much larger concentration. Both are red on a plot clipped at yield, and only one of them is a result. Reporting the global maximum as "the peak" reports whichever of the two happens to be higher. Equal to sigma_vm_max when nothing was excluded. |
u | number[][] | yes | Translation at each node, m, global axes. |
u_max | number | yes | Largest nodal translation magnitude, m. |
warnings | string[] | yes |
ConsequencesClass
Table A1 consequences classes. Class 2 is split into its Lower and Upper risk groups (the published standard's 2a and 2b).
One of: "Class1", "Class2Lower", "Class2Upper", "Class3"
ConsolState
Which branch of the e-log(sigma') curve the consolidation settlement used, or why it was skipped.
One of:
"NormallyConsolidated"- Normally consolidated: the whole stress increase rides the virgin compression line (Cc)."OverconsolidatedRecompression"- Overconsolidated and the final stress stays below preconsolidation: recompression only (Cr)."OverconsolidatedCrossing"- Overconsolidated but the stress increase crosses preconsolidation: Cr then Cc."NotComputed"- No compressible layer / missing parameters: consolidation was not computed (not zero).
Construction
One of: "Framed", "LoadBearingWall"
CraneResult
Used by en1991_3_crane.
| Field | Type | Required | Description |
|---|---|---|---|
axle_spacings_m | number[] | yes | |
axle_weights_kn | number[] | yes | The axle train for the runway beam: the group 1 wheel loads on rail 1 at the wheel spacings. |
buffer_h_b1_kn | number | yes | Buffer forces (kN): H_B,1 from the crane's kinetic energy, H_B,2 from the crab. |
buffer_h_b2_kn | number | yes | |
drive_force_kn | number | yes | Drive force K (kN), the lever l_s (m), the moment M (kNm). |
drive_moment_knm | number | yes | |
fatigue_q_e_normal_kn | number | null | Fatigue damage-equivalent wheel loads (kN per wheel), normal and shear, if a class was given. | |
fatigue_q_e_shear_kn | number | null | ||
groups | LoadGroup[] | yes | |
l_s_m | number | yes | |
phi_1 | number[] | yes | |
phi_2 | number | yes | |
phi_4 | number | yes | |
phi_5 | number | yes | |
phi_7 | number | yes | |
q_r_max_acc_static | number | yes | |
q_r_max_kn | number | yes | The characteristic maximum wheel load (group 1, phi_1 = 1.1 and phi_2), kN per wheel. |
q_r_max_static | number | yes | Static wheel loads (no dynamic factor), kN per wheel: loaded crane near rail (Q_r,max), loaded far rail (Q_r,(max)), unloaded near rail (Q_r,min), unloaded far rail (Q_r,(min)). |
q_r_min_acc_static | number | yes | |
q_r_min_kn | number | yes | The characteristic minimum wheel load (unloaded crane, phi_1 = 0.9), kN per wheel. |
q_r_min_static | number | yes | |
skew_f | number | yes | Skewing: f, S (kN), and the transverse wheel forces per wheel pair on rails 1 and 2 (kN). |
skew_h_t_rail1_kn | number[] | yes | |
skew_h_t_rail2_kn | number[] | yes | |
skew_s_kn | number | yes | |
standard | string | yes | |
steps | Step[] | yes | |
verified | boolean | yes | |
warnings | string[] | yes | |
xi_1 | number | yes |
Derivation
Used by as4100_phi_mbx_derivation, as4100_phi_ms_derivation, as4100_phi_nc_derivation.
A complete derivation for one check: the givens, the working, and the headline result.
| Field | Type | Required | Description |
|---|---|---|---|
code | string | yes | Governing standard name, e.g. "AS 4100". |
edition | string | yes | Edition/year of that standard as IMPLEMENTED by the solver - recorded so a historical calc stays traceable to the rules it was run under, even after the standard is revised. |
inputs | Input[] | yes | |
result | Step | yes | The headline line (capacity or utilisation) - carries the pass/fail. |
steps | Step[] | yes | |
title | string | yes |
DesignSection
WHERE THE BENDING CHECK'S CRITICAL SECTION SITS - AS 3600:2018 Cl 20.4.2. The clause names three, and they are not interchangeable: they differ by how much of the support is assumed to spread the load before the cantilever starts, and the difference goes straight into the design moment. (a) the face of the column, pedestal or wall for concrete members; (b) halfway between the centre and face of the wall for a masonry wall; (c) halfway between the face of the column and the edge of the base plate for a steel column and base plate. (a) IS THE DEFAULT and is what this module has always done, so no existing result moves. (b) is more conservative than the face - a masonry wall cannot be relied on to spread the load to its own face - and (c) is less, because a base plate does spread it. A NOTE ON WHERE THE CLAUSE LIVES. Section 20 is "Plain concrete pedestals and footings", and this is the only place AS 3600 states the rule explicitly; it is the convention applied to reinforced pads as well. That is said out loud rather than implied, because a reader checking the citation will find it in the plain-concrete section and should not have to wonder whether it was misread. Cl 6.2.3's "0.7 times the length of a support from the centre-line" is a DIFFERENT rule for a different thing - the critical section for negative moments in a continuous flexural member - and is deliberately not offered here.
One of:
kind: "face"- (a) At the face of the column. The default, and what every result before 2026-09-09 used.kind: "masonry_wall"- (b) Halfway between the centre of the wall and its face - a masonry wall.kind: "steel_base_plate"- (c) Halfway between the column face and the edge of the base plate, for a steel column.plate_bis the base plate's dimension in the direction being checked, in metres; a plate no larger than the column collapses to the face, which is the honest answer for one.Field Type Required Description kind"steel_base_plate"yes plate_bxnumberyes plate_bynumberyes
DisplacementExtreme
| Field | Type | Required | Description |
|---|---|---|---|
component | string | yes | |
load_case_id | integer | yes | |
node_id | integer | yes | |
value | number | yes |
DistributionRule
The vertical distribution rule, by standard.
One of:
"as1170_4"- AS 1170.4:2024 Cl 6.3: the whole shear split byw h^k, k interpolating with the period."nzs1170_5"- NZS 1170.5:2004 Cl 6.2.1.3: a flatFt = 0.08 Vlumped at the TOP level, and the remaining0.92 Vsplit byw h- no period-dependent exponent at all. The difference is not a refinement of the same shape. Under AS the top level's share is whateverw h^kgives it; under NZS it is that share of 0.92 V PLUS a fixed 8% of the whole shear. Both rules sum to V, so a total-equals-V check cannot tell them apart - which is exactly how the wrong one gets shipped unnoticed.
DominantOpening
Where the dominant opening is, if there is one. ratio is its area over the total open area of the other walls and roof (Table 5.1(B)). wall: "none", "x0" / "xb" (the long side walls at x = 0 and x = span), "y0" / "yl" (the end walls at y = 0 and y = length). at_m is its centre, measured along that wall from its start (x for an end wall, y for a side wall); negative = the wall's middle.
| Field | Type | Required | Description |
|---|---|---|---|
at_m | number | Default: -1. | |
ratio | number | Default: 0. | |
wall | string | Default: "none". |
DoubleAngleConnectors
The interconnectors of a double-angle member (SA-156): AS 4100 Cl 6.5 designs two angles back to back as one member only with their connector spacing, and the gap between the backs (a packer or the gusset they straddle; 0 = in contact) sets the pair's inertia about its axis of symmetry. Absent for a member = not given: the check refuses it and says what to enter.
| Field | Type | Required | Description |
|---|---|---|---|
gap_mm | number | Default: 0. | |
member_id | integer | yes | |
spacing_mm | number | yes |
DsmCapacity
DSM member capacity result. Loads in N, moments in N*mm.
| Field | Type | Required | Description |
|---|---|---|---|
dist_b | DsmMode | yes | |
dist_c | DsmMode | yes | |
elastic_source | string | Where the local and distortional elastic buckling came from: "finite_strip" (the section's finite strip, SA-73) or "element_method" (the plate/rotational-spring fallback). Default: "". | |
global_b | DsmMode | yes | |
global_c | DsmMode | yes | |
gov_b | string | yes | |
gov_by | string | Default: "". | |
gov_c | string | yes | |
local_b | DsmMode | yes | |
local_by | DsmMode | Default: {"cap":0,"ncr":0}. | |
local_c | DsmMode | yes | |
my | number | yes | |
my_y | number | Minor-axis bending: first-yield My_y (Zfy*fy) and the minor local-buckling result Mbl_y. Minor-axis bending has no lateral-torsional mode (Mbe_y = My_y) and distortional is not critical, so the governing minor capacity is min(My_y, Mbl_y). Default: 0. | |
ny | number | yes | |
phi_mb | number | yes | |
phi_mby | number | Default: 0. | |
phi_nc | number | yes | |
phi_rb | number | Web-crippling capacity phi*Rb (N), end-one-flange, 50 mm bearing (indicative default). Default: 0. |
DsmMode
One DSM limit-state result (a buckling mode -> a capacity).
| Field | Type | Required | Description |
|---|---|---|---|
cap | number | yes | Nominal capacity from the DSM strength curve (N or N*mm). |
ncr | number | yes | Elastic buckling load/moment for this mode (N or N*mm). |
Edges
Distances from the anchor GROUP's outermost anchor to the concrete free edges, mm, in plate coordinates: x_neg is the edge in the -x direction, etc. None = far from that edge.
| Field | Type | Required | Description |
|---|---|---|---|
far_from_all | boolean | An UNSTATED edge is not a far edge. A group in the middle of a large slab says so here, and then any None above means "farther than c_cr,N". Without it, a missing distance makes the concrete checks NotDetermined - "far" was the silent default and it is the unconservative one. Default: false. | |
x_neg | number | null | Default: null. | |
x_pos | number | null | Default: null. | |
y_neg | number | null | Default: null. | |
y_pos | number | null | Default: null. |
EquivalentRigidities
Rigidities given directly, in MATERIAL axes: for decking, ribbed and hollowcore slabs, or CLT from its layup, where no single homogeneous material describes the plate. A and S in N/m, D in N m, engineering shear strain and twist.
| Field | Type | Required | Description |
|---|---|---|---|
a11 | number | yes | |
a12 | number | yes | |
a22 | number | yes | |
a66 | number | yes | |
d11 | number | yes | |
d12 | number | yes | |
d22 | number | yes | |
d66 | number | yes | |
s13 | number | yes | |
s23 | number | yes |
FeAnchor
A HOLDING-DOWN ANCHOR: a bolt that grips the concrete instead of a second ply, modelled as a grounded spring that can PULL and cannot PUSH. # Why this exists A base plate's anchors are declared as bolts, and a bolt in this module connects the plies it pierces. An anchor pierces exactly one - the base plate - and the concrete below is not a plate, so before this an anchor was a HOLE THAT CONNECTED NOTHING. The joint was instead held by a support box: the plate pinned rigidly in a small box around each anchor and held vertically over its whole area. That model gives plate bending and says nothing at all about the anchors, because a rigid restraint has no force to report and infinite stiffness to contribute. A base-plate joint FEA was a picture of a plate with the one question a base plate exists to answer left out. # What it is A spring from the anchor's hole rim - the same tributary-weighted rim mean the bolt connector uses, so it is independent of how finely that rim happened to mesh - to ground. Three components: - AXIAL, along axis, TENSION ONLY. E A / L_eff, where L_eff is the anchor's stretching length: the free length between the plate and the point in the concrete where the anchor is actually gripped, not the embedment. An anchor is engaged only when the plate lifts off it; pushing on an anchor is what the CONCRETE does, and that is FeBed below. - SHEAR, perpendicular to axis, always active. Always, because an anchor in a hole bears on that hole whichever way the plate is moving. # What it is not No pretension, no slip, no cone breakout, no bond. The spring says how the plate and the anchors SHARE the uplift, not whether an anchor or the concrete around it is strong enough - that is the component check's question and it stays there.
| Field | Type | Required | Description |
|---|---|---|---|
area | number | yes | Tensile stress area, m^2. |
bolt | integer | yes | Index into ConnFeaInput::bolts of the shank this anchor is. The hole is cut by that bolt as usual; this adds the ground connection the bolt cannot make for itself. |
e | number | yes | Young's modulus of the anchor, Pa. |
free_len | number | yes | Stretching length, m - plate underside to the effective grip point in the concrete. NOT the embedment: a cast-in anchor with a plate washer is gripped at the washer, a chemical anchor is gripped over its bond length and stretches over roughly half of it. |
into | number[] | yes | Direction from the plate INTO the concrete, global. Need not be unit. This is what makes the tension-only test a statement about the joint and not about which way a caller happened to point the bolt axis: the anchor is in TENSION when the rim moves opposite to it. |
k_shear | number | null | Shear stiffness of one anchor, N/m. None derives it from the shank in double curvature over the standoff - see anchor_shear_stiffness. Default: null. | |
standoff | number | null | Standoff, m: the gap between the plate's underside and the concrete face that the anchor bends over in shear - grout, a levelling nut, or nothing. None uses the plate half-thickness, which is the grouted-tight case. Default: null. |
FeBed
The CONCRETE under a bearing plate: an elastic bed that can PUSH and cannot PULL. # Why this exists The base plate used to be held vertically over its whole area by a rigid support box. Two things follow from that and both are wrong in the same direction. The plate cannot LIFT OFF, so an uplift case is carried by a restraint a real base does not have - and every newton the bed carries in tension is a newton the ANCHORS do not, so anchor tension comes out too low, which is the unconservative direction on the one number the joint is designed for. And a rigid bed puts the whole bearing reaction into a knife edge under the column, so the plate's own bending is wrong too. # What it is A Winkler bed: an independent spring at every node of the plate, along into, of stiffness k * A_i where A_i is that node's tributary area, so refining the mesh does not change the answer. Compression only - a node that lifts drops out and the bed under it carries nothing. # Choosing k A subgrade modulus in Pa/m. For a base plate on a concrete pedestal the usual reading is k ~ E_c / h, with h the depth of concrete that participates - about the plate's own half-width for a plate on a large block. This module does not choose it: a stiffness nobody chose is exactly what the rigid box was. The caller states it and the result reports what it did. The bed's job here is the DISTRIBUTION, not the magnitude. Bearing stress against 0.85 f'c and the confinement factor remain the component check's - this cannot say whether the concrete is strong enough, only where the plate presses on it and how much is left for the anchors.
| Field | Type | Required | Description |
|---|---|---|---|
into | number[] | yes | Direction from the plate INTO the concrete, global. Need not be unit. |
k | number | yes | Subgrade modulus, Pa/m (N/m per m^2 of plate). |
plate | integer | yes | Index into ConnFeaInput::plates of the plate that bears. |
FeBolt
A bolt shank: where a hole is cut, and - since spec step 4 part 3 - a LINEAR connector that carries shear and tension between the plies it passes through. See bolt_connector_stiffness for what that connector is and, more importantly, what it is not: there is no pretension, no contact, no slip and no bearing nonlinearity, so a bolted joint modelled with these cannot open and cannot pry. Those are spec steps 6 and 7.
| Field | Type | Required | Description |
|---|---|---|---|
area | number | null | Effective shank area, m^2. None uses the plain shank pi d^2 / 4. A bolt threaded through the shear plane carries about 0.78 of that, and a caller that knows which it is should say so here rather than shrink dia - dia also sizes the HOLE. Default: null. | |
axis | number[] | yes | Shank direction, global. Need not be unit. |
dia | number | yes | Shank (bolt) diameter, m. |
e | number | null | Young's modulus of the bolt, Pa. Required before the bolt is allowed to CONNECT anything - conn_fea_solve refuses a bolt that pierces two plies without one, for the same reason it refuses a plate without one. A bolt that pierces a single ply is only a hole and needs nothing. Default: null. | |
hole | number | null | Hole diameter override, m. None uses the AS 4100 Cl 14.3.2 standard clearance hole via crate::fasteners::hole_diameter. Default: null. | |
k_shear | number | null | Shear stiffness override for the connector, N/m, stated for a SINGLE-SHEAR pair (the stiffness between the two plies). None derives it - see bolt_connector_stiffness. Default: null. | |
k_tension | number | null | Tension stiffness override for the connector, N/m, stated the same way. Default: null. | |
len | number | yes | Gripped length of the shank, m. A plate is only pierced if its mid-surface falls within len/2 of pos along the axis - which is what stops a bolt in one part of the joint from punching a hole through a parallel plate somewhere else. |
pos | number[] | yes | Centre of the shank, global. |
FeLoad
A load RESULTANT applied over a region, spread across the mesh nodes inside it. The spread is by nodal tributary area, so refining the mesh does not change the answer, and the moment is delivered as a force field about the region's own area-weighted centroid - which makes its net force exactly zero by construction rather than approximately zero by symmetry. (That distinction was a real bug on the raft: a moment applied about the wrong point injected phantom vertical load. See footing_fe's column-load note.)
| Field | Type | Required | Description |
|---|---|---|---|
at | number[] | null | The point the resultant acts THROUGH. None uses the region's weighted centroid, which is what a pressure-like load wants. A member's N/V/M are stated about its own axis, and that is not the same point: the weighted centroid is a property of the MESH, and an unstructured mesh over a symmetric section does not put it exactly on the axis. Measured on a 360UB stub, the offset was around 0.7 mm - which sounds like nothing until it acts on 400 kN about a weak axis 15x softer than the strong one, where it moved the free end 0.8 mm sideways under a "pure" axial load, and moved differently on every mesh. Naming the point removes the mesh from the answer. Default: null. | |
axis | number[] | null | The region is additionally a SLAB: nodes within slab of the plane through at normal to axis. A member end is a face normal to the member, and a pitched member's face is not normal to any world axis - the box alone, made thin to catch a face, caught a line of it (one node, on the shipped portal's rafters, 2026-09-03) and the moment could not be applied. With the plane named, the box only has to be big enough and the slab does the selecting. Default: null. | |
force | number[] | Force resultant, N, global axes. Default: [0,0,0]. | |
max | number[] | yes | |
min | number[] | yes | |
moment | number[] | Moment resultant, N.m, global axes, about at when given and about the region's own weighted centroid otherwise. Default: [0,0,0]. | |
slab | number | null | Default: null. |
FePlate
A flat plate in the joint: a polygon in its own 2D frame, placed in 3D. origin/ex/ey place the plate's mid-surface: a local point (x, y) maps to origin + x*ex + y*ey, and the plate normal is ex x ey. ex and ey need not arrive unit or exactly orthogonal - Placement::from_axes orthonormalises them and refuses a degenerate pair.
| Field | Type | Required | Description |
|---|---|---|---|
coarsen | Coarsen | null | GRADED sizing for a plate that is context rather than subject - a member stub: the caller's target size at the from points (the cut face at the joint), growing at rate per metre of distance to h_far. A stub meshed uniformly at the joint's size was two thirds of the element count of an eaves joint and none of its answer (2026-09-03). None = uniform. Default: null. | |
e | number | null | Young's modulus, Pa. None is carried through untouched by the mesher; conn_fea_solve REFUSES a plate without it rather than assuming a steel value, because a modulus quietly filled in is a stiffness nobody chose. Default: null. | |
ex | number[] | yes | Local +x direction in global coordinates. |
ey | number[] | yes | Local +y direction in global coordinates. |
fu | number | null | Tensile strength, Pa. Used ONLY by the bolt connector, for EN 1993-1-8 Table 6.11's bearing stiffness k_12, which is a function of the ply's f_u. None means that component is left out and the connector carries the shank's own flexibility alone - which is stiffer, and is said out loud in a warning rather than left to be discovered. Default: null. | |
fy | number | null | Yield stress, Pa. None is carried through untouched - see the module note on why this is not defaulted. Default: null. | |
id | string | yes | Label carried through to the mesh so the viewer can name a part. Not interpreted. |
nu | number | null | Poisson's ratio. None uses 0.3. Unlike e and fy this is defaulted deliberately: for structural steel 0.3 is a material constant, not a design decision, and there is no plausible input for which a caller meant something else and forgot to say so. It is a field rather than a buried constant so that the value is visible in the input a caller can print. Default: null. | |
origin | number[] | yes | Global position of the plate's local origin, on the MID-SURFACE. |
outline | number[][] | yes | Outline in the plate's local 2D frame, metres. Winding is normalised to CCW here, so a caller that hands over a CW outline still gets a correct mesh. |
t | number | yes | Plate thickness, m. |
FeRotationProbe
WHERE TO MEASURE A ROTATION, for the joint stiffness Sj = M / theta. Named by the CALLER, not found here, and the boundary is deliberate. conn_fea knows plates, bolts and welds; it does not know which plate is a beam web and which is a column flange. The layer that assembles a joint from its members (jointfea.js) knows exactly that, so it names the cross-sections to measure and this returns their rotations. Teaching the FEA member topology to save the caller a box would put the same knowledge in two places. Selection is identical to a load or support region - a box, optionally narrowed to a slab about a plane - so a pitched member's face is describable here for the same reason it is there.
| Field | Type | Required | Description |
|---|---|---|---|
about | number[] | null | The axis to report the rotation about, normally the member's bending axis. None reports the vector only - for a caller that wants to choose the axis after seeing it. Default: null. | |
at | number[] | null | Default: null. | |
axis | number[] | null | Default: null. | |
max | number[] | yes | |
min | number[] | yes | |
name | string | yes | The caller's name for this section, echoed back. Sj is a ratio between two of them, and a result that only carried an index would make that pairing positional. |
slab | number | null | Default: null. |
FeSupport
A restrained REGION: every mesh node inside the axis-aligned box has the listed DOFs fixed. A box rather than a node list because the caller works in geometry, not in mesh indices - and the mesh is rebuilt whenever the element size changes, so any index the caller held would be stale. fixed is [ux, uy, uz, rx, ry, rz] in GLOBAL axes.
| Field | Type | Required | Description |
|---|---|---|---|
at | number[] | null | Default: null. | |
axis | number[] | null | Optional slab, as on FeLoad: nodes within slab of the plane through at normal to axis. A held member end is a face, and a pitched member's face is not a world-axis box. Default: null. | |
fixed | boolean[] | yes | |
max | number[] | yes | |
min | number[] | yes | |
slab | number | null | Default: null. |
FeWeld
A WELD: ties one plate's edge to another plate, so load can pass between them. The tie is a node-to-surface constraint enforced by penalty, not a merging of nodes. Merging needs coincident nodes, and two plates drawn at their real positions meet at their MID-SURFACES only after trimming - a fin plate's edge sits half a column-flange thickness off the flange's mid-surface, and each plate is meshed independently so no node of one lands on a node of the other. So each welded edge node is instead constrained to move with the point it projects onto on the other plate, including the rigid offset between the two. The weld is treated as RIGID (spec: "start RIGID, refine to a weld stiffness later"). It has no strength here and no flexibility: a weld that would fail is not detected by this, and the component-method weld checks remain the only thing that says whether it is adequate.
| Field | Type | Required | Description |
|---|---|---|---|
end | number[] | yes | |
penalty | number | null | Penalty stiffness as a multiple of the welded plate's membrane stiffness E t. None uses WELD_PENALTY. Raising it tightens the constraint and worsens the conditioning; the answer must not depend on it, which weld_tie_is_insensitive_to_the_penalty checks. Default: null. | |
plate | integer | yes | Index into ConnFeaInput::plates of the plate whose EDGE is welded. |
start | number[] | yes | The weld line in global coordinates. Boundary nodes of plate within tol of this segment are the ones tied. |
to | integer | yes | Index into ConnFeaInput::plates of the plate it is welded TO. |
tol | number | yes | How close a boundary node must be to the weld line to be part of it, m. |
FloorMode
A mode as the footfall calculation needs it: frequency, the modal mass of the unity-normalised shape, and the unity-normalised amplitudes at the excitation and response points.
| Field | Type | Required | Description |
|---|---|---|---|
frequency_hz | number | yes | |
modal_mass_kg | number | yes | |
mu_e | number | yes | |
mu_r | number | yes |
FloorVibrationResult
Used by p354_floor_vibration.
| Field | Type | Required | Description |
|---|---|---|---|
base_value | number | yes | |
cutoff_hz | number | yes | |
damping_ratio | number | yes | |
floor_class | string | yes | "low" or "high", by Table 6.1. |
fundamental_hz | number | yes | |
governing | string | yes | |
governing_pace_hz | number | yes | |
limit | number | yes | |
ok | boolean | yes | |
response_factor | number | yes | The governing response factor (the larger of steady-state and transient) and where it came from. |
standard | string | yes | |
steady_state | SteadyStateResult | null | ||
steps | Step[] | yes | |
transient | TransientResult | yes | |
verified | boolean | yes | |
warnings | string[] | yes | |
weighting | Weighting | yes |
FootingCode
The design standard for the concrete checks. AS 3600 (default) or ACI 318-19; a FootingStandard impl supplies each code's coefficients (footing_standard.rs). Serialised camelCase ("as3600"/"aci318").
One of: "as3600", "aci318", "eurocode2"
GeoPolygon
A classification polygon: an outer ring plus optional holes, with a name and an optional attribute value (e.g. a wind-region code or a site-class string read from the source feature).
| Field | Type | Required | Description |
|---|---|---|---|
class | string | null | Optional attribute carried from the source feature (e.g. "C", "M", "SITE_CLASS" value). Default: null. | |
name | string | Default: "". | |
rings | number[][][] | yes | Rings in GeoJSON order: rings[0] is the outer ring, rings[1..] are holes. Each vertex [lon, lat]. |
Governing
| Field | Type | Required | Description |
|---|---|---|---|
combination | string | yes | |
mode | string | yes | |
util | number | yes |
ImposedRow
Used by as1170_1_imposed.
Table 3.1 - reference values of imposed floor actions. udl_kpa/point_kn are None where the standard's cell is not a flat number (a per-metre-of-storage-height rate, a line load, "same as areas providing access", "to be calculated", or a dash) - the full wording lives in note and in the ledger doc, never invented as a spurious float.
| Field | Type | Required | Description |
|---|---|---|---|
category | string | yes | |
note | string | yes | |
point_kn | number | null | ||
udl_kpa | number | null | ||
use_ | string | yes |
Input
A "given" shown at the top of a derivation (the inputs the working starts from).
| Field | Type | Required | Description |
|---|---|---|---|
source | string | yes | Where the value came from (catalogue, member force, assumption) - for traceability. |
symbol | string | yes | |
unit | string | yes | |
value | number | yes |
LoadGroup
One group of Table 2.2, as characteristic wheel loads on the runway beam.
| Field | Type | Required | Description |
|---|---|---|---|
buffer_kn | number | yes | |
group | integer | yes | |
h_l_per_rail_kn | number | yes | Horizontal loads the group carries (kN per wheel unless stated): longitudinal H_L per rail, transverse H_T per rail, skewing guide force S, buffer H_B. |
h_t_rail1_kn | number | yes | |
h_t_rail2_kn | number | yes | |
name | string | yes | |
note | string | yes | |
phi_crane | number | yes | The factors the group applies to the crane self-weight and the hoist load. |
phi_hoist | number | yes | |
q_rail1_per_wheel_kn | number | yes | Vertical wheel loads on rail 1 (the near rail, crab at its minimum approach) and rail 2 (kN per wheel). |
q_rail2_per_wheel_kn | number | yes | |
skew_s_kn | number | yes |
MaterialAxisResult
Plate results in the material axes of an orthotropic plate (axis 1 = its PlateOrthotropy::axis projected onto the plate). Moments and membrane forces are per metre width and turn as tensors: m1 = mx c^2 + my s^2 + 2 mxy c s, m2 = mx s^2 + my c^2 - 2 mxy c s, m12 = (my - mx) c s + mxy (c^2 - s^2), with the same for n from the membrane forces (stress x thickness).
| Field | Type | Required | Description |
|---|---|---|---|
angle | number | yes | Angle (rad) from the element's local x to material axis 1; element-specific, for tracing. |
m1 | number | yes | Bending moment along the grain: the one that bends fibres running along axis 1 (N m/m). |
m12 | number | yes | Twisting moment in the material axes (N m/m). |
m2 | number | yes | Bending moment for fibres running along axis 2, across the grain (N m/m). |
n1 | number | yes | Membrane force along axis 1 (N/m, tension positive). |
n12 | number | yes | In-plane shear force in the material axes (N/m). |
n2 | number | yes | Membrane force along axis 2 (N/m). |
MemberUtilSummary
| Field | Type | Required | Description |
|---|---|---|---|
governing | string | yes | |
member_id | integer | yes | |
pass | boolean | yes | |
utilMax | number | yes |
Mesh2d
A triangulated 2D mesh: node coordinates, CCW-wound triangles (indices into nodes), and the subset of node indices that lie on the mesh boundary (outer + hole edges).
| Field | Type | Required | Description |
|---|---|---|---|
boundary_nodes | integer[] | yes | |
nodes | number[][] | yes | |
tris | integer[][] | yes |
MeshFidelity
Mesh fidelity for a raft solve - the light/deep trade an engineer iterates with. LIGHT is a coarse, fast, preliminary mesh (honestly INDICATIVE on a large mat); DEEP targets the E3 convergence threshold with a high triangle budget, so a large mat converges to a certified result at the cost of a slower (off-thread) solve. Defaults to LIGHT so a quick edit-solve loop stays responsive; the caller opts into DEEP for the final check.
One of: "light", "deep"
ModelStats
| Field | Type | Required | Description |
|---|---|---|---|
combinationCount | integer | yes | |
hasEnvelope | boolean | yes | |
loadCaseCount | integer | yes | |
memberCount | integer | yes | |
nodeCount | integer | yes | |
plateCount | integer | yes |
OrthotropyInput
How an orthotropic plate's stiffness is given. Constants are in MATERIAL axes (axis 1 along PlateOrthotropy::axis).
One of:
kind: "material"- Homogeneous orthotropic material; the plate'sthicknessapplies. Pa.Field Type Required Description e1numberyes e2numberyes g12numberyes g13numberyes g23numberyes kind"material"yes nu12numberyes kind: "rigidities"- Equivalent rigidities (decking, ribbed/hollowcore slabs, CLT from its layup). A and S in N/m, D in N m. The plate'sthicknessis then used only for self-weight, mass and the nominal stresses.
PartialFactors
Partial factors. EN 1992-4 Table 4.1 defaults; AS 5216 values unverified (see module doc).
| Field | Type | Required | Description |
|---|---|---|---|
gamma_mc | number | yes | |
gamma_mp | number | yes | |
verified | boolean | Steel tension/shear are the caller's AS 4100 design capacities (phi already applied). Default: false. |
PassFailRollup
| Field | Type | Required | Description |
|---|---|---|---|
failingMembers | integer | yes | |
maxUtilOverall | number | yes | |
pass | boolean | yes | |
passingMembers | integer | yes | |
totalMembersChecked | integer | yes |
PedestalInput
Used by pedestal_design.
| Field | Type | Required | Description |
|---|---|---|---|
aScTotal | number | yes | TOTAL longitudinal steel area Asc (mm^2), summed over all bars. |
barDia | number | yes | Longitudinal bar diameter (mm) - to place the bar centroid off the cover. |
braced | boolean | yes | Whether the pedestal is braced against sidesway (Cl 10.3.1). Pedestals are normally braced by the surrounding construction; braced uses the Le/r < 25 limit, unbraced Le/r < 22. |
cover | number | yes | Clear cover to the longitudinal bars (mm). |
dcX | number | yes | Pedestal plan dimension along global X (mm). |
dcY | number | yes | Pedestal plan dimension along global Y (mm). |
fPrimeC | number | yes | Concrete characteristic strength f'c (MPa). |
fPrimeCBearing | number | yes | Concrete strength at the bearing interface (MPa) - the weaker of the bearing member and the pedestal. Zero means "use the pedestal f'c" (Cl 12.6 takes the weaker of the two concretes). |
fSy | number | yes | Reinforcement yield strength fsy (MPa). |
height | number | yes | Pedestal height (mm) - used by the (deferred) slenderness classification. |
kEff | number | yes | Effective length factor k (Cl 10.5.3). Le = k * height. Default 1.0 is conservative (a pedestal fixed into the footing has a lower k, so 1.0 over-estimates slenderness, which only makes the short-column test stricter - the safe direction, since a slender pedestal is refused). |
loadBx | number | yes | Loaded bearing footprint on the pedestal TOP along X (mm) - the steel column or base plate. Zero means "not supplied", and the Cl 12.6 bearing check is then reported NotDetermined. |
loadBy | number | yes | Loaded bearing footprint on the pedestal top along Y (mm). |
mxStar | number | yes | Design moment about the global X axis (N·mm). |
myStar | number | yes | Design moment about the global Y axis (N·mm). |
nStar | number | yes | Design axial load N* (N), compression positive. |
PedestalResult
Used by pedestal_design.
| Field | Type | Required | Description |
|---|---|---|---|
adequate | boolean | null | Some(true/false) once every check is determined; None while any check is NotDetermined, because an undetermined check cannot be certified adequate. | |
bearing | CheckState | yes | Cl 12.6 bearing at the loaded interface. Ok when util <= 1; NotDetermined when no loaded area was supplied (bearing cannot be checked without it). |
bearingUtil | number | yes | Cl 12.6 bearing utilisation at the loaded interface (NaN when not determined). |
fitmentMaxSpacing | number | yes | Cl 10.7.4.3(b)(i): maximum fitment spacing = min(Dc, 15.db) for single bars (mm). |
fitmentMinDia | number | yes | Cl 10.7.4.3(a) Table: minimum fitment/tie bar diameter for the longitudinal bar size (mm). |
fitments | CheckState | yes | Cl 10.7.3/10.7.4 fitments. Ok = the detailing requirement is determined (min fitment diameter + max spacing below); it states what to provide, not a demand pass/fail. |
phiMN | number | yes | Bending capacity at the applied axial load phi.Mn (N·mm) for the governing axis. |
phiNuo | number | yes | Squash-load capacity phi.Nuo (N) for the governing axis. |
reducedMinPermitted | boolean | yes | Cl 10.7.1(a) proviso: a reduced minimum is permitted when Ag.fsy > 0.15 N*. |
slenderness | CheckState | yes | Cl 10.3.1 short-column classification. Ok = short (the M-N check above is valid with slenderness moments taken as zero); NotAdequate = slender (needs the Cl 10.4 moment magnifier, which this module does not perform - the pedestal is refused rather than designed unsafely). |
slendernessLimit | number | yes | The short-column limit applied (25 braced / 22 unbraced), Cl 10.3.1. |
slendernessRatio | number | yes | Slenderness ratio Le/r (Cl 10.3.1, r per Cl 10.5.2) on the most slender axis. |
steelMax | CheckState | yes | Cl 10.7.1(b): Asc <= 0.04 Ag. |
steelMin | CheckState | yes | Cl 10.7.1(a): Asc >= 0.01 Ag. |
steelRatio | number | yes | Longitudinal steel ratio Asc/Ag. |
utilInteraction | number | yes | Governing M-N interaction utilisation (Cl 10). <= 1.0 is adequate. |
PileCapInput
Used by pilecap_design.
| Field | Type | Required | Description |
|---|---|---|---|
barDia | number | Main bar diameter (mm) - to place the bar centroid and set the effective depth. Default: 0. | |
capBx | number | Cap plan dimensions (mm). Default: 0. | |
capBy | number | Default: 0. | |
capThickness | number | Cap overall thickness (mm). Default: 0. | |
capWeight | number | yes | Cap self-weight + soil overburden (N), added to the axial as uniform compression. 0 to ignore. |
columnBx | number | Column footprint on the cap (mm) - the flexure/shear critical sections start at the column face. Default: 0. | |
columnBy | number | Default: 0. | |
cover | number | Cover to the main (bottom) bars (mm). Default: 0. | |
fPrimeC | number | Cap concrete strength f'c (MPa). Default: 0. | |
fSy | number | Reinforcement yield strength fsy (MPa). Default: 0. | |
mxStar | number | yes | Column design moment about the global X axis (N.m). |
myStar | number | yes | Column design moment about the global Y axis (N.m). |
nStar | number | yes | Column design axial N* (N), compression positive. |
pileCapCompression | number | yes | Single-pile capacity in compression (N). <= 0 => the compression check is NotDetermined. |
pileCapTension | number | yes | Single-pile capacity in tension / uplift (N), positive magnitude. 0 means the piles are taken as unable to carry tension, so any uplift fails. |
pileDia | number | Pile diameter/side (mm) - the loaded area for the pile-punching check. 0 -> pile punching is not checked (NotDetermined), but column punching still is. Default: 0. | |
piles | number[][] | yes | Pile plan positions (m), measured from the COLUMN / load point (any consistent origin - the centroid is computed from these). |
standard | FootingCode | The concrete design standard (AS 3600 default / ACI 318 / Eurocode 2) for the SHALLOW-cap concrete checks (flexure Cl 8.1, one-way shear Cl 8.2, punching Cl 9.3). Omitted -> AS 3600, so every existing payload is unchanged. The DEEP-cap strut-and-tie model (Section 7) is AS 3600 regardless of this field - a per-code strut-and-tie is out of scope (see strut_and_tie). Default: "as3600". |
PileCapResult
Used by pilecap_design.
| Field | Type | Required | Description |
|---|---|---|---|
adequate | boolean | null | Some(true/false) only when the APPLICABLE method is fully checked: a shallow cap by the flexural model (flexure + one-way shear + punching), a deep cap by strut-and-tie. None when the governing method's checks are not all determined (missing geometry) - a deep cap is never certified on the conservative beam model. | |
capAstReq | number | yes | |
capFlexure | CheckState | yes | Cap FLEXURE at the column face (AS 3600 Cl 8.1). Ok when the section can carry the design moment (steel found); NotAdequate when it cannot; NotDetermined when no cap geometry supplied. |
capMStar | number | yes | Governing design moment at the column face (N.mm) and the required bottom steel (mm^2, total across the cap width) in that direction. |
capPunching | CheckState | yes | Cap PUNCHING (Cl 9.3): the worst of column punching (the column into the cap) and pile punching (a pile up through the cap, with free-edge perimeter truncation for edge/corner piles). Ok when the worst util <= 1. NotDetermined when no cap geometry. |
capPunchingUtil | number | yes | |
capShear | CheckState | yes | Cap one-way (beam) SHEAR at d from the column face (Cl 8.2). Ok when V* <= phi.Vuc. |
capShearUtil | number | yes | |
compressionCheck | CheckState | yes | Cl-independent capacity checks. |
compressionUtil | number | yes | Compression utilisation = max_reaction / pile_cap_compression. |
deepCap | boolean | yes | True when the cap is DEEP - the nearest pile centre is within the effective depth of the column face (a_v <= d). The flexural/beam-shear model is then conservative or inapplicable and the strut-and-tie model (Section 7) governs; strut_tie is that check. |
maxReaction | number | yes | Largest compression reaction (N). |
minReaction | number | yes | Smallest reaction (N) - negative means uplift. |
reactions | number[] | yes | Per-pile axial reaction (N), compression positive, in the input pile order. |
strutTie | CheckState | yes | Deep-cap STRUT-AND-TIE model (AS 3600:2018 Section 7). Ok when the model is valid (every strut-to-tie angle >= 30 deg, Cl 7 item (g)) and the strut concrete is adequate; NotAdequate when an angle is too shallow or a strut over-stresses; NotDetermined without the geometry. |
strutTieAstReq | number | yes | Required bottom TIE steel Ast (mm^2) in the governing direction = T / (0.85 fsy), Cl 7.3. |
strutTieMinAngleDeg | number | yes | Minimum strut-to-tie angle (deg) - below 30 the STM is not permitted. |
strutTieUtil | number | yes | Worst strut concrete-stress utilisation (Cl 7.2.3, phi_st 0.65, beta_s Cl 7.2.2) at the pile node. |
uplift | boolean | yes | True when any pile is in tension (min_reaction < 0). |
upliftCheck | CheckState | yes | |
upliftUtil | number | yes | Uplift utilisation = |min_reaction| / pile_cap_tension when uplift occurs (else 0). Infinite when a pile lifts but no tension capacity was given. |
PileInput
Used by pile_design.
| Field | Type | Required | Description |
|---|---|---|---|
diameter | number | yes | Pile shaft diameter (m). The tip is at the bottom of the last layer (embedded length = sum of the layer thicknesses). |
driven | boolean | yes | Driven pile mobilises higher lateral stress on the shaft than a bored one (K factor). |
gammaConcrete | number | Concrete unit weight for the pier's own weight (kN/m^3), 24 by default; buoyant below the WT. Default: 24. | |
hStar | number | Design lateral load at the pier head (kN), applied load_height above ground. 0 = no check. Default: 0. | |
layers | PileSoilLayer[] | yes | Soil profile, top-down; the pile is embedded through all of it. |
loadHeight | number | Height of the lateral load above ground level (m): the base plate height, or 0 at grade. Default: 0. | |
nStar | number | yes | Design axial compression N* (kN). 0 -> utilisation reported as 0. |
nUplift | number | Design uplift (tension) load on the pier (kN). 0 = no check. Default: 0. | |
phiG | number | yes | AS 2159 geotechnical strength reduction factor phi_g (from the risk assessment, ~0.40-0.65). |
tensionShaftFactor | number | Fraction of the compression shaft resistance mobilised in tension (0.7 by default). Default: 0.7. | |
waterTable | number | yes | Depth to the water table (m from the surface); large = dry. |
PileResult
Used by pile_design.
| Field | Type | Required | Description |
|---|---|---|---|
baseUltimate | number | yes | Ultimate base (end bearing) resistance (kN). |
design | number | yes | Design geotechnical strength Rd,g = phi_g . Rd,ug (kN). |
embeddedLength | number | yes | Embedded length (m) = sum of layer thicknesses. |
lateralDesign | number | yes | Lateral: design lateral resistance phi_g x H_u (kN). |
lateralMethod | string | yes | "broms-cohesive" or "broms-cohesionless". |
lateralMomentAtHStar | number | yes | Lateral: the moment in the pier under H* (Broms scales with the load), kNm. |
lateralMomentDepth | number | yes | Lateral: depth below ground to the maximum moment (m). |
lateralMomentUltimate | number | yes | Lateral: maximum bending moment in the pier at the ultimate lateral load (kNm), for the section check; scaled to H* in lateral_moment_at_h_star. |
lateralSoil | string | yes | The idealised soil the lateral check used: c_u (kPa) or phi' (deg) and gamma' (kN/m^3). |
lateralUltimate | number | yes | Lateral: Broms ultimate lateral load at the head (kN). |
pierWeight | number | yes | Uplift: the pier's own weight (kN), buoyant below the water table. |
shaftUltimate | number | yes | Ultimate shaft (skin friction) resistance (kN). |
ultimate | number | yes | Ultimate geotechnical strength Rd,ug = shaft + base (kN). |
upliftDesign | number | yes | Uplift: design resistance = phi_g x tension shaft + pier weight (the weight is not a geotechnical strength and takes no phi_g) (kN). |
upliftShaftUltimate | number | yes | Uplift: shaft resistance in tension (kN) = tension_shaft_factor x compression shaft. |
upliftUltimate | number | yes | Uplift: ultimate resistance = tension shaft + pier weight (kN). |
util | number | yes | Utilisation N* / Rd,g (NaN when no capacity). |
utilLateral | number | yes | Lateral utilisation H* / lateral_design (NaN when not asked). |
utilUplift | number | yes | Uplift utilisation N_uplift / uplift_design (NaN when not asked). |
verified | boolean | yes | |
warnings | string[] | yes |
PileSoilLayer
| Field | Type | Required | Description |
|---|---|---|---|
cohesive | boolean | yes | Cohesive (clay) uses su; else cohesionless (sand) uses phi_deg. |
gamma | number | yes | Total unit weight (kN/m^3), for the effective overburden. |
phiDeg | number | yes | Effective friction angle phi' (deg) - cohesionless layers. |
su | number | yes | Undrained shear strength su (kPa) - cohesive layers. |
thickness | number | yes | Layer thickness (m), top-down. |
PlateMeshInfo
Per-plate mesh bookkeeping, so a caller can attribute anything back to the plate it came from.
| Field | Type | Required | Description |
|---|---|---|---|
holes_cut | integer | yes | Holes actually cut into this plate. Fewer than the bolts aimed at it means one was refused - the reason is in ConnFeaMesh::warnings. |
id | string | yes | |
node_end | integer | yes | |
node_start | integer | yes | [start, end) into ConnFeaMesh::nodes. |
thickness | number | yes | |
tri_end | integer | yes | |
tri_start | integer | yes | [start, end) into ConnFeaMesh::tris. |
PlateOrthotropy
An orthotropic plate. Kept beside Plate for the same reason as cables: plate literals and saved models that predate it need no change. axis is a GLOBAL direction for material axis 1; each element projects it onto its own plane, so one vector serves a whole panel whatever its corner numbering or orientation.
| Field | Type | Required | Description |
|---|---|---|---|
axis | number[] | yes | |
input | OrthotropyInput | yes | |
plate_id | integer | yes |
PlateTakeoff
Per-plate take-off line.
| Field | Type | Required | Description |
|---|---|---|---|
area_m2 | number | yes | |
mass_kg | number | yes | |
num | integer | yes | |
surface_area_m2 | number | yes | One-side surface area (for coating / galvanising estimates). |
Polygon
A simple polygonal region: an outer boundary and zero or more holes. outer must wind counter-clockwise; each entry in holes must wind clockwise. Later tasks (constrained Delaunay + hole carving) rely on this winding convention to classify triangles as inside/outside the region.
| Field | Type | Required | Description |
|---|---|---|---|
holes | number[][][] | yes | |
outer | number[][] | yes |
ProbeRotation
One probe's answer.
| Field | Type | Required | Description |
|---|---|---|---|
about | number | null | Its component about about, rad. None when no axis was named or no rotation was fitted. | |
at | number[] | yes | The centroid of the caught nodes, m - the point the rotation is reported about. |
name | string | yes | |
nodes | integer | yes | How many mesh nodes the probe caught. Reported because a probe over three nodes and one over three hundred are not equally trustworthy, and only the caller can judge which it has. |
rotation | number[] | null | The fitted rigid-body rotation, rad, as an axis-angle vector. None when the caught set cannot define one - too few nodes, or too close to collinear. |
RaftFeInput
Used by raft_fe_solve.
Input for one unstructured-mesh raft FE run.
| Field | Type | Required | Description |
|---|---|---|---|
columns | ColumnLoad[] | yes | |
e_concrete | number | yes | |
ks | number | yes | |
nu | number | yes | |
poly | Polygon | yes | |
self_weight | number | yes | |
sizing | SizingField | yes | |
thickness | number | yes |
RaftFeResult
Used by raft_fe_solve.
Result of one unstructured-mesh raft FE run.
| Field | Type | Required | Description |
|---|---|---|---|
applied_load | number | yes | |
converged | boolean | yes | |
equilibrium_error | number | yes | |
mesh | Mesh2d | yes | |
mx_nodes | number[] | yes | |
mxy_nodes | number[] | yes | |
my_nodes | number[] | yes | |
q_max | number | yes | |
q_min | number | yes | |
q_nodes | number[] | yes | |
sum_reaction | number | yes | |
uz_nodes | number[] | yes | |
vx_nodes | number[] | yes | |
vy_nodes | number[] | yes | |
warnings | string[] | yes |
RaftPointInput
Used by raft_design.
Input for a raft reinforcement point.
| Field | Type | Required | Description |
|---|---|---|---|
d | number | yes | Effective depth (mm), concrete strength (MPa), steel yield (MPa). |
fPrimeC | number | yes | |
fSy | number | yes | |
mx | number | yes | Plate bending + twisting moments per metre (N.mm/m): Mx, My, Mxy. |
mxy | number | yes | |
my | number | yes |
RaftReo
Used by raft_design.
Raft reinforcement at a point: the required steel (mm^2 per metre width) in each direction, each face, from the Wood-Armer design moments. d = effective depth (mm), f_prime_c, f_sy (MPa). A moment a 1 m section cannot carry returns None for that entry (honest - never a silent 0).
| Field | Type | Required | Description |
|---|---|---|---|
astXBottom | number | null | Bottom/top steel in the X and Y directions, mm^2/m. None = the section cannot carry that moment. | |
astXTop | number | null | ||
astYBottom | number | null | ||
astYTop | number | null | ||
design | WoodArmer | yes | The Wood-Armer design moments used (per metre: N.mm/m). |
RcDesignStatus
One of:
"ok"- Steel found within the limits."too_small"- No steel within the limits works: the section has to grow."review"- Steel found, but part of the design is not covered here (fitments, slenderness)."not_determined"- The input cannot be designed (no section, no f'c).
ReactionExtreme
| Field | Type | Required | Description |
|---|---|---|---|
component | string | yes | |
load_case_id | integer | yes | |
node_id | integer | yes | |
value | number | yes |
ReinforcementClass
THE REINFORCEMENT'S DUCTILITY CLASS - AS/NZS 4671, and what AS 3600 Table 2.2.2(b) does with it. For bending without axial tension or compression the standard gives two different capacity reduction factors, and they are not close: (b)(i) Class N reinforcement and/or tendons: 0.65 <= phi = 1.24 - 13 k_uo / 12 <= 0.85 (b)(ii) Class L reinforcement: phi = 0.65, flat A lightly reinforced pad designed on the Class N curve gets phi near 0.85; the same pad with mesh gets 0.65, which is 24% less capacity for the same bars. Designing mesh on the Class N factor is therefore unconservative by about that much, and nothing in the geometry says which was meant - only the specification does. MESH IS CLASS L, and is a separate variant rather than an alias because the two are different things to a detailer even though Table 2.2.2 treats them alike: a schedule that says "mesh" and a schedule that says "Class L bars" are not the same document. phi is identical for both, and the code says so at the one place it is read rather than by leaving them to look coincidental.
One of:
"n"- Normal ductility - deformed bar to AS/NZS 4671. The default, and what every result before 2026-09-09 assumed."l"- Low ductility bar."mesh"- Welded wire mesh, which is Class L for Table 2.2.2.
RestraintEdge
The edge a bending member's lateral restraints hold (Cl 3.2.3.2).
One of:
"compression","tension""tension_and_torsional"- Continuous tension-edge restraint plus torsional restraints atla_phi(Eq 3.2(8)).
RidgeTieCapacity
Used by ridge_tie_cleat_check.
| Field | Type | Required | Description |
|---|---|---|---|
governing | string | yes | |
util_bolt_shear | number | yes | |
util_max | number | yes | |
util_plate_axial | number | yes | |
util_plate_bearing | number | yes | |
util_plate_bending | number | yes | |
util_plate_shear | number | yes | |
util_tie_bearing | number | yes | |
util_weld | number | yes |
RobustnessResult
Used by en1991_1_7_robustness.
| Field | Type | Required | Description |
|---|---|---|---|
class | ConsequencesClass | yes | |
class_examples | string | yes | |
class_label | string | yes | |
construction | Construction | yes | |
f_t | number | null | A6.2: F_t (kN/m or kN), None for framed construction. | |
horizontal_ties_required | boolean | yes | Whether the strategy asks for horizontal ties at all (Class 2 and above). |
key_element_ad_kpa | number | yes | A9: the key-element accidental design action A_d (kN/m2), horizontal and vertical, one at a time. |
notional_removal_damage_limit | number | yes | A5(c): the admissible local damage on notional removal, 15 percent of the floor in each of two adjacent storeys. |
standard | string | yes | |
steps | Step[] | yes | |
strategy | string | yes | |
t_internal | number | yes | A6.1 framed: internal tie force T_i (kN) and perimeter tie force T_p (kN); A6.2 wall: internal T_i (kN/m of floor width) and peripheral T_p (kN). |
t_perimeter | number | yes | |
t_vertical | number | null | A7: framed, the accidental design tensile force on the column (kN); wall, the vertical tie force (N per the formula, reported in kN/m of wall). | |
t_vertical_units | string | yes | |
tie_units | string | yes | The unit the horizontal tie forces are in: "kN" (framed) or "kN/m, kN" (wall internal, peripheral). |
verified | boolean | yes | |
vertical_ties_required | boolean | yes | Whether the strategy asks for vertical ties or the notional-removal alternative (Class 2b). |
warnings | string[] | yes |
RoofSnow
Used by as1170_snow_load.
| Field | Type | Required | Description |
|---|---|---|---|
balanced_only | boolean | yes | |
cases | SnowCase[] | yes | |
ce | number | yes | |
citation | string | yes | |
equation | string | yes | |
gamma_kn_m3 | number | yes | |
kp | number | yes | |
overhang_kn_m | number | yes | Cl 4.2.3: the edge overhang load, kN per metre of eave, from the peak case. |
peak_kpa | number | yes | The largest load any case puts on any slope, kPa - the number a first pass sizes to. |
sg_kpa | number | yes |
SectionRollup
Roll-up by section name (matches the JS bySection shape).
| Field | Type | Required | Description |
|---|---|---|---|
count | integer | yes | |
mass_per_metre_kg | number | yes | |
section | string | yes | |
totalLength_m | number | yes | |
totalMass_kg | number | yes |
SettlementInput
Used by settlement_design.
| Field | Type | Required | Description |
|---|---|---|---|
b | number | yes | Footing plan dimensions (m). The least dimension is used as B in the elastic formula. |
cc | number | yes | Compression index Cc (virgin line slope). |
cr | number | yes | Recompression index Cr (unload-reload slope). 0 falls back to Cc when overconsolidated. |
depthFactor | number | yes | Embedment (depth) correction factor I_F (<= 1), Fox's correction. 1.0 (default/conservative) ignores the reduction from founding below the surface. |
e0 | number | yes | Initial void ratio e0. |
eSoil | number | yes | Soil drained (long-term) or undrained elastic modulus for the immediate part (kPa). |
hLayer | number | yes | Compressible layer thickness (m). <= 0 means "no consolidation layer" -> ConsolState::NotComputed. |
l | number | yes | |
nuSoil | number | yes | Soil Poisson's ratio (-). |
qNet | number | yes | Net applied bearing pressure at founding level (kPa) - the pressure ABOVE the pre-existing overburden, which is what drives settlement. |
sigmaPc | number | yes | Preconsolidation pressure sigma'_p (kPa). <= sigma'_0 is treated as normally consolidated. |
sigmaV0 | number | yes | Initial vertical effective stress at mid-layer, sigma'_0 (kPa). |
zToMid | number | yes | Depth from founding level to the MIDDLE of the compressible layer (m), where the representative stress increase is evaluated. |
SettlementResult
Used by settlement_design.
| Field | Type | Required | Description |
|---|---|---|---|
consolState | ConsolState | yes | Which e-log(sigma') branch was used (or NotComputed). |
consolidation | number | yes | Primary consolidation settlement (mm); 0 with state NotComputed when there is no layer. |
deltaSigmaMid | number | yes | Stress increase at mid-layer from the 2:1 spread, delta-sigma (kPa). |
immediate | number | yes | Immediate (elastic) settlement (mm). |
total | number | yes | Total settlement (mm) = immediate + consolidation. |
SgCombination
A factored load combination.
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | yes | |
name | string | yes | |
terms | SgCombinationTerm[] | yes |
SgCombinationTerm
One term in a load combination: (load_case_id * factor).
| Field | Type | Required | Description |
|---|---|---|---|
factor | number | yes | |
load_case_id | integer | yes |
SgEndRelease
End-release flags for a member end (true = released, false = fixed).
| Field | Type | Required | Description |
|---|---|---|---|
fx | boolean | yes | |
fy | boolean | yes | |
fz | boolean | yes | |
mx | boolean | yes | |
my | boolean | yes | |
mz | boolean | yes |
SgEntryInfo
Used by list_sg_entries.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | |
size | integer | yes |
SgImportDiagnostics
Diagnostic summary produced during import_sg_model.
| Field | Type | Required | Description |
|---|---|---|---|
decoded_tags | string[] | yes | Tags that were successfully decoded. |
missing_tags | string[] | yes | Tags that were not present at all. |
skipped_tags | string[] | yes | Tags that were present in the archive but are intentionally skipped (e.g. large result blobs or tags not yet decoded). |
SgLoadCase
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | yes | |
name | string | Default: "". |
SgMaterial
| Field | Type | Required | Description |
|---|---|---|---|
alpha | number | Default: 0. | |
density | number | yes | |
e | number | yes | |
fu | number | Default: 0. | |
fy | number | Default: 0. | |
g | number | yes | |
id | integer | yes | |
library | string | Default: "". | |
name | string | yes | |
nu | number | yes |
SgMember
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | yes | |
material_id | integer | yes | |
name | string | Member name / description from @SD (empty if not present). Default: "". | |
node_a | integer | yes | |
node_b | integer | yes | |
release_a | SgEndRelease | yes | |
release_b | SgEndRelease | yes | |
section_id | integer | yes |
SgMemberLoad
| Field | Type | Required | Description |
|---|---|---|---|
load_case_id | integer | yes | |
load_type | integer | yes | SpaceGass load category code (kept for diagnostics; 1/2/3 = load grouping). |
member_id | integer | yes | |
qx | number | yes | Distributed load intensity at the START of the loaded length, in SI (N/m), resolved onto global axes. qy is vertical (negative = gravity). |
qx2 | number | yes | Intensity at the END of the loaded length (N/m). Equal to the start value for a uniform UDL; differs only for a trapezoidal load. |
qy | number | yes | |
qy2 | number | yes | |
qz | number | yes | |
qz2 | number | yes |
SgMemberOffset
| Field | Type | Required | Description |
|---|---|---|---|
axis | integer | yes | 0 = global axes, 1 = local axes (best-effort, observed as 0 in samples). |
member_id | integer | yes | |
offset_a | number[] | yes | Offset at end A [dx, dy, dz] in metres. |
offset_b | number[] | yes | Offset at end B [dx, dy, dz] in metres. |
SgMemberPointLoad
| Field | Type | Required | Description |
|---|---|---|---|
axis | integer | yes | 0/1 = global/local axes (best-effort). |
fx | number | yes | Forces in Newtons (converted from kN stored in file). |
fy | number | yes | |
fz | number | yes | |
load_case_id | integer | yes | |
member_id | integer | yes | |
mx | number | yes | Moments in N·m (converted from kN·m stored in file). |
my | number | yes | |
mz | number | yes | |
position_ratio | number | yes | Load position as a ratio (0.0 to 1.0) along the member. |
sub_load | integer | yes | Sub-load index (SpaceGass internal grouping). |
SgModel
Used by import_sg_model.
| Field | Type | Required | Description |
|---|---|---|---|
combinations | SgCombination[] | yes | |
connection_config | ConnectionConfig | null | ||
diagnostics | SgImportDiagnostics | yes | |
entries | SgEntryInfo[] | yes | |
load_cases | SgLoadCase[] | yes | |
materials | SgMaterial[] | yes | |
member_loads | SgMemberLoad[] | yes | |
member_offsets | SgMemberOffset[] | yes | |
member_point_loads | SgMemberPointLoad[] | yes | |
members | SgMember[] | yes | |
nodal_loads | SgNodalLoad[] | yes | |
nodes | SgNode[] | yes | |
plate_loads | SgPlateLoad[] | yes | |
plates | SgPlate[] | yes | |
restraints | SgRestraint[] | yes | |
section_info | SgSectionInfo | null | ||
sections | SgSection[] | yes | |
self_weights | SgSelfWeight[] | yes |
SgNodalLoad
| Field | Type | Required | Description |
|---|---|---|---|
fx | number | yes | Forces in Newtons (converted from kN stored in file). |
fy | number | yes | |
fz | number | yes | |
load_case_id | integer | yes | |
mx | number | yes | Moments in N\u00b7m (converted from kN\u00b7m stored in file). |
my | number | yes | |
mz | number | yes | |
node_id | integer | yes |
SgNode
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | yes | |
x | number | yes | |
y | number | yes | |
z | number | yes |
SgPlate
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | yes | |
material_id | integer | yes | |
node_ids | integer[] | yes | |
thickness | number | yes | Thickness in metres (0.0 when not decoded). |
SgPlateLoad
| Field | Type | Required | Description |
|---|---|---|---|
load_case_id | integer | yes | |
plate_id | integer | yes | |
pressure | number | yes | Pressure in Pa (positive = upward in local z). |
SgRestraint
| Field | Type | Required | Description |
|---|---|---|---|
flags | integer | yes | DOF bit-mask: bit 0=Tx, 1=Ty, 2=Tz, 3=Rx, 4=Ry, 5=Rz. |
node_id | integer | yes | |
raw_code | string | yes | Raw 4-char ASCII code from the binary record (for diagnostics). |
SgSection
| Field | Type | Required | Description |
|---|---|---|---|
a | number | yes | Cross-sectional area in m² (0.0 when not decoded). |
grade | string | yes | Steel grade label, e.g. "AUST300" (best-effort; may be a section tag). |
id | integer | yes | 1-based section id - matches SgMember.section_id (the @MB section index). |
iyy | number | yes | Strong-axis second moment of area Iyy in m⁴ (0.0 when not decoded). |
izz | number | yes | Weak-axis second moment of area Izz in m⁴ (0.0 when not decoded). |
j | number | yes | St. Venant torsion constant J in m⁴ (0.0 when not decoded). |
name | string | yes | Catalogue profile name as stored by SpaceGass, e.g. "460 UB 67.1", "100758 UA", "W10x12". Empty when a block carries no catalogue name. |
tapered | boolean | yes | True when this section is a tapered/custom profile (no catalogue name). |
SgSectionInfo
| Field | Type | Required | Description |
|---|---|---|---|
field_0_1 | integer | yes | Header field at bytes 0-1 (observed = 0x0200 = 512). Meaning unknown; kept for diagnostics. |
field_2_3 | integer | yes | Header field at bytes 2-3 (observed = 0x0578 = 1400). Meaning unknown; kept for diagnostics. |
field_4_7 | integer | yes | Header field at bytes 4-7 (observed = 30). Meaning unknown; kept for diagnostics. |
has_header | boolean | yes | True when the blob looks like a recognised header. |
raw_size | integer | yes | Raw size of the @SI blob (for diagnostics). |
records | SgSectionInfoRecord[] | yes | Decoded variable-length records at the tail of the blob. |
SgSectionInfoRecord
One variable-length record stored inside @SI. In the only sample that carries @SI (Portal Frame Worked Example.SG) these records are site/seismic data (type 9, e.g. "NEWCASTLE 5%") rather than section geometry. The shape is exposed so callers can inspect it and so the decoder can be extended once a sample with true custom-section geometry appears.
| Field | Type | Required | Description |
|---|---|---|---|
factors | number[] | yes | |
name | string | yes | |
record_type | integer | yes |
SgSelfWeight
| Field | Type | Required | Description |
|---|---|---|---|
factor | number | yes | Multiplier on self-weight (>=0). SpaceGass stores this as a signed acceleration; the sign indicates direction (negative = downward) and the magnitude is the factor applied to self-weight. |
load_case_id | integer | yes |
SizingField
Controls target element size and local refinement for the mesher (Task 3).
| Field | Type | Required | Description |
|---|---|---|---|
grade_rate | number | How fast the size GROWS away from a refine point: h = target + grade_rate * distance. 1.0 (the default) is the unit slope this field always had. A member stub graded away from the joint wants ~0.2: fine at the cut face, coarsening over a few section depths. Default: 1. | |
h_max | number | yes | Largest element edge length permitted anywhere in the mesh. |
h_min | number | yes | Smallest element edge length the refiner is allowed to introduce (prevents non-termination from infinitely shrinking triangles near sharp features). |
min_angle_deg | number | yes | Minimum interior angle (degrees) Ruppert refinement (Task 3) will enforce. |
refine_points | [number[], number][] | yes | Point-based local refinement: (location, target size). Element size is tightened near each point down to the given target, bounded below by h_min. |
SnowCase
One load case of the roof snow load.
| Field | Type | Required | Description |
|---|---|---|---|
label | string | yes | Which figure and case this is, e.g. "Figure 6.3 case (iv), windward slope". |
leeward_kpa | number | yes | Load on the leeward slope, kPa; equal to windward_kpa on a mono-pitched roof. |
windward_kpa | number | yes | Load on the windward (or the only) slope, kPa. |
SoilLayer
A soil layer for the Appendix D computation.
| Field | Type | Required | Description |
|---|---|---|---|
ipt | number | yes | Instability index Ipt (%/pF) for the layer (lateral-restraint factor assumed folded in). |
thickness_mm | number | yes | Layer thickness (mm). |
Species
Hardwood or softwood: an F-grade's tension strength differs between them (Table H2.1).
One of: "softwood", "hardwood"
StationOutput
One of: "objects", "pack", "none"
SteadyContribution
One (mode, harmonic) steady-state contribution at the governing pace frequency.
| Field | Type | Required | Description |
|---|---|---|---|
a_w_rms | number | yes | |
alpha_h | number | yes | |
beta | number | yes | |
force_n | number | yes | |
harmonic | integer | yes | |
harmonic_hz | number | yes | |
magnification | number | yes | |
mode | integer | yes | |
weighting | number | yes |
SteadyStateResult
| Field | Type | Required | Description |
|---|---|---|---|
a_w_rms | number | yes | |
build_up_factor | number | yes | |
contributions | SteadyContribution[] | yes | |
pace_hz | number | yes | |
response_factor | number | yes | |
sweep | number[][] | yes | Response factor at every pace frequency swept, as (f_p, R) pairs. |
Step
One line of working: symbol = formula = subs = value [unit] (clause).
| Field | Type | Required | Description |
|---|---|---|---|
clause | CodeRef | yes | Governing code reference (standard + year + clause), travelling with the value. |
formula | string | yes | Symbolic LaTeX, no numbers. |
note | string | null | ||
status | StepStatus | yes | |
subs | string | yes | The same expression with values substituted (LaTeX). |
symbol | string | yes | |
unit | string | yes | |
value | number | yes | The scalar result of this line, in the unit named by unit. Source of truth. |
StepStatus
Status of a derivation line. The final/headline line of a check is a pass/fail; intermediate working lines are Info. Serialises to the lowercase strings the JS renderer expects.
One of:
"info","pass","fail""na"- Not applicable (e.g. a branch that doesn't govern for this section).
SurfaceKind
Which face of the building a surface is. National adapters map these to their own coefficient tables.
One of: "windward_wall", "leeward_wall", "side_wall", "windward_roof", "leeward_roof"
SurfacePressure
Assembled design pressures on one surface for one direction (core output, standard-agnostic).
| Field | Type | Required | Description |
|---|---|---|---|
area | number | yes | |
cfig_ext | number | yes | |
cfig_ext_alt | number | yes | Alternate design shape factor (roof pressure/less-negative case); equals cfig_ext if only one. |
direction | WindDirection | yes | |
kind | SurfaceKind | yes | |
name | string | yes | |
p_ext_alt_pa | number | yes | External pressure for the ALTERNATE case q * Cfig,e_alt (Pa) - roofs: the pressure/downward case. |
p_ext_pa | number | yes | External pressure p_e = q * Cfig,e (Pa) for the governing (uplift) case. |
p_net_ineg_pa | number | yes | Net pressure with the internal-suction case (q*(Cfig,e - Cfig,i_neg)), Pa. |
p_net_ipos_pa | number | yes | Net pressure with the internal-pressure case (q*(Cfig,e - Cfig,i_pos)), Pa. |
TableStatus
One table the adapter's numbers stand on, and what it was verified against. A verified: false row names what stands in for the table.
| Field | Type | Required | Description |
|---|---|---|---|
against | string | yes | |
table | string | yes | |
verified | boolean | yes |
TakeoffLine
Per-member take-off line (matches the JS quantityTakeoff line shape).
| Field | Type | Required | Description |
|---|---|---|---|
costed | boolean | yes | |
length_m | number | yes | |
mass_kg | number | yes | |
mass_per_metre_kg | number | yes | |
num | integer | yes | |
section | string | yes | |
surface_area_m2 | number | yes | Paintable / galvanisable surface area (m²), zero when section dimensions are unavailable. |
TakeoffReport
Used by quantity_takeoff.
Complete take-off report (JS-compatible shape).
| Field | Type | Required | Description |
|---|---|---|---|
bySection | SectionRollup[] | yes | Per-section roll-ups, heaviest first. |
lines | TakeoffLine[] | yes | Per-member lines, in model order. |
plates | PlateTakeoff[] | yes | Plate take-off lines. |
totals | TakeoffTotals | yes | Grand totals. |
TakeoffTotals
Grand totals.
| Field | Type | Required | Description |
|---|---|---|---|
length_m | number | yes | |
mass_kg | number | yes | |
memberCount | integer | yes | |
uncosted | integer | yes | Members that could not be costed (missing section, material, or nodes). |
TransientContribution
One mode's transient (impulse) contribution at the governing pace frequency.
| Field | Type | Required | Description |
|---|---|---|---|
a_w_peak | number | yes | |
frequency_hz | number | yes | |
impulse_ns | number | yes | |
mode | integer | yes | |
weighting | number | yes |
TransientResult
| Field | Type | Required | Description |
|---|---|---|---|
a_w_peak | number | yes | |
a_w_rms | number | yes | |
contributions | TransientContribution[] | yes | |
pace_hz | number | yes | |
response_factor | number | yes | |
sweep | number[][] | yes |
ValidationResult
Used by validate_model.
Result of validating a single snapshot.
| Field | Type | Required | Description |
|---|---|---|---|
valid | boolean | yes | |
violations | Violation[] | yes |
Violation
A single validation violation.
| Field | Type | Required | Description |
|---|---|---|---|
detail | string | yes | |
entity | string | yes | |
field | string | yes | |
id | string | yes | |
kind | string | yes | |
severity | string | yes |
WasmAisc360Assumptions
| Field | Type | Required | Description |
|---|---|---|---|
cb | number | yes | |
compressionClause | string | "E7" when a slender element cut the compression area below gross (Pn = Fcr Ae), else "E3". Default: "". | |
lb | number | yes | |
leMajor | number | yes | |
leMinor | number | yes |
WasmAisc360CompositeInput
Used by aisc360_composite_check.
| Field | Type | Required | Description |
|---|---|---|---|
a_s | number | yes | |
b_eff_mm | number | yes | |
d_mm | number | yes | |
f_prime_c_mpa | number | yes | |
fu_stud_mpa | number | yes | |
fy_mpa | number | yes | |
n_studs | integer | yes | |
phi | number | Default: 0.9. | |
stud_dia_mm | number | yes | |
t_c_mm | number | yes |
WasmAisc360CompositeResult
Used by aisc360_composite_check.
| Field | Type | Required | Description |
|---|---|---|---|
degree_of_shear_connection | number | yes | |
horizontal_shear_force | number | yes | |
phi_mn_full | number | yes | |
phi_mn_partial | number | yes | |
stud_shear_force | number | yes |
WasmAisc360MemberInput
Used by aisc360_member_check.
| Field | Type | Required | Description |
|---|---|---|---|
a | number | yes | |
bf | number | yes | |
cb | number | Default: 0. | |
d | number | yes | |
e | number | Default: 0. | |
fu | number | Default: 0. | |
fy | number | yes | |
hollow | boolean | A hollow section (RHS/SHS/CHS). Slender-element compression (E7) is applied to I-shapes only until the hollow-wall case, Table E7.1 (b), is in; absent means an I-shape. Default: false. | |
iyy | number | yes | |
izz | number | yes | |
j | number | yes | |
lb | number | yes | |
leMajor | number | yes | |
leMinor | number | yes | |
mxStar | number | yes | |
myStar | number | yes | |
nStar | number | yes | |
szz | number | Default: 0. | |
tf | number | yes | |
tw | number | yes | |
vxStar | number | yes | |
zzz | number | Default: 0. |
WasmAisc360MemberResult
Used by aisc360_member_check.
| Field | Type | Required | Description |
|---|---|---|---|
assumptions | WasmAisc360Assumptions | yes | |
governing | string | yes | |
phiMnx | number | yes | |
phiMny | number | yes | |
phiPn | number | yes | |
phiPnComp | number | yes | |
phiVn | number | yes | |
section_class | string | yes | |
utilAxial | number | yes | |
utilCombined | number | yes | |
utilFlexX | number | yes | |
utilFlexY | number | yes | |
utilMax | number | yes | |
utilShear | number | yes |
WasmAiscBoltInput
Used by aisc360_bolt_capacity.
| Field | Type | Required | Description |
|---|---|---|---|
bolt_diameter | number | yes | |
bolt_grade | string | yes | |
clear_distance | number | Default: 0. | |
n_shear_planes | integer | yes | |
ply_fu | number | Default: 0. | |
ply_thickness | number | Default: 0. | |
threads_excluded | boolean | Default: false. |
WasmAiscBoltResult
Used by aisc360_bolt_capacity.
| Field | Type | Required | Description |
|---|---|---|---|
phiRnBearing | number | yes | |
phiRnShear | number | yes | |
phiRnTearout | number | yes | |
phiRnTension | number | yes |
WasmAiscWeldInput
Used by aisc360_weld_capacity.
| Field | Type | Required | Description |
|---|---|---|---|
fexx | number | yes | |
leg_size | number | yes | |
length | number | yes | |
theta_deg | number | Default: 0. |
WasmAiscWeldResult
Used by aisc360_weld_capacity.
| Field | Type | Required | Description |
|---|---|---|---|
phiRn | number | yes |
WasmAs1720Input
Used by as1720_timber_check.
The timber check input: fem_core::as1720::TimberMemberInput plus the two legacy length fields. le_bending was the restraint spacing and le_compression the column length (g13 1); both still work, and the new la_y / length win when given. The legacy k7 / k13 fields are accepted and ignored: k7 is the bearing factor, not a load-sharing one, and the standard has no k13 for columns (it is k12).
| Field | Type | Required | Description |
|---|---|---|---|
a_t | number | null | Net tension area (mm²) when holes reduce it; defaults to the gross area. Default: null. | |
b | number | Breadth of ONE board (mm). Stability uses it; area and Z use n_boards · b. Default: 0. | |
category | integer | Application category 1, 2 or 3 (Table 2.1). Default: 2. | |
d | number | Default: 0. | |
g13x | number | Effective length factors g13 about x (major) and y (minor), Table 3.2. Default: 1. | |
g13y | number | Default: 1. | |
grade | string | Default: "F17". | |
high_temp | boolean | Seasoned timber in Queensland north of 25°S or elsewhere north of 16°S: k6 = 0.9. Default: false. | |
k1 | number | Default: 1. | |
k12 | number | null | Default: null. | |
k12c | number | null | Default: null. | |
k4 | number | null | Default: null. | |
k6 | number | null | Default: null. | |
k9 | number | null | Default: null. | |
la_phi | number | null | Spacing of torsional restraints (only for TensionAndTorsional). Default: null. | |
la_y | number | null | Spacing of restraints against lateral (minor-axis) displacement, for S1 and S4. Defaults to length. Default: null. | |
le_bending | number | Default: 0. | |
le_compression | number | Default: 0. | |
length | number | null | Member length L (mm): the span for k9 and the length for column buckling. Default: null. | |
m_star | number | Default: 0. | |
n_boards | integer | Boards nailed or screwed side by side (a "2/190x35" is 2). Default: 1. | |
n_members | integer | Members in the parallel system for k9 (1 = single member) and their spacing (mm). Default: 1. | |
n_star | number | Default: 0. | |
nt_star | number | Default: 0. | |
partial_seasoning | boolean | Unseasoned timber that will partly season in service: k4 by least dimension (Table 2.5). Default: false. | |
r | number | Ratio of temporary to total design action effect (Appendix E2); ≤ 0 is taken as 0.25. Default: 0.25. | |
restraint_edge | RestraintEdge | Default: "compression". | |
seasoned | boolean | Default: true. | |
spacing | number | Default: 0. | |
species | Species | Default: "softwood". | |
v_star | number | Default: 0. |
WasmAs1720Result
Used by as1720_timber_check.
| Field | Type | Required | Description |
|---|---|---|---|
E | number | yes | |
S1 | number | yes | |
S3 | number | yes | |
S4 | number | yes | |
continuousRestraint | boolean | yes | |
fB | number | yes | |
fC | number | yes | |
fS | number | yes | |
fT | number | yes | |
governing | string | yes | |
k1 | number | yes | |
k12 | number | yes | |
k12c | number | yes | |
k12x | number | yes | |
k12y | number | yes | |
k4 | number | yes | |
k6 | number | yes | |
k9 | number | yes | |
phi | number | yes | |
phiM | number | yes | |
phiN | number | yes | Compression capacity, the smaller of the two axes. |
phiNcx | number | yes | |
phiNcy | number | yes | |
phiNt | number | yes | |
phiV | number | yes | |
rhoB | number | yes | |
rhoC | number | yes | |
stabilityAssessed | boolean | yes | |
utilM | number | yes | |
utilMax | number | yes | |
utilN | number | yes | |
utilNt | number | yes | |
utilV | number | yes |
WasmAs2870Input
Used by as2870_design.
| Field | Type | Required | Description |
|---|---|---|---|
construction | string | Default: "". | |
du_surface | number | Default: 1.2. | |
footing_system | string | Default: "". | |
hs_m | number | Default: 1.5. | |
layers | SoilLayer[] | Default: []. | |
site_class | string | Optional: skip the soil profile and use this class directly ("M", "H1-D", ...). Default: "". | |
slab_length_m | number | Default: 15. |
WasmAs4100AlphaMInput
Used by as4100_alpha_m.
| Field | Type | Required | Description |
|---|---|---|---|
my1 | number | yes | |
my2 | number | yes |
WasmAs4100AlphaMResult
Used by as4100_alpha_m.
| Field | Type | Required | Description |
|---|---|---|---|
alpha_m | number | yes |
WasmAs4100CellularInput
Used by as4100_cellular_check.
| Field | Type | Required | Description |
|---|---|---|---|
alpha_b | number | Default: 0. | |
alpha_m_case | integer | yes | |
b_f_mm | number | yes | |
d_mm | number | yes | |
d_o_mm | number | yes | |
fy_mpa | number | yes | |
le_mm | number | yes | |
length_mm | number | yes | |
s_mm | number | yes | |
t_f_mm | number | yes | |
t_w_mm | number | yes |
WasmAs4100CellularResult
Used by as4100_cellular_check.
| Field | Type | Required | Description |
|---|---|---|---|
phi_m_b | number | yes | |
phi_m_gross | number | yes | |
phi_m_net | number | yes | |
phi_m_vierendeel | number | yes | |
phi_v_net | number | yes | |
phi_v_web_post | number | yes | |
web_post_slenderness | number | yes |
WasmAs4100CombinedInput
Used by as4100_combined.
| Field | Type | Required | Description |
|---|---|---|---|
kf | number | Default: 1. | |
m_star_x | number | yes | |
m_star_y | number | Default: 0. | |
n_star | number | yes | |
ns | number | yes | |
phi_mbx | number | yes | |
phi_mby | number | Default: 0. | |
phi_msx | number | yes | |
phi_msy | number | Default: 0. | |
phi_ncx | number | yes | |
phi_ncy | number | yes | |
phi_nt | number | yes | |
section_class | string | yes |
WasmAs4100CombinedResult
Used by as4100_combined.
| Field | Type | Required | Description |
|---|---|---|---|
axial_util | number | yes | |
member_util_x | number | yes | |
member_util_y | number | yes | |
phi_m_ox | number | yes | |
phi_m_oy | number | yes | |
phi_m_rx | number | yes | |
phi_m_ry | number | yes | |
section_util_x | number | yes | |
section_util_y | number | yes | |
util_biaxial_member | number | yes | |
util_biaxial_section | number | yes | |
util_max | number | yes |
WasmAs4100FatigueInput
Used by as4100_fatigue_check.
| Field | Type | Required | Description |
|---|---|---|---|
apply_beta_tf | boolean | Default: false. | |
category | string | yes | |
fy_mpa | number | yes | |
phi | number | Default: 0.9. | |
spectrum | [number, number][] | yes | |
t_mm | number | yes |
WasmAs4100FatigueResult
Used by as4100_fatigue_check.
| Field | Type | Required | Description |
|---|---|---|---|
applicable | boolean | yes | |
damage | number | yes | |
ok | boolean | yes |
WasmAs4100FireInput
Used by as4100_fire_check.
| Field | Type | Required | Description |
|---|---|---|---|
ambient_capacity | number | yes | |
exposure | string | yes | |
fire_demand | number | yes | |
section_factor | number | yes | |
time_min | number | yes |
WasmAs4100FireResult
Used by as4100_fire_check.
| Field | Type | Required | Description |
|---|---|---|---|
limiting_temp | number | yes | |
load_ratio | number | yes | |
ok | boolean | yes | |
steel_temp | number | yes | |
temp_margin | number | yes |
WasmAs4100OptimizeInput
Used by as4100_optimize_section.
| Field | Type | Required | Description |
|---|---|---|---|
alpha_b | number | Default: 0. | |
alpha_m_case | integer | yes | |
categories | string[] | Default: []. | |
fy_mpa | number | yes | |
le_mm | number | yes | |
mx_star | number | yes | |
my_star | number | Default: 0. | |
n_star | number | yes | |
v_star | number | yes |
WasmAs4100OptimizeResult
Used by as4100_optimize_section.
| Field | Type | Required | Description |
|---|---|---|---|
best_category | string | yes | |
best_mass_kg_m | number | yes | |
best_name | string | yes | |
considered | integer | yes | |
feasible | integer | yes | |
found | boolean | yes | |
util_max | number | yes |
WasmAs4100PhiMbxInput
Used by as4100_phi_mbx, as4100_phi_mbx_derivation.
| Field | Type | Required | Description |
|---|---|---|---|
alpha_m_case | integer | yes | 0=UniformMoment, 1=SimplySupportedUdl, 2=SimplySupportedPointLoad, 3=EndMoments, 4=CantileverUdl |
beta_m | number | Default: 0. | |
bf | number | yes | |
d | number | yes | |
e | number | Default: 200000. | |
fyf | number | yes | |
fyw | number | yes | |
g | number | Default: 80000. | |
i_w | number | Default: 0. | |
i_y | number | yes | |
j | number | yes | |
le_mm | number | yes | |
phi | number | Default: 0.9. | |
s_x | number | yes | |
tf | number | yes | |
tw | number | yes | |
z_x | number | yes |
WasmAs4100PhiMbxResult
Used by as4100_phi_mbx.
| Field | Type | Required | Description |
|---|---|---|---|
alpha_m | number | yes | |
alpha_s | number | yes | |
m_o | number | yes | |
m_sx | number | yes | |
phi_m_bx | number | yes |
WasmAs4100PhiMsResult
Used by as4100_phi_ms.
| Field | Type | Required | Description |
|---|---|---|---|
lambda_s | number | yes | |
lambda_sp | number | yes | |
lambda_sy | number | yes | |
m_sx | number | yes | |
phi_m_sx | number | yes | |
section_class | string | yes | |
z_ex | number | yes |
WasmAs4100PhiNcInput
Used by as4100_phi_nc, as4100_phi_nc_derivation.
| Field | Type | Required | Description |
|---|---|---|---|
alpha_b | number | Default: 0. | |
area | number | yes | |
fy | number | yes | |
kf | number | Default: 1. | |
le_mm | number | yes | |
phi | number | Default: 0.9. | |
r | number | yes |
WasmAs4100PhiNcResult
Used by as4100_phi_nc.
| Field | Type | Required | Description |
|---|---|---|---|
alpha_c | number | yes | |
lambda_n | number | yes | |
n_c | number | yes | |
n_s | number | yes | |
phi_n_c | number | yes |
WasmAs4100PhiVvInput
Used by as4100_phi_vv.
| Field | Type | Required | Description |
|---|---|---|---|
d | number | yes | |
fy | number | yes | |
section_name | string | yes | |
tf | number | yes | |
tw | number | yes |
WasmAs4100PhiVvResult
Used by as4100_phi_vv.
| Field | Type | Required | Description |
|---|---|---|---|
phi_vv | number | yes |
WasmAs4100SectionInput
Used by as4100_phi_ms, as4100_phi_ms_derivation.
| Field | Type | Required | Description |
|---|---|---|---|
bf | number | yes | |
d | number | yes | |
fyf | number | yes | |
fyw | number | yes | |
s_x | number | yes | |
tf | number | yes | |
tw | number | yes | |
z_x | number | yes |
WasmAs4100TaperedInput
Used by as4100_tapered_check.
| Field | Type | Required | Description |
|---|---|---|---|
alpha_b | number | Default: 0. | |
alpha_m_case | integer | yes | |
b_f_mm | number | yes | |
d_a_mm | number | yes | |
d_b_mm | number | yes | |
fy_mpa | number | yes | |
le_mm | number | yes | |
length_mm | number | yes | |
t_f_mm | number | yes | |
t_w_mm | number | yes |
WasmAs4100TaperedResult
Used by as4100_tapered_check.
| Field | Type | Required | Description |
|---|---|---|---|
d_govern_mm | number | yes | |
phi_mb | number | yes | |
phi_ms | number | yes | |
phi_nc | number | yes | |
taper_ratio | number | yes | |
x_govern_mm | number | yes |
WasmAs4600CombinedInput
Used by as4600_combined.
| Field | Type | Required | Description |
|---|---|---|---|
m_star_x | number | Default: 0. | |
m_star_y | number | Default: 0. | |
n_comp | number | Default: 0. | |
n_tens | number | Default: 0. | |
phi_mbx | number | Default: 0. | |
phi_mby | number | Default: 0. | |
phi_ncx | number | Default: 0. | |
phi_ncy | number | Default: 0. | |
phi_nt | number | Default: 0. |
WasmAs4600Input
Used by as4600_capacity.
| Field | Type | Required | Description |
|---|---|---|---|
b | number | yes | |
d | number | yes | |
e | number | Default: 200000. | |
f_y | number | yes | |
lip | number | Default: 0. | |
r | number | Default: 0. | |
section_type | string | yes | |
t | number | yes |
WasmAs4600Result
Used by as4600_capacity.
| Field | Type | Required | Description |
|---|---|---|---|
aEff | number | yes | |
aGross | number | yes | |
governing | string | yes | |
phiMs | number | yes | |
phiNc | number | yes | |
zEff | number | yes | |
zGross | number | yes |
WasmAs5100Assumptions
| Field | Type | Required | Description |
|---|---|---|---|
alpha_m | number | yes | |
alpha_s | number | yes | |
leMajor | number | yes | |
leMinor | number | yes | |
section_class | string | yes |
WasmAs5100CombinedInput
Used by as5100_combined.
| Field | Type | Required | Description |
|---|---|---|---|
kf | number | Default: 1. | |
mStarX | number | yes | |
mStarY | number | Default: 0. | |
nStar | number | yes | |
ns | number | yes | |
phiMbx | number | yes | |
phiMby | number | Default: 0. | |
phiMsx | number | yes | |
phiMsy | number | Default: 0. | |
phiNcx | number | yes | |
phiNcy | number | yes | |
phiNt | number | yes | |
sectionClass | string | yes |
WasmAs5100CombinedResult
Used by as5100_combined.
| Field | Type | Required | Description |
|---|---|---|---|
axialUtil | number | yes | |
memberUtilX | number | yes | |
memberUtilY | number | yes | |
phiMOx | number | yes | |
phiMOy | number | yes | |
phiMRx | number | yes | |
phiMRy | number | yes | |
sectionUtilX | number | yes | |
sectionUtilY | number | yes | |
utilBiaxialMember | number | yes | |
utilBiaxialSection | number | yes | |
utilMax | number | yes |
WasmAs5100MemberInput
Used by as5100_member_check.
| Field | Type | Required | Description |
|---|---|---|---|
a | number | yes | |
alphaMCase | integer | yes | 0=UniformMoment, 1=SimplySupportedUdl, 2=SimplySupportedPointLoad, 3=EndMoments, 4=CantileverUdl |
beta_m | number | Default: 0. | |
bf | number | yes | |
d | number | yes | |
e | number | Default: 200000. | |
fu | number | Default: 0. | |
fy | number | yes | |
iyy | number | yes | |
izz | number | yes | |
j | number | yes | |
leMajor | number | yes | |
leMinor | number | yes | |
mxStar | number | yes | |
myStar | number | Default: 0. | |
nStar | number | yes | |
syy | number | Default: 0. | |
szz | number | Default: 0. | |
tf | number | yes | |
tw | number | yes | |
vxStar | number | Default: 0. | |
zyy | number | Default: 0. | |
zzz | number | Default: 0. |
WasmAs5100MemberResult
Used by as5100_member_check.
| Field | Type | Required | Description |
|---|---|---|---|
assumptions | WasmAs5100Assumptions | yes | |
governing | string | yes | |
phiMbx | number | yes | |
phiMby | number | yes | |
phiMsx | number | yes | |
phiMsy | number | yes | |
phiNcx | number | yes | |
phiNcy | number | yes | |
phiNt | number | yes | |
phiVv | number | yes | |
section_class | string | yes | |
utilAxial | number | yes | |
utilCombined | number | yes | |
utilFlexX | number | yes | |
utilFlexY | number | yes | |
utilMax | number | yes | |
utilShear | number | yes |
WasmAsce7CpResult
Used by asce7_roof_pressure_coefficient, asce7_wall_pressure_coefficient.
| Field | Type | Required | Description |
|---|---|---|---|
c_p | number | yes | |
c_p_b | number | null | Design case B where Fig. 27.3-1 gives a second one; null when it does not. BOTH cases must be checked - B is often a downward pressure and governs different members from A. | |
clause | string | yes | |
uses | string | yes | "q_z" (point height, windward wall only) or "q_h" (mean roof height, everything else). The figure chooses this, not the caller. |
WasmAsce7RoofCpInput
Used by asce7_roof_pressure_coefficient.
| Field | Type | Required | Description |
|---|---|---|---|
dist_from_windward_edge_over_h | number | Distance from the windward edge divided by h. Used by the parallel-to-ridge case, which zones the roof by distance rather than by slope. Default: 0. | |
face | string | yes | "windward", "leeward" or "parallel" (wind parallel to the ridge). |
h_over_l | number | yes | h/L - mean roof height over the plan dimension along the wind. |
theta_deg | number | yes | Roof angle theta, degrees from horizontal. |
WasmAsce7SurfacePressureInput
Used by asce7_surface_pressure.
| Field | Type | Required | Description |
|---|---|---|---|
c_p | number | yes | |
g | number | yes | Gust-effect factor G, Section 26.11. NO DEFAULT: 0.85 is the rigid-building value and this build does not classify a model as rigid or flexible, so it must be supplied. |
q_h_pa | number | yes | q_h, Pa - the velocity pressure at mean roof height. |
q_z_pa | number | yes | q_z, Pa - the velocity pressure at the height of the point considered. |
uses | string | yes | "q_z" or "q_h" - which velocity pressure the figure sends to this surface. Take it from the uses field of the coefficient call rather than choosing it. |
WasmAsce7SurfacePressureResult
Used by asce7_surface_pressure.
| Field | Type | Required | Description |
|---|---|---|---|
c_p | number | yes | |
clause | string | yes | |
g | number | yes | |
p_pa | number | yes | p = q G C_p, Pa. Positive acts toward the surface, negative away from it. |
q_source | string | yes | |
q_used_pa | number | yes |
WasmAsce7VelocityPressureInput
Used by asce7_velocity_pressure.
| Field | Type | Required | Description |
|---|---|---|---|
basic_wind_speed_ms | number | yes | Basic wind speed V, m/s (Section 26.5 hazard maps). |
exposure | string | yes | Exposure category letter: "B", "C" or "D" (Section 26.7). |
ground_elevation_m | number | Ground elevation above mean sea level, m, for K_e. NOT the terrain gradient height. Default: 0. | |
k_d | number | yes | Wind directionality factor K_d, Table 26.6-1. 0.85 for buildings. |
k_zt | number | Topographic factor K_zt, Section 26.8.2. 1.0 on flat terrain. Default: 1. | |
z_m | number | yes | Height above ground, m. |
WasmAsce7VelocityPressureResult
Used by asce7_velocity_pressure.
| Field | Type | Required | Description |
|---|---|---|---|
clause | string | yes | |
k_d | number | yes | |
k_e | number | yes | |
k_z | number | yes | |
k_zt | number | yes | |
q_pa | number | yes | |
z_used_m | number | yes |
WasmAsce7WallCpInput
Used by asce7_wall_pressure_coefficient.
| Field | Type | Required | Description |
|---|---|---|---|
face | string | yes | "windward", "side" or "leeward". |
l_over_b | number | yes | L/B - plan dimension along the wind over the dimension across it. |
WasmAutoSizeCandidate
A catalogue candidate: a serialized section plus its catalogue mass + design group. name comes from the flattened WasmSection.
| Field | Type | Required | Description |
|---|---|---|---|
a | number | yes | |
bf | number | Default: 0. | |
category | string | yes | |
cold_formed | boolean | Default: false. | |
d | number | Default: 0. | |
fy | number | Default: 0. | |
id | integer | yes | |
iw | number | Default: 0. | |
iyy | number | yes | |
izz | number | yes | |
j | number | yes | |
lip | number | Default: 0. | |
mass_kg_m | number | yes | |
name | string | Default: "". | |
syy | number | Default: 0. | |
szz | number | Default: 0. | |
tf | number | Default: 0. | |
tw | number | Default: 0. | |
x0 | number | Default: 0. | |
zyy | number | Default: 0. | |
zzz | number | Default: 0. |
WasmAutoSizeInput
Used by auto_size.
| Field | Type | Required | Description |
|---|---|---|---|
candidates | { [key]: WasmAutoSizeCandidate[] } | ||
model | WasmModel | yes | |
options | WasmAutoSizeOptions | ||
sizable | WasmSizableSpec[] |
WasmAutoSizeOptions
| Field | Type | Required | Description |
|---|---|---|---|
max_iter | integer | Default: 8. | |
target | number | Default: 1. |
WasmAxisCapacity
| Field | Type | Required | Description |
|---|---|---|---|
Ze | number | yes | |
compactness | WasmAxisCompactness | yes | |
phiMb | number | yes | |
phiMs | number | yes |
WasmAxisCompactness
| Field | Type | Required | Description |
|---|---|---|---|
class | string | yes | |
flange | WasmPlateCompactness | yes | |
web | WasmPlateCompactness | yes |
WasmBasePlateAssumptions
| Field | Type | Required | Description |
|---|---|---|---|
method | string | yes | |
phi_concrete | number | yes | |
phi_steel | number | yes |
WasmBasePlateInput
Used by base_plate_check.
| Field | Type | Required | Description |
|---|---|---|---|
bolt_count | integer | Default: 0. | |
bolt_diameter | number | Default: 0. | |
bolt_grade | string | Default: "". | |
column_bf | number | yes | |
column_d | number | yes | |
concrete_fc | number | yes | |
n_star | number | yes | |
plate_b | number | yes | |
plate_d | number | yes | |
plate_fy | number | yes | |
plate_t | number | yes | |
v_star | number | Default: 0. |
WasmBasePlateResult
Used by base_plate_check.
| Field | Type | Required | Description |
|---|---|---|---|
assumptions | WasmBasePlateAssumptions | yes | |
bearing_pressure | number | yes | |
cantilever_b | number | yes | |
cantilever_d | number | yes | |
confinement | number | yes | |
n_star | number | yes | |
phiAnchorShear | number | yes | |
phiNcConc | number | yes | |
phiPlateBending | number | yes | |
t_req | number | yes | |
util_anchor_shear | number | yes | |
util_bearing | number | yes | |
util_bolts | number | yes | |
util_interaction | number | yes | |
util_max | number | yes | |
util_plate | number | yes |
WasmBearingStiffenerInput
Used by bearing_stiffener_check.
Load-bearing web stiffener pair (conn_stiffener::bearing_stiffener_capacity). SI in; mm/MPa inside.
| Field | Type | Required | Description |
|---|---|---|---|
b_es | number | yes | |
d_1 | number | yes | |
f_y | number | yes | |
f_ys | number | yes | |
r_star | number | yes | |
t_f | number | yes | |
t_s | number | yes | |
t_w | number | yes |
WasmBearingStiffenerResult
Used by bearing_stiffener_check.
| Field | Type | Required | Description |
|---|---|---|---|
alphaC | number | yes | |
lambdaN | number | yes | |
outstandRatio | number | yes | |
phiRsb | number | yes | |
phiRsy | number | yes | |
r_star | number | yes | |
util_max | number | yes | |
util_stiffener_buckling | number | yes | |
util_stiffener_yield | number | yes |
WasmBoltGroupInput
Used by eccentric_bolt_group_check.
| Field | Type | Required | Description |
|---|---|---|---|
boltDiameter | number | yes | |
boltGrade | string | yes | |
bolts | WasmBoltPositionInput[] | yes | |
kr | number | yes | |
mz | number | yes | |
nN | integer | yes | |
nX | integer | yes | |
vx | number | yes | |
vy | number | yes |
WasmBoltGroupResult
Used by eccentric_bolt_group_check.
| Field | Type | Required | Description |
|---|---|---|---|
governingBolt | integer | yes | |
phiVbolt | number | yes | |
phiVtotal | number | yes | |
util_max | number | yes | |
vResultantGov | number | yes |
WasmBoltInput
Used by bolt_capacity.
| Field | Type | Required | Description |
|---|---|---|---|
bolt_diameter | number | yes | |
bolt_grade | string | yes | |
kr | number | Default: 1. | |
ply_fu | number | Default: 0. | |
ply_thickness | number | Default: 0. | |
shear_planes_threads_excluded | integer | yes | |
shear_planes_threads_intercepted | integer | yes |
WasmBoltLayout
Used by bolt_layout.
| Field | Type | Required | Description |
|---|---|---|---|
cols | integer | yes | |
edge | number | yes | |
end | number | yes | |
fits | boolean | yes | |
gauge | number | yes | |
pitch | number | yes | |
plateH | number | yes | |
plateW | number | yes | |
positions | WasmBoltPos[] | yes | |
rows | integer | yes | |
trace | string[] | yes |
WasmBoltLayoutInput
Used by bolt_layout.
| Field | Type | Required | Description |
|---|---|---|---|
availWidth | number | yes | |
boltDiameter | number | yes | |
count | integer | yes | |
edge | number | null | Default: null. | |
edgeType | string | Default: "". | |
end | number | null | Default: null. | |
gauge | number | null | Default: null. | |
pitch | number | null | Default: null. |
WasmBoltPos
| Field | Type | Required | Description |
|---|---|---|---|
x | number | yes | |
y | number | yes |
WasmBoltPositionInput
| Field | Type | Required | Description |
|---|---|---|---|
x | number | yes | |
y | number | yes |
WasmBoltResult
Used by bolt_capacity.
| Field | Type | Required | Description |
|---|---|---|---|
minEdge | number | yes | |
minGauge | number | yes | |
minPitch | number | yes | |
phiNtf | number | yes | |
phiVb | number | yes | |
phiVf | number | yes |
WasmBridgingInput
Used by bridging_check.
Purlin bridging bracket (conn_bridging.rs). SI in (m, Pa, N); the core works in mm and MPa. The detail the source documents: two M12 through the purlin WEB into a formed end bracket on the bridging member (Stramit PGB-DI). leg is the bracket's leg - the offset from the bolt line to the bridging member's own axis - and it is what the bracket bends under.
| Field | Type | Required | Description |
|---|---|---|---|
bolt_count | integer | yes | |
bolt_dia | number | yes | |
bolt_grade | string | yes | |
bracket_b | number | yes | |
bracket_fu | number | yes | |
bracket_fy | number | yes | |
bracket_t | number | yes | |
gauge | number | yes | The bolt line's gauge: the spacing of the bolts up the purlin's web. |
leg | number | The bracket's leg: how far the bridging member's axis sits off the bolt line. Default: 0. | |
m_star | number | Default: 0. | |
n_star | number | yes | |
v_star | number | yes | |
web_fu | number | yes | |
web_t | number | yes |
WasmBridgingResult
Used by bridging_check.
| Field | Type | Required | Description |
|---|---|---|---|
bearingC | number | yes | |
components | WasmConnComponent[] | yes | |
govComponent | string | yes | |
govUtil | number | yes | |
notes | string[] | yes | |
status | string | yes |
WasmBucklingMode
| Field | Type | Required | Description |
|---|---|---|---|
index | integer | yes | |
load_factor | number | yes | |
mode_shape | WasmNodeDisplacement[] | yes |
WasmBucklingResults
Used by solve_model_buckling.
| Field | Type | Required | Description |
|---|---|---|---|
modes | WasmBucklingMode[] | yes | |
warnings | string[] | Eigensolver self-check notes (Sturm-count mismatch). Non-empty means the mode set is suspect and the UI must show it. |
WasmCable
| Field | Type | Required | Description |
|---|---|---|---|
member_id | integer | yes | |
model | string | Default: "". | |
unstressed_length | number | null | Default: null. |
WasmCapacityAssumptions
| Field | Type | Required | Description |
|---|---|---|---|
alpha_b | number | yes | |
alpha_m | number | yes | |
alpha_s | number | yes | |
kl | number | yes | |
kr | number | yes | |
kt | number | yes | |
le_x | number | yes | |
le_y | number | yes |
WasmColumnSideInput
Used by column_side_check.
| Field | Type | Required | Description |
|---|---|---|---|
beamD | number | yes | |
beamTf | number | yes | |
bfCol | number | The column flange width, m. Default: 0. | |
bothFlangesRestrained | boolean | Both column flanges are held at the joint (Cl 5.13.4 slenderness 2.5 d1/tw, else 5.0). Default: false. | |
dCol | number | yes | |
flangeInTstub | boolean | The column flange is already checked as bolted T-stubs, so the flange yield line row is left out. Default: false. | |
flangeWeldLeg | number | The beam flange's fillet weld leg to the column, m (0 for a butt weld or none). Default: 0. | |
fyCol | number | yes | |
mStar | number | yes | |
nStar | number | Default: 0. | |
plateT | number | The end plate's thickness, m (0 on a welded joint). Default: 0. | |
stiffenerFy | number | The continuity stiffeners' yield stress, Pa. Default: 0. | |
stiffenerT | number | The continuity stiffeners' thickness, m (0 when none are drawn). Default: 0. | |
tfCol | number | yes | |
twCol | number | yes |
WasmColumnSideResult
Used by column_side_check.
| Field | Type | Required | Description |
|---|---|---|---|
components | WasmConnComponent[] | yes | |
govComponent | string | yes | |
govUtil | number | yes | |
notes | string[] | yes | |
status | string | yes | |
stiffenersRequired | boolean | yes |
WasmCombinationResults
Results output
| Field | Type | Required | Description |
|---|---|---|---|
combination_id | integer | yes | |
displacements | WasmNodeDisplacement[] | yes | |
member_forces | WasmMemberForce[] | yes | |
member_station_forces | WasmMemberStationForces[] | yes | |
name | string | yes | |
reactions | WasmReaction[] | yes |
WasmCombinedColumn
| Field | Type | Required | Description |
|---|---|---|---|
bx | number | yes | |
by | number | yes | |
mxService | number | Default: 0. | |
mxStar | number | Default: 0. | |
myService | number | Default: 0. | |
myStar | number | Default: 0. | |
nService | number | Default: 0. | |
nStar | number | yes | |
x | number | yes |
WasmCombinedFootingInput
Used by combined_footing_design.
| Field | Type | Required | Description |
|---|---|---|---|
barDiameter | number | Default: 0. | |
bearingBasis | string | Default: "allowable". | |
columns | WasmCombinedColumn[] | yes | |
cover | number | yes | |
fPrimeC | number | yes | |
fPrimeCColumn | number | Default: 0. | |
fSy | number | yes | |
footingBx | number | yes | |
footingBy | number | yes | |
footingH | number | yes | |
qBearing | number | yes | |
selfWeight | number | Default: 0. | |
standard | FootingCode | Default: "as3600". |
WasmCombinedFootingResult
Used by combined_footing_design.
| Field | Type | Required | Description |
|---|---|---|---|
aStBottomReq | number | yes | |
aStMin | number | yes | |
aStTopReq | number | yes | |
aStTransverseReq | number | yes | |
checksRefused | string[] | yes | |
contactState | string | yes | |
governing | string | yes | |
mHog | number | yes | |
mSag | number | yes | |
mTransverse | number | yes | |
note | string | null | ||
phiVPunch | number | yes | |
phiVUc | number | yes | |
qAllowable | number | yes | |
qMax | number | yes | |
resultantX | number | yes | |
utilBearing | number | yes | |
utilBearingStress | number | yes | |
utilDevelopment | number | yes | |
utilMax | number | yes | |
utilMoment | number | yes | |
utilPunching | number | yes | |
utilShear | number | yes | |
utilTransverse | number | yes | |
vDesign | number | yes | |
vPunch | number | yes |
WasmComboGenInput
Used by generate_load_combinations.
| Field | Type | Required | Description |
|---|---|---|---|
code | string | Which code's combination set: "asnzs" (default) | "asce7" | "eurocode". Default: "". | |
load_cases | WasmLoadCase[] | yes | |
occupancy | string | null | AS/NZS 1170.0 Table 4.1 occupancy: resolves psi_s/psi_l/psi_c/psi_e at once. Overridden per-field by any of the explicit psi_* fields above. Default: null. | |
psi0_q | number | null | Default: null. | |
psi0_s | number | null | Default: null. | |
psi0_w | number | null | Default: null. | |
psi1_q | number | null | Default: null. | |
psi2_q | number | null | Default: null. | |
psi_c | number | null | Default: null. | |
psi_e | number | null | AS/NZS 1170.0 Table 4.1 earthquake combination factor. Default: null. | |
psi_l | number | null | Default: null. | |
psi_s | number | null | Default: null. |
WasmComboGenOutput
Used by generate_load_combinations.
| Field | Type | Required | Description |
|---|---|---|---|
combinations | WasmLoadCombination[] | yes |
WasmComboTerm
| Field | Type | Required | Description |
|---|---|---|---|
factor | number | yes | |
load_case_id | integer | yes |
WasmCompositeBeamInput
Used by composite_beam_check.
| Field | Type | Required | Description |
|---|---|---|---|
b_f | number | yes | |
beam_spacing | number | yes | |
d | number | yes | |
d_s | number | yes | |
d_stud | number | yes | |
f_prime_c | number | yes | |
f_u_stud | number | yes | |
f_y | number | yes | |
m_star | number | yes | |
n_studs | integer | yes | |
span | number | yes | |
t_f | number | yes | |
t_w | number | yes | |
z_e | number | yes |
WasmCompositeBeamResult
Used by composite_beam_check.
| Field | Type | Required | Description |
|---|---|---|---|
bEff | number | yes | |
eta | number | yes | |
fCc | number | yes | |
fSt | number | yes | |
mBare | number | yes | |
mFull | number | yes | |
nStudsReq | number | yes | |
phiMbv | number | yes | |
phiNQ | number | yes | |
pnaInSlab | boolean | yes | |
util_max | number | yes | |
util_moment | number | yes | |
util_stud | number | yes |
WasmCompressionCapacity
| Field | Type | Required | Description |
|---|---|---|---|
Ns | number | yes | |
alpha_c | number | yes | |
kf | number | yes | |
lambda_n | number | yes | |
phiNcx | number | yes | |
phiNcy | number | yes |
WasmConnComponent
One limit-state row on the wire: {name, clause, demand, capacity, util, status}.
| Field | Type | Required | Description |
|---|---|---|---|
capacity | number | yes | |
clause | string | yes | |
demand | number | yes | |
name | string | yes | |
status | string | yes | |
util | number | yes |
WasmConnStiffenerComponent
| Field | Type | Required | Description |
|---|---|---|---|
capacity | number | yes | |
clause | string | yes | |
demand | number | yes | |
name | string | yes | |
status | string | yes | |
util | number | yes |
WasmConnStiffenerInput
Used by conn_stiffener_check.
| Field | Type | Required | Description |
|---|---|---|---|
b_col | number | yes | |
d_col | number | yes | |
flange_bending_util | number | yes | |
flange_force | number | yes | |
fy_col | number | yes | |
fy_stiffener | number | yes | |
panel_shear_util | number | yes | |
tf_col | number | yes | |
tw_col | number | yes | |
web_bearing_util | number | yes |
WasmConnStiffenerResult
Used by conn_stiffener_check.
| Field | Type | Required | Description |
|---|---|---|---|
components | WasmConnStiffenerComponent[] | yes | |
continuity_plate_area_req | number | yes | |
continuity_plate_thickness_min | number | yes | |
doubler_area_req | number | yes | |
doubler_thickness_min | number | yes | |
flange_force | number | yes | |
status | string | yes | |
stiffeners_required | boolean | yes |
WasmContinuousInfluenceLineInput
Used by influence_line_continuous.
| Field | Type | Required | Description |
|---|---|---|---|
action | string | yes | |
member_ids | integer[] | yes | |
model | WasmModel | yes | |
n_points | integer | Default: 101. | |
station_local_x | number | yes | |
station_member | integer | yes | |
support_node | integer | Default: 0. |
WasmContinuousInfluenceLineResult
Used by influence_line_continuous.
| Field | Type | Required | Description |
|---|---|---|---|
action | string | yes | |
ordinates | number[] | yes | |
positions | number[] | yes | |
station_local_x | number | yes | |
station_member | integer | yes | |
support_reaction_node | integer | null | ||
total_length | number | yes |
WasmCraneInput
Used by en1991_3_crane.
| Field | Type | Required | Description |
|---|---|---|---|
bridge_weight_kn | number | yes | |
buffer_stiffness_kn_m | number | Default: 0. | |
buffer_xi | number | Default: 0.5. | |
crab_weight_kn | number | Default: 0. | |
driven_wheels | integer | Default: 2. | |
fatigue_class | integer | null | Default: null. | |
friction | number | Default: 0.2. | |
guide_spacing_m | number | Default: 0. | |
hoist_load_kn | number | yes | |
hoisting_class | integer | Default: 2. | |
hoisting_speed_ms | number | Default: 0.1. | |
min_approach_m | number | Default: 1. | |
phi_5 | number | Default: 1.5. | |
skew_angle_rad | number | Default: 0.015. | |
span_m | number | yes | |
travel_speed_ms | number | Default: 0. | |
wheel_pair_distances_m | number[] | Default: []. | |
wheel_spacings_m | number[] | Default: [3]. | |
wheels_per_rail | integer | Default: 2. |
WasmDiaphragm
Rigid in-plane diaphragm: node ids tied to move as one rigid body in the horizontal plane.
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | yes | |
node_ids | integer[] | yes |
WasmDirectThInput
Used by solve_model_time_history_direct.
Input for solve_model_time_history_direct (ADR 0013 Step 3): the modal path's input plus the scheme and the damping form. scheme is "newmark" (with beta, gamma, default average acceleration) or "hht" (with alpha in OpenSees's convention, default 0.9). Damping is rayleigh: [a0, a1] when given, else damping_ratio fitted at the first two modes.
| Field | Type | Required | Description |
|---|---|---|---|
alpha | number | null | Default: null. | |
beta | number | null | Default: null. | |
damping_ratio | number | Default: 0.05. | |
direction | number[] | Default: [1,0,0]. | |
gamma | number | null | Default: null. | |
model | WasmModel | yes | |
nonlinear | boolean | Default: false. | |
rayleigh | number[] | null | Default: null. | |
record | number[][] | yes | |
scheme | string | Default: "". | |
track_node | integer | null | Default: null. |
WasmDynamicFloorInput
Used by as1170_dynamic_base_shear_floor.
Input for as1170_dynamic_base_shear_floor: the seismic site inputs the equivalent-static base shear needs, plus the dynamic analysis's own base shear and the seismic weight it acted on.
| Field | Type | Required | Description |
|---|---|---|---|
annual_probability | number | null | Default: null. | |
height_m | number | yes | |
kt | number | null | Eq 6.2(7) inputs: kt and the structure height hn, metres. Default: null. | |
location | string | null | Default: null. | |
mu | number | null | Default: null. | |
soil | string | Default: "". | |
sp | number | null | Default: null. | |
system | string | null | Default: null. | |
v_dynamic | number | yes | The base shear the dynamic analysis produced, newtons. |
weight | number | yes | Seismic weight Wt, newtons - the same mass the dynamic analysis used. |
z | number | null | Default: null. |
WasmEc1PeakVelocityPressureInput
Used by ec1_peak_velocity_pressure.
AS/NZS 1170.3:2003 snow actions: the ground snow load for the site (Section 5), the exposure coefficient (Cl 4.2.2), and the roof load cases for a mono- or duo-pitched roof (Sections 6 and 7), with the edge overhang load of Cl 4.2.3.
| Field | Type | Required | Description |
|---|---|---|---|
c_0 | number | Orography factor c_0(z). 1.0 where orography is not significant. Default: 1. | |
k_i | number | Turbulence factor k_I. A National Annex parameter; the EN recommends 1.0. Default: 1. | |
rho_kg_m3 | number | Air density, kg/m3. A NATIONAL ANNEX parameter; the EN recommends 1.25. Default: 1.25. | |
terrain | string | yes | Terrain category label: "0", "I", "II", "III" or "IV" (Table 4.1). |
v_b_ms | number | yes | Basic wind velocity v_b, m/s, from the national map (Section 4.2). |
z_m | number | yes | Height above ground, m. |
WasmEc1PeakVelocityPressureResult
Used by ec1_peak_velocity_pressure.
| Field | Type | Required | Description |
|---|---|---|---|
c_0 | number | yes | |
c_e | number | yes | q_p / q_b, EN's exposure factor c_e(z) - the number an engineer recognises at a glance. |
c_r | number | yes | |
clause | string | yes | |
i_v | number | yes | |
q_b_pa | number | yes | |
q_p_pa | number | yes | |
v_m_ms | number | yes | |
z_used_m | number | yes |
WasmEc3Assumptions
| Field | Type | Required | Description |
|---|---|---|---|
c1 | number | yes | |
curveLT | string | yes | |
curveY | string | yes | |
curveZ | string | yes | |
lcrLT | number | yes | |
lcrY | number | yes | |
lcrZ | number | yes |
WasmEc3MemberInput
Used by ec3_member_check.
| Field | Type | Required | Description |
|---|---|---|---|
a | number | yes | |
bf | number | yes | |
c1 | number | Default: 0. | |
d | number | yes | |
e | number | Default: 0. | |
fy | number | yes | |
iyy | number | yes | |
izz | number | yes | |
j | number | yes | |
lcrLT | number | yes | |
lcrY | number | yes | |
lcrZ | number | yes | |
myStar | number | yes | |
mzStar | number | yes | |
nStar | number | yes | |
name | string | Section name (optional): picks the Cl 6.2.6(3) shear area by shape (I, channel, RHS, CHS). Default: "". | |
r | number | Root radius (m, optional): the fillets' part of the rolled-section shear area. Default: 0. | |
szz | number | Default: 0. | |
tf | number | yes | |
tw | number | yes | |
vyStar | number | yes | |
w_el_y | number | Default: 0. | |
w_pl_y | number | Default: 0. | |
zzz | number | Default: 0. |
WasmEc3MemberResult
Used by ec3_member_check.
| Field | Type | Required | Description |
|---|---|---|---|
MbRd | number | yes | |
MyRd | number | yes | |
MzRd | number | yes | |
NbYRd | number | yes | |
NbZRd | number | yes | |
NcRd | number | yes | |
NtRd | number | yes | |
VplRd | number | yes | |
assumptions | WasmEc3Assumptions | yes | |
governing | string | yes | |
section_class | string | yes | |
utilAxial | number | yes | |
utilCombined | number | yes | |
utilFlexY | number | yes | |
utilFlexZ | number | yes | |
utilMax | number | yes | |
utilShear | number | yes |
WasmEndGap
| Field | Type | Required | Description |
|---|---|---|---|
gap_mm | number | yes | |
member_id | integer | yes |
WasmEndPlateDrawnRow
| Field | Type | Required | Description |
|---|---|---|---|
bolts | integer | yes | |
y | number | yes |
WasmEndPlateInput
Used by end_plate_check.
| Field | Type | Required | Description |
|---|---|---|---|
beam_bf | number | Default: 0. | |
beam_d | number | yes | |
beam_fy | number | Default: 0. | |
beam_tf | number | yes | |
beam_tw | number | Default: 0. | |
bolt_count_tension | integer | yes | |
bolt_count_total | integer | Total bolts sharing the shear. 0 defaults to twice the tension count. Default: 0. | |
bolt_diameter | number | yes | |
bolt_grade | string | yes | |
both_directions | boolean | The moment's sign is not known in the joint frame: check with the tension at either flange (rows mirrored to beam_d - y) and report the worse. Default: false. | |
column_bf | number | Default: 0. | |
column_d | number | The column the plate bolts to (m, Pa; SA-118): with it the rows are also limited by the column flange as T-stubs and the column web in transverse tension. Default: 0. | |
column_fy | number | Default: 0. | |
column_r1 | number | Default: 0. | |
column_stiffened | boolean | Continuity stiffeners opposite the tension flange (the web's tension is theirs). Default: false. | |
column_tf | number | Default: 0. | |
column_tw | number | Default: 0. | |
flange_weld_leg | number | Default: 0. | |
gauge | number | Centre-to-centre gauge of the two bolt columns (m). Default: 0. | |
m_star | number | yes | |
plate_ext | number | How far the plate runs past the tension flange's outer face (m); 0 for a flush plate. Default: 0. | |
plate_fy | number | yes | |
plate_thickness | number | yes | |
plate_width | number | Default: 0. | |
rows | WasmEndPlateDrawnRow[] | The drawn bolt rows (SA-87). When given, the plate is checked as AS 4100 T-stubs (connections::end_plate_tstub_as4100) instead of the strip model: each row's y (m) from the tension flange's outer face, positive towards the compression flange, and its bolt count. Default: []. | |
v_star | number | Coincident connection shear (N). Optional; 0 skips the Cl 9.2.2.3 combined shear + tension interaction on the tension bolts. Default: 0. | |
web_weld_leg | number | Default: 0. |
WasmEndPlateMultiRowInput
Used by end_plate_moment_multirow_check.
| Field | Type | Required | Description |
|---|---|---|---|
bolt_diameter | number | yes | |
bolt_grade | string | yes | |
fc_rd | number | yes | |
plate_fy | number | yes | |
plate_thickness | number | yes | |
plate_width | number | yes | |
rows | WasmEndPlateRowInput[] | yes |
WasmEndPlateMultiRowResult
Used by end_plate_moment_multirow_check.
| Field | Type | Required | Description |
|---|---|---|---|
fc_rd | number | yes | |
m_rd | number | yes | |
notes | string[] | yes | |
rows | WasmEndPlateRowResult[] | yes | |
total_tension | number | yes |
WasmEndPlateResult
Used by end_plate_check.
| Field | Type | Required | Description |
|---|---|---|---|
columnInTstub | boolean | The column flange and web in tension were in the T-stub rows (SA-118). Default: false. | |
d_eff | number | yes | |
governing | string | Default: "". | |
m_star | number | yes | |
method | string | "tstub" (the drawn rows, AS 4100 T-stubs) or "strip" (no rows given: the plate as one strip). Default: "". | |
notes | string[] | Default: []. | |
phiBoltsTension | number | yes | |
phiMDes | number | yes | |
phiPlateBending | number | yes | |
row_capacity | number[] | Default: []. | |
row_modes | string[] | Per tension row: governing T-stub mode and its capacity (N), top row first. Default: []. | |
tStar | number | yes | |
utilWebWeld | number | The web welds to the plate under the shear and the rows' tension, Cl 9.6.3.10 (SA-119). Default: 0. | |
util_bolt_combined | number | yes | |
util_bolts | number | yes | |
util_max | number | yes | |
util_plate | number | yes |
WasmEndPlateRowInput
| Field | Type | Required | Description |
|---|---|---|---|
bolts | integer | yes | |
kind | WasmEndPlateRowKindInput | yes | |
lever_arm | number | yes |
WasmEndPlateRowKindInput
One of:
type: "extended"Field Type Required Description enumberyes exnumberyes mxnumberyes type"extended"yes type: "first_below_flange"Field Type Required Description enumberyes mnumberyes m2numberyes type"first_below_flange"yes type: "inner"Field Type Required Description enumberyes mnumberyes type"inner"yes type: "end"Field Type Required Description enumberyes mnumberyes type"end"yes
WasmEndPlateRowResult
| Field | Type | Required | Description |
|---|---|---|---|
ft_rd | number | yes | |
leff_1 | number | yes | |
leff_2 | number | yes | |
mode | string | yes |
WasmEnvelopeResults
| Field | Type | Required | Description |
|---|---|---|---|
displacements_max | WasmNodeDisplacement[] | yes | |
displacements_min | WasmNodeDisplacement[] | yes | |
member_forces_max | WasmMemberForce[] | yes | |
member_forces_min | WasmMemberForce[] | yes | |
reactions_max | WasmReaction[] | yes | |
reactions_min | WasmReaction[] | yes |
WasmFinPlateInput
Used by fin_plate_check.
| Field | Type | Required | Description |
|---|---|---|---|
bolt_columns | integer | Default: 0. | |
bolt_count | integer | yes | |
bolt_diameter | number | yes | |
bolt_grade | string | yes | |
edge_distance | number | Default: 0. | |
end_distance | number | Default: 0. | |
gauge | number | Default: 0. | |
pitch | number | Default: 0. | |
plate_depth | number | yes | |
plate_fu | number | yes | |
plate_fy | number | yes | |
plate_thickness | number | yes | |
v_star | number | yes | |
weld_fuw | number | Default: 480000000. | |
weld_leg_size | number | yes | |
weld_length | number | yes |
WasmFinPlateResult
Used by fin_plate_check.
| Field | Type | Required | Description |
|---|---|---|---|
phiBlockShear | number | yes | |
phiBolts | number | yes | |
phiPlateBearing | number | yes | |
phiPlateShear | number | yes | |
phiPlateTearout | number | yes | |
phiVDes | number | yes | |
phiWeld | number | yes | |
util_block_shear | number | yes | |
util_bolts | number | yes | |
util_max | number | yes | |
util_plate_bearing | number | yes | |
util_plate_shear | number | yes | |
util_plate_tearout | number | yes | |
util_weld | number | yes | |
v_star | number | yes |
WasmFloorVibrationInput
Used by p354_floor_vibration.
{ modes: [{ frequency_hz, modal_mass_kg, mu_e, mu_r }], damping_ratio | damping: "furnished", weighting: "Wb"|"Wg"|"Wd", cutoff_hz | floor: "general"|"enclosed"|"staircase", pace_min_hz, pace_max_hz, person_weight_n, walking_path_m, limit, vertical }
| Field | Type | Required | Description |
|---|---|---|---|
cutoff_hz | number | null | Default: null. | |
damping | string | Default: "". | |
damping_ratio | number | null | Default: null. | |
floor | string | Default: "". | |
limit | number | Default: 8. | |
modes | FloorMode[] | yes | |
pace_max_hz | number | Default: 2.2. | |
pace_min_hz | number | Default: 1.8. | |
person_weight_n | number | Default: 746. | |
vertical | boolean | Default: true. | |
walking_path_m | number | null | Default: null. | |
weighting | string | Default: "". |
WasmFootingFeInput
Used by footing_fe_pressure.
| Field | Type | Required | Description |
|---|---|---|---|
bx | number | yes | |
by | number | yes | |
cx | number | Default: 0.4. | |
cy | number | Default: 0.4. | |
e_concrete | number | Default: 30000000000. | |
ks | number | yes | |
mx | number | Default: 0. | |
my | number | Default: 0. | |
n | number | yes | |
nu | number | Default: 0.2. | |
nx | integer | Default: 12. | |
ny | integer | Default: 12. | |
self_weight | number | Default: 0. | |
thickness | number | yes |
WasmFootingSizeInput
Used by footing_size_for_bearing.
| Field | Type | Required | Description |
|---|---|---|---|
aspect | number | by/bx. Defaults to 1.0 (square). Default: 0. | |
footingH | number | Footing thickness, m, so self-weight can grow with the plan area inside the loop. Default: 0. | |
mxService | number | Default: 0. | |
myService | number | Default: 0. | |
nService | number | yes | Unfactored vertical load, kN. Bearing is a working-stress check. |
qAllowable | number | yes | Allowable bearing pressure, kPa. Already factored if the caller's basis was "ultimate". |
WasmFootingSizeResult
Used by footing_size_for_bearing.
| Field | Type | Required | Description |
|---|---|---|---|
bx | number | yes | |
by | number | yes | |
converged | boolean | yes | |
note | string | null | ||
qMax | number | yes | |
util | number | yes |
WasmGeoClassifyInput
Used by geo_classify_point.
| Field | Type | Required | Description |
|---|---|---|---|
point | number[] | yes | Query point [lon, lat]. |
polygons | GeoPolygon[] | Candidate polygons (name, optional class attribute, GeoJSON rings). Default: []. |
WasmGradeBeamColumn
| Field | Type | Required | Description |
|---|---|---|---|
nStar | number | yes | |
x | number | yes |
WasmGradeBeamInput
Used by grade_beam_design.
| Field | Type | Required | Description |
|---|---|---|---|
columns | WasmGradeBeamColumn[] | yes | |
cover | number | yes | |
fPrimeC | number | yes | |
fSy | number | yes | |
ks | number | yes | Modulus of subgrade reaction, N/m^3. Geotechnical; no default - see grade_beam.rs. |
length | number | yes | |
nElements | integer | Default: 0. | |
standard | FootingCode | Concrete design code for the longitudinal flexure design. Omitted -> AS 3600, so a payload without a standard designs exactly as before. Default: "as3600". | |
thickness | number | yes | |
width | number | yes |
WasmGradeBeamResult
Used by grade_beam_design.
| Field | Type | Required | Description |
|---|---|---|---|
aStBottomReq | number | yes | |
aStMin | number | yes | |
aStTopReq | number | yes | |
checksRefused | string[] | yes | |
lambdaL | number | yes | |
mHog | number | yes | |
mSag | number | yes | |
note | string | null | ||
qMax | number | yes | |
qMaxAt | number | yes | |
rigidity | string | yes | |
settlementMax | number | yes | |
utilMoment | number | yes | |
vMax | number | yes |
WasmGussetInput
Used by gusset_check.
| Field | Type | Required | Description |
|---|---|---|---|
alphaB | number | Default: 0.5. | |
boltDiameter | number | yes | |
count | integer | yes | |
edgeType | string | Default: "". | |
grade | string | Default: "8.8". | |
k | number | Default: 0.65. | |
lb | number | Default: 0.12. | |
memberWidth | number | yes | |
nShearPlanes | integer | Default: 1. | |
nStar | number | yes | |
plateFu | number | yes | |
plateFy | number | yes | |
plateThickness | number | yes |
WasmGussetResult
Used by gusset_check.
| Field | Type | Required | Description |
|---|---|---|---|
components | WasmConnComponent[] | yes | |
govComponent | string | yes | |
govUtil | number | yes | |
layout | WasmBoltLayout | yes | |
notes | string[] | yes | |
status | string | yes |
WasmGussetSupportInput
Used by gusset_support_check.
A gusset's bolted support fitting (conn_gusset_support). SI in; mm/MPa inside.
| Field | Type | Required | Description |
|---|---|---|---|
bolt_dia | number | yes | |
bolt_grade | string | yes | |
bolted_plate | boolean | yes | |
cols | integer | yes | |
f_par | number | yes | |
f_perp | number | yes | |
gusset_bolts | integer | yes | |
lever | number | yes | |
m_star | number | yes | |
pitch | number | yes | |
plate_fy | number | yes | |
plate_t | number | yes | |
ply_fu | number | yes | |
ply_t | number | yes | |
rows | integer | yes | |
strip | number | yes | |
weld_leg | number | yes | |
weld_len | number | yes |
WasmGussetSupportResult
Used by gusset_support_check.
| Field | Type | Required | Description |
|---|---|---|---|
f_par | number | yes | |
f_perp | number | yes | |
tOuter | number | yes | |
util_face_bolts | number | yes | |
util_gusset_bolts | number | yes | |
util_gusset_weld | number | yes | |
util_max | number | yes | |
util_plate_bending | number | yes | |
util_ply_bearing | number | yes |
WasmHollowBraceEndInput
Used by hollow_brace_end_check.
Hollow-section brace end on a gusset (conn_hollow_brace.rs). SI in (m, Pa, N); the core works in mm and MPa.
| Field | Type | Required | Description |
|---|---|---|---|
bolt_columns | integer | Default: 1. | |
bolt_count | integer | yes | |
bolt_dia | number | yes | |
bolt_grade | string | yes | |
n_star | number | yes | |
slotted | boolean | true: a tongue in a slotted tube; false: a lug on an end plate, the tube whole (plan A2b). Default: true. | |
tongue_end | number | yes | |
tongue_fu | number | yes | |
tongue_fy | number | yes | |
tongue_t | number | yes | |
tongue_w | number | yes | |
tube_d | number | yes | |
tube_fu | number | yes | |
tube_fy | number | yes | |
tube_t | number | yes | |
weld_leg | number | yes | |
weld_len | number | yes |
WasmHollowBraceEndResult
Used by hollow_brace_end_check.
| Field | Type | Required | Description |
|---|---|---|---|
n_star | number | yes | |
phiBoltShear | number | yes | |
phiTongueBearing | number | yes | |
phiTongueFracture | number | yes | |
phiTongueTearout | number | yes | |
phiTongueYield | number | yes | |
phiTubeNet | number | yes | |
phiWeld | number | yes | |
shearLagU | number | yes | |
util_bolt_shear | number | yes | |
util_max | number | yes | |
util_tongue | number | yes | |
util_tongue_bearing | number | yes | |
util_tube | number | yes | |
util_weld | number | yes |
WasmImposedInput
Used by as1170_1_imposed.
| Field | Type | Required | Description |
|---|---|---|---|
category | string | yes | |
use | string | Default: "". |
WasmInfluenceLineInput
Used by influence_line.
| Field | Type | Required | Description |
|---|---|---|---|
action | string | yes | |
n_points | integer | Default: 101. | |
span | number | yes | |
station | number | yes | |
support_type | string | yes |
WasmInfluenceLineResult
Used by influence_line.
| Field | Type | Required | Description |
|---|---|---|---|
action | string | yes | |
ordinates | number[] | yes | |
positions | number[] | yes | |
span | number | yes | |
station | number | yes | |
support | string | yes |
WasmLapInput
Used by lap_check.
Cold-formed lap splice (conn_lap.rs). SI in (m, Pa, N); the core works in mm and MPa.
| Field | Type | Required | Description |
|---|---|---|---|
bolt_count | integer | yes | |
bolt_dia | number | yes | |
bolt_grade | string | yes | |
eccentricity | number | The ply standoff: how far the bolt line sits off the member's own axis. Default: 0. | |
m_star | number | Default: 0. | |
n_star | number | yes | |
pitch | number | yes | |
ply1_fu | number | yes | |
ply1_t | number | yes | |
ply2_fu | number | yes | |
ply2_t | number | yes | |
v_star | number | yes |
WasmLapResult
Used by lap_check.
| Field | Type | Required | Description |
|---|---|---|---|
bearingC | number | yes | |
components | WasmConnComponent[] | yes | |
govComponent | string | yes | |
govUtil | number | yes | |
kr | number | yes | |
lapLength | number | yes | |
notes | string[] | yes | |
status | string | yes |
WasmLoadCase
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | yes | |
load_case_type | integer | 0=Dead, 1=Live, 2=Wind, 3=Seismic, 4=Snow, 5=Other, 6=WindUltimate, 7=WindServiceability, 8=SeismicServiceability Default: 0. | |
name | string | yes | |
self_weight_factor | number | Default: 0. |
WasmLoadCaseResults
| Field | Type | Required | Description |
|---|---|---|---|
capacity_warnings | string[] | Members the selected design code could not check (unsupported section type/class) - a missing capacity record means NOT CHECKED, never OK. | |
deactivated | integer[] | Members deactivated by the tension/compression-only iteration for this case: zero force, no capacity row, and THIS is what says so. | |
displacements | WasmNodeDisplacement[] | yes | |
load_case_id | integer | yes | |
member_capacities | WasmMemberCapacity[] | Default: []. | |
member_forces | WasmMemberForce[] | yes | |
member_station_forces | WasmMemberStationForces[] | Default: []. | |
plate_nodal_results | WasmPlateNodalResult[] | ||
plate_nodal_results_smoothed | WasmPlateNodalResult[] | ||
plate_notes | string[] | Information about the plates (orthotropy, compressed plates and the buckling analysis) - NOT a self-check; see AnalysisResults::plate_notes. | |
plate_results | WasmPlateResult[] | Default: []. | |
reactions | WasmReaction[] | yes | |
solver_warnings | string[] | Numerical self-checks on the solve (equilibrium residual). Non-empty means the displacement solution itself is suspect - surface it. |
WasmLoadCombination
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | yes | |
name | string | yes | |
terms | WasmComboTerm[] | yes | List of { load_case_id, factor } terms |
WasmMaterial
| Field | Type | Required | Description |
|---|---|---|---|
alpha | number | Default: 0.000012. | |
e | number | yes | |
fu | number | Default: 400000000. | |
fy | number | Default: 250000000. | |
g | number | yes | |
id | integer | yes | |
name | string | Default: "". | |
nu | number | Default: 0.3. | |
rho | number | Default: 7850. |
WasmMember
| Field | Type | Required | Description |
|---|---|---|---|
beta | number | yes | |
fixity_a | integer | Default: 0. | |
fixity_b | integer | Default: 0. | |
flange_restrained | boolean | Compression flange continuously restrained (e.g. sheeting) -> no LTB. Defaults to false. Default: false. | |
id | integer | yes | |
ke_x | number | Effective-length factor for major-axis buckling / LTB. Defaults to 1.0. Default: 0. | |
ke_y | number | Effective-length factor for minor-axis compression buckling. Defaults to 1.0. Default: 0. | |
material_id | integer | yes | |
member_type | integer | yes | |
node_a | integer | yes | |
node_b | integer | yes | |
offset_a | number[] | Default: [0,0,0]. | |
offset_b | number[] | Default: [0,0,0]. | |
section_id | integer | yes |
WasmMemberCapacitiesInput
Used by member_capacities_only.
| Field | Type | Required | Description |
|---|---|---|---|
member_forces | WasmMemberForce[] | Optional member forces for alpha_m / utilisation update. If provided, must contain one entry per member with solved end forces. Default: []. | |
model | WasmModel | yes |
WasmMemberCapacitiesOutput
Used by member_capacities_only.
| Field | Type | Required | Description |
|---|---|---|---|
capacity_warnings | string[] | Members the selected design code could not check (unsupported section type/class) - one human-readable line each. The UI must surface these: a missing capacity record means NOT CHECKED, never OK. | |
member_capacities | WasmMemberCapacity[] | yes |
WasmMemberCapacity
| Field | Type | Required | Description |
|---|---|---|---|
angle | AngleWorking | null | AS 4100 Cl 8.4.6 parts for a single angle truss member (SA-115); absent otherwise. | |
assumptions | WasmCapacityAssumptions | yes | |
axis_x | WasmAxisCapacity | yes | |
axis_y | WasmAxisCapacity | yes | |
code | string | Design code: "AS4100" (hot-rolled) or "AS4600" (cold-formed DSM). Default: "". | |
compression | WasmCompressionCapacity | yes | |
dsm | DsmCapacity | null | DSM mode breakdown (local/distortional/global) when code == "AS4600". | |
fy | number | yes | |
member_id | integer | yes | |
phi | number | yes | |
phiMox | number | yes | |
phiMoy | number | yes | |
phiMrx | number | yes | The axial-reduced moment capacities the two interactions above are formed from (N.m): section, Cl 8.3.2/8.3.3, and member out-of-plane, Cl 8.4.4. Without these the report can print the interaction formula but not one capacity inside it. |
phiMry | number | yes | |
phiNt | number | yes | |
phiVv | number | yes | |
phiVvMinor | number | Minor-axis shear capacity (N), for Vz across the section's width (SA-39); 0 where the code path does not compute it. Default: 0. | |
utilBiaxialMember | number | yes | |
utilBiaxialSection | number | yes | |
utilMax | number | yes |
WasmMemberForce
| Field | Type | Required | Description |
|---|---|---|---|
fx1 | number | yes | |
fx2 | number | yes | |
fy1 | number | yes | |
fy2 | number | yes | |
fz1 | number | yes | |
fz2 | number | yes | |
member_id | integer | yes | |
mx1 | number | yes | |
mx2 | number | yes | |
my1 | number | yes | |
my2 | number | yes | |
my_span | number | As mz_span, for |My| (minor axis). Default: 0. | |
mz1 | number | yes | |
mz2 | number | yes | |
mz_quarters | number[] | |Mz| at 0.25, 0.5 and 0.75 of the member, from its stations: with mz_span these are the four moments of AS 4100 Eq 5.6.1.1(2) / NZS 3404 Cl 5.6.1.1, so a check fed this row alone (auto-size's member_capacities_only) takes the same alpha_m the solve does. Zero when the row has no stations. Default: [0,0,0]. | |
mz_span | number | The largest |Mz| (major axis) anywhere along the member, from its station forces, ends included. A simply supported beam's governing moment is at midspan, where both END moments are zero, and a design check that reads only mz1/mz2 calls a failing beam safe - which is what the Studio's per-member utilisation did until 2026-09-23 (SA-04). 0 when the row has no stations. Default: 0. |
WasmMemberLoad
| Field | Type | Required | Description |
|---|---|---|---|
end_ratio | number | Default: 0. | |
load_case_id | integer | yes | |
load_type | integer | Default: 0. | |
member_id | integer | yes | |
qx | number | yes | |
qx2 | number | Default: 0. | |
qy | number | yes | |
qy2 | number | Default: 0. | |
qz | number | yes | |
qz2 | number | Default: 0. | |
start_ratio | number | Default: 0. |
WasmMemberStationForces
| Field | Type | Required | Description |
|---|---|---|---|
member_id | integer | yes | |
stations | WasmStationForce[] | yes |
WasmModalInput
Used by solve_model_modal_with_options.
The input of solve_model_modal_with_options: the model and the modal options.
| Field | Type | Required | Description |
|---|---|---|---|
model | WasmModel | yes | |
options | WasmModalOptions | Default: {"mass_matrix":"","n_modes":0}. |
WasmModalMode
| Field | Type | Required | Description |
|---|---|---|---|
eigenvalue | number | yes | |
frequency_hz | number | yes | |
index | integer | yes | |
modal_mass_kg | number | Modal mass (kg) for the unity-normalised shape (largest nodal translation = 1); SCI P354's M_n. Default: 0. | |
mode_shape | WasmNodeDisplacement[] | yes | |
unity_scale | number | Multiply a mode_shape translation by this to get the unity-normalised amplitude mu. Default: 1. |
WasmModalOptions
| Field | Type | Required | Description |
|---|---|---|---|
mass_matrix | string | Default: "". | |
n_modes | integer | Default: 0. |
WasmModalResults
Used by solve_model_modal.
| Field | Type | Required | Description |
|---|---|---|---|
modes | WasmModalMode[] | yes | |
warnings | string[] | Eigensolver self-check notes (Sturm-count mismatch, low seismic mass participation). Non-empty means the mode set is suspect. |
WasmModel
Used by analysis_report, connection_takeoff, quantity_takeoff, solve_model, solve_model_buckling, solve_model_modal, solve_model_modal_with_options, solve_model_nonlinear, solve_model_nonlinear_3d, solve_model_nonlinear_with_options, solve_model_pdelta, solve_model_tc, validate_model.
| Field | Type | Required | Description |
|---|---|---|---|
cables | WasmCable[] | Per-cable-member settings for the 3D nonlinear path (ADR 0013 Step 1): which model ("chord" | "catenary") and the optional unstressed length in metres. Default: []. | |
design_code | string | Design code for member capacity checks: "AS4100" (default), "AISC360", "EC3". Default: "AS4100". | |
diaphragms | WasmDiaphragm[] | Default: []. | |
double_angle_connectors | DoubleAngleConnectors[] | Double-angle interconnectors (SA-156) - see model::DoubleAngleConnectors; the core type's own serde shape is the wire shape. Default: []. | |
end_gaps | WasmEndGap[] | Member-end gaps (ADR 0013 Step 2): { member_id, gap_mm } on truss / compression-only members. Default: []. | |
load_cases | WasmLoadCase[] | yes | |
load_combinations | WasmLoadCombination[] | Default: []. | |
materials | WasmMaterial[] | yes | |
member_loads | WasmMemberLoad[] | yes | |
members | WasmMember[] | yes | |
nodal_loads | WasmNodalLoad[] | yes | |
nodes | WasmNode[] | yes | |
plate_loads | WasmPlateLoad[] | Default: []. | |
plate_orthotropy | PlateOrthotropy[] | Orthotropic plates: { plate_id, axis: [x, y, z], input: { kind: "material", e1, e2, g12, nu12, g13, g23 } | { kind: "rigidities", a11, a22, a12, a66, d11, d22, d12, d66, s13, s23 } }. The core type's own serde shape is the wire shape; see model::PlateOrthotropy. Default: []. | |
plates | WasmPlate[] | Default: []. | |
sections | WasmSection[] | yes | |
shear_centre_loaded | integer[] | Member ids loaded at the shear centre rather than on the top flange (the default) - see model::Model::shear_centre_loaded. Default: []. |
WasmModeResponse
| Field | Type | Required | Description |
|---|---|---|---|
baseShear | number | yes | |
effectiveMass | number | yes | |
frequencyHz | number | yes | |
modeIndex | integer | yes | |
participationFactor | number | yes | |
periodS | number | yes | |
spectralAccel | number | yes |
WasmMomentBaseInput
Used by moment_base_check.
| Field | Type | Required | Description |
|---|---|---|---|
boltDiameter | number | yes | |
columnBf | number | Default: 0. | |
columnD | number | yes | |
concreteFc | number | yes | |
grade | string | Default: "8.8". | |
mStar | number | yes | |
nStar | number | Default: 0. | |
nTension | integer | yes | |
plateB | number | yes | |
plateD | number | yes | |
plateFy | number | yes | |
plateT | number | yes | |
vStar | number | Default: 0. |
WasmMomentBaseResult
Used by moment_base_check.
| Field | Type | Required | Description |
|---|---|---|---|
anchorTension | number | yes | |
bearingLength | number | yes | |
components | WasmConnComponent[] | yes | |
govComponent | string | yes | |
govUtil | number | yes | |
notes | string[] | yes | |
status | string | yes |
WasmMovingLoadInput
Used by moving_load_effect.
| Field | Type | Required | Description |
|---|---|---|---|
action | string | yes | |
n_points | integer | yes | |
span | number | yes | |
station | number | yes | |
support_type | string | yes | |
vehicle | WasmVehicle | yes |
WasmMovingLoadResult
Used by moving_load_effect.
| Field | Type | Required | Description |
|---|---|---|---|
critical_position_max | number | yes | |
critical_position_min | number | yes | |
max_value | number | yes | |
min_value | number | yes |
WasmNlOptions
Used by solve_model_nonlinear_3d, solve_model_nonlinear_with_options.
Options for solve_model_nonlinear_with_options (plan item 5). Every field has the default the planar solve always had; material: "plastic" turns on fibre sections with the material's own fy (or fy here, Pa) and control: "arc" traces past limit points.
| Field | Type | Required | Description |
|---|---|---|---|
control | string | Default: "". | |
ds | number | null | ||
fibers | integer | Default: 16. | |
fy | number | null | ||
hardening | number | Default: 0. | |
load_case_id | integer | Default: 0. | |
material | string | Default: "". | |
max_iterations | integer | Default: 60. | |
n_steps | integer | Default: 20. | |
tolerance | number | Default: 0.000001. |
WasmNodalLoad
| Field | Type | Required | Description |
|---|---|---|---|
fx | number | yes | |
fy | number | yes | |
fz | number | yes | |
load_case_id | integer | yes | |
mx | number | Default: 0. | |
my | number | Default: 0. | |
mz | number | Default: 0. | |
node_id | integer | yes |
WasmNode
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | yes | |
mass | number | Default: 0. | |
restraint_flags | integer | yes | |
settlement | number[] | Default: [0,0,0,0,0,0]. | |
spring_stiffness | number[] | Default: [0,0,0,0,0,0]. | |
support_no_tension | boolean | Bears but cannot pull (ADR 0013 Step 2); honoured by the 3D nonlinear path only. Default: false. | |
x | number | yes | |
y | number | yes | |
z | number | yes |
WasmNodeDisplacement
| Field | Type | Required | Description |
|---|---|---|---|
node_id | integer | yes | |
rx | number | yes | |
ry | number | yes | |
rz | number | yes | |
ux | number | yes | |
uy | number | yes | |
uz | number | yes |
WasmNotionalInput
Used by as4100_notional_force.
| Field | Type | Required | Description |
|---|---|---|---|
adequately_braced | boolean | Legacy input from before the 2020 edition's single factor; accepted and ignored. Default: false. | |
multi_storey | boolean | AS 4100 Cl 3.2.4 applies to multi-storey buildings only. Default true. Default: true. | |
total_gravity_load | number | yes | Total design vertical load applied at the floor level (N). |
WasmNotionalResult
Used by as4100_notional_force.
| Field | Type | Required | Description |
|---|---|---|---|
force | number | yes |
WasmNzDesignCoefficientInput
Used by nzs1170_design_coefficient.
NZS 1170.5:2004 Cl 5.2.1.1: the ultimate limit state horizontal design action coefficient. sp (Cl 4.4) and mu (Cl 4.3) are caller inputs: Section 4 selects them from the structural system, which this module does not model. Everything else is the Section 3 spectrum this build already carries.
| Field | Type | Required | Description |
|---|---|---|---|
annual_probability | number | yes | |
mu | number | yes | Structural ductility factor mu, Cl 4.3. |
n_max | number | null | Default: null. | |
near_fault_km | number | null | Default: null. | |
period | number | yes | T1, the largest translational period in the direction considered (Cl 4.1). |
soil | string | yes | |
sp | number | yes | Structural performance factor Sp, Cl 4.4. |
z | number | yes |
WasmNzDesignCoefficientResult
Used by nzs1170_design_coefficient.
| Field | Type | Required | Description |
|---|---|---|---|
c_t | number | yes | |
cd | number | yes | |
cd_unfloored | number | yes | |
clause | string | yes | |
floor | number | yes | |
floor_governs | boolean | yes | True when Eq 5.2(2)'s floor decided the answer. |
k_mu | number | yes | |
r | number | yes | |
r_capped | boolean | yes | |
sp | number | yes |
WasmNzDesignSpectrumInput
Used by nzs1170_design_spectrum.
NZS 1170.5:2004 Eq 5.2(1)/(2) at EVERY period of Table 3.1: the inelastic design spectrum. A COMPOSITION of the single-period path, so there is one implementation of Cd in the crate. Read fem_core::nzs1170_5::design_spectrum for what IS and is NOT verified about using it as a modal design spectrum - the clause basis is a reading, and the T = 0 ordinate is the sharp edge of it.
| Field | Type | Required | Description |
|---|---|---|---|
annual_probability | number | yes | |
mu | number | yes | Structural ductility factor mu, Cl 4.3. |
n_max | number | null | Default: null. | |
near_fault_km | number | null | Default: null. | |
soil | string | yes | |
sp | number | yes | Structural performance factor Sp, Cl 4.4. |
z | number | yes |
WasmNzDesignSpectrumResult
Used by nzs1170_design_spectrum.
| Field | Type | Required | Description |
|---|---|---|---|
citation | string | yes | The same sentence the UI prints beside the numbers, so the reading travels with them. |
clause | string | yes | |
floored | boolean | yes | True when the floor decided at least one ordinate, for a one-line caveat. |
floored_periods | number[] | yes | The periods where Eq 5.2(2)'s floor decided the ordinate rather than Eq 5.2(1). |
mu | number | yes | |
points | [number, number][] | yes | (period s, Cd) pairs, one per Table 3.1 period, ascending. |
r | number | yes | |
r_capped | boolean | yes | |
sp | number | yes | |
z | number | yes |
WasmNzEquivalentStaticInput
Used by nzs1170_equivalent_static.
NZS 1170.5:2004 Cl 6.2: the equivalent static method - base shear and the force at each level.
| Field | Type | Required | Description |
|---|---|---|---|
annual_probability | number | yes | |
levels | [number, number][] | yes | (seismic weight N, height above base m) per level, in any order. |
mu | number | yes | |
n_max | number | null | Default: null. | |
near_fault_km | number | null | Default: null. | |
period | number | yes | |
soil | string | yes | |
sp | number | yes | |
weight | number | null | Seismic weight Wt, newtons (Cl 4.2). Omit to have it summed from levels. Default: null. | |
z | number | yes |
WasmNzEquivalentStaticResult
Used by nzs1170_equivalent_static.
| Field | Type | Required | Description |
|---|---|---|---|
base_shear | number | yes | |
cd | number | yes | |
cd_unfloored | number | yes | |
clause | string | yes | |
floor_governs | boolean | yes | |
k_mu | number | yes | |
levels | WasmNzStoreyForce[] | yes | |
seismic_weight | number | yes |
WasmNzPartInput
Used by nzs1170_part_force.
NZS 1170.5:2004 Section 8: the earthquake force on a part or component supported at level i. cph (Table 8.2) and rp (Table 8.1) are caller inputs - neither table is carried, and a risk factor is the importance of somebody's plant, not something to guess. A part supported directly on the ground floor is out of scope for this clause entirely: Cl 8.2 sends it to Section 5 as a separate structure, which is the engineer's call rather than something detectable here.
| Field | Type | Required | Description |
|---|---|---|---|
annual_probability | number | yes | |
cph | number | yes | Part horizontal response factor C_ph, Table 8.2. |
hi | number | yes | Height of the part's attachment above the base, m. Below ground floor reads as ground floor. |
hn | number | yes | Height from the base to the uppermost seismic mass, m. |
n_max | number | null | Default: null. | |
near_fault_km | number | null | Default: null. | |
rp | number | yes | Part risk factor R_p, Table 8.1. |
soil | string | yes | |
tp | number | yes | Period of the part itself, seconds (Cl 8.4). |
wp | number | yes | Weight of the part, newtons. |
z | number | yes |
WasmNzPartResult
Used by nzs1170_part_force.
| Field | Type | Required | Description |
|---|---|---|---|
c_hi | number | yes | |
c_i | number | yes | |
c_zero | number | yes | C(0), from Table 3.1's BRACKETED column - not the general spectrum at zero period. |
capped | boolean | yes | True when 3.6 W_p decided the answer. |
clause | string | yes | |
cp | number | yes | |
force | number | yes | F_ph, newtons, after Eq 8.5(1)'s 3.6 W_p cap. |
unbounded | number | yes |
WasmNzs3404CombinedInput
Used by nzs3404_combined.
One member, one load case. Capacities are DESIGN values (phi already applied), demands are the load case's, and n_star is NEGATIVE in compression.
| Field | Type | Required | Description |
|---|---|---|---|
doubly_symmetric | boolean | Whether the outline is doubly symmetric. With kf and the class, this is the third condition on the higher tier of Cl 8.3.2/8.3.3, and it cannot be inferred from the numbers above. Default: false. | |
kf | number | Default: 1. | |
m_star_x | number | yes | |
m_star_y | number | Default: 0. | |
n_star | number | yes | |
phi_mbx | number | yes | |
phi_msx | number | yes | |
phi_msy | number | Default: 0. | |
phi_ncx | number | yes | |
phi_ncy | number | yes | |
phi_ns | number | yes | |
phi_nt | number | yes | |
phi_vv | number | Default: 0. | |
section_class | string | yes | "compact" | "non-compact" | "slender", from the capacity record. |
v_star | number | Default: 0. |
WasmNzs3404CombinedResult
Used by nzs3404_combined.
| Field | Type | Required | Description |
|---|---|---|---|
governed_by | string | yes | The clause the governing check came from, for the report line. |
higher_tier | boolean | yes | |
phi_m_ix | number | yes | |
phi_m_ox | number | yes | |
phi_m_rx | number | yes | |
phi_m_ry | number | yes | |
util_axial | number | yes | |
util_max | number | yes | |
util_member_biaxial | number | yes | |
util_member_in_plane | number | yes | |
util_member_out_of_plane | number | yes | |
util_section_biaxial | number | yes | |
util_section_x | number | yes | |
util_section_y | number | yes | |
util_shear | number | yes |
WasmNzs3404MemberInput
Used by nzs3404_member_check.
One member, one load case, in the units the studio already speaks: mm, MPa, N and N·mm.
| Field | Type | Required | Description |
|---|---|---|---|
ag | number | yes | Gross area, net area (mm²) and the Cl 7.3 correction factor for eccentric end connections. |
alpha_m | number | Cl 5.6.1.1 moment modification factor. Pass 1.0 for uniform moment. Default: 1. | |
an | number | Default: 0. | |
bf | number | Default: 0. | |
category | string | yes | "1", "2", "3" or "4" - NZS 3404 Section 12. No default: see the note above. |
d | number | yes | Overall depth, flange width, flange thickness, web thickness (mm). For a CHS, d is the outside diameter and tw the wall. |
doubly_symmetric | boolean | Whether the outline is doubly symmetric - one of the three conditions on the higher tier of Section 8, and not inferable from the numbers above. Default: false. | |
e | number | Elastic and shear moduli (MPa). Default to the standard's steel values. Default: 200000. | |
family | string | yes | Which shear-area and slenderness family the outline belongs to: "hot-rolled-i", "welded-i", "rhs", "chs". |
fu | number | yes | Tensile strength (MPa). |
fyf | number | yes | Flange yield stress (MPa) - Cl 5.2.1 reads the FLANGE value, not the lower of flange and web. |
fyw | number | Web yield stress (MPa). Default: 0. | |
g | number | Default: 80000. | |
iw | number | yes | |
iy | number | yes | Second moment of area about the minor axis (mm⁴), torsion constant (mm⁴), warping constant (mm⁶) - the Cl 5.6.1.1 reference buckling moment needs all three. |
j | number | yes | |
kf | number | Form factor (Cl 6.2). 1.0 for a fully effective section. Default: 1. | |
kte | number | Default: 1. | |
le_ltb | number | yes | |
lex | number | yes | Effective lengths for compression about each axis, and for lateral-torsional buckling (mm). |
ley | number | yes | |
m_star_x | number | Default: 0. | |
m_star_y | number | Default: 0. | |
n_star | number | Design actions for this load case. n_star is NEGATIVE in compression. Default: 0. | |
rx | number | yes | Radii of gyration (mm). |
ry | number | yes | |
sx | number | yes | |
sy | number | yes | |
tf | number | Default: 0. | |
tw | number | yes | |
v_star | number | Default: 0. | |
zx | number | yes | Elastic and plastic section moduli about each axis (mm³). |
zy | number | yes |
WasmNzSiteHazardInput
Used by nzs1170_site_hazard.
NZS 1170.5:2004 Cl 3.1: the elastic site hazard spectrum for horizontal loading. z is the hazard factor, a caller input: Table 3.3's list of New Zealand locations is not carried, so this build cannot look it up and does not pretend to. n_max likewise comes from Table 3.7, which needs the fault list of Table 3.6 to be meaningful; omit it and the near-fault factor is 1.0, which is what Cl 3.1.6.1 gives at an annual probability of 1/250 or more frequent.
| Field | Type | Required | Description |
|---|---|---|---|
annual_probability | number | yes | Annual probability of exceedance, as a fraction: 1/500 is 0.002 (Table 3.5). |
n_max | number | null | Nmax(T) from Table 3.7, which this build does not carry. Default: null. | |
near_fault_km | number | null | Shortest distance to a Table 3.6 fault, km. With n_max, drives Cl 3.1.6. Default: null. | |
period | number | yes | Period T, seconds. Table 3.1 stops at 4.5 s and so does this. |
soil | string | yes | Site subsoil class A, B, C, D or E (Cl 3.1.3). A and B are one column of Table 3.1. |
z | number | yes | Hazard factor Z (Cl 3.1.4, Table 3.3). |
WasmNzSiteHazardResult
Used by nzs1170_site_hazard.
| Field | Type | Required | Description |
|---|---|---|---|
c_t | number | yes | |
ch_t | number | yes | |
clause | string | yes | |
n_t_d | number | yes | |
r | number | yes | |
r_capped | boolean | yes | True when Cl 3.1.1's cap held Z R down to 0.7. |
r_table | number | yes | |
z | number | yes |
WasmNzStoreyForce
| Field | Type | Required | Description |
|---|---|---|---|
force | number | yes | |
height | number | yes | |
top_lump | number | yes | The 0.08 V lump, which is non-zero at the top level only. |
weight | number | yes |
WasmOpenWindInput
Used by as1170_open_wind.
One export, routed by kind, so a scripting caller has one door for every open structure: { kind: "hoarding", region, terrain, return_period_years, m_d, m_s, m_t, b, c, h, solidity, wind: "normal"|"45"|"parallel", return_corner, friction: "ribs"|"corrugations"|"smooth" } { kind: "free_roof", ...site..., roof: "mono"|"pitched"|"troughed", alpha_deg, h, d, b, blockage (0 empty .. 1 blocked), wind: "0"|"90"|"180", tributary_area_m2, k_l } { kind: "attached_canopy", ...site..., h, hc, wc, slope_deg, enclosure: "open"|"wall_one_side"|"wall_two_sides", parallel, tributary_area_m2, k_l } { kind: "local_pressure", case: "WA1".."SA5", b, d, h, cp_e, parapet_hp } Every refusal comes back as { "error": ... }, never as a zero.
| Field | Type | Required | Description |
|---|---|---|---|
alpha_deg | number | Default: 0. | |
b | number | Default: 0. | |
blockage | number | Default: 0. | |
c | number | Default: 0. | |
case | string | Default: "". | |
cp_e | number | Default: 0. | |
d | number | Default: 0. | |
enclosure | string | Default: "". | |
friction | string | Default: "". | |
h | number | Default: 0. | |
hc | number | Default: 0. | |
k_l | number | Default: 1. | |
kind | string | yes | |
m_d | number | Default: 1. | |
m_s | number | Default: 1. | |
m_t | number | Default: 1. | |
parallel | boolean | Default: false. | |
parapet_hp | number | null | Default: null. | |
region | string | Default: "A". | |
return_corner | boolean | Default: false. | |
return_period_years | number | Default: 500. | |
roof | string | Default: "". | |
slope_deg | number | Default: 0. | |
solidity | number | Default: 1. | |
terrain | string | Default: "TC2". | |
tributary_area_m2 | number | Default: 10. | |
wc | number | Default: 0. | |
wind | string | Default: "". |
WasmPadFootingInput
Used by pad_footing_design.
| Field | Type | Required | Description |
|---|---|---|---|
asDowelProvided | number | Default: 0. | |
asProvidedX | number | Default: 0. | |
asProvidedY | number | Default: 0. | |
barDiameter | number | Default: 0. | |
bearingBasis | string | Default: "allowable". | |
columnBx | number | yes | |
columnBy | number | yes | |
columnEx | number | Default: 0. | |
columnEy | number | Default: 0. | |
columnPosition | string | Default: "interior". | |
cover | number | yes | |
designSection | DesignSection | Default: {"kind":"face"}. | |
fPrimeC | number | yes | |
fPrimeCColumn | number | Default: 0. | |
fSy | number | yes | |
footingBx | number | yes | |
footingBy | number | yes | |
footingH | number | yes | |
mxService | number | Default: 0. | |
mxStar | number | yes | |
myService | number | Default: 0. | |
myStar | number | yes | |
nService | number | Default: 0. | |
nStar | number | yes | |
pedestalHeight | number | Default: 0. | |
phiBaseDeg | number | Default: 30. | |
qBearing | number | yes | |
reinfClass | ReinforcementClass | Default: "n". | |
reinforced | boolean | Default: true. | |
selfWeight | number | Default: 0. | |
standard | FootingCode | Default: "as3600". | |
vStar | number | Default: 0. |
WasmPadFootingResult
Used by pad_footing_design.
| Field | Type | Required | Description |
|---|---|---|---|
aSDowelReq | number | yes | |
aStMin | number | yes | |
aStXProvided | number | yes | |
aStXReq | number | yes | |
aStYProvided | number | yes | |
aStYReq | number | yes | |
bearingStressCapacity | number | yes | |
bearingStressDemand | number | yes | |
checksRefused | string[] | yes | |
contactState | string | yes | |
cornerPressures | number[] | yes | |
dEff | number | yes | |
developmentAvailableM | number | yes | |
developmentDetail | string | yes | |
developmentLstM | number | yes | |
governing | string | yes | |
infinite | string[] | yes | Utilisation fields that are +Infinity (a decided failure), which JSON would otherwise turn into null and so into "not evaluated". The JS adapter restores them. |
kUoX | number | yes | |
kUoY | number | yes | |
mXDesign | number | yes | |
mYDesign | number | yes | |
note | string | null | ||
overturningE | number | yes | |
overturningELimit | number | yes | |
phiBendingX | number | yes | |
phiBendingY | number | yes | |
phiVPunch | number | yes | |
phiVUc | number | yes | |
plain | WasmPlainConcreteCheck | null | Present only when the caller asked for an UNREINFORCED footing; null otherwise, which is what every existing caller sees. | |
punchingPerimeter | number | yes | |
qAllowable | number | yes | |
qMax | number | yes | |
slidingResistance | number | yes | |
thicknessRequired | number | yes | |
utilBearing | number | yes | |
utilBearingStress | number | yes | |
utilDevelopment | number | yes | |
utilDowelDevelopment | number | yes | |
utilDowelTension | number | yes | |
utilMax | number | yes | |
utilMomentX | number | yes | |
utilMomentY | number | yes | |
utilOverturning | number | yes | |
utilPedestal | number | yes | |
utilPunching | number | yes | |
utilShear | number | yes | |
utilSliding | number | yes | |
vPunch | number | yes | |
vUc | number | yes | |
vX | number | yes | |
vY | number | yes |
WasmPartInput
Used by as1170_part_force.
AS 1170.4:2024 Section 8, parts and components. method picks the clause: "simple" is Cl 8.3 (height amplification, no analysis of the structure needed) and "acceleration" is Cl 8.2(1) (an effective floor acceleration the caller already has).
| Field | Type | Required | Description |
|---|---|---|---|
annual_probability | number | null | ||
ductility | string | "flexible-ductile", "rigid", "non-ductile" or "connection" (Cl 8.2). Default: "". | |
floor_acceleration | number | null | Cl 8.2(1): effective floor acceleration at the component's level, as a fraction of g. It is floored at k_p Z C_h(0) by the clause, and the result says whether that floor applied. Default: null. | |
hn_m | number | null | Cl 8.3: total height of the structure above the structural base, metres. Default: null. | |
hx_m | number | null | Cl 8.3: height at which the component is attached above the structural base, metres. Default: null. | |
importance | string | "importance-level-4", "life-safety-critical" or "other" (Cl 8.2). Default: "". | |
location | string | null | Table 3.2 location name, or pass z directly from Figure 3.2. Default: null. | |
mechanical_or_electrical | boolean | Cl 8.1.3: a mechanical or electrical component also takes a vertical force of half the horizontal one, NOT acting at the same time. Set this and the result carries it. Default: false. | |
method | string | Default: "". | |
mounting | string | "flexible-spring-mechanical" or "other" (Cl 8.2). Default: "". | |
soil | string | yes | Site sub-soil class Ae to Ee; Table 6.4's BRACKETED Ch(0) is the one Section 8 uses. |
weight_n | number | yes | W_c, the component's seismic weight, in NEWTONS. |
z | number | null | Default: null. |
WasmPartResult
Used by as1170_part_force.
| Field | Type | Required | Description |
|---|---|---|---|
a_c | number | yes | |
a_floor | number | yes | |
acceleration_floored | boolean | yes | |
bound | string | yes | "computed", "lower" (0.05 W_c governed) or "upper" (0.5 W_c governed). |
clause | string | yes | |
force_n | number | yes | |
height_amplification | number | null | ||
i_c | number | yes | |
r_c | number | yes | |
unbounded_n | number | yes | |
vertical_n | number | null | Cl 8.1.3's vertical force, when the component is mechanical or electrical. It is an ALTERNATIVE load case to the horizontal force, never an addition to it. |
WasmPlainConcreteCheck
The AS 3600 Section 20 plain-concrete checks, in the camelCase the browser reads. Its own struct rather than re-exporting fem_core::pad_footing::PlainConcreteCheck because the core type is snake_case and Serialize-only, and every other field crossing this boundary is camelCase and round-trips. ADDED 2026-09-09 with the reinforced option itself. Without it the boundary returned governing: "plain_moment" and a utilisation over 1.0 with no check behind it - a number an engineer is asked to act on and cannot see the working for. The option was reachable and its ANSWER was not.
| Field | Type | Required | Description |
|---|---|---|---|
dDesign | number | yes | Design depth D used by Section 20, m. Not d_eff: plain concrete has no bar to measure to. |
fCtF | number | yes | Characteristic flexural tensile strength, MPa (Cl 3.1.1.3, 0.6*sqrt(f'c)). |
meetsMinDepth | boolean | yes | Cl 20.2: does the pad meet the minimum depth for a plain footing? |
phiMuo | number | yes | |
phiVu | number | yes | |
utilMoment | number | yes | |
utilShear | number | yes |
WasmPlate
Input model for WASM. Quad-only: triangles are not supported by the current formulation.
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | yes | |
material_id | integer | yes | |
node_ids | integer[] | yes | Three ids (a triangle, stored [a, b, c, c]) or four (a quad). |
thickness | number | yes |
WasmPlateCompactness
| Field | Type | Required | Description |
|---|---|---|---|
lambda_e | number | yes | |
lambda_ep | number | yes | |
lambda_ey | number | yes |
WasmPlateLoad
| Field | Type | Required | Description |
|---|---|---|---|
load_case_id | integer | yes | |
plate_id | integer | yes | |
pressure | number | yes |
WasmPlateNodalResult
| Field | Type | Required | Description |
|---|---|---|---|
mx | number | yes | |
mxy | number | yes | |
my | number | yes | |
node_id | integer | yes | |
plate_id | integer | yes | |
sx | number | yes | |
sy | number | yes | |
txy | number | yes | |
vonMises | number | yes | |
vonMisesMembrane | number | von Mises of the membrane stresses only; vonMises is the surface peak (SA-45). Default: 0. |
WasmPlateResult
| Field | Type | Required | Description |
|---|---|---|---|
bucklingFactor | number | null | ||
material_axes | MaterialAxisResult | null | Orthotropic plates only: m1/m2/m12 and n1/n2/n12 along the grain (see model::MaterialAxisResult). | |
mx | number | yes | |
mx_star_bottom | number | yes | |
mx_star_top | number | yes | |
mxy | number | yes | |
my | number | yes | |
my_star_bottom | number | yes | |
my_star_top | number | yes | |
plate_id | integer | yes | |
sigma1Bottom | number | yes | |
sigma1Top | number | yes | |
sigma2Bottom | number | yes | |
sigma2Top | number | yes | |
sx | number | yes | |
sxBottom | number | yes | |
sxTop | number | yes | |
sy | number | yes | |
syBottom | number | yes | |
syTop | number | yes | |
thetaPBottom | number | yes | |
thetaPTop | number | yes | |
txy | number | yes | |
vonMises | number | yes | |
vonMisesMembrane | number | von Mises of the membrane stresses only; vonMises is the surface peak (SA-45). Default: 0. |
WasmPoint2
| Field | Type | Required | Description |
|---|---|---|---|
x | number | yes | |
y | number | yes |
WasmPortalWindInput
Used by as1170_portal_wind.
AS/NZS 1170.2 wind on a portal-framed building, per direction (0, 180, 90, 270): q at h, wall Cpe, side-wall and roof zones from the windward edge, Ka for one frame, and the internal pressure with a dominant opening placed in a named wall (Table 5.1(B)). The same site/building fields as as1170_wind_design, plus opening: { ratio, wall: "none"\|"x0"\|"xb"\|"y0"\|"yl", at_m } and trib (one frame's tributary width, m). Returns { directions: [...] } or { error }.
| Field | Type | Required | Description |
|---|---|---|---|
alpha_deg | number | Default: 0. | |
b | number | yes | |
d | number | yes | |
h_e | number | yes | |
m_d | number | Default: 1. | |
m_s | number | Default: 1. | |
m_t | number | Default: 1. | |
open_ratio | number | Default: 0. | |
opening | DominantOpening | null | Default: null. | |
region | string | yes | |
return_period_years | number | Default: 500. | |
roof | string | Default: "". | |
terrain | string | yes | |
trib | number | Default: 0. |
WasmPressureFieldInput
Used by footing_pressure_field.
| Field | Type | Required | Description |
|---|---|---|---|
bx | number | yes | |
by | number | yes | |
mx | number | yes | |
my | number | yes | |
n | number | yes | |
nx | integer | Default: 25. | |
ny | integer | Default: 25. |
WasmPurlinCleatInput
Used by purlin_cleat_check.
Purlin cleat (conn_purlin.rs). SI in (m, Pa, N); the core works in mm and MPa.
| Field | Type | Required | Description |
|---|---|---|---|
bolt_count | integer | yes | |
bolt_dia | number | yes | |
bolt_grade | string | yes | |
bolt_height | number | yes | |
cleat_b | number | yes | |
cleat_edge | number | yes | |
cleat_fu | number | yes | |
cleat_fy | number | yes | |
cleat_t | number | yes | |
purlin_fu | number | yes | |
purlin_t | number | yes | |
v_lat | number | Default: 0. | |
v_star | number | yes | |
weld_leg | number | yes |
WasmPurlinCleatResult
Used by purlin_cleat_check.
| Field | Type | Required | Description |
|---|---|---|---|
bearingC | number | yes | |
phiBoltShear | number | yes | |
phiCleatBearing | number | yes | |
phiCleatBending | number | yes | |
phiCleatTearout | number | yes | |
phiPurlinBearing | number | yes | |
phiWeldShear | number | yes | |
util_bolt_shear | number | yes | |
util_cleat_bearing | number | yes | |
util_cleat_bending | number | yes | |
util_max | number | yes | |
util_purlin_bearing | number | yes | |
util_weld | number | yes | |
v_lat | number | yes | |
v_star | number | yes |
WasmRaftFeInput
Used by raft_fe_design.
Task 9 wasm-boundary input: a polygon raft footprint + column loads + the reinforcement design parameters, camelCase JSON. No sizing field is exposed here - raft_fe_design below derives one automatically (see derive_raft_sizing) so a UI caller only ever supplies plan geometry and loads, never mesher internals.
| Field | Type | Required | Description |
|---|---|---|---|
columns | ColumnLoad[] | yes | |
dEff | number | yes | |
eConcrete | number | Default: 30000000000. | |
fPrimeC | number | yes | |
fSy | number | yes | |
fidelity | MeshFidelity | Default: "light". | |
holes | number[][][] | Default: []. | |
ks | number | yes | |
ksHi | number | yes | |
ksLo | number | yes | |
nu | number | Default: 0.2. | |
outer | number[][] | yes | |
selfWeight | number | Default: 0. | |
thickness | number | yes |
WasmRcBarRow
| Field | Type | Required | Description |
|---|---|---|---|
count | integer | yes | |
diameter | number | yes |
WasmRcBeamCapacityInput
Used by rc_beam_section_capacity.
| Field | Type | Required | Description |
|---|---|---|---|
b | number | yes | Section width (m). |
bottom_bars | WasmRcBarRow | yes | Bottom reinforcement row. |
cover | number | yes | Concrete cover to bar centroid (m). |
e_c | number | Concrete elastic modulus (Pa). Defaults to 30 GPa. Default: 30000000000. | |
e_s | number | Steel elastic modulus (Pa). Defaults to 200 GPa. Default: 200000000000. | |
f_prime_c | number | yes | Concrete compressive strength f'c (Pa). |
f_sy | number | yes | Steel yield stress fsy (Pa). |
h | number | yes | Section height (m). |
kappa_max | number | Maximum curvature for the M-κ curve (1/m). Default: 0.005. | |
mesh_size | number | Fiber mesh size (m). Smaller = more accurate but slower. Default: 0.002. | |
n_kappa_points | integer | Number of points on the M-κ curve. Default: 20. | |
top_bars | WasmRcBarRow | null | Top reinforcement row (optional). Default: null. |
WasmRcBeamCapacityOutput
Used by rc_beam_section_capacity.
| Field | Type | Required | Description |
|---|---|---|---|
area_concrete | number | yes | Plain concrete area, b × h (m²). |
area_transformed | number | yes | Transformed gross area, concrete + n·A_s (m²). |
d_na_cracked | number | yes | Cracked neutral-axis depth from extreme compression fibre (m). |
i_cracked | number | yes | Cracked second moment of area about cracked neutral axis (m⁴). |
i_gross | number | yes | Gross second moment of area about centroidal x-axis (m⁴). |
k_uo | number | yes | Neutral-axis parameter k_uo = c / d_o at ultimate. |
m_cr | number | yes | Cracking moment (N·m). |
m_u | number | yes | Nominal ultimate moment capacity from AS 3600 stress block (N·m). |
moment_curvature | WasmRcMomentCurvaturePoint[] | yes | Moment-curvature curve. |
phi | number | yes | Capacity reduction factor, AS 3600 Table 2.2.2 (ductility-dependent, 0.65 to 0.85). |
phi_m_u | number | yes | Capacity-reduced ultimate moment phi * M_u (N·m). |
y_centroid | number | yes | Gross section centroid height from bottom (m). |
WasmRcBeamInput
Used by as3600_rc_beam_moment.
| Field | Type | Required | Description |
|---|---|---|---|
a_sc | number | Default: 0. | |
a_st | number | yes | |
b | number | yes | |
d | number | yes | |
d_sc | number | Default: 0. | |
f_prime_c | number | yes | |
f_sy | number | yes |
WasmRcBeamResult
Used by as3600_rc_beam_moment.
| Field | Type | Required | Description |
|---|---|---|---|
a | number | yes | |
kU | number | yes | |
overReinforced | boolean | yes | |
phi | number | yes | |
phiMu | number | yes |
WasmRcBeamServiceInput
Used by as3600_rc_beam_serviceability.
| Field | Type | Required | Description |
|---|---|---|---|
a_sc | number | Default: 0. | |
a_st | number | yes | |
b | number | yes | SI in: m, m^2, Pa, N/m, N.m. b, D (d_section), d, d_sc; A_st, A_sc; f'c, E_s (default 200 GPa) |
d | number | yes | |
d_sc | number | Default: 0. | |
d_section | number | yes | |
defl_limit | number | null | Default: null. | |
e_s | number | null | Default: null. | |
eps_cs | number | null | Default: null. | |
f_prime_c | number | yes | |
g | number | yes | |
m_s | number | null | M_s* in N.m, required for continuous spans Default: null. | |
psi_l | number | yes | |
psi_s | number | yes | |
q | number | yes | |
span | number | yes | |
support | BeamSupport | yes | "simply_supported" | "cantilever" | "continuous_end" | "continuous_interior" |
WasmRcBiaxialInput
Used by rc_column_interaction_surface_3d.
| Field | Type | Required | Description |
|---|---|---|---|
b | number | yes | |
f_prime_c | number | yes | Concrete compressive strength f'c (Pa). |
f_sy | number | yes | Steel yield stress fsy (Pa). |
h | number | yes | |
mesh_size | number | Fiber mesh size (m). Defaults to 0.005. Default: 0.002. | |
n_c | integer | Number of neutral-axis depths per angle (>= 3). Default: 21. | |
n_theta | integer | Number of neutral-axis angles to sweep (>= 2). Default: 8. | |
rebars | WasmRcRebar[] | Reinforcing bars as a list of {x, y, area} (SI units). Default: []. |
WasmRcBiaxialOutput
Used by rc_column_interaction_surface_3d.
| Field | Type | Required | Description |
|---|---|---|---|
n_c | integer | yes | |
n_theta | integer | yes | |
points | WasmRcBiaxialPoint[] | yes |
WasmRcBiaxialPoint
| Field | Type | Required | Description |
|---|---|---|---|
m_x | number | yes | |
m_y | number | yes | |
p | number | yes |
WasmRcColumnCurvePoint
| Field | Type | Required | Description |
|---|---|---|---|
c | number | yes | |
label | string | yes | |
m | number | yes | |
n | number | yes | |
phi | number | yes | |
phiM | number | yes | |
phiN | number | yes |
WasmRcColumnCurveResult
Used by as3600_rc_column_interaction_curve.
| Field | Type | Required | Description |
|---|---|---|---|
mBalanced | number | yes | |
nBalanced | number | yes | |
phiMu | number | yes | |
phiNuo | number | yes | |
points | WasmRcColumnCurvePoint[] | yes |
WasmRcColumnInput
Used by as3600_rc_column_capacity, as3600_rc_column_interaction_curve.
| Field | Type | Required | Description |
|---|---|---|---|
a_sc | number | yes | |
a_st | number | yes | |
b | number | yes | |
d | number | yes | |
d_sc | number | Default: 0. | |
d_section | number | yes | |
f_prime_c | number | yes | |
f_sy | number | yes | |
m_star | number | yes | |
n_star | number | yes |
WasmRcColumnResult
Used by as3600_rc_column_capacity.
Moments are N·m, matching the input contract and as3600_rc_column_interaction_curve. The conversions below were /1e6 (which yields kN·m) until 2026-09-21. This export has no JS consumer, so unlike as3600_rc_beam_moment it was never wrong on screen - it was waiting to be.
| Field | Type | Required | Description |
|---|---|---|---|
curve | WasmRcColumnCurveResult | yes | |
phiMN | number | yes | |
phiMu | number | yes | |
phiNuo | number | yes | |
util_interaction | number | yes | |
util_m | number | yes | |
util_max | number | yes | |
util_n | number | yes |
WasmRcDesignItem
Used by as3600_rc_design_batch.
One member for as3600_rc_design_batch. SI throughout: m, Pa, N, N·m. Moments and shears are magnitudes; n_max / n_min are the envelope's axial loads, compression positive.
| Field | Type | Required | Description |
|---|---|---|---|
cover | number | null | Default: null. | |
f_prime_c | number | yes | |
f_sy | number | null | Default: null. | |
h_y | number | yes | |
h_z | number | yes | |
length | number | Default: 0. | |
member_id | integer | yes | |
my_neg_z | number | Default: 0. | |
my_pos_z | number | Default: 0. | |
mz_neg_y | number | Default: 0. | |
mz_pos_y | number | Default: 0. | |
n_max | number | Default: 0. | |
n_min | number | Default: 0. | |
v_y | number | Default: 0. | |
v_z | number | Default: 0. | |
vertical | boolean | Default: false. |
WasmRcDesignOut
Used by as3600_rc_design_batch.
The steel one member needs, SI: areas in m², shears in N.
| Field | Type | Required | Description |
|---|---|---|---|
asTotal | number | yes | |
astNegY | number | yes | |
astNegZ | number | yes | |
astPosY | number | yes | |
astPosZ | number | yes | |
fitmentsNeeded | boolean | yes | |
kU | number | yes | |
kind | string | yes | |
leR | number | yes | |
memberId | integer | yes | |
notes | string[] | yes | |
pReq | number | yes | |
phiVucY | number | yes | |
phiVucZ | number | yes | |
ratio | number | null | k_u / 0.36 (beam) or p / 4 % (column); null when the section is too small. | |
status | RcDesignStatus | yes |
WasmRcMemberInput
Used by as3600_rc_member_check.
| Field | Type | Required | Description |
|---|---|---|---|
a_sc | number | Default: 0. | |
a_st | number | yes | |
b | number | yes | |
d | number | yes | |
d_sc | number | Default: 0. | |
d_section | number | yes | |
f_prime_c | number | yes | |
f_sy | number | yes | |
m_star | number | yes | |
n_star | number | yes | |
v_star | number | yes |
WasmRcMemberResult
Used by as3600_rc_member_check.
| Field | Type | Required | Description |
|---|---|---|---|
governing | string | yes | |
phiMN | number | yes | |
phiMu | number | yes | |
phiNuo | number | yes | |
phiVuc | number | yes | |
util_axial | number | yes | |
util_bending | number | yes | |
util_interaction | number | yes | |
util_max | number | yes | |
util_shear | number | yes |
WasmRcMomentCurvaturePoint
| Field | Type | Required | Description |
|---|---|---|---|
kappa | number | yes | |
m | number | yes |
WasmRcRebar
| Field | Type | Required | Description |
|---|---|---|---|
area | number | yes | |
x | number | yes | |
y | number | yes |
WasmRcShearInput
Used by as3600_rc_beam_shear.
| Field | Type | Required | Description |
|---|---|---|---|
a_st | number | yes | |
b | number | yes | |
d | number | yes | |
d_overall | number | Overall depth D (m), optional: d_v = max(0.72 D, 0.9 d) (AS 3600 Cl 8.2.1.9). 0 -> 0.9 d. Default: 0. | |
f_prime_c | number | yes |
WasmRcShearResult
Used by as3600_rc_beam_shear.
| Field | Type | Required | Description |
|---|---|---|---|
phi | number | yes | |
phiVuc | number | yes | |
rhoW | number | yes | |
vUc | number | yes |
WasmReaction
| Field | Type | Required | Description |
|---|---|---|---|
mx | number | yes | |
my | number | yes | |
mz | number | yes | |
node_id | integer | yes | |
rx | number | yes | |
ry | number | yes | |
rz | number | yes |
WasmResponseSpectrumInput
Used by response_spectrum_analysis.
| Field | Type | Required | Description |
|---|---|---|---|
combination_method | string | Default: "SRSS". | |
damping_ratio | number | Default: 0.05. | |
direction | string | yes | |
model | WasmModel | yes | |
n_modes | integer | Default: 10. | |
spectrum_points | number[][] | yes | Spectrum points as [[period_s, accel_m_s2], ...] |
WasmResponseSpectrumResult
Used by response_spectrum_analysis.
| Field | Type | Required | Description |
|---|---|---|---|
combination_method | string | yes | |
combined_base_shear | number | yes | |
combined_displacements | WasmNodeDisplacement[] | yes | |
damping_ratio | number | yes | |
direction | string | yes | |
mode_responses | WasmModeResponse[] | yes | |
total_effective_mass | number | yes | |
total_mass | number | yes |
WasmResults
Used by analysis_report, session_resolve_loads, session_resolve_member, solve_model, solve_model_pdelta, solve_model_pdelta_with_options, solve_model_tc, solve_model_tc_with_options, solve_model_with_options.
| Field | Type | Required | Description |
|---|---|---|---|
auto_restrained | WasmSingularDof[] | Zero-stiffness DOFs auto-restrained so the model could solve (aggregated across load cases, de-duplicated). Empty/omitted for a clean model. | |
combinations | WasmCombinationResults[] | ||
combo_stations_omitted | boolean | The combinations carry no station forces (a large job; see COMBO_STATION_LIMIT). Their stations are the factored sum of their load cases' - the studio rebuilds them on demand. | |
conditioning | WasmSoftDof[] | Free DOFs left "soft" (tiny but non-zero diagonal stiffness) after auto-restrain - the model solved but is near-singular here, so results may be unreliable (aggregated across load cases, keeping the worst stiffness ratio per node/dof). Empty/omitted for a well-conditioned model. | |
envelope | WasmEnvelopeResults | null | ||
load_cases | WasmLoadCaseResults[] | yes |
WasmRetainingWallInput
Used by retaining_wall_design.
| Field | Type | Required | Description |
|---|---|---|---|
baseThickness | number | yes | |
baseWidth | number | yes | |
cover | number | yes | |
fPrimeC | number | yes | |
fSy | number | yes | |
gammaSoil | number | yes | |
gamma_conc | number | Default: 24. | |
ka | number | yes | |
phi_base_deg | number | Default: 30. | |
qAllowable | number | yes | |
stemThicknessBase | number | yes | |
stemThicknessTop | number | yes | |
toeLength | number | yes | |
wallHeight | number | yes |
WasmRetainingWallResult
Used by retaining_wall_design.
| Field | Type | Required | Description |
|---|---|---|---|
eccentricity | number | yes | |
governing | string | yes | |
heelAst | number | yes | |
heelMoment | number | yes | |
overturningMoment | number | yes | |
pa | number | yes | |
paHeight | number | yes | |
qMax | number | yes | |
qMin | number | yes | |
restoringMoment | number | yes | |
resultantX | number | yes | |
slidingResistance | number | yes | |
stemAst | number | yes | |
stemMoment | number | yes | |
utilBearing | number | yes | |
utilHeel | number | yes | |
utilMax | number | yes | |
utilOverturning | number | yes | |
utilSliding | number | yes | |
utilStem | number | yes |
WasmRidgeTieInput
Used by ridge_tie_cleat_check.
| Field | Type | Required | Description |
|---|---|---|---|
bolt_diameter | number | yes | |
bolt_grade | string | Default: "8.8". | |
e | number | yes | Weld line to the bolt group's centroid (m). |
n_bolts | integer | yes | |
n_star | number | Default: 0. | |
plate_b | number | yes | |
plate_fu | number | yes | |
plate_fy | number | yes | |
plate_t | number | yes | |
tie_end | number | Default: 0. | |
tie_fu | number | Default: 440000000. | |
tie_tw | number | yes | |
v_star | number | Default: 0. | |
weld_fuw | number | Default: 480000000. | |
weld_leg | number | yes |
WasmRobustnessInput
Used by en1991_1_7_robustness.
{ class: "1"|"2a"|"2b"|"3", construction: "framed"|"wall", gk_kpa, qk_kpa, psi, tie_spacing_m, tie_span_m, storeys, z_m, column_storey_reaction_kn, wall_clear_height_m, wall_thickness_m, wall_plan_area_mm2 }
| Field | Type | Required | Description |
|---|---|---|---|
class | string | yes | |
column_storey_reaction_kn | number | Default: 0. | |
construction | string | Default: "". | |
gk_kpa | number | Default: 0. | |
psi | number | Default: 1. | |
qk_kpa | number | Default: 0. | |
storeys | integer | Default: 1. | |
tie_spacing_m | number | Default: 0. | |
tie_span_m | number | Default: 0. | |
wall_clear_height_m | number | Default: 0. | |
wall_plan_area_mm2 | number | Default: 0. | |
wall_thickness_m | number | Default: 0. | |
z_m | number | Default: 0. |
WasmRodBraceInput
Used by rod_brace_check.
Rod bracing cleat (conn_rod_brace.rs). SI in (m, Pa, N); the core works in mm and MPa.
| Field | Type | Required | Description |
|---|---|---|---|
bolt_count | integer | yes | |
bolt_dia | number | yes | |
bolt_grade | string | yes | |
lug_edge | number | yes | |
lug_fu | number | yes | |
lug_t | number | yes | |
n_star | number | yes | |
n_star_bolts | number | Default: 0. | |
pin_dia | number | yes | |
pin_fy | number | yes | |
pin_shear_planes | integer | Default: 2. | |
rod_dia | number | yes | |
rod_fu | number | yes | |
rod_fy | number | yes | |
threaded | boolean | Default: true. | |
v_star_bolts | number | Default: 0. |
WasmRodBraceResult
Used by rod_brace_check.
| Field | Type | Required | Description |
|---|---|---|---|
n_star | number | yes | |
phiBoltShear | number | yes | |
phiBoltTension | number | yes | |
phiLugBearing | number | yes | |
phiLugTearout | number | yes | |
phiPinBearing | number | yes | |
phiPinShear | number | yes | |
phiRod | number | yes | |
rodAn_mm2 | number | yes | |
util_bolts | number | yes | |
util_lug | number | yes | |
util_max | number | yes | |
util_pin_bearing | number | yes | |
util_pin_shear | number | yes | |
util_rod | number | yes |
WasmSeatInput
Used by seat_check.
Seated beam connection (conn_seat.rs). SI in (m, Pa, N); the core works in mm and MPa. The detail the ASI's Design Guide 6 specifies: a seat welded to the column's face, the beam's bottom flange bearing on it, a stiffener under the seat. seat_len is both the bearing length and the cantilever the seat's own bending is taken over.
| Field | Type | Required | Description |
|---|---|---|---|
beam_d | number | yes | |
beam_fy | number | yes | |
beam_tf | number | yes | |
beam_tw | number | yes | |
seat_fy | number | yes | |
seat_len | number | yes | |
seat_t | number | yes | |
seat_w | number | yes | |
stiff_fy | number | yes | |
stiff_h | number | yes | |
stiff_t | number | yes | |
v_star | number | yes | |
weld_fuw | number | Default: 480000000. | |
weld_leg | number | yes | |
weld_len | number | yes |
WasmSeatResult
Used by seat_check.
| Field | Type | Required | Description |
|---|---|---|---|
bearingWidth | number | yes | |
components | WasmConnComponent[] | yes | |
govComponent | string | yes | |
govUtil | number | yes | |
notes | string[] | yes | |
phiBearingBuckling | number | yes | |
phiBearingYield | number | yes | |
status | string | yes |
WasmSection
| Field | Type | Required | Description |
|---|---|---|---|
a | number | yes | |
bf | number | Default: 0. | |
cold_formed | boolean | Default: false. | |
d | number | Default: 0. | |
fy | number | Default: 0. | |
id | integer | yes | |
iw | number | Default: 0. | |
iyy | number | yes | |
izz | number | yes | |
j | number | yes | |
lip | number | Default: 0. | |
name | string | Default: "". | |
syy | number | Default: 0. | |
szz | number | Default: 0. | |
tf | number | Default: 0. | |
tw | number | Default: 0. | |
x0 | number | Default: 0. | |
zyy | number | Default: 0. | |
zzz | number | Default: 0. |
WasmSectionBuilderInput
Used by section_properties.
| Field | Type | Required | Description |
|---|---|---|---|
loops | WasmPoint2[][] | yes |
WasmSectionBuilderResult
Used by section_properties.
| Field | Type | Required | Description |
|---|---|---|---|
Asx | number | yes | |
Asy | number | yes | |
I1 | number | yes | |
I2 | number | yes | |
Ip | number | yes | |
Iw | number | yes | |
Ixx | number | yes | |
Ixy | number | yes | |
Iyy | number | yes | |
Japprox | number | yes | |
Jopen | number | yes | |
Sx | number | yes | |
Sy | number | yes | |
Zxapprox | number | yes | |
Zyapprox | number | yes | |
area | number | yes | |
cx | number | yes | |
cy | number | yes | |
rx | number | yes | |
ry | number | yes | |
thetaP | number | yes |
WasmSectionDimsInput
Used by section_props_from_dims.
| Field | Type | Required | Description |
|---|---|---|---|
Iw_mm6 | number | Default: 0. | |
Ix_mm4 | number | Default: 0. | |
Iy_mm4 | number | Default: 0. | |
J_mm4 | number | Default: 0. | |
Zx_mm3 | number | Default: 0. | |
area_mm2 | number | Default: 0. | |
category | string | yes | |
depth_mm | number | yes | |
flangeThickness_mm | number | Default: 0. | |
flangeWidth_mm | number | yes | |
lipLength_mm | number | Default: 0. | |
name | string | Default: "". | |
webThickness_mm | number | yes |
WasmSeismicDistributionInput
Used by distribute_seismic_forces.
| Field | Type | Required | Description |
|---|---|---|---|
baseShear | number | yes | |
direction | number[] | yes | |
distribution | DistributionRule | Which standard's vertical distribution rule: "as1170_4" (the default, and what every caller that predates this field gets) or "nzs1170_5". See DistributionRule in fem-core. Default: "as1170_4". | |
eccentricityFraction | number | AS 1170.4:2024 Cl 6.6: the accidental eccentricity as a fraction of the storey's plan dimension across the action. The clause says +/- 0.1b; 0.0 (the default) keeps the force at the nominal centre of mass. Both signs have to be run to find the adverse one. Default: 0. | |
loadCaseId | integer | yes | |
model | WasmModel | yes | |
period | number | yes | |
storeys | WasmStoreyDefinition[] | Default: []. | |
vertical_axis | string | null | Default: null. |
WasmSeismicDistributionResult
Used by distribute_seismic_forces.
| Field | Type | Required | Description |
|---|---|---|---|
k | number | yes | |
nodalLoads | WasmNodalLoad[] | yes | |
storeyForces | WasmStoreyForce[] | yes | |
sumForces | number | yes | |
totalBaseShear | number | yes |
WasmSeismicInput
Used by as1170_seismic_base_shear.
| Field | Type | Required | Description |
|---|---|---|---|
annual_probability | number | null | ||
height_m | number | null | Default: null. | |
kt | number | null | Default: null. | |
location | string | null | Default: null. | |
mu | number | null | Default: null. | |
period | number | null | Default: null. | |
r_u | number | null | Default: null. | |
s_p | number | null | Default: null. | |
soil | string | yes | |
sp | number | null | Default: null. | |
system | string | null | Default: null. | |
weight | number | yes | |
z | number | null | Default: null. | |
zone | string | null | Default: null. |
WasmSeismicResult
Used by as1170_seismic_base_shear.
| Field | Type | Required | Description |
|---|---|---|---|
c_h | number | yes | |
cd | number | yes | |
citation | string | yes | |
floored | boolean | yes | |
kp | number | yes | |
kp_z_used | number | yes | |
mu | number | yes | |
sp | number | yes | |
t1 | number | yes | |
v | number | yes | |
z | number | yes |
WasmShearBeam
The supported beam, SI (m, Pa). cope: "none" | "top" | "double".
| Field | Type | Required | Description |
|---|---|---|---|
bf | number | Default: 0. | |
cope | string | Default: "". | |
d | number | yes | |
d_cb | number | Default: 0. | |
d_ct | number | Default: 0. | |
fu | number | Default: 440000000. | |
fy | number | Default: 300000000. | |
fyw | number | Default: 0. | |
l_c | number | Default: 0. | |
tf | number | yes | |
tw | number | yes | |
welded | boolean | Default: false. |
WasmShearKeyInput
Used by shear_key_check.
| Field | Type | Required | Description |
|---|---|---|---|
boltDiameter | number | Default: 0. | |
concreteFc | number | yes | |
fuw | number | Default: 480000000. | |
grade | string | Default: "8.8". | |
keyB | number | yes | |
keyFy | number | yes | |
keyH | number | yes | |
keyT | number | yes | |
nAnchor | integer | Default: 0. | |
nStar | number | Default: 0. | |
plateB | number | yes | |
plateD | number | yes | |
plateFy | number | Default: 0. | |
plateT | number | Default: 0. | |
vStar | number | Default: 0. | |
weldLeg | number | Default: 0. |
WasmShearKeyResult
Used by shear_key_check.
| Field | Type | Required | Description |
|---|---|---|---|
components | WasmConnComponent[] | yes | |
govComponent | string | yes | |
govUtil | number | yes | |
notes | string[] | yes | |
status | string | yes |
WasmShearPlateInput
Used by shear_plate_check.
| Field | Type | Required | Description |
|---|---|---|---|
a | number | Default: 0. | |
a_eh_beam | number | Default: 0. | |
a_ev | number | yes | Plate edge distance to the end bolts (vertical). |
beam | WasmShearBeam | null | The beam as an object, or flat as beam_d / beam_bf / beam_tf / beam_tw / beam_fy / beam_fu - the flat form is what a family package's input map can name. | |
beam_bf | number | Default: 0. | |
beam_cope | string | The flat form's cope (SA-113): "none" (default), "swc" / "top", "dwc" / "double", with its top depth, bottom depth and length (m). The nested beam object carries the same fields. Default: "". | |
beam_d | number | Default: 0. | |
beam_d_cb | number | Default: 0. | |
beam_d_ct | number | Default: 0. | |
beam_fu | number | Default: 440000000. | |
beam_fy | number | Default: 300000000. | |
beam_l_c | number | Default: 0. | |
beam_tf | number | Default: 0. | |
beam_tw | number | Default: 0. | |
bolt_count | integer | Default: 0. | |
bolt_diameter | number | yes | |
bolt_grade | string | Default: "8.8". | |
cols | integer | Default: 1. | |
gauge | number | Default: 0. | |
kind | string | "fep" (flexible end plate) or "wsp" (web side plate / fin plate, the default). Default: "wsp". | |
pitch | number | yes | |
plate_b | number | yes | |
plate_fu | number | yes | |
plate_fy | number | yes | |
plate_t | number | yes | |
rows | integer | Rows, or leave 0 and give the total bolt_count: rows = ceil(count / cols). Default: 0. | |
s_g1 | number | WSP: weld line to the first bolt column, the beam's end distance, beam top to the top bolt. Default: 0. | |
threads_included | boolean | Default: true. | |
v_star | number | Default: 0. | |
weld_fuw | number | Default: 480000000. | |
weld_leg | number | yes |
WasmShearPlateResult
Used by shear_plate_check.
| Field | Type | Required | Description |
|---|---|---|---|
components | WasmConnComponent[] | yes | |
dI | number | yes | |
e | number | yes | |
govComponent | string | yes | |
govUtil | number | yes | |
governing | string | yes | |
kind | string | yes | |
notes | string[] | yes | |
phiVDes | number | yes | Least component capacity (N) and its key (Va..Vh), whatever the demand. |
status | string | yes |
WasmShearTorsionInput
Used by rc_shear_torsion_combined.
| Field | Type | Required | Description |
|---|---|---|---|
aSt | number | yes | |
b | number | yes | |
d | number | yes | |
fPrimeC | number | yes | |
h | number | yes | |
tStar | number | yes | |
vStar | number | yes |
WasmShearTorsionResult
Used by rc_shear_torsion_combined.
| Field | Type | Required | Description |
|---|---|---|---|
governing | string | yes | |
phiTUc | number | yes | |
phiVUc | number | yes | |
utilCombined | number | yes | |
utilMax | number | yes | |
utilT | number | yes | |
utilV | number | yes |
WasmSingularDof
A node/direction flagged by the singularity analysis. dof is 0..5 = {Tx,Ty,Tz,Rx,Ry,Rz}; label is the human-readable form.
| Field | Type | Required | Description |
|---|---|---|---|
dof | integer | yes | |
label | string | yes | |
node | integer | yes |
WasmSizableSpec
One member the optimiser may resize.
| Field | Type | Required | Description |
|---|---|---|---|
category | string | yes | |
current_kg | number | yes | |
member_id | integer | yes |
WasmSlabDeflectionInput
Used by as3600_slab_deflection.
| Field | Type | Required | Description |
|---|---|---|---|
d | number | yes | |
f_sy | number | yes | |
span | number | yes | |
support_type | integer | Default: 0. | |
thickness | number | Default: 0. |
WasmSlabDeflectionResult
Used by as3600_slab_deflection.
| Field | Type | Required | Description |
|---|---|---|---|
lOverDActual | number | yes | |
lOverDLimit | number | yes | |
util_deflection | number | yes |
WasmSlabInput
Used by as3600_slab_check.
| Field | Type | Required | Description |
|---|---|---|---|
a_st_per_m | number | yes | |
col_a | number | yes | |
col_b | number | yes | |
cover | number | yes | |
d | number | yes | |
f_prime_c | number | yes | |
f_sy | number | yes | |
m_star | number | yes | |
mv_star | number | Moment transferred to the support, M*v (N·m); see WasmSlabPunchingInput::mv_star. Default: 0. | |
n_star | number | yes | |
span | number | yes | |
support_type | integer | Default: 0. | |
thickness | number | Default: 0. |
WasmSlabPunchingInput
Used by as3600_slab_punching_shear.
| Field | Type | Required | Description |
|---|---|---|---|
col_a | number | yes | |
col_b | number | yes | |
cover | number | yes | |
d | number | yes | |
f_prime_c | number | yes | |
mv_star | number | Moment transferred to the support, M*v (N·m). Defaults to 0 so an existing payload keeps its old meaning, but Cl 9.3.2(b)(ii) requires it whenever moment IS transferred. Default: 0. | |
n_star | number | yes |
WasmSlabPunchingResult
Used by as3600_slab_punching_shear.
| Field | Type | Required | Description |
|---|---|---|---|
betaH | number | yes | Cl 9.3.1.4 shape factor, and the Cl 9.3.4 moment-transfer outputs. Reported so the result can be hand-checked against the clause instead of taken on trust. |
d | number | yes | |
f_cv | number | yes | |
phiVUo | number | yes | |
u | number | yes | |
util_punching | number | yes | |
vStarEquivalent | number | yes | |
vU | number | yes | |
vUo | number | yes |
WasmSlabResult
Used by as3600_slab_check.
| Field | Type | Required | Description |
|---|---|---|---|
a_st_min | number | yes | |
a_st_provided | number | yes | |
betaH | number | yes | |
fCv | number | yes | |
governing | string | yes | |
lOverDActual | number | yes | |
lOverDLimit | number | yes | |
phiMu | number | yes | |
phiVUo | number | yes | |
util_deflection | number | yes | |
util_max | number | yes | |
util_min_steel | number | yes | |
util_moment | number | yes | |
util_punching | number | yes | |
vStarEquivalent | number | yes |
WasmSlabStripInput
Used by as3600_slab_strip_moment.
| Field | Type | Required | Description |
|---|---|---|---|
a_st_per_m | number | yes | |
cover | number | yes | |
d | number | yes | |
f_prime_c | number | yes | |
f_sy | number | yes | |
m_star | number | yes | |
thickness | number | Default: 0. |
WasmSlabStripResult
Used by as3600_slab_strip_moment.
| Field | Type | Required | Description |
|---|---|---|---|
a_st_min | number | yes | |
a_st_provided | number | yes | |
phiMu | number | yes | |
util_min_steel | number | yes | |
util_moment | number | yes |
WasmSnowInput
Used by as1170_snow_load.
| Field | Type | Required | Description |
|---|---|---|---|
altitude_m | number | Height above the Australian Height Datum or New Zealand mean sea level, metres. Default: 0. | |
annual_probability | number | null | Annual probability of exceedance, as a fraction: 1/500 is 0.002 (Table 5.1). Default: null. | |
exposure | string | sheltered, semi-sheltered or windswept (Cl 4.2.2). Default: "". | |
location | string | null | A named Table 5.2 site, which this build does not carry: refused by name if given. Default: null. | |
region | string | AS/NZS 1170.3:2003 snow region: AS, AT, NzNorth, NzSouth (alpine); AN, AC, AsSub, AtSub (sub-alpine Australia); N1 to N5 (sub-alpine New Zealand). Default: "". | |
roof_pitch2_deg | number | null | The second slope of a duo-pitched roof; absent for a mono-pitched one. Default: null. | |
roof_pitch_deg | number | Roof slope, degrees. Default: 0. | |
terrain_factor | number | null | Terrain classification factor kt, Australian ALPINE regions only: 0.7, 1.0 or 1.3 (Cl 5.3). Default: null. |
WasmSoftDof
A "soft" DOF: solved, but its diagonal stiffness is alarmingly small relative to the model maximum (near-mechanism / ill-conditioned). stiffnessRatio is |diag| / max_diag - tiny means results at this DOF may be unreliable.
| Field | Type | Required | Description |
|---|---|---|---|
dof | integer | yes | |
label | string | yes | |
node | integer | yes | |
stiffnessRatio | number | yes |
WasmSolveInput
Used by building_slenderness_check, session_create, session_resolve_loads, session_resolve_member, solve_model_pdelta_with_options, solve_model_tc_with_options, solve_model_with_options.
Model + options wrapper for solve requests that need non-default settings.
| Field | Type | Required | Description |
|---|---|---|---|
model | WasmModel | yes | |
options | WasmSolveOptions | Default: {"extrapolate_plate_results":false,"n_stations":11,"smooth_plate_nodal_results":false,"station_output":"objects"}. |
WasmSolveOptions
Solver options exposed to the frontend (mirrors SkyCIV "General Solver" settings).
| Field | Type | Required | Description |
|---|---|---|---|
extrapolate_plate_results | boolean | Default: false. | |
n_stations | integer | Default: 11. | |
smooth_plate_nodal_results | boolean | Default: false. | |
station_output | StationOutput | How the member station forces come back: objects (the default, as always), pack (flat typed arrays per load case - solve_model_typed only; the string export writes objects), or none (not at all: a caller that reads capacities and end forces, like auto-size, skips the bulk of the result). Default: "objects". |
WasmSpectrumInput
Used by as1170_design_spectrum.
Input for as1170_design_spectrum: the seismic input MINUS the period and the seismic weight, which a spectrum does not need. The analysis supplies the periods and the model supplies the mass, so requiring either here would make a caller invent a number to get a spectrum.
| Field | Type | Required | Description |
|---|---|---|---|
annual_probability | number | null | Default: null. | |
location | string | null | Default: null. | |
mu | number | null | Default: null. | |
soil | string | Default: "". | |
sp | number | null | Default: null. | |
system | string | null | Default: null. | |
z | number | null | Default: null. |
WasmSpliceInput
Used by splice_check.
| Field | Type | Required | Description |
|---|---|---|---|
boltDiameter | number | yes | |
endDist | number | Default: 0. | |
flangeT | number | yes | |
fpB | number | yes | |
fpFu | number | yes | |
fpFy | number | yes | |
fpT | number | yes | |
grade | string | Default: "8.8". | |
mStar | number | yes | |
nFlange | integer | yes | |
nStar | number | Default: 0. | |
nWeb | integer | Default: 0. | |
pitch | number | yes | |
sectionD | number | yes | |
vStar | number | Default: 0. | |
wpT | number | Default: 0. |
WasmSpliceResult
Used by splice_check.
| Field | Type | Required | Description |
|---|---|---|---|
components | WasmConnComponent[] | yes | |
govComponent | string | yes | |
govUtil | number | yes | |
notes | string[] | yes | |
status | string | yes |
WasmStationForce
| Field | Type | Required | Description |
|---|---|---|---|
dy | number | yes | |
dz | number | yes | |
mx | number | yes | |
my | number | yes | |
mz | number | yes | |
n | number | yes | |
s | number | yes | |
s_norm | number | yes | |
vy | number | yes | |
vz | number | yes |
WasmStoreyDefinition
| Field | Type | Required | Description |
|---|---|---|---|
elevation | number | yes | |
nodeIds | integer[] | yes |
WasmStoreyForce
| Field | Type | Required | Description |
|---|---|---|---|
cv | number | yes | |
elevation | number | yes | |
force | number | yes | |
weight | number | yes |
WasmStripFootingInput
Used by strip_footing_design.
| Field | Type | Required | Description |
|---|---|---|---|
asLongProvided | number | Longitudinal steel provided EACH face, mm^2 (0 = check against max(required, minimum)). Default: 0. | |
asProvided | number | Default: 0. | |
barDiameter | number | Default: 0. | |
bearingBasis | string | Default: "allowable". | |
cover | number | yes | |
fPrimeC | number | yes | |
fSy | number | yes | |
longitudinalBarDiameter | number | Default: 0. | |
longitudinalSpan | number | Length of lost support the strip spans along the wall, m (0 = not designed). Default: 0. | |
mService | number | Default: 0. | |
mStar | number | Default: 0. | |
nService | number | Default: 0. | |
nStar | number | yes | |
qBearing | number | yes | |
reinforced | boolean | false = an unreinforced strip, checked to AS 3600 Section 20 across its width. Default: true. | |
selfWeight | number | Default: 0. | |
standard | FootingCode | Default: "as3600". | |
stripThickness | number | yes | |
stripWidth | number | yes | |
wallThickness | number | yes |
WasmStripFootingResult
Used by strip_footing_design.
| Field | Type | Required | Description |
|---|---|---|---|
aStMin | number | yes | |
aStReq | number | yes | |
checksRefused | string[] | yes | |
contactState | string | yes | |
dEff | number | yes | |
developmentDetail | string | yes | |
developmentLst | number | yes | |
governing | string | yes | |
kUo | number | yes | |
longitudinal | WasmStripLongitudinal | null | The design along the wall, present only when a span of lost support was given. | |
mDesign | number | yes | |
note | string | null | ||
phiBending | number | yes | |
phiVUc | number | yes | |
plain | WasmPlainConcreteCheck | null | The Section 20 checks, present only for an unreinforced strip. | |
qAllowable | number | yes | |
qMax | number | yes | |
qMin | number | yes | |
utilBearing | number | yes | |
utilDevelopment | number | yes | |
utilMax | number | yes | |
utilMoment | number | yes | |
utilShear | number | yes | |
vDesign | number | yes |
WasmStripLongitudinal
The strip designed along the wall over a span of lost support, in the camelCase the browser reads.
| Field | Type | Required | Description |
|---|---|---|---|
aStMin | number | yes | |
aStReq | number | yes | |
d | number | yes | |
mDesign | number | yes | |
phiVUc | number | yes | |
span | number | yes | |
utilMoment | number | yes | |
utilShear | number | yes | |
vDesign | number | yes | |
w | number | yes |
WasmThroughPlateInput
Used by through_plate_check.
A hollow member through a gusset (conn_hollow_brace::through_plate_capacity). SI in; mm/MPa inside.
| Field | Type | Required | Description |
|---|---|---|---|
f_star | number | yes | |
n_slots | integer | yes | |
n_star | number | yes | |
plate_t | number | yes | |
tube_d | number | yes | |
tube_fu | number | yes | |
tube_fy | number | yes | |
tube_t | number | yes | |
weld_leg | number | yes | |
weld_len | number | yes |
WasmThroughPlateResult
Used by through_plate_check.
| Field | Type | Required | Description |
|---|---|---|---|
f_star | number | yes | |
n_star | number | yes | |
phiTubeNet | number | yes | |
phiWeld | number | yes | |
util_max | number | yes | |
util_through_weld | number | yes | |
util_tube_through | number | yes |
WasmTimeHistoryInput
Used by modal_time_history_analysis.
| Field | Type | Required | Description |
|---|---|---|---|
damping_ratio | number | Default: 0.05. | |
direction | number[] | Direction vector [dx, dy, dz] Default: [1,0,0]. | |
model | WasmModel | yes | |
n_modes | integer | Default: 10. | |
record | number[][] | yes | Ground motion record: [[time_s, accel_m_s2], ...] |
WasmTimeHistoryResult
Used by modal_time_history_analysis.
| Field | Type | Required | Description |
|---|---|---|---|
dt | number | yes | |
n_modes | integer | yes | |
n_steps | integer | yes | |
peakBaseShearX | number | yes | |
peakBaseShearY | number | yes | |
peakBaseShearZ | number | yes | |
peak_displacements | WasmNodeDisplacement[] | yes |
WasmVehicle
| Field | Type | Required | Description |
|---|---|---|---|
axle_spacings | number[] | yes | |
axle_weights | number[] | yes |
WasmWebBearingInput
Used by as4100_web_bearing.
AS 4100 Cl 5.13 web bearing (I/C-section webs). SI in (m, Pa), SI out (N). end_dist omitted or negative means an interior load.
| Field | Type | Required | Description |
|---|---|---|---|
b_s | number | yes | Stiff bearing length (m). |
both_flanges_restrained | boolean | Both flanges restrained against lateral movement (default true). Default: true. | |
d1 | number | yes | Clear web depth between flanges (m). |
end_dist | number | Distance from member end to the nearer edge of the bearing (m). Negative or missing = interior load. Default: -1. | |
fy | number | yes | Web yield stress (Pa). |
tf | number | yes | |
tw | number | yes |
WasmWebCleatInput
Used by web_cleat_check.
| Field | Type | Required | Description |
|---|---|---|---|
boltDiameter | number | yes | |
dCleat | number | yes | |
eSup | number | Default: 0. | |
eWeb | number | yes | |
edgeDist | number | Default: 0. | |
endDist | number | Default: 0. | |
fuCleat | number | yes | |
fuWeb | number | yes | |
fyCleat | number | yes | |
grade | string | Default: "8.8". | |
nSup | integer | yes | |
nWeb | integer | yes | |
pitch | number | yes | |
tCleat | number | yes | |
tWeb | number | yes | |
vStar | number | yes |
WasmWebCleatResult
Used by web_cleat_check.
| Field | Type | Required | Description |
|---|---|---|---|
components | WasmConnComponent[] | yes | |
govComponent | string | yes | |
govUtil | number | yes | |
notes | string[] | yes | |
status | string | yes |
WasmWeldedMomentInput
Used by welded_moment_check.
| Field | Type | Required | Description |
|---|---|---|---|
flangeB | number | yes | |
flangeCpbw | boolean | Default: true. | |
flangeLeg | number | Default: 0. | |
flangeT | number | yes | |
fuw | number | Default: 480000000. | |
fy | number | yes | |
mStar | number | yes | |
nStar | number | Default: 0. | |
sectionD | number | yes | |
vStar | number | Default: 0. | |
webLeg | number | Default: 0. | |
webT | number | Default: 0. |
WasmWeldedMomentResult
Used by welded_moment_check.
| Field | Type | Required | Description |
|---|---|---|---|
components | WasmConnComponent[] | yes | |
govComponent | string | yes | |
govUtil | number | yes | |
notes | string[] | yes | |
status | string | yes |
WasmWeldGroupInput
Used by weld_group_check.
| Field | Type | Required | Description |
|---|---|---|---|
fuw | number | yes | |
kr | number | yes | |
mz | number | yes | |
segments | WasmWeldSegmentInput[] | yes | |
vx | number | yes | |
vy | number | yes |
WasmWeldGroupResult
Used by weld_group_check.
| Field | Type | Required | Description |
|---|---|---|---|
governingSegment | integer | yes | |
phiVperMmGov | number | yes | |
phiVtotal | number | yes | |
util_max | number | yes | |
vPerMmGov | number | yes |
WasmWeldInput
Used by weld_capacity.
| Field | Type | Required | Description |
|---|---|---|---|
fuw | number | Default: 480000000. | |
kr | number | Default: 1. | |
leg_size | number | yes | |
length | number | yes |
WasmWeldResult
Used by weld_capacity.
| Field | Type | Required | Description |
|---|---|---|---|
phiVw | number | yes |
WasmWeldSegmentInput
| Field | Type | Required | Description |
|---|---|---|---|
legSize | number | yes | |
x1 | number | yes | |
x2 | number | yes | |
y1 | number | yes | |
y2 | number | yes |
WasmWindDesignInput
Used by as1170_wind_design.
| Field | Type | Required | Description |
|---|---|---|---|
alpha_deg | number | Default: 0. | |
b | number | yes | |
d | number | yes | |
h_e | number | yes | |
m_d | number | Default: 1. | |
m_s | number | Default: 1. | |
m_t | number | Default: 1. | |
open_ratio | number | Default: 0. | |
region | string | yes | |
return_period_years | number | Default: 500. | |
roof | string | Default: "". | |
terrain | string | yes |
WasmWindInput
Used by as1170_wind_pressure.
| Field | Type | Required | Description |
|---|---|---|---|
height | number | yes | |
region | string | yes | |
return_period_factor | number | Default: 1. | |
terrain | string | yes |
WasmWindResult
Used by as1170_wind_pressure.
| Field | Type | Required | Description |
|---|---|---|---|
mC | number | yes | |
mZcat | number | yes | |
p | number | yes | |
q | number | yes | |
vDes | number | yes | |
vR | number | yes |
Weighting
The BS 6841 frequency weighting curves of Section 5.2.2, as Table 5.1 assigns them: W_g for vision and hand control (critical working areas, z), W_b for discomfort (z), W_d for the x and y axes.
One of: "Wg", "Wb", "Wd"
WindDesign
Used by as1170_wind_design.
The full design result the UI consumes.
| Field | Type | Required | Description |
|---|---|---|---|
standard | string | yes | |
surfaces | SurfacePressure[] | yes | |
tables | TableStatus[] | yes | Per-table verification, the adapter's own statement (WindStandard::table_status). |
trace | Step[] | yes | |
verified | boolean | yes | ALWAYS false until an engineer cross-checks the coefficient tables against the standard. |
warnings | string[] | yes |
WindDirection
Wind direction relative to the building. Theta0 = wind normal to the ridge (across the span - the case that governs a portal frame); Theta90 = wind parallel to the ridge (along the building).
One of: "theta0", "theta90"
WoodArmer
Wood-Armer design moments at a point (per unit width). Each is the magnitude of the design moment for that face and direction; 0 means no steel is required there. *_bottom resist sagging (bottom face), *_top resist hogging (top face).
| Field | Type | Required | Description |
|---|---|---|---|
mxBottom | number | yes | |
mxTop | number | yes | |
myBottom | number | yes | |
myTop | number | yes |