Skip to content

WASM types ​

Generated by scripts/gen_wasm_manifest.mjs from the Rust types (via schemars) - do not edit. Run npm run docs:wasm to 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.

FieldTypeRequiredDescription
maxDisplacementsDisplacementExtreme[]yes
maxReactionsReactionExtreme[]yes
memberUtilisationMemberUtilSummary[]yes
passFailRollupPassFailRollupyes
statsModelStatsyes

Anchor ​

FieldTypeRequiredDescription
dia_mmnumberyes
head_dia_mmnumber | nullHead (or nut/washer) diameter for the pull-out check; None = pull-out NotDetermined. Default: null.
hef_mmnumber | nullEffective embedment. None = not stated = every concrete check NotDetermined. Default: null.
x_mmnumberyes
y_mmnumberyes

AnchorCheckResult ​

Used by conn_anchor_check.

FieldTypeRequiredDescription
adequateboolean | null
bar_dev_length_mmnumber | nullAS 3600 development length the claimed bars need, mm (reported; certification is the gate).
bars_acceptedinteger[]yesBars the reinforcement gate accepted / rejected, by index into reinforcement.bars.
bars_rejected[integer, string][]yes
combinationsCombResult[]yes
cone_geometryConeGeometry | null
factorsPartialFactorsyes
governingGoverning | nullThe 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).
notesstring[]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.

FieldTypeRequiredDescription
shear_nnumberyes
tension_nnumberyes

AnchorForce2 ​

Force per holding-down anchor, recovered from the grounded spring.

FieldTypeRequiredDescription
anchorintegeryesIndex into ConnFeaInput::anchors.
boltintegeryesIndex into ConnFeaInput::bolts of the shank, so a caller can name it the way the drawing does without holding both lists.
engagedbooleanyesDid the final active set have this anchor in tension?
shearnumberyesTransverse force on the anchor, N. Always present: an anchor in a hole bears on that hole whichever way the plate is going.
tensionnumberyesAxial 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.
upliftnumberyesUplift 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.

FieldTypeRequiredDescription
anchorsAnchor[]yes
concreteConcreteyes
edgesEdgesDefault: {"far_from_all":false,"x_neg":null,"x_pos":null,"y_neg":null,"y_pos":null}.
factorsPartialFactors | nullDefault: null.
justification_notesstring[]Default: [].
loadsCombination[]yes
per_anchor_forcesAnchorForce[][] | nullPer combination, per anchor, when the joint FEA solved them. Same order as loads. Default: null.
phi_nt_nnumber | nullSteel design capacities per anchor, N (AS 4100, phi included). None = steel NotDetermined. Default: null.
phi_vs_nnumber | nullDefault: null.
post_installedbooleanPost-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.
reinforcementAnchorReinforcement | nullDefault: 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.

FieldTypeRequiredDescription
barsBar[]yes
cover_mmnumber | nullConfining cover to the bar (mm) for the AS 3600 Cl 13.1.2.2 development length report. Default: null.
developed_abovebooleanDefault: false.
developed_belowbooleanDefault: false.
symmetricbooleanDefault: false.

AngleWorking ​

The parts of the AS 4100 Cl 8.4.6 single-angle check (SI: N, N.m, m).

FieldTypeRequiredDescription
cos_alphanumberyes
enumberyesEccentricity e = ch - t/2 (m) and cos(alpha), alpha between the x and h axes.
equal_legsbooleanyes
ktnumberyesTable 7.3.2 kt for the net-section tension check the engineer makes with the real holes.
phi_mbxnumberyesphi Mbx about the major principal axis (N.m).
phi_nchnumberyesphi 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.

FieldTypeRequiredDescription
idintegeryes
numintegeryes
tostringyes
toKgnumberyes
utilnumber | null

AutoSizeReport ​

Used by auto_size.

Auto-size outcome. Mirrors the JS autoSizeModel return shape (camelCase fields).

FieldTypeRequiredDescription
changesAutoSizeChange[]yes
convergedbooleanyes
iterationsintegeryes
massAfternumberyes
massBeforenumberyes
nonebooleanyes
solveErrorstring | nullWhy 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).
targetnumberyes

Bar ​

FieldTypeRequiredDescription
dia_mmnumberyes
fy_mpanumberyes
x_mmnumberyes
y_mmnumberyes

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.

FieldTypeRequiredDescription
bedintegeryesIndex into ConnFeaInput::beds.
contact_fractionnumberyesFraction 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.
forcenumberyesTotal 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_nodesintegeryesNodes that lifted off, of the plate's total.
plateintegeryesIndex into ConnFeaInput::plates of the plate that bears.
pressure_maxnumberyesPeak 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_nodesintegeryes

BoltForce ​

Force per bolt, recovered from the connector. Elastic, and with no strength behind it.

FieldTypeRequiredDescription
boltintegeryesIndex into ConnFeaInput::bolts.
pliesintegeryesHow many plies the bolt connects. 2 = single shear, 3 = double shear.
shearnumberyesThe 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.
tensionnumberyesAxial 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.

FieldTypeRequiredDescription
boltintegeryesIndex into ConnFeaInput::bolts.
edge_distnumberyesDistance from the hole centre to the nearest plate boundary, m - EN 1993-1-8's e_b.
offsetnumberyesSigned 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.
pitchnumber | nullCentre-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.
plateintegeryesIndex into ConnFeaMesh::plates.
radiusnumberyesHole radius, m.
rim_nodesinteger[]yesMesh node indices on the hole rim, global numbering.
rim_weightsnumber[]yesTributary 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.

FieldTypeRequiredDescription
building_height_mnumberyes
directionstringyesDirection that was checked: "x", "y", or "xy" (resultant).
governing_load_case_idintegeryes
governing_node_idintegeryes
limit_rationumberyes
max_displacement_mnumberyes
passbooleanyes
slenderness_rationumber | nullThe 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 ​

FieldTypeRequiredDescription
action_nnumber | null
clausestringyes
notestring | null
resistance_nnumber | nullDesign resistance (N) and design action (N) behind the utilisation, when determined.
stateCheckStateyes
utilnumber | 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.

FieldTypeRequiredDescription
fromnumber[][]yes
h_farnumberyes
ratenumberyes

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).

FieldTypeRequiredDescription
clausestringyesClause / section / table, e.g. "Cl 5.2.1" or "Table 6.3.3(1)".
standardstringyese.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.
yearstringyesEdition/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.

FieldTypeRequiredDescription
axial_utilnumberyesAxial utilisation: |Ncomp| / min(φNcx, φNcy), or |Ntens| / φNt in tension
util_maxnumberyesCl 3.5 linear interaction sum = axial_util + util_mx + util_my
util_mxnumberyesMajor-axis bending utilisation M*x / φMbx
util_mynumberyesMinor-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.

FieldTypeRequiredDescription
bxnumberyes
bynumberyes
cxnumberyes
cynumberyes
mxnumberyes
mynumberyes
nnumberyes
pedestal_bxnumberOptional 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_bynumberDefault: 0.

Combination ​

One FACTORED (ULS) combination at the plate. Sign: n_n positive = tension on the group.

FieldTypeRequiredDescription
mx_nmmnumberMoments about the plate's x and y axes, N.mm. Distributed to anchors elastically. Default: 0.
my_nmmnumberDefault: 0.
n_nnumberDefault: 0.
namestringyes
seismicbooleanDefault: false.
vx_nnumberDefault: 0.
vy_nnumberDefault: 0.

CombResult ​

FieldTypeRequiredDescription
anchor_shear_nnumber[]yes
anchor_tension_nnumber[]yesPer-anchor tension (N, +ve) and shear (N) this combination was checked with.
blowoutCheckyes
combined_concreteCheckyes
combined_steelCheckyes
namestringyes
pryoutCheckyes
rebar_creditedbooleanyesTrue when the tension cone row is the reinforcement tie, not the concrete cone.
seismicbooleanyes
seismic_qualificationCheckyes
shear_edgeCheckyes
shear_steelCheckyes
splittingCheckyes
tension_coneCheckyes
tension_pulloutCheckyes
tension_steelCheckyes

Concrete ​

FieldTypeRequiredDescription
crackedbooleanCracked 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_mpanumberyes
thickness_mmnumberyes

ConeGeometry ​

FieldTypeRequiredDescription
ac_n0_mm2numberyes
ac_n_mm2numberyes
hef_mmnumberyes
k1numberyes
n_rk_c0_nnumberyes
psi_ec_nnumberyes
psi_re_nnumberyes
psi_s_nnumberyes

Connection ​

One derived connection at a shared node.

FieldTypeRequiredDescription
boltCountintegeryesEstimated bolt count.
coatingArea_m2numberyesPaintable / galvanisable surface area contributed by this joint (m²).
connectionTypestringyesInferred connection type.
cutCountintegeryesEstimated cut / prep operations.
holeCountintegeryesEstimated hole count (drilled / punched holes).
membersinteger[]yesMember ids whose ends meet at this node.
node_idintegeryes
weldLength_mnumberyesEstimated 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.

FieldTypeRequiredDescription
batch_check_design_checkbooleanDefault: false.
batch_check_design_connection_stringstring | nullDefault: null.
batch_check_design_designbooleanDefault: false.
batch_check_design_load_case_stringstring | nullDefault: null.
batch_check_design_use_minimum_design_actionsbooleanDefault: false.
beam_end_clearancenumber | nullDefault: null.
bolt_categoryinteger | null0 = commercial, 1 = structural Default: null.
bolt_gaugenumber | nullDefault: null.
bolt_pitchnumber | nullDefault: null.
bolt_strengthinteger | null0 = normal (4.6), 1 = high (8.8) Default: null.
bolt_threadsinteger | null0 = excluded, 1 = intercepted Default: null.
cleat_strengthinteger | nullDefault: null.
connection_dxf_layer_bolts_namestring | nullDefault: null.
connection_dxf_layer_centerlines_namestring | nullDefault: null.
connection_dxf_layer_cut_offs_namestring | nullDefault: null.
connection_dxf_layer_dimensions_namestring | nullDefault: null.
connection_dxf_layer_footings_namestring | nullDefault: null.
connection_dxf_layer_geometry_namestring | nullDefault: null.
connection_dxf_layer_hidden_lines_namestring | nullDefault: null.
connection_dxf_layer_plates_namestring | nullDefault: null.
connection_dxf_layer_text_namestring | nullDefault: null.
coped_flange_clearancenumber | nullDefault: null.
coping_radiinumber | nullDefault: null.
edge_distancenumber | nullEdge distance multiplier x bolt diameter. Default: null.
flange_weld_typeinteger | null0 = fillet, 1 = CJP Default: null.
member_strengthinteger | nullDefault: null.
minimum_cope_distancenumber | nullDefault: null.
moment_bolt_procedureinteger | nullDefault: null.
plate_strengthinteger | null0 = normal, 1 = high Default: null.
plate_thick_maxnumber | nullDefault: null.
plate_thick_minnumber | nullDefault: null.
report_connection_calculationsbooleanDefault: false.
report_connection_detailed_outputbooleanDefault: false.
report_connection_input_databooleanDefault: false.
report_connection_result_summarybooleanDefault: false.
report_connection_specificationsbooleanDefault: false.
report_connection_stringstring | nullDefault: null.
report_connection_warnings_and_notesbooleanDefault: false.
report_pass_fail_criteriastring | nullDefault: null.
simple_bolt_procedureinteger | nullDefault: null.
snug_bolt_maxnumber | nullDefault: null.
snug_bolt_minnumber | nullDefault: null.
stiffener_weld_categoryinteger | nullDefault: null.
tens_bolt_maxnumber | nullDefault: null.
tens_bolt_minnumber | nullDefault: null.
weld_categoryinteger | null0 = GP, 1 = structural purpose Default: null.
weld_maxnumber | nullDefault: null.
weld_minnumber | nullDefault: null.
weld_strengthinteger | null0 = normal, 1 = high Default: null.

ConnectionTakeoff ​

Used by connection_takeoff.

Complete connection take-off report.

FieldTypeRequiredDescription
connectionsConnection[]yes
totalsConnectionTotalsyes

ConnectionTotals ​

Grand totals across all connections.

FieldTypeRequiredDescription
boltCountintegeryes
coatingArea_m2numberyes
cutCountintegeryes
holeCountintegeryes
weldLength_mnumberyes

ConnFeaInput ​

Used by conn_fea_mesh, conn_fea_solve.

One meshing (and, with supports/loads, one solving) run over a whole joint.

FieldTypeRequiredDescription
anchorsFeAnchor[]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: [].
bedsFeBed[]Elastic beds under bearing plates. Ignored by conn_fea_mesh. Default: [].
boltsFeBolt[]Default: [].
loadsFeLoad[]What is applied. Ignored by conn_fea_mesh. Default: [].
platesFePlate[]yes
rotation_probesFeRotationProbe[]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: [].
sizingSizingFieldyesThe 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).
supportsFeSupport[]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: [].
weldsFeWeld[]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.

FieldTypeRequiredDescription
bolt_holesBoltHole[]One entry per (bolt, plate) pair where a hole was actually CUT. A bolt with fewer than two of these connects nothing. Default: [].
boundary_nodesinteger[]yesNode 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.
nodesnumber[][]yes
plate_of_triinteger[]yesFor each triangle, the index into ConnFeaMesh::plates it belongs to.
platesPlateMeshInfo[]yes
trisinteger[][]yes
warningsstring[]yesEverything 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.

FieldTypeRequiredDescription
anchor_forcesAnchorForce2[]One entry per holding-down anchor. The number a base plate exists to produce. Default: [].
applied_forcenumber[]yesApplied force resultant, N, and the reaction the supports returned - which must equal it.
applied_momentnumber[]yesThe 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.
bedsBedResult[]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_forcesBoltForce[]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_passesinteger | nullHow 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.
convergedbooleanyesTrue only when the solver returned, the solution is finite, and equilibrium closes.
elastic_stress_rationumber | nullsigma_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_errornumberyes|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.
meshConnFeaMeshyes
reaction_forcenumber[]yes
reaction_momentnumber[]yes
rotationsProbeRotation[]One entry per rotation probe, in the order they were given. Default: [].
sigma_vmnumber[]yesElastic 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_maxnumberyes
sigma_vm_max_jointnumberyesThe 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.
unumber[][]yesTranslation at each node, m, global axes.
u_maxnumberyesLargest nodal translation magnitude, m.
warningsstring[]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.

FieldTypeRequiredDescription
axle_spacings_mnumber[]yes
axle_weights_knnumber[]yesThe axle train for the runway beam: the group 1 wheel loads on rail 1 at the wheel spacings.
buffer_h_b1_knnumberyesBuffer forces (kN): H_B,1 from the crane's kinetic energy, H_B,2 from the crab.
buffer_h_b2_knnumberyes
drive_force_knnumberyesDrive force K (kN), the lever l_s (m), the moment M (kNm).
drive_moment_knmnumberyes
fatigue_q_e_normal_knnumber | nullFatigue damage-equivalent wheel loads (kN per wheel), normal and shear, if a class was given.
fatigue_q_e_shear_knnumber | null
groupsLoadGroup[]yes
l_s_mnumberyes
phi_1number[]yes
phi_2numberyes
phi_4numberyes
phi_5numberyes
phi_7numberyes
q_r_max_acc_staticnumberyes
q_r_max_knnumberyesThe characteristic maximum wheel load (group 1, phi_1 = 1.1 and phi_2), kN per wheel.
q_r_max_staticnumberyesStatic 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_staticnumberyes
q_r_min_knnumberyesThe characteristic minimum wheel load (unloaded crane, phi_1 = 0.9), kN per wheel.
q_r_min_staticnumberyes
skew_fnumberyesSkewing: f, S (kN), and the transverse wheel forces per wheel pair on rails 1 and 2 (kN).
skew_h_t_rail1_knnumber[]yes
skew_h_t_rail2_knnumber[]yes
skew_s_knnumberyes
standardstringyes
stepsStep[]yes
verifiedbooleanyes
warningsstring[]yes
xi_1numberyes

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.

FieldTypeRequiredDescription
codestringyesGoverning standard name, e.g. "AS 4100".
editionstringyesEdition/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.
inputsInput[]yes
resultStepyesThe headline line (capacity or utilisation) - carries the pass/fail.
stepsStep[]yes
titlestringyes

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_b is 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.

    FieldTypeRequiredDescription
    kind"steel_base_plate"yes
    plate_bxnumberyes
    plate_bynumberyes

DisplacementExtreme ​

FieldTypeRequiredDescription
componentstringyes
load_case_idintegeryes
node_idintegeryes
valuenumberyes

DistributionRule ​

The vertical distribution rule, by standard.

One of:

  • "as1170_4" - AS 1170.4:2024 Cl 6.3: the whole shear split by w h^k, k interpolating with the period.
  • "nzs1170_5" - NZS 1170.5:2004 Cl 6.2.1.3: a flat Ft = 0.08 V lumped at the TOP level, and the remaining 0.92 V split by w 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 whatever w h^k gives 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.

FieldTypeRequiredDescription
at_mnumberDefault: -1.
rationumberDefault: 0.
wallstringDefault: "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.

FieldTypeRequiredDescription
gap_mmnumberDefault: 0.
member_idintegeryes
spacing_mmnumberyes

DsmCapacity ​

DSM member capacity result. Loads in N, moments in N*mm.

FieldTypeRequiredDescription
dist_bDsmModeyes
dist_cDsmModeyes
elastic_sourcestringWhere 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_bDsmModeyes
global_cDsmModeyes
gov_bstringyes
gov_bystringDefault: "".
gov_cstringyes
local_bDsmModeyes
local_byDsmModeDefault: {"cap":0,"ncr":0}.
local_cDsmModeyes
mynumberyes
my_ynumberMinor-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.
nynumberyes
phi_mbnumberyes
phi_mbynumberDefault: 0.
phi_ncnumberyes
phi_rbnumberWeb-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).

FieldTypeRequiredDescription
capnumberyesNominal capacity from the DSM strength curve (N or N*mm).
ncrnumberyesElastic 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.

FieldTypeRequiredDescription
far_from_allbooleanAn 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_negnumber | nullDefault: null.
x_posnumber | nullDefault: null.
y_negnumber | nullDefault: null.
y_posnumber | nullDefault: 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.

FieldTypeRequiredDescription
a11numberyes
a12numberyes
a22numberyes
a66numberyes
d11numberyes
d12numberyes
d22numberyes
d66numberyes
s13numberyes
s23numberyes

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.

FieldTypeRequiredDescription
areanumberyesTensile stress area, m^2.
boltintegeryesIndex 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.
enumberyesYoung's modulus of the anchor, Pa.
free_lennumberyesStretching 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.
intonumber[]yesDirection 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_shearnumber | nullShear stiffness of one anchor, N/m. None derives it from the shank in double curvature over the standoff - see anchor_shear_stiffness. Default: null.
standoffnumber | nullStandoff, 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.

FieldTypeRequiredDescription
intonumber[]yesDirection from the plate INTO the concrete, global. Need not be unit.
knumberyesSubgrade modulus, Pa/m (N/m per m^2 of plate).
plateintegeryesIndex 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.

FieldTypeRequiredDescription
areanumber | nullEffective 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.
axisnumber[]yesShank direction, global. Need not be unit.
dianumberyesShank (bolt) diameter, m.
enumber | nullYoung'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.
holenumber | nullHole diameter override, m. None uses the AS 4100 Cl 14.3.2 standard clearance hole via crate::fasteners::hole_diameter. Default: null.
k_shearnumber | nullShear 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_tensionnumber | nullTension stiffness override for the connector, N/m, stated the same way. Default: null.
lennumberyesGripped 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.
posnumber[]yesCentre 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.)

FieldTypeRequiredDescription
atnumber[] | nullThe 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.
axisnumber[] | nullThe 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.
forcenumber[]Force resultant, N, global axes. Default: [0,0,0].
maxnumber[]yes
minnumber[]yes
momentnumber[]Moment resultant, N.m, global axes, about at when given and about the region's own weighted centroid otherwise. Default: [0,0,0].
slabnumber | nullDefault: 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.

FieldTypeRequiredDescription
coarsenCoarsen | nullGRADED 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.
enumber | nullYoung'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.
exnumber[]yesLocal +x direction in global coordinates.
eynumber[]yesLocal +y direction in global coordinates.
funumber | nullTensile 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.
fynumber | nullYield stress, Pa. None is carried through untouched - see the module note on why this is not defaulted. Default: null.
idstringyesLabel carried through to the mesh so the viewer can name a part. Not interpreted.
nunumber | nullPoisson'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.
originnumber[]yesGlobal position of the plate's local origin, on the MID-SURFACE.
outlinenumber[][]yesOutline 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.
tnumberyesPlate 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.

FieldTypeRequiredDescription
aboutnumber[] | nullThe 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.
atnumber[] | nullDefault: null.
axisnumber[] | nullDefault: null.
maxnumber[]yes
minnumber[]yes
namestringyesThe 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.
slabnumber | nullDefault: 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.

FieldTypeRequiredDescription
atnumber[] | nullDefault: null.
axisnumber[] | nullOptional 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.
fixedboolean[]yes
maxnumber[]yes
minnumber[]yes
slabnumber | nullDefault: 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.

FieldTypeRequiredDescription
endnumber[]yes
penaltynumber | nullPenalty 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.
plateintegeryesIndex into ConnFeaInput::plates of the plate whose EDGE is welded.
startnumber[]yesThe weld line in global coordinates. Boundary nodes of plate within tol of this segment are the ones tied.
tointegeryesIndex into ConnFeaInput::plates of the plate it is welded TO.
tolnumberyesHow 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.

FieldTypeRequiredDescription
frequency_hznumberyes
modal_mass_kgnumberyes
mu_enumberyes
mu_rnumberyes

FloorVibrationResult ​

Used by p354_floor_vibration.

FieldTypeRequiredDescription
base_valuenumberyes
cutoff_hznumberyes
damping_rationumberyes
floor_classstringyes"low" or "high", by Table 6.1.
fundamental_hznumberyes
governingstringyes
governing_pace_hznumberyes
limitnumberyes
okbooleanyes
response_factornumberyesThe governing response factor (the larger of steady-state and transient) and where it came from.
standardstringyes
steady_stateSteadyStateResult | null
stepsStep[]yes
transientTransientResultyes
verifiedbooleanyes
warningsstring[]yes
weightingWeightingyes

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).

FieldTypeRequiredDescription
classstring | nullOptional attribute carried from the source feature (e.g. "C", "M", "SITE_CLASS" value). Default: null.
namestringDefault: "".
ringsnumber[][][]yesRings in GeoJSON order: rings[0] is the outer ring, rings[1..] are holes. Each vertex [lon, lat].

Governing ​

FieldTypeRequiredDescription
combinationstringyes
modestringyes
utilnumberyes

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.

FieldTypeRequiredDescription
categorystringyes
notestringyes
point_knnumber | null
udl_kpanumber | null
use_stringyes

Input ​

A "given" shown at the top of a derivation (the inputs the working starts from).

FieldTypeRequiredDescription
sourcestringyesWhere the value came from (catalogue, member force, assumption) - for traceability.
symbolstringyes
unitstringyes
valuenumberyes

LoadGroup ​

One group of Table 2.2, as characteristic wheel loads on the runway beam.

FieldTypeRequiredDescription
buffer_knnumberyes
groupintegeryes
h_l_per_rail_knnumberyesHorizontal 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_knnumberyes
h_t_rail2_knnumberyes
namestringyes
notestringyes
phi_cranenumberyesThe factors the group applies to the crane self-weight and the hoist load.
phi_hoistnumberyes
q_rail1_per_wheel_knnumberyesVertical wheel loads on rail 1 (the near rail, crab at its minimum approach) and rail 2 (kN per wheel).
q_rail2_per_wheel_knnumberyes
skew_s_knnumberyes

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).

FieldTypeRequiredDescription
anglenumberyesAngle (rad) from the element's local x to material axis 1; element-specific, for tracing.
m1numberyesBending moment along the grain: the one that bends fibres running along axis 1 (N m/m).
m12numberyesTwisting moment in the material axes (N m/m).
m2numberyesBending moment for fibres running along axis 2, across the grain (N m/m).
n1numberyesMembrane force along axis 1 (N/m, tension positive).
n12numberyesIn-plane shear force in the material axes (N/m).
n2numberyesMembrane force along axis 2 (N/m).

MemberUtilSummary ​

FieldTypeRequiredDescription
governingstringyes
member_idintegeryes
passbooleanyes
utilMaxnumberyes

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).

FieldTypeRequiredDescription
boundary_nodesinteger[]yes
nodesnumber[][]yes
trisinteger[][]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 ​

FieldTypeRequiredDescription
combinationCountintegeryes
hasEnvelopebooleanyes
loadCaseCountintegeryes
memberCountintegeryes
nodeCountintegeryes
plateCountintegeryes

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's thickness applies. Pa.

    FieldTypeRequiredDescription
    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's thickness is 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).

FieldTypeRequiredDescription
gamma_mcnumberyes
gamma_mpnumberyes
verifiedbooleanSteel tension/shear are the caller's AS 4100 design capacities (phi already applied). Default: false.

PassFailRollup ​

FieldTypeRequiredDescription
failingMembersintegeryes
maxUtilOverallnumberyes
passbooleanyes
passingMembersintegeryes
totalMembersCheckedintegeryes

PedestalInput ​

Used by pedestal_design.

FieldTypeRequiredDescription
aScTotalnumberyesTOTAL longitudinal steel area Asc (mm^2), summed over all bars.
barDianumberyesLongitudinal bar diameter (mm) - to place the bar centroid off the cover.
bracedbooleanyesWhether 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.
covernumberyesClear cover to the longitudinal bars (mm).
dcXnumberyesPedestal plan dimension along global X (mm).
dcYnumberyesPedestal plan dimension along global Y (mm).
fPrimeCnumberyesConcrete characteristic strength f'c (MPa).
fPrimeCBearingnumberyesConcrete 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).
fSynumberyesReinforcement yield strength fsy (MPa).
heightnumberyesPedestal height (mm) - used by the (deferred) slenderness classification.
kEffnumberyesEffective 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).
loadBxnumberyesLoaded 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.
loadBynumberyesLoaded bearing footprint on the pedestal top along Y (mm).
mxStarnumberyesDesign moment about the global X axis (N·mm).
myStarnumberyesDesign moment about the global Y axis (N·mm).
nStarnumberyesDesign axial load N* (N), compression positive.

PedestalResult ​

Used by pedestal_design.

FieldTypeRequiredDescription
adequateboolean | nullSome(true/false) once every check is determined; None while any check is NotDetermined, because an undetermined check cannot be certified adequate.
bearingCheckStateyesCl 12.6 bearing at the loaded interface. Ok when util <= 1; NotDetermined when no loaded area was supplied (bearing cannot be checked without it).
bearingUtilnumberyesCl 12.6 bearing utilisation at the loaded interface (NaN when not determined).
fitmentMaxSpacingnumberyesCl 10.7.4.3(b)(i): maximum fitment spacing = min(Dc, 15.db) for single bars (mm).
fitmentMinDianumberyesCl 10.7.4.3(a) Table: minimum fitment/tie bar diameter for the longitudinal bar size (mm).
fitmentsCheckStateyesCl 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.
phiMNnumberyesBending capacity at the applied axial load phi.Mn (N·mm) for the governing axis.
phiNuonumberyesSquash-load capacity phi.Nuo (N) for the governing axis.
reducedMinPermittedbooleanyesCl 10.7.1(a) proviso: a reduced minimum is permitted when Ag.fsy > 0.15 N*.
slendernessCheckStateyesCl 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).
slendernessLimitnumberyesThe short-column limit applied (25 braced / 22 unbraced), Cl 10.3.1.
slendernessRationumberyesSlenderness ratio Le/r (Cl 10.3.1, r per Cl 10.5.2) on the most slender axis.
steelMaxCheckStateyesCl 10.7.1(b): Asc <= 0.04 Ag.
steelMinCheckStateyesCl 10.7.1(a): Asc >= 0.01 Ag.
steelRationumberyesLongitudinal steel ratio Asc/Ag.
utilInteractionnumberyesGoverning M-N interaction utilisation (Cl 10). <= 1.0 is adequate.

PileCapInput ​

Used by pilecap_design.

FieldTypeRequiredDescription
barDianumberMain bar diameter (mm) - to place the bar centroid and set the effective depth. Default: 0.
capBxnumberCap plan dimensions (mm). Default: 0.
capBynumberDefault: 0.
capThicknessnumberCap overall thickness (mm). Default: 0.
capWeightnumberyesCap self-weight + soil overburden (N), added to the axial as uniform compression. 0 to ignore.
columnBxnumberColumn footprint on the cap (mm) - the flexure/shear critical sections start at the column face. Default: 0.
columnBynumberDefault: 0.
covernumberCover to the main (bottom) bars (mm). Default: 0.
fPrimeCnumberCap concrete strength f'c (MPa). Default: 0.
fSynumberReinforcement yield strength fsy (MPa). Default: 0.
mxStarnumberyesColumn design moment about the global X axis (N.m).
myStarnumberyesColumn design moment about the global Y axis (N.m).
nStarnumberyesColumn design axial N* (N), compression positive.
pileCapCompressionnumberyesSingle-pile capacity in compression (N). <= 0 => the compression check is NotDetermined.
pileCapTensionnumberyesSingle-pile capacity in tension / uplift (N), positive magnitude. 0 means the piles are taken as unable to carry tension, so any uplift fails.
pileDianumberPile 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.
pilesnumber[][]yesPile plan positions (m), measured from the COLUMN / load point (any consistent origin - the centroid is computed from these).
standardFootingCodeThe 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.

FieldTypeRequiredDescription
adequateboolean | nullSome(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.
capAstReqnumberyes
capFlexureCheckStateyesCap 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.
capMStarnumberyesGoverning design moment at the column face (N.mm) and the required bottom steel (mm^2, total across the cap width) in that direction.
capPunchingCheckStateyesCap 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.
capPunchingUtilnumberyes
capShearCheckStateyesCap one-way (beam) SHEAR at d from the column face (Cl 8.2). Ok when V* <= phi.Vuc.
capShearUtilnumberyes
compressionCheckCheckStateyesCl-independent capacity checks.
compressionUtilnumberyesCompression utilisation = max_reaction / pile_cap_compression.
deepCapbooleanyesTrue 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.
maxReactionnumberyesLargest compression reaction (N).
minReactionnumberyesSmallest reaction (N) - negative means uplift.
reactionsnumber[]yesPer-pile axial reaction (N), compression positive, in the input pile order.
strutTieCheckStateyesDeep-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.
strutTieAstReqnumberyesRequired bottom TIE steel Ast (mm^2) in the governing direction = T / (0.85 fsy), Cl 7.3.
strutTieMinAngleDegnumberyesMinimum strut-to-tie angle (deg) - below 30 the STM is not permitted.
strutTieUtilnumberyesWorst strut concrete-stress utilisation (Cl 7.2.3, phi_st 0.65, beta_s Cl 7.2.2) at the pile node.
upliftbooleanyesTrue when any pile is in tension (min_reaction < 0).
upliftCheckCheckStateyes
upliftUtilnumberyesUplift 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.

FieldTypeRequiredDescription
diameternumberyesPile shaft diameter (m). The tip is at the bottom of the last layer (embedded length = sum of the layer thicknesses).
drivenbooleanyesDriven pile mobilises higher lateral stress on the shaft than a bored one (K factor).
gammaConcretenumberConcrete unit weight for the pier's own weight (kN/m^3), 24 by default; buoyant below the WT. Default: 24.
hStarnumberDesign lateral load at the pier head (kN), applied load_height above ground. 0 = no check. Default: 0.
layersPileSoilLayer[]yesSoil profile, top-down; the pile is embedded through all of it.
loadHeightnumberHeight of the lateral load above ground level (m): the base plate height, or 0 at grade. Default: 0.
nStarnumberyesDesign axial compression N* (kN). 0 -> utilisation reported as 0.
nUpliftnumberDesign uplift (tension) load on the pier (kN). 0 = no check. Default: 0.
phiGnumberyesAS 2159 geotechnical strength reduction factor phi_g (from the risk assessment, ~0.40-0.65).
tensionShaftFactornumberFraction of the compression shaft resistance mobilised in tension (0.7 by default). Default: 0.7.
waterTablenumberyesDepth to the water table (m from the surface); large = dry.

PileResult ​

Used by pile_design.

FieldTypeRequiredDescription
baseUltimatenumberyesUltimate base (end bearing) resistance (kN).
designnumberyesDesign geotechnical strength Rd,g = phi_g . Rd,ug (kN).
embeddedLengthnumberyesEmbedded length (m) = sum of layer thicknesses.
lateralDesignnumberyesLateral: design lateral resistance phi_g x H_u (kN).
lateralMethodstringyes"broms-cohesive" or "broms-cohesionless".
lateralMomentAtHStarnumberyesLateral: the moment in the pier under H* (Broms scales with the load), kNm.
lateralMomentDepthnumberyesLateral: depth below ground to the maximum moment (m).
lateralMomentUltimatenumberyesLateral: 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.
lateralSoilstringyesThe idealised soil the lateral check used: c_u (kPa) or phi' (deg) and gamma' (kN/m^3).
lateralUltimatenumberyesLateral: Broms ultimate lateral load at the head (kN).
pierWeightnumberyesUplift: the pier's own weight (kN), buoyant below the water table.
shaftUltimatenumberyesUltimate shaft (skin friction) resistance (kN).
ultimatenumberyesUltimate geotechnical strength Rd,ug = shaft + base (kN).
upliftDesignnumberyesUplift: design resistance = phi_g x tension shaft + pier weight (the weight is not a geotechnical strength and takes no phi_g) (kN).
upliftShaftUltimatenumberyesUplift: shaft resistance in tension (kN) = tension_shaft_factor x compression shaft.
upliftUltimatenumberyesUplift: ultimate resistance = tension shaft + pier weight (kN).
utilnumberyesUtilisation N* / Rd,g (NaN when no capacity).
utilLateralnumberyesLateral utilisation H* / lateral_design (NaN when not asked).
utilUpliftnumberyesUplift utilisation N_uplift / uplift_design (NaN when not asked).
verifiedbooleanyes
warningsstring[]yes

PileSoilLayer ​

FieldTypeRequiredDescription
cohesivebooleanyesCohesive (clay) uses su; else cohesionless (sand) uses phi_deg.
gammanumberyesTotal unit weight (kN/m^3), for the effective overburden.
phiDegnumberyesEffective friction angle phi' (deg) - cohesionless layers.
sunumberyesUndrained shear strength su (kPa) - cohesive layers.
thicknessnumberyesLayer thickness (m), top-down.

PlateMeshInfo ​

Per-plate mesh bookkeeping, so a caller can attribute anything back to the plate it came from.

FieldTypeRequiredDescription
holes_cutintegeryesHoles actually cut into this plate. Fewer than the bolts aimed at it means one was refused - the reason is in ConnFeaMesh::warnings.
idstringyes
node_endintegeryes
node_startintegeryes[start, end) into ConnFeaMesh::nodes.
thicknessnumberyes
tri_endintegeryes
tri_startintegeryes[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.

FieldTypeRequiredDescription
axisnumber[]yes
inputOrthotropyInputyes
plate_idintegeryes

PlateTakeoff ​

Per-plate take-off line.

FieldTypeRequiredDescription
area_m2numberyes
mass_kgnumberyes
numintegeryes
surface_area_m2numberyesOne-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.

FieldTypeRequiredDescription
holesnumber[][][]yes
outernumber[][]yes

ProbeRotation ​

One probe's answer.

FieldTypeRequiredDescription
aboutnumber | nullIts component about about, rad. None when no axis was named or no rotation was fitted.
atnumber[]yesThe centroid of the caught nodes, m - the point the rotation is reported about.
namestringyes
nodesintegeryesHow 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.
rotationnumber[] | nullThe 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.

FieldTypeRequiredDescription
columnsColumnLoad[]yes
e_concretenumberyes
ksnumberyes
nunumberyes
polyPolygonyes
self_weightnumberyes
sizingSizingFieldyes
thicknessnumberyes

RaftFeResult ​

Used by raft_fe_solve.

Result of one unstructured-mesh raft FE run.

FieldTypeRequiredDescription
applied_loadnumberyes
convergedbooleanyes
equilibrium_errornumberyes
meshMesh2dyes
mx_nodesnumber[]yes
mxy_nodesnumber[]yes
my_nodesnumber[]yes
q_maxnumberyes
q_minnumberyes
q_nodesnumber[]yes
sum_reactionnumberyes
uz_nodesnumber[]yes
vx_nodesnumber[]yes
vy_nodesnumber[]yes
warningsstring[]yes

RaftPointInput ​

Used by raft_design.

Input for a raft reinforcement point.

FieldTypeRequiredDescription
dnumberyesEffective depth (mm), concrete strength (MPa), steel yield (MPa).
fPrimeCnumberyes
fSynumberyes
mxnumberyesPlate bending + twisting moments per metre (N.mm/m): Mx, My, Mxy.
mxynumberyes
mynumberyes

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).

FieldTypeRequiredDescription
astXBottomnumber | nullBottom/top steel in the X and Y directions, mm^2/m. None = the section cannot carry that moment.
astXTopnumber | null
astYBottomnumber | null
astYTopnumber | null
designWoodArmeryesThe 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 ​

FieldTypeRequiredDescription
componentstringyes
load_case_idintegeryes
node_idintegeryes
valuenumberyes

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 at la_phi (Eq 3.2(8)).

RidgeTieCapacity ​

Used by ridge_tie_cleat_check.

FieldTypeRequiredDescription
governingstringyes
util_bolt_shearnumberyes
util_maxnumberyes
util_plate_axialnumberyes
util_plate_bearingnumberyes
util_plate_bendingnumberyes
util_plate_shearnumberyes
util_tie_bearingnumberyes
util_weldnumberyes

RobustnessResult ​

Used by en1991_1_7_robustness.

FieldTypeRequiredDescription
classConsequencesClassyes
class_examplesstringyes
class_labelstringyes
constructionConstructionyes
f_tnumber | nullA6.2: F_t (kN/m or kN), None for framed construction.
horizontal_ties_requiredbooleanyesWhether the strategy asks for horizontal ties at all (Class 2 and above).
key_element_ad_kpanumberyesA9: the key-element accidental design action A_d (kN/m2), horizontal and vertical, one at a time.
notional_removal_damage_limitnumberyesA5(c): the admissible local damage on notional removal, 15 percent of the floor in each of two adjacent storeys.
standardstringyes
stepsStep[]yes
strategystringyes
t_internalnumberyesA6.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_perimeternumberyes
t_verticalnumber | nullA7: 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_unitsstringyes
tie_unitsstringyesThe unit the horizontal tie forces are in: "kN" (framed) or "kN/m, kN" (wall internal, peripheral).
verifiedbooleanyes
vertical_ties_requiredbooleanyesWhether the strategy asks for vertical ties or the notional-removal alternative (Class 2b).
warningsstring[]yes

RoofSnow ​

Used by as1170_snow_load.

FieldTypeRequiredDescription
balanced_onlybooleanyes
casesSnowCase[]yes
cenumberyes
citationstringyes
equationstringyes
gamma_kn_m3numberyes
kpnumberyes
overhang_kn_mnumberyesCl 4.2.3: the edge overhang load, kN per metre of eave, from the peak case.
peak_kpanumberyesThe largest load any case puts on any slope, kPa - the number a first pass sizes to.
sg_kpanumberyes

SectionRollup ​

Roll-up by section name (matches the JS bySection shape).

FieldTypeRequiredDescription
countintegeryes
mass_per_metre_kgnumberyes
sectionstringyes
totalLength_mnumberyes
totalMass_kgnumberyes

SettlementInput ​

Used by settlement_design.

FieldTypeRequiredDescription
bnumberyesFooting plan dimensions (m). The least dimension is used as B in the elastic formula.
ccnumberyesCompression index Cc (virgin line slope).
crnumberyesRecompression index Cr (unload-reload slope). 0 falls back to Cc when overconsolidated.
depthFactornumberyesEmbedment (depth) correction factor I_F (<= 1), Fox's correction. 1.0 (default/conservative) ignores the reduction from founding below the surface.
e0numberyesInitial void ratio e0.
eSoilnumberyesSoil drained (long-term) or undrained elastic modulus for the immediate part (kPa).
hLayernumberyesCompressible layer thickness (m). <= 0 means "no consolidation layer" -> ConsolState::NotComputed.
lnumberyes
nuSoilnumberyesSoil Poisson's ratio (-).
qNetnumberyesNet applied bearing pressure at founding level (kPa) - the pressure ABOVE the pre-existing overburden, which is what drives settlement.
sigmaPcnumberyesPreconsolidation pressure sigma'_p (kPa). <= sigma'_0 is treated as normally consolidated.
sigmaV0numberyesInitial vertical effective stress at mid-layer, sigma'_0 (kPa).
zToMidnumberyesDepth from founding level to the MIDDLE of the compressible layer (m), where the representative stress increase is evaluated.

SettlementResult ​

Used by settlement_design.

FieldTypeRequiredDescription
consolStateConsolStateyesWhich e-log(sigma') branch was used (or NotComputed).
consolidationnumberyesPrimary consolidation settlement (mm); 0 with state NotComputed when there is no layer.
deltaSigmaMidnumberyesStress increase at mid-layer from the 2:1 spread, delta-sigma (kPa).
immediatenumberyesImmediate (elastic) settlement (mm).
totalnumberyesTotal settlement (mm) = immediate + consolidation.

SgCombination ​

A factored load combination.

FieldTypeRequiredDescription
idintegeryes
namestringyes
termsSgCombinationTerm[]yes

SgCombinationTerm ​

One term in a load combination: (load_case_id * factor).

FieldTypeRequiredDescription
factornumberyes
load_case_idintegeryes

SgEndRelease ​

End-release flags for a member end (true = released, false = fixed).

FieldTypeRequiredDescription
fxbooleanyes
fybooleanyes
fzbooleanyes
mxbooleanyes
mybooleanyes
mzbooleanyes

SgEntryInfo ​

Used by list_sg_entries.

FieldTypeRequiredDescription
namestringyes
sizeintegeryes

SgImportDiagnostics ​

Diagnostic summary produced during import_sg_model.

FieldTypeRequiredDescription
decoded_tagsstring[]yesTags that were successfully decoded.
missing_tagsstring[]yesTags that were not present at all.
skipped_tagsstring[]yesTags that were present in the archive but are intentionally skipped (e.g. large result blobs or tags not yet decoded).

SgLoadCase ​

FieldTypeRequiredDescription
idintegeryes
namestringDefault: "".

SgMaterial ​

FieldTypeRequiredDescription
alphanumberDefault: 0.
densitynumberyes
enumberyes
funumberDefault: 0.
fynumberDefault: 0.
gnumberyes
idintegeryes
librarystringDefault: "".
namestringyes
nunumberyes

SgMember ​

FieldTypeRequiredDescription
idintegeryes
material_idintegeryes
namestringMember name / description from @SD (empty if not present). Default: "".
node_aintegeryes
node_bintegeryes
release_aSgEndReleaseyes
release_bSgEndReleaseyes
section_idintegeryes

SgMemberLoad ​

FieldTypeRequiredDescription
load_case_idintegeryes
load_typeintegeryesSpaceGass load category code (kept for diagnostics; 1/2/3 = load grouping).
member_idintegeryes
qxnumberyesDistributed load intensity at the START of the loaded length, in SI (N/m), resolved onto global axes. qy is vertical (negative = gravity).
qx2numberyesIntensity at the END of the loaded length (N/m). Equal to the start value for a uniform UDL; differs only for a trapezoidal load.
qynumberyes
qy2numberyes
qznumberyes
qz2numberyes

SgMemberOffset ​

FieldTypeRequiredDescription
axisintegeryes0 = global axes, 1 = local axes (best-effort, observed as 0 in samples).
member_idintegeryes
offset_anumber[]yesOffset at end A [dx, dy, dz] in metres.
offset_bnumber[]yesOffset at end B [dx, dy, dz] in metres.

SgMemberPointLoad ​

FieldTypeRequiredDescription
axisintegeryes0/1 = global/local axes (best-effort).
fxnumberyesForces in Newtons (converted from kN stored in file).
fynumberyes
fznumberyes
load_case_idintegeryes
member_idintegeryes
mxnumberyesMoments in N·m (converted from kN·m stored in file).
mynumberyes
mznumberyes
position_rationumberyesLoad position as a ratio (0.0 to 1.0) along the member.
sub_loadintegeryesSub-load index (SpaceGass internal grouping).

SgModel ​

Used by import_sg_model.

FieldTypeRequiredDescription
combinationsSgCombination[]yes
connection_configConnectionConfig | null
diagnosticsSgImportDiagnosticsyes
entriesSgEntryInfo[]yes
load_casesSgLoadCase[]yes
materialsSgMaterial[]yes
member_loadsSgMemberLoad[]yes
member_offsetsSgMemberOffset[]yes
member_point_loadsSgMemberPointLoad[]yes
membersSgMember[]yes
nodal_loadsSgNodalLoad[]yes
nodesSgNode[]yes
plate_loadsSgPlateLoad[]yes
platesSgPlate[]yes
restraintsSgRestraint[]yes
section_infoSgSectionInfo | null
sectionsSgSection[]yes
self_weightsSgSelfWeight[]yes

SgNodalLoad ​

FieldTypeRequiredDescription
fxnumberyesForces in Newtons (converted from kN stored in file).
fynumberyes
fznumberyes
load_case_idintegeryes
mxnumberyesMoments in N\u00b7m (converted from kN\u00b7m stored in file).
mynumberyes
mznumberyes
node_idintegeryes

SgNode ​

FieldTypeRequiredDescription
idintegeryes
xnumberyes
ynumberyes
znumberyes

SgPlate ​

FieldTypeRequiredDescription
idintegeryes
material_idintegeryes
node_idsinteger[]yes
thicknessnumberyesThickness in metres (0.0 when not decoded).

SgPlateLoad ​

FieldTypeRequiredDescription
load_case_idintegeryes
plate_idintegeryes
pressurenumberyesPressure in Pa (positive = upward in local z).

SgRestraint ​

FieldTypeRequiredDescription
flagsintegeryesDOF bit-mask: bit 0=Tx, 1=Ty, 2=Tz, 3=Rx, 4=Ry, 5=Rz.
node_idintegeryes
raw_codestringyesRaw 4-char ASCII code from the binary record (for diagnostics).

SgSection ​

FieldTypeRequiredDescription
anumberyesCross-sectional area in m² (0.0 when not decoded).
gradestringyesSteel grade label, e.g. "AUST300" (best-effort; may be a section tag).
idintegeryes1-based section id - matches SgMember.section_id (the @MB section index).
iyynumberyesStrong-axis second moment of area Iyy in m⁴ (0.0 when not decoded).
izznumberyesWeak-axis second moment of area Izz in m⁴ (0.0 when not decoded).
jnumberyesSt. Venant torsion constant J in m⁴ (0.0 when not decoded).
namestringyesCatalogue profile name as stored by SpaceGass, e.g. "460 UB 67.1", "100758 UA", "W10x12". Empty when a block carries no catalogue name.
taperedbooleanyesTrue when this section is a tapered/custom profile (no catalogue name).

SgSectionInfo ​

FieldTypeRequiredDescription
field_0_1integeryesHeader field at bytes 0-1 (observed = 0x0200 = 512). Meaning unknown; kept for diagnostics.
field_2_3integeryesHeader field at bytes 2-3 (observed = 0x0578 = 1400). Meaning unknown; kept for diagnostics.
field_4_7integeryesHeader field at bytes 4-7 (observed = 30). Meaning unknown; kept for diagnostics.
has_headerbooleanyesTrue when the blob looks like a recognised header.
raw_sizeintegeryesRaw size of the @SI blob (for diagnostics).
recordsSgSectionInfoRecord[]yesDecoded 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.

FieldTypeRequiredDescription
factorsnumber[]yes
namestringyes
record_typeintegeryes

SgSelfWeight ​

FieldTypeRequiredDescription
factornumberyesMultiplier 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_idintegeryes

SizingField ​

Controls target element size and local refinement for the mesher (Task 3).

FieldTypeRequiredDescription
grade_ratenumberHow 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_maxnumberyesLargest element edge length permitted anywhere in the mesh.
h_minnumberyesSmallest element edge length the refiner is allowed to introduce (prevents non-termination from infinitely shrinking triangles near sharp features).
min_angle_degnumberyesMinimum interior angle (degrees) Ruppert refinement (Task 3) will enforce.
refine_points[number[], number][]yesPoint-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.

FieldTypeRequiredDescription
labelstringyesWhich figure and case this is, e.g. "Figure 6.3 case (iv), windward slope".
leeward_kpanumberyesLoad on the leeward slope, kPa; equal to windward_kpa on a mono-pitched roof.
windward_kpanumberyesLoad on the windward (or the only) slope, kPa.

SoilLayer ​

A soil layer for the Appendix D computation.

FieldTypeRequiredDescription
iptnumberyesInstability index Ipt (%/pF) for the layer (lateral-restraint factor assumed folded in).
thickness_mmnumberyesLayer 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.

FieldTypeRequiredDescription
a_w_rmsnumberyes
alpha_hnumberyes
betanumberyes
force_nnumberyes
harmonicintegeryes
harmonic_hznumberyes
magnificationnumberyes
modeintegeryes
weightingnumberyes

SteadyStateResult ​

FieldTypeRequiredDescription
a_w_rmsnumberyes
build_up_factornumberyes
contributionsSteadyContribution[]yes
pace_hznumberyes
response_factornumberyes
sweepnumber[][]yesResponse factor at every pace frequency swept, as (f_p, R) pairs.

Step ​

One line of working: symbol = formula = subs = value [unit] (clause).

FieldTypeRequiredDescription
clauseCodeRefyesGoverning code reference (standard + year + clause), travelling with the value.
formulastringyesSymbolic LaTeX, no numbers.
notestring | null
statusStepStatusyes
subsstringyesThe same expression with values substituted (LaTeX).
symbolstringyes
unitstringyes
valuenumberyesThe 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).

FieldTypeRequiredDescription
areanumberyes
cfig_extnumberyes
cfig_ext_altnumberyesAlternate design shape factor (roof pressure/less-negative case); equals cfig_ext if only one.
directionWindDirectionyes
kindSurfaceKindyes
namestringyes
p_ext_alt_panumberyesExternal pressure for the ALTERNATE case q * Cfig,e_alt (Pa) - roofs: the pressure/downward case.
p_ext_panumberyesExternal pressure p_e = q * Cfig,e (Pa) for the governing (uplift) case.
p_net_ineg_panumberyesNet pressure with the internal-suction case (q*(Cfig,e - Cfig,i_neg)), Pa.
p_net_ipos_panumberyesNet 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.

FieldTypeRequiredDescription
againststringyes
tablestringyes
verifiedbooleanyes

TakeoffLine ​

Per-member take-off line (matches the JS quantityTakeoff line shape).

FieldTypeRequiredDescription
costedbooleanyes
length_mnumberyes
mass_kgnumberyes
mass_per_metre_kgnumberyes
numintegeryes
sectionstringyes
surface_area_m2numberyesPaintable / galvanisable surface area (m²), zero when section dimensions are unavailable.

TakeoffReport ​

Used by quantity_takeoff.

Complete take-off report (JS-compatible shape).

FieldTypeRequiredDescription
bySectionSectionRollup[]yesPer-section roll-ups, heaviest first.
linesTakeoffLine[]yesPer-member lines, in model order.
platesPlateTakeoff[]yesPlate take-off lines.
totalsTakeoffTotalsyesGrand totals.

TakeoffTotals ​

Grand totals.

FieldTypeRequiredDescription
length_mnumberyes
mass_kgnumberyes
memberCountintegeryes
uncostedintegeryesMembers that could not be costed (missing section, material, or nodes).

TransientContribution ​

One mode's transient (impulse) contribution at the governing pace frequency.

FieldTypeRequiredDescription
a_w_peaknumberyes
frequency_hznumberyes
impulse_nsnumberyes
modeintegeryes
weightingnumberyes

TransientResult ​

FieldTypeRequiredDescription
a_w_peaknumberyes
a_w_rmsnumberyes
contributionsTransientContribution[]yes
pace_hznumberyes
response_factornumberyes
sweepnumber[][]yes

ValidationResult ​

Used by validate_model.

Result of validating a single snapshot.

FieldTypeRequiredDescription
validbooleanyes
violationsViolation[]yes

Violation ​

A single validation violation.

FieldTypeRequiredDescription
detailstringyes
entitystringyes
fieldstringyes
idstringyes
kindstringyes
severitystringyes

WasmAisc360Assumptions ​

FieldTypeRequiredDescription
cbnumberyes
compressionClausestring"E7" when a slender element cut the compression area below gross (Pn = Fcr Ae), else "E3". Default: "".
lbnumberyes
leMajornumberyes
leMinornumberyes

WasmAisc360CompositeInput ​

Used by aisc360_composite_check.

FieldTypeRequiredDescription
a_snumberyes
b_eff_mmnumberyes
d_mmnumberyes
f_prime_c_mpanumberyes
fu_stud_mpanumberyes
fy_mpanumberyes
n_studsintegeryes
phinumberDefault: 0.9.
stud_dia_mmnumberyes
t_c_mmnumberyes

WasmAisc360CompositeResult ​

Used by aisc360_composite_check.

FieldTypeRequiredDescription
degree_of_shear_connectionnumberyes
horizontal_shear_forcenumberyes
phi_mn_fullnumberyes
phi_mn_partialnumberyes
stud_shear_forcenumberyes

WasmAisc360MemberInput ​

Used by aisc360_member_check.

FieldTypeRequiredDescription
anumberyes
bfnumberyes
cbnumberDefault: 0.
dnumberyes
enumberDefault: 0.
funumberDefault: 0.
fynumberyes
hollowbooleanA 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.
iyynumberyes
izznumberyes
jnumberyes
lbnumberyes
leMajornumberyes
leMinornumberyes
mxStarnumberyes
myStarnumberyes
nStarnumberyes
szznumberDefault: 0.
tfnumberyes
twnumberyes
vxStarnumberyes
zzznumberDefault: 0.

WasmAisc360MemberResult ​

Used by aisc360_member_check.

FieldTypeRequiredDescription
assumptionsWasmAisc360Assumptionsyes
governingstringyes
phiMnxnumberyes
phiMnynumberyes
phiPnnumberyes
phiPnCompnumberyes
phiVnnumberyes
section_classstringyes
utilAxialnumberyes
utilCombinednumberyes
utilFlexXnumberyes
utilFlexYnumberyes
utilMaxnumberyes
utilShearnumberyes

WasmAiscBoltInput ​

Used by aisc360_bolt_capacity.

FieldTypeRequiredDescription
bolt_diameternumberyes
bolt_gradestringyes
clear_distancenumberDefault: 0.
n_shear_planesintegeryes
ply_funumberDefault: 0.
ply_thicknessnumberDefault: 0.
threads_excludedbooleanDefault: false.

WasmAiscBoltResult ​

Used by aisc360_bolt_capacity.

FieldTypeRequiredDescription
phiRnBearingnumberyes
phiRnShearnumberyes
phiRnTearoutnumberyes
phiRnTensionnumberyes

WasmAiscWeldInput ​

Used by aisc360_weld_capacity.

FieldTypeRequiredDescription
fexxnumberyes
leg_sizenumberyes
lengthnumberyes
theta_degnumberDefault: 0.

WasmAiscWeldResult ​

Used by aisc360_weld_capacity.

FieldTypeRequiredDescription
phiRnnumberyes

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).

FieldTypeRequiredDescription
a_tnumber | nullNet tension area (mm²) when holes reduce it; defaults to the gross area. Default: null.
bnumberBreadth of ONE board (mm). Stability uses it; area and Z use n_boards · b. Default: 0.
categoryintegerApplication category 1, 2 or 3 (Table 2.1). Default: 2.
dnumberDefault: 0.
g13xnumberEffective length factors g13 about x (major) and y (minor), Table 3.2. Default: 1.
g13ynumberDefault: 1.
gradestringDefault: "F17".
high_tempbooleanSeasoned timber in Queensland north of 25°S or elsewhere north of 16°S: k6 = 0.9. Default: false.
k1numberDefault: 1.
k12number | nullDefault: null.
k12cnumber | nullDefault: null.
k4number | nullDefault: null.
k6number | nullDefault: null.
k9number | nullDefault: null.
la_phinumber | nullSpacing of torsional restraints (only for TensionAndTorsional). Default: null.
la_ynumber | nullSpacing of restraints against lateral (minor-axis) displacement, for S1 and S4. Defaults to length. Default: null.
le_bendingnumberDefault: 0.
le_compressionnumberDefault: 0.
lengthnumber | nullMember length L (mm): the span for k9 and the length for column buckling. Default: null.
m_starnumberDefault: 0.
n_boardsintegerBoards nailed or screwed side by side (a "2/190x35" is 2). Default: 1.
n_membersintegerMembers in the parallel system for k9 (1 = single member) and their spacing (mm). Default: 1.
n_starnumberDefault: 0.
nt_starnumberDefault: 0.
partial_seasoningbooleanUnseasoned timber that will partly season in service: k4 by least dimension (Table 2.5). Default: false.
rnumberRatio of temporary to total design action effect (Appendix E2); ≤ 0 is taken as 0.25. Default: 0.25.
restraint_edgeRestraintEdgeDefault: "compression".
seasonedbooleanDefault: true.
spacingnumberDefault: 0.
speciesSpeciesDefault: "softwood".
v_starnumberDefault: 0.

WasmAs1720Result ​

Used by as1720_timber_check.

FieldTypeRequiredDescription
Enumberyes
S1numberyes
S3numberyes
S4numberyes
continuousRestraintbooleanyes
fBnumberyes
fCnumberyes
fSnumberyes
fTnumberyes
governingstringyes
k1numberyes
k12numberyes
k12cnumberyes
k12xnumberyes
k12ynumberyes
k4numberyes
k6numberyes
k9numberyes
phinumberyes
phiMnumberyes
phiNnumberyesCompression capacity, the smaller of the two axes.
phiNcxnumberyes
phiNcynumberyes
phiNtnumberyes
phiVnumberyes
rhoBnumberyes
rhoCnumberyes
stabilityAssessedbooleanyes
utilMnumberyes
utilMaxnumberyes
utilNnumberyes
utilNtnumberyes
utilVnumberyes

WasmAs2870Input ​

Used by as2870_design.

FieldTypeRequiredDescription
constructionstringDefault: "".
du_surfacenumberDefault: 1.2.
footing_systemstringDefault: "".
hs_mnumberDefault: 1.5.
layersSoilLayer[]Default: [].
site_classstringOptional: skip the soil profile and use this class directly ("M", "H1-D", ...). Default: "".
slab_length_mnumberDefault: 15.

WasmAs4100AlphaMInput ​

Used by as4100_alpha_m.

FieldTypeRequiredDescription
my1numberyes
my2numberyes

WasmAs4100AlphaMResult ​

Used by as4100_alpha_m.

FieldTypeRequiredDescription
alpha_mnumberyes

WasmAs4100CellularInput ​

Used by as4100_cellular_check.

FieldTypeRequiredDescription
alpha_bnumberDefault: 0.
alpha_m_caseintegeryes
b_f_mmnumberyes
d_mmnumberyes
d_o_mmnumberyes
fy_mpanumberyes
le_mmnumberyes
length_mmnumberyes
s_mmnumberyes
t_f_mmnumberyes
t_w_mmnumberyes

WasmAs4100CellularResult ​

Used by as4100_cellular_check.

FieldTypeRequiredDescription
phi_m_bnumberyes
phi_m_grossnumberyes
phi_m_netnumberyes
phi_m_vierendeelnumberyes
phi_v_netnumberyes
phi_v_web_postnumberyes
web_post_slendernessnumberyes

WasmAs4100CombinedInput ​

Used by as4100_combined.

FieldTypeRequiredDescription
kfnumberDefault: 1.
m_star_xnumberyes
m_star_ynumberDefault: 0.
n_starnumberyes
nsnumberyes
phi_mbxnumberyes
phi_mbynumberDefault: 0.
phi_msxnumberyes
phi_msynumberDefault: 0.
phi_ncxnumberyes
phi_ncynumberyes
phi_ntnumberyes
section_classstringyes

WasmAs4100CombinedResult ​

Used by as4100_combined.

FieldTypeRequiredDescription
axial_utilnumberyes
member_util_xnumberyes
member_util_ynumberyes
phi_m_oxnumberyes
phi_m_oynumberyes
phi_m_rxnumberyes
phi_m_rynumberyes
section_util_xnumberyes
section_util_ynumberyes
util_biaxial_membernumberyes
util_biaxial_sectionnumberyes
util_maxnumberyes

WasmAs4100FatigueInput ​

Used by as4100_fatigue_check.

FieldTypeRequiredDescription
apply_beta_tfbooleanDefault: false.
categorystringyes
fy_mpanumberyes
phinumberDefault: 0.9.
spectrum[number, number][]yes
t_mmnumberyes

WasmAs4100FatigueResult ​

Used by as4100_fatigue_check.

FieldTypeRequiredDescription
applicablebooleanyes
damagenumberyes
okbooleanyes

WasmAs4100FireInput ​

Used by as4100_fire_check.

FieldTypeRequiredDescription
ambient_capacitynumberyes
exposurestringyes
fire_demandnumberyes
section_factornumberyes
time_minnumberyes

WasmAs4100FireResult ​

Used by as4100_fire_check.

FieldTypeRequiredDescription
limiting_tempnumberyes
load_rationumberyes
okbooleanyes
steel_tempnumberyes
temp_marginnumberyes

WasmAs4100OptimizeInput ​

Used by as4100_optimize_section.

FieldTypeRequiredDescription
alpha_bnumberDefault: 0.
alpha_m_caseintegeryes
categoriesstring[]Default: [].
fy_mpanumberyes
le_mmnumberyes
mx_starnumberyes
my_starnumberDefault: 0.
n_starnumberyes
v_starnumberyes

WasmAs4100OptimizeResult ​

Used by as4100_optimize_section.

FieldTypeRequiredDescription
best_categorystringyes
best_mass_kg_mnumberyes
best_namestringyes
consideredintegeryes
feasibleintegeryes
foundbooleanyes
util_maxnumberyes

WasmAs4100PhiMbxInput ​

Used by as4100_phi_mbx, as4100_phi_mbx_derivation.

FieldTypeRequiredDescription
alpha_m_caseintegeryes0=UniformMoment, 1=SimplySupportedUdl, 2=SimplySupportedPointLoad, 3=EndMoments, 4=CantileverUdl
beta_mnumberDefault: 0.
bfnumberyes
dnumberyes
enumberDefault: 200000.
fyfnumberyes
fywnumberyes
gnumberDefault: 80000.
i_wnumberDefault: 0.
i_ynumberyes
jnumberyes
le_mmnumberyes
phinumberDefault: 0.9.
s_xnumberyes
tfnumberyes
twnumberyes
z_xnumberyes

WasmAs4100PhiMbxResult ​

Used by as4100_phi_mbx.

FieldTypeRequiredDescription
alpha_mnumberyes
alpha_snumberyes
m_onumberyes
m_sxnumberyes
phi_m_bxnumberyes

WasmAs4100PhiMsResult ​

Used by as4100_phi_ms.

FieldTypeRequiredDescription
lambda_snumberyes
lambda_spnumberyes
lambda_synumberyes
m_sxnumberyes
phi_m_sxnumberyes
section_classstringyes
z_exnumberyes

WasmAs4100PhiNcInput ​

Used by as4100_phi_nc, as4100_phi_nc_derivation.

FieldTypeRequiredDescription
alpha_bnumberDefault: 0.
areanumberyes
fynumberyes
kfnumberDefault: 1.
le_mmnumberyes
phinumberDefault: 0.9.
rnumberyes

WasmAs4100PhiNcResult ​

Used by as4100_phi_nc.

FieldTypeRequiredDescription
alpha_cnumberyes
lambda_nnumberyes
n_cnumberyes
n_snumberyes
phi_n_cnumberyes

WasmAs4100PhiVvInput ​

Used by as4100_phi_vv.

FieldTypeRequiredDescription
dnumberyes
fynumberyes
section_namestringyes
tfnumberyes
twnumberyes

WasmAs4100PhiVvResult ​

Used by as4100_phi_vv.

FieldTypeRequiredDescription
phi_vvnumberyes

WasmAs4100SectionInput ​

Used by as4100_phi_ms, as4100_phi_ms_derivation.

FieldTypeRequiredDescription
bfnumberyes
dnumberyes
fyfnumberyes
fywnumberyes
s_xnumberyes
tfnumberyes
twnumberyes
z_xnumberyes

WasmAs4100TaperedInput ​

Used by as4100_tapered_check.

FieldTypeRequiredDescription
alpha_bnumberDefault: 0.
alpha_m_caseintegeryes
b_f_mmnumberyes
d_a_mmnumberyes
d_b_mmnumberyes
fy_mpanumberyes
le_mmnumberyes
length_mmnumberyes
t_f_mmnumberyes
t_w_mmnumberyes

WasmAs4100TaperedResult ​

Used by as4100_tapered_check.

FieldTypeRequiredDescription
d_govern_mmnumberyes
phi_mbnumberyes
phi_msnumberyes
phi_ncnumberyes
taper_rationumberyes
x_govern_mmnumberyes

WasmAs4600CombinedInput ​

Used by as4600_combined.

FieldTypeRequiredDescription
m_star_xnumberDefault: 0.
m_star_ynumberDefault: 0.
n_compnumberDefault: 0.
n_tensnumberDefault: 0.
phi_mbxnumberDefault: 0.
phi_mbynumberDefault: 0.
phi_ncxnumberDefault: 0.
phi_ncynumberDefault: 0.
phi_ntnumberDefault: 0.

WasmAs4600Input ​

Used by as4600_capacity.

FieldTypeRequiredDescription
bnumberyes
dnumberyes
enumberDefault: 200000.
f_ynumberyes
lipnumberDefault: 0.
rnumberDefault: 0.
section_typestringyes
tnumberyes

WasmAs4600Result ​

Used by as4600_capacity.

FieldTypeRequiredDescription
aEffnumberyes
aGrossnumberyes
governingstringyes
phiMsnumberyes
phiNcnumberyes
zEffnumberyes
zGrossnumberyes

WasmAs5100Assumptions ​

FieldTypeRequiredDescription
alpha_mnumberyes
alpha_snumberyes
leMajornumberyes
leMinornumberyes
section_classstringyes

WasmAs5100CombinedInput ​

Used by as5100_combined.

FieldTypeRequiredDescription
kfnumberDefault: 1.
mStarXnumberyes
mStarYnumberDefault: 0.
nStarnumberyes
nsnumberyes
phiMbxnumberyes
phiMbynumberDefault: 0.
phiMsxnumberyes
phiMsynumberDefault: 0.
phiNcxnumberyes
phiNcynumberyes
phiNtnumberyes
sectionClassstringyes

WasmAs5100CombinedResult ​

Used by as5100_combined.

FieldTypeRequiredDescription
axialUtilnumberyes
memberUtilXnumberyes
memberUtilYnumberyes
phiMOxnumberyes
phiMOynumberyes
phiMRxnumberyes
phiMRynumberyes
sectionUtilXnumberyes
sectionUtilYnumberyes
utilBiaxialMembernumberyes
utilBiaxialSectionnumberyes
utilMaxnumberyes

WasmAs5100MemberInput ​

Used by as5100_member_check.

FieldTypeRequiredDescription
anumberyes
alphaMCaseintegeryes0=UniformMoment, 1=SimplySupportedUdl, 2=SimplySupportedPointLoad, 3=EndMoments, 4=CantileverUdl
beta_mnumberDefault: 0.
bfnumberyes
dnumberyes
enumberDefault: 200000.
funumberDefault: 0.
fynumberyes
iyynumberyes
izznumberyes
jnumberyes
leMajornumberyes
leMinornumberyes
mxStarnumberyes
myStarnumberDefault: 0.
nStarnumberyes
syynumberDefault: 0.
szznumberDefault: 0.
tfnumberyes
twnumberyes
vxStarnumberDefault: 0.
zyynumberDefault: 0.
zzznumberDefault: 0.

WasmAs5100MemberResult ​

Used by as5100_member_check.

FieldTypeRequiredDescription
assumptionsWasmAs5100Assumptionsyes
governingstringyes
phiMbxnumberyes
phiMbynumberyes
phiMsxnumberyes
phiMsynumberyes
phiNcxnumberyes
phiNcynumberyes
phiNtnumberyes
phiVvnumberyes
section_classstringyes
utilAxialnumberyes
utilCombinednumberyes
utilFlexXnumberyes
utilFlexYnumberyes
utilMaxnumberyes
utilShearnumberyes

WasmAsce7CpResult ​

Used by asce7_roof_pressure_coefficient, asce7_wall_pressure_coefficient.

FieldTypeRequiredDescription
c_pnumberyes
c_p_bnumber | nullDesign 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.
clausestringyes
usesstringyes"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.

FieldTypeRequiredDescription
dist_from_windward_edge_over_hnumberDistance 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.
facestringyes"windward", "leeward" or "parallel" (wind parallel to the ridge).
h_over_lnumberyesh/L - mean roof height over the plan dimension along the wind.
theta_degnumberyesRoof angle theta, degrees from horizontal.

WasmAsce7SurfacePressureInput ​

Used by asce7_surface_pressure.

FieldTypeRequiredDescription
c_pnumberyes
gnumberyesGust-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_panumberyesq_h, Pa - the velocity pressure at mean roof height.
q_z_panumberyesq_z, Pa - the velocity pressure at the height of the point considered.
usesstringyes"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.

FieldTypeRequiredDescription
c_pnumberyes
clausestringyes
gnumberyes
p_panumberyesp = q G C_p, Pa. Positive acts toward the surface, negative away from it.
q_sourcestringyes
q_used_panumberyes

WasmAsce7VelocityPressureInput ​

Used by asce7_velocity_pressure.

FieldTypeRequiredDescription
basic_wind_speed_msnumberyesBasic wind speed V, m/s (Section 26.5 hazard maps).
exposurestringyesExposure category letter: "B", "C" or "D" (Section 26.7).
ground_elevation_mnumberGround elevation above mean sea level, m, for K_e. NOT the terrain gradient height. Default: 0.
k_dnumberyesWind directionality factor K_d, Table 26.6-1. 0.85 for buildings.
k_ztnumberTopographic factor K_zt, Section 26.8.2. 1.0 on flat terrain. Default: 1.
z_mnumberyesHeight above ground, m.

WasmAsce7VelocityPressureResult ​

Used by asce7_velocity_pressure.

FieldTypeRequiredDescription
clausestringyes
k_dnumberyes
k_enumberyes
k_znumberyes
k_ztnumberyes
q_panumberyes
z_used_mnumberyes

WasmAsce7WallCpInput ​

Used by asce7_wall_pressure_coefficient.

FieldTypeRequiredDescription
facestringyes"windward", "side" or "leeward".
l_over_bnumberyesL/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.

FieldTypeRequiredDescription
anumberyes
bfnumberDefault: 0.
categorystringyes
cold_formedbooleanDefault: false.
dnumberDefault: 0.
fynumberDefault: 0.
idintegeryes
iwnumberDefault: 0.
iyynumberyes
izznumberyes
jnumberyes
lipnumberDefault: 0.
mass_kg_mnumberyes
namestringDefault: "".
syynumberDefault: 0.
szznumberDefault: 0.
tfnumberDefault: 0.
twnumberDefault: 0.
x0numberDefault: 0.
zyynumberDefault: 0.
zzznumberDefault: 0.

WasmAutoSizeInput ​

Used by auto_size.

FieldTypeRequiredDescription
candidates{ [key]: WasmAutoSizeCandidate[] }
modelWasmModelyes
optionsWasmAutoSizeOptions
sizableWasmSizableSpec[]

WasmAutoSizeOptions ​

FieldTypeRequiredDescription
max_iterintegerDefault: 8.
targetnumberDefault: 1.

WasmAxisCapacity ​

FieldTypeRequiredDescription
Zenumberyes
compactnessWasmAxisCompactnessyes
phiMbnumberyes
phiMsnumberyes

WasmAxisCompactness ​

FieldTypeRequiredDescription
classstringyes
flangeWasmPlateCompactnessyes
webWasmPlateCompactnessyes

WasmBasePlateAssumptions ​

FieldTypeRequiredDescription
methodstringyes
phi_concretenumberyes
phi_steelnumberyes

WasmBasePlateInput ​

Used by base_plate_check.

FieldTypeRequiredDescription
bolt_countintegerDefault: 0.
bolt_diameternumberDefault: 0.
bolt_gradestringDefault: "".
column_bfnumberyes
column_dnumberyes
concrete_fcnumberyes
n_starnumberyes
plate_bnumberyes
plate_dnumberyes
plate_fynumberyes
plate_tnumberyes
v_starnumberDefault: 0.

WasmBasePlateResult ​

Used by base_plate_check.

FieldTypeRequiredDescription
assumptionsWasmBasePlateAssumptionsyes
bearing_pressurenumberyes
cantilever_bnumberyes
cantilever_dnumberyes
confinementnumberyes
n_starnumberyes
phiAnchorShearnumberyes
phiNcConcnumberyes
phiPlateBendingnumberyes
t_reqnumberyes
util_anchor_shearnumberyes
util_bearingnumberyes
util_boltsnumberyes
util_interactionnumberyes
util_maxnumberyes
util_platenumberyes

WasmBearingStiffenerInput ​

Used by bearing_stiffener_check.

Load-bearing web stiffener pair (conn_stiffener::bearing_stiffener_capacity). SI in; mm/MPa inside.

FieldTypeRequiredDescription
b_esnumberyes
d_1numberyes
f_ynumberyes
f_ysnumberyes
r_starnumberyes
t_fnumberyes
t_snumberyes
t_wnumberyes

WasmBearingStiffenerResult ​

Used by bearing_stiffener_check.

FieldTypeRequiredDescription
alphaCnumberyes
lambdaNnumberyes
outstandRationumberyes
phiRsbnumberyes
phiRsynumberyes
r_starnumberyes
util_maxnumberyes
util_stiffener_bucklingnumberyes
util_stiffener_yieldnumberyes

WasmBoltGroupInput ​

Used by eccentric_bolt_group_check.

FieldTypeRequiredDescription
boltDiameternumberyes
boltGradestringyes
boltsWasmBoltPositionInput[]yes
krnumberyes
mznumberyes
nNintegeryes
nXintegeryes
vxnumberyes
vynumberyes

WasmBoltGroupResult ​

Used by eccentric_bolt_group_check.

FieldTypeRequiredDescription
governingBoltintegeryes
phiVboltnumberyes
phiVtotalnumberyes
util_maxnumberyes
vResultantGovnumberyes

WasmBoltInput ​

Used by bolt_capacity.

FieldTypeRequiredDescription
bolt_diameternumberyes
bolt_gradestringyes
krnumberDefault: 1.
ply_funumberDefault: 0.
ply_thicknessnumberDefault: 0.
shear_planes_threads_excludedintegeryes
shear_planes_threads_interceptedintegeryes

WasmBoltLayout ​

Used by bolt_layout.

FieldTypeRequiredDescription
colsintegeryes
edgenumberyes
endnumberyes
fitsbooleanyes
gaugenumberyes
pitchnumberyes
plateHnumberyes
plateWnumberyes
positionsWasmBoltPos[]yes
rowsintegeryes
tracestring[]yes

WasmBoltLayoutInput ​

Used by bolt_layout.

FieldTypeRequiredDescription
availWidthnumberyes
boltDiameternumberyes
countintegeryes
edgenumber | nullDefault: null.
edgeTypestringDefault: "".
endnumber | nullDefault: null.
gaugenumber | nullDefault: null.
pitchnumber | nullDefault: null.

WasmBoltPos ​

FieldTypeRequiredDescription
xnumberyes
ynumberyes

WasmBoltPositionInput ​

FieldTypeRequiredDescription
xnumberyes
ynumberyes

WasmBoltResult ​

Used by bolt_capacity.

FieldTypeRequiredDescription
minEdgenumberyes
minGaugenumberyes
minPitchnumberyes
phiNtfnumberyes
phiVbnumberyes
phiVfnumberyes

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.

FieldTypeRequiredDescription
bolt_countintegeryes
bolt_dianumberyes
bolt_gradestringyes
bracket_bnumberyes
bracket_funumberyes
bracket_fynumberyes
bracket_tnumberyes
gaugenumberyesThe bolt line's gauge: the spacing of the bolts up the purlin's web.
legnumberThe bracket's leg: how far the bridging member's axis sits off the bolt line. Default: 0.
m_starnumberDefault: 0.
n_starnumberyes
v_starnumberyes
web_funumberyes
web_tnumberyes

WasmBridgingResult ​

Used by bridging_check.

FieldTypeRequiredDescription
bearingCnumberyes
componentsWasmConnComponent[]yes
govComponentstringyes
govUtilnumberyes
notesstring[]yes
statusstringyes

WasmBucklingMode ​

FieldTypeRequiredDescription
indexintegeryes
load_factornumberyes
mode_shapeWasmNodeDisplacement[]yes

WasmBucklingResults ​

Used by solve_model_buckling.

FieldTypeRequiredDescription
modesWasmBucklingMode[]yes
warningsstring[]Eigensolver self-check notes (Sturm-count mismatch). Non-empty means the mode set is suspect and the UI must show it.

WasmCable ​

FieldTypeRequiredDescription
member_idintegeryes
modelstringDefault: "".
unstressed_lengthnumber | nullDefault: null.

WasmCapacityAssumptions ​

FieldTypeRequiredDescription
alpha_bnumberyes
alpha_mnumberyes
alpha_snumberyes
klnumberyes
krnumberyes
ktnumberyes
le_xnumberyes
le_ynumberyes

WasmColumnSideInput ​

Used by column_side_check.

FieldTypeRequiredDescription
beamDnumberyes
beamTfnumberyes
bfColnumberThe column flange width, m. Default: 0.
bothFlangesRestrainedbooleanBoth column flanges are held at the joint (Cl 5.13.4 slenderness 2.5 d1/tw, else 5.0). Default: false.
dColnumberyes
flangeInTstubbooleanThe column flange is already checked as bolted T-stubs, so the flange yield line row is left out. Default: false.
flangeWeldLegnumberThe beam flange's fillet weld leg to the column, m (0 for a butt weld or none). Default: 0.
fyColnumberyes
mStarnumberyes
nStarnumberDefault: 0.
plateTnumberThe end plate's thickness, m (0 on a welded joint). Default: 0.
stiffenerFynumberThe continuity stiffeners' yield stress, Pa. Default: 0.
stiffenerTnumberThe continuity stiffeners' thickness, m (0 when none are drawn). Default: 0.
tfColnumberyes
twColnumberyes

WasmColumnSideResult ​

Used by column_side_check.

FieldTypeRequiredDescription
componentsWasmConnComponent[]yes
govComponentstringyes
govUtilnumberyes
notesstring[]yes
statusstringyes
stiffenersRequiredbooleanyes

WasmCombinationResults ​

Results output

FieldTypeRequiredDescription
combination_idintegeryes
displacementsWasmNodeDisplacement[]yes
member_forcesWasmMemberForce[]yes
member_station_forcesWasmMemberStationForces[]yes
namestringyes
reactionsWasmReaction[]yes

WasmCombinedColumn ​

FieldTypeRequiredDescription
bxnumberyes
bynumberyes
mxServicenumberDefault: 0.
mxStarnumberDefault: 0.
myServicenumberDefault: 0.
myStarnumberDefault: 0.
nServicenumberDefault: 0.
nStarnumberyes
xnumberyes

WasmCombinedFootingInput ​

Used by combined_footing_design.

FieldTypeRequiredDescription
barDiameternumberDefault: 0.
bearingBasisstringDefault: "allowable".
columnsWasmCombinedColumn[]yes
covernumberyes
fPrimeCnumberyes
fPrimeCColumnnumberDefault: 0.
fSynumberyes
footingBxnumberyes
footingBynumberyes
footingHnumberyes
qBearingnumberyes
selfWeightnumberDefault: 0.
standardFootingCodeDefault: "as3600".

WasmCombinedFootingResult ​

Used by combined_footing_design.

FieldTypeRequiredDescription
aStBottomReqnumberyes
aStMinnumberyes
aStTopReqnumberyes
aStTransverseReqnumberyes
checksRefusedstring[]yes
contactStatestringyes
governingstringyes
mHognumberyes
mSagnumberyes
mTransversenumberyes
notestring | null
phiVPunchnumberyes
phiVUcnumberyes
qAllowablenumberyes
qMaxnumberyes
resultantXnumberyes
utilBearingnumberyes
utilBearingStressnumberyes
utilDevelopmentnumberyes
utilMaxnumberyes
utilMomentnumberyes
utilPunchingnumberyes
utilShearnumberyes
utilTransversenumberyes
vDesignnumberyes
vPunchnumberyes

WasmComboGenInput ​

Used by generate_load_combinations.

FieldTypeRequiredDescription
codestringWhich code's combination set: "asnzs" (default) | "asce7" | "eurocode". Default: "".
load_casesWasmLoadCase[]yes
occupancystring | nullAS/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_qnumber | nullDefault: null.
psi0_snumber | nullDefault: null.
psi0_wnumber | nullDefault: null.
psi1_qnumber | nullDefault: null.
psi2_qnumber | nullDefault: null.
psi_cnumber | nullDefault: null.
psi_enumber | nullAS/NZS 1170.0 Table 4.1 earthquake combination factor. Default: null.
psi_lnumber | nullDefault: null.
psi_snumber | nullDefault: null.

WasmComboGenOutput ​

Used by generate_load_combinations.

FieldTypeRequiredDescription
combinationsWasmLoadCombination[]yes

WasmComboTerm ​

FieldTypeRequiredDescription
factornumberyes
load_case_idintegeryes

WasmCompositeBeamInput ​

Used by composite_beam_check.

FieldTypeRequiredDescription
b_fnumberyes
beam_spacingnumberyes
dnumberyes
d_snumberyes
d_studnumberyes
f_prime_cnumberyes
f_u_studnumberyes
f_ynumberyes
m_starnumberyes
n_studsintegeryes
spannumberyes
t_fnumberyes
t_wnumberyes
z_enumberyes

WasmCompositeBeamResult ​

Used by composite_beam_check.

FieldTypeRequiredDescription
bEffnumberyes
etanumberyes
fCcnumberyes
fStnumberyes
mBarenumberyes
mFullnumberyes
nStudsReqnumberyes
phiMbvnumberyes
phiNQnumberyes
pnaInSlabbooleanyes
util_maxnumberyes
util_momentnumberyes
util_studnumberyes

WasmCompressionCapacity ​

FieldTypeRequiredDescription
Nsnumberyes
alpha_cnumberyes
kfnumberyes
lambda_nnumberyes
phiNcxnumberyes
phiNcynumberyes

WasmConnComponent ​

One limit-state row on the wire: &#123;name, clause, demand, capacity, util, status&#125;.

FieldTypeRequiredDescription
capacitynumberyes
clausestringyes
demandnumberyes
namestringyes
statusstringyes
utilnumberyes

WasmConnStiffenerComponent ​

FieldTypeRequiredDescription
capacitynumberyes
clausestringyes
demandnumberyes
namestringyes
statusstringyes
utilnumberyes

WasmConnStiffenerInput ​

Used by conn_stiffener_check.

FieldTypeRequiredDescription
b_colnumberyes
d_colnumberyes
flange_bending_utilnumberyes
flange_forcenumberyes
fy_colnumberyes
fy_stiffenernumberyes
panel_shear_utilnumberyes
tf_colnumberyes
tw_colnumberyes
web_bearing_utilnumberyes

WasmConnStiffenerResult ​

Used by conn_stiffener_check.

FieldTypeRequiredDescription
componentsWasmConnStiffenerComponent[]yes
continuity_plate_area_reqnumberyes
continuity_plate_thickness_minnumberyes
doubler_area_reqnumberyes
doubler_thickness_minnumberyes
flange_forcenumberyes
statusstringyes
stiffeners_requiredbooleanyes

WasmContinuousInfluenceLineInput ​

Used by influence_line_continuous.

FieldTypeRequiredDescription
actionstringyes
member_idsinteger[]yes
modelWasmModelyes
n_pointsintegerDefault: 101.
station_local_xnumberyes
station_memberintegeryes
support_nodeintegerDefault: 0.

WasmContinuousInfluenceLineResult ​

Used by influence_line_continuous.

FieldTypeRequiredDescription
actionstringyes
ordinatesnumber[]yes
positionsnumber[]yes
station_local_xnumberyes
station_memberintegeryes
support_reaction_nodeinteger | null
total_lengthnumberyes

WasmCraneInput ​

Used by en1991_3_crane.

FieldTypeRequiredDescription
bridge_weight_knnumberyes
buffer_stiffness_kn_mnumberDefault: 0.
buffer_xinumberDefault: 0.5.
crab_weight_knnumberDefault: 0.
driven_wheelsintegerDefault: 2.
fatigue_classinteger | nullDefault: null.
frictionnumberDefault: 0.2.
guide_spacing_mnumberDefault: 0.
hoist_load_knnumberyes
hoisting_classintegerDefault: 2.
hoisting_speed_msnumberDefault: 0.1.
min_approach_mnumberDefault: 1.
phi_5numberDefault: 1.5.
skew_angle_radnumberDefault: 0.015.
span_mnumberyes
travel_speed_msnumberDefault: 0.
wheel_pair_distances_mnumber[]Default: [].
wheel_spacings_mnumber[]Default: [3].
wheels_per_railintegerDefault: 2.

WasmDiaphragm ​

Rigid in-plane diaphragm: node ids tied to move as one rigid body in the horizontal plane.

FieldTypeRequiredDescription
idintegeryes
node_idsinteger[]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.

FieldTypeRequiredDescription
alphanumber | nullDefault: null.
betanumber | nullDefault: null.
damping_rationumberDefault: 0.05.
directionnumber[]Default: [1,0,0].
gammanumber | nullDefault: null.
modelWasmModelyes
nonlinearbooleanDefault: false.
rayleighnumber[] | nullDefault: null.
recordnumber[][]yes
schemestringDefault: "".
track_nodeinteger | nullDefault: 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.

FieldTypeRequiredDescription
annual_probabilitynumber | nullDefault: null.
height_mnumberyes
ktnumber | nullEq 6.2(7) inputs: kt and the structure height hn, metres. Default: null.
locationstring | nullDefault: null.
munumber | nullDefault: null.
soilstringDefault: "".
spnumber | nullDefault: null.
systemstring | nullDefault: null.
v_dynamicnumberyesThe base shear the dynamic analysis produced, newtons.
weightnumberyesSeismic weight Wt, newtons - the same mass the dynamic analysis used.
znumber | nullDefault: 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.

FieldTypeRequiredDescription
c_0numberOrography factor c_0(z). 1.0 where orography is not significant. Default: 1.
k_inumberTurbulence factor k_I. A National Annex parameter; the EN recommends 1.0. Default: 1.
rho_kg_m3numberAir density, kg/m3. A NATIONAL ANNEX parameter; the EN recommends 1.25. Default: 1.25.
terrainstringyesTerrain category label: "0", "I", "II", "III" or "IV" (Table 4.1).
v_b_msnumberyesBasic wind velocity v_b, m/s, from the national map (Section 4.2).
z_mnumberyesHeight above ground, m.

WasmEc1PeakVelocityPressureResult ​

Used by ec1_peak_velocity_pressure.

FieldTypeRequiredDescription
c_0numberyes
c_enumberyesq_p / q_b, EN's exposure factor c_e(z) - the number an engineer recognises at a glance.
c_rnumberyes
clausestringyes
i_vnumberyes
q_b_panumberyes
q_p_panumberyes
v_m_msnumberyes
z_used_mnumberyes

WasmEc3Assumptions ​

FieldTypeRequiredDescription
c1numberyes
curveLTstringyes
curveYstringyes
curveZstringyes
lcrLTnumberyes
lcrYnumberyes
lcrZnumberyes

WasmEc3MemberInput ​

Used by ec3_member_check.

FieldTypeRequiredDescription
anumberyes
bfnumberyes
c1numberDefault: 0.
dnumberyes
enumberDefault: 0.
fynumberyes
iyynumberyes
izznumberyes
jnumberyes
lcrLTnumberyes
lcrYnumberyes
lcrZnumberyes
myStarnumberyes
mzStarnumberyes
nStarnumberyes
namestringSection name (optional): picks the Cl 6.2.6(3) shear area by shape (I, channel, RHS, CHS). Default: "".
rnumberRoot radius (m, optional): the fillets' part of the rolled-section shear area. Default: 0.
szznumberDefault: 0.
tfnumberyes
twnumberyes
vyStarnumberyes
w_el_ynumberDefault: 0.
w_pl_ynumberDefault: 0.
zzznumberDefault: 0.

WasmEc3MemberResult ​

Used by ec3_member_check.

FieldTypeRequiredDescription
MbRdnumberyes
MyRdnumberyes
MzRdnumberyes
NbYRdnumberyes
NbZRdnumberyes
NcRdnumberyes
NtRdnumberyes
VplRdnumberyes
assumptionsWasmEc3Assumptionsyes
governingstringyes
section_classstringyes
utilAxialnumberyes
utilCombinednumberyes
utilFlexYnumberyes
utilFlexZnumberyes
utilMaxnumberyes
utilShearnumberyes

WasmEndGap ​

FieldTypeRequiredDescription
gap_mmnumberyes
member_idintegeryes

WasmEndPlateDrawnRow ​

FieldTypeRequiredDescription
boltsintegeryes
ynumberyes

WasmEndPlateInput ​

Used by end_plate_check.

FieldTypeRequiredDescription
beam_bfnumberDefault: 0.
beam_dnumberyes
beam_fynumberDefault: 0.
beam_tfnumberyes
beam_twnumberDefault: 0.
bolt_count_tensionintegeryes
bolt_count_totalintegerTotal bolts sharing the shear. 0 defaults to twice the tension count. Default: 0.
bolt_diameternumberyes
bolt_gradestringyes
both_directionsbooleanThe 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_bfnumberDefault: 0.
column_dnumberThe 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_fynumberDefault: 0.
column_r1numberDefault: 0.
column_stiffenedbooleanContinuity stiffeners opposite the tension flange (the web's tension is theirs). Default: false.
column_tfnumberDefault: 0.
column_twnumberDefault: 0.
flange_weld_legnumberDefault: 0.
gaugenumberCentre-to-centre gauge of the two bolt columns (m). Default: 0.
m_starnumberyes
plate_extnumberHow far the plate runs past the tension flange's outer face (m); 0 for a flush plate. Default: 0.
plate_fynumberyes
plate_thicknessnumberyes
plate_widthnumberDefault: 0.
rowsWasmEndPlateDrawnRow[]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_starnumberCoincident connection shear (N). Optional; 0 skips the Cl 9.2.2.3 combined shear + tension interaction on the tension bolts. Default: 0.
web_weld_legnumberDefault: 0.

WasmEndPlateMultiRowInput ​

Used by end_plate_moment_multirow_check.

FieldTypeRequiredDescription
bolt_diameternumberyes
bolt_gradestringyes
fc_rdnumberyes
plate_fynumberyes
plate_thicknessnumberyes
plate_widthnumberyes
rowsWasmEndPlateRowInput[]yes

WasmEndPlateMultiRowResult ​

Used by end_plate_moment_multirow_check.

FieldTypeRequiredDescription
fc_rdnumberyes
m_rdnumberyes
notesstring[]yes
rowsWasmEndPlateRowResult[]yes
total_tensionnumberyes

WasmEndPlateResult ​

Used by end_plate_check.

FieldTypeRequiredDescription
columnInTstubbooleanThe column flange and web in tension were in the T-stub rows (SA-118). Default: false.
d_effnumberyes
governingstringDefault: "".
m_starnumberyes
methodstring"tstub" (the drawn rows, AS 4100 T-stubs) or "strip" (no rows given: the plate as one strip). Default: "".
notesstring[]Default: [].
phiBoltsTensionnumberyes
phiMDesnumberyes
phiPlateBendingnumberyes
row_capacitynumber[]Default: [].
row_modesstring[]Per tension row: governing T-stub mode and its capacity (N), top row first. Default: [].
tStarnumberyes
utilWebWeldnumberThe web welds to the plate under the shear and the rows' tension, Cl 9.6.3.10 (SA-119). Default: 0.
util_bolt_combinednumberyes
util_boltsnumberyes
util_maxnumberyes
util_platenumberyes

WasmEndPlateRowInput ​

FieldTypeRequiredDescription
boltsintegeryes
kindWasmEndPlateRowKindInputyes
lever_armnumberyes

WasmEndPlateRowKindInput ​

One of:

  • type: "extended"

    FieldTypeRequiredDescription
    enumberyes
    exnumberyes
    mxnumberyes
    type"extended"yes
  • type: "first_below_flange"

    FieldTypeRequiredDescription
    enumberyes
    mnumberyes
    m2numberyes
    type"first_below_flange"yes
  • type: "inner"

    FieldTypeRequiredDescription
    enumberyes
    mnumberyes
    type"inner"yes
  • type: "end"

    FieldTypeRequiredDescription
    enumberyes
    mnumberyes
    type"end"yes

WasmEndPlateRowResult ​

FieldTypeRequiredDescription
ft_rdnumberyes
leff_1numberyes
leff_2numberyes
modestringyes

WasmEnvelopeResults ​

FieldTypeRequiredDescription
displacements_maxWasmNodeDisplacement[]yes
displacements_minWasmNodeDisplacement[]yes
member_forces_maxWasmMemberForce[]yes
member_forces_minWasmMemberForce[]yes
reactions_maxWasmReaction[]yes
reactions_minWasmReaction[]yes

WasmFinPlateInput ​

Used by fin_plate_check.

FieldTypeRequiredDescription
bolt_columnsintegerDefault: 0.
bolt_countintegeryes
bolt_diameternumberyes
bolt_gradestringyes
edge_distancenumberDefault: 0.
end_distancenumberDefault: 0.
gaugenumberDefault: 0.
pitchnumberDefault: 0.
plate_depthnumberyes
plate_funumberyes
plate_fynumberyes
plate_thicknessnumberyes
v_starnumberyes
weld_fuwnumberDefault: 480000000.
weld_leg_sizenumberyes
weld_lengthnumberyes

WasmFinPlateResult ​

Used by fin_plate_check.

FieldTypeRequiredDescription
phiBlockShearnumberyes
phiBoltsnumberyes
phiPlateBearingnumberyes
phiPlateShearnumberyes
phiPlateTearoutnumberyes
phiVDesnumberyes
phiWeldnumberyes
util_block_shearnumberyes
util_boltsnumberyes
util_maxnumberyes
util_plate_bearingnumberyes
util_plate_shearnumberyes
util_plate_tearoutnumberyes
util_weldnumberyes
v_starnumberyes

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 }

FieldTypeRequiredDescription
cutoff_hznumber | nullDefault: null.
dampingstringDefault: "".
damping_rationumber | nullDefault: null.
floorstringDefault: "".
limitnumberDefault: 8.
modesFloorMode[]yes
pace_max_hznumberDefault: 2.2.
pace_min_hznumberDefault: 1.8.
person_weight_nnumberDefault: 746.
verticalbooleanDefault: true.
walking_path_mnumber | nullDefault: null.
weightingstringDefault: "".

WasmFootingFeInput ​

Used by footing_fe_pressure.

FieldTypeRequiredDescription
bxnumberyes
bynumberyes
cxnumberDefault: 0.4.
cynumberDefault: 0.4.
e_concretenumberDefault: 30000000000.
ksnumberyes
mxnumberDefault: 0.
mynumberDefault: 0.
nnumberyes
nunumberDefault: 0.2.
nxintegerDefault: 12.
nyintegerDefault: 12.
self_weightnumberDefault: 0.
thicknessnumberyes

WasmFootingSizeInput ​

Used by footing_size_for_bearing.

FieldTypeRequiredDescription
aspectnumberby/bx. Defaults to 1.0 (square). Default: 0.
footingHnumberFooting thickness, m, so self-weight can grow with the plan area inside the loop. Default: 0.
mxServicenumberDefault: 0.
myServicenumberDefault: 0.
nServicenumberyesUnfactored vertical load, kN. Bearing is a working-stress check.
qAllowablenumberyesAllowable bearing pressure, kPa. Already factored if the caller's basis was "ultimate".

WasmFootingSizeResult ​

Used by footing_size_for_bearing.

FieldTypeRequiredDescription
bxnumberyes
bynumberyes
convergedbooleanyes
notestring | null
qMaxnumberyes
utilnumberyes

WasmGeoClassifyInput ​

Used by geo_classify_point.

FieldTypeRequiredDescription
pointnumber[]yesQuery point [lon, lat].
polygonsGeoPolygon[]Candidate polygons (name, optional class attribute, GeoJSON rings). Default: [].

WasmGradeBeamColumn ​

FieldTypeRequiredDescription
nStarnumberyes
xnumberyes

WasmGradeBeamInput ​

Used by grade_beam_design.

FieldTypeRequiredDescription
columnsWasmGradeBeamColumn[]yes
covernumberyes
fPrimeCnumberyes
fSynumberyes
ksnumberyesModulus of subgrade reaction, N/m^3. Geotechnical; no default - see grade_beam.rs.
lengthnumberyes
nElementsintegerDefault: 0.
standardFootingCodeConcrete design code for the longitudinal flexure design. Omitted -> AS 3600, so a payload without a standard designs exactly as before. Default: "as3600".
thicknessnumberyes
widthnumberyes

WasmGradeBeamResult ​

Used by grade_beam_design.

FieldTypeRequiredDescription
aStBottomReqnumberyes
aStMinnumberyes
aStTopReqnumberyes
checksRefusedstring[]yes
lambdaLnumberyes
mHognumberyes
mSagnumberyes
notestring | null
qMaxnumberyes
qMaxAtnumberyes
rigiditystringyes
settlementMaxnumberyes
utilMomentnumberyes
vMaxnumberyes

WasmGussetInput ​

Used by gusset_check.

FieldTypeRequiredDescription
alphaBnumberDefault: 0.5.
boltDiameternumberyes
countintegeryes
edgeTypestringDefault: "".
gradestringDefault: "8.8".
knumberDefault: 0.65.
lbnumberDefault: 0.12.
memberWidthnumberyes
nShearPlanesintegerDefault: 1.
nStarnumberyes
plateFunumberyes
plateFynumberyes
plateThicknessnumberyes

WasmGussetResult ​

Used by gusset_check.

FieldTypeRequiredDescription
componentsWasmConnComponent[]yes
govComponentstringyes
govUtilnumberyes
layoutWasmBoltLayoutyes
notesstring[]yes
statusstringyes

WasmGussetSupportInput ​

Used by gusset_support_check.

A gusset's bolted support fitting (conn_gusset_support). SI in; mm/MPa inside.

FieldTypeRequiredDescription
bolt_dianumberyes
bolt_gradestringyes
bolted_platebooleanyes
colsintegeryes
f_parnumberyes
f_perpnumberyes
gusset_boltsintegeryes
levernumberyes
m_starnumberyes
pitchnumberyes
plate_fynumberyes
plate_tnumberyes
ply_funumberyes
ply_tnumberyes
rowsintegeryes
stripnumberyes
weld_legnumberyes
weld_lennumberyes

WasmGussetSupportResult ​

Used by gusset_support_check.

FieldTypeRequiredDescription
f_parnumberyes
f_perpnumberyes
tOuternumberyes
util_face_boltsnumberyes
util_gusset_boltsnumberyes
util_gusset_weldnumberyes
util_maxnumberyes
util_plate_bendingnumberyes
util_ply_bearingnumberyes

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.

FieldTypeRequiredDescription
bolt_columnsintegerDefault: 1.
bolt_countintegeryes
bolt_dianumberyes
bolt_gradestringyes
n_starnumberyes
slottedbooleantrue: a tongue in a slotted tube; false: a lug on an end plate, the tube whole (plan A2b). Default: true.
tongue_endnumberyes
tongue_funumberyes
tongue_fynumberyes
tongue_tnumberyes
tongue_wnumberyes
tube_dnumberyes
tube_funumberyes
tube_fynumberyes
tube_tnumberyes
weld_legnumberyes
weld_lennumberyes

WasmHollowBraceEndResult ​

Used by hollow_brace_end_check.

FieldTypeRequiredDescription
n_starnumberyes
phiBoltShearnumberyes
phiTongueBearingnumberyes
phiTongueFracturenumberyes
phiTongueTearoutnumberyes
phiTongueYieldnumberyes
phiTubeNetnumberyes
phiWeldnumberyes
shearLagUnumberyes
util_bolt_shearnumberyes
util_maxnumberyes
util_tonguenumberyes
util_tongue_bearingnumberyes
util_tubenumberyes
util_weldnumberyes

WasmImposedInput ​

Used by as1170_1_imposed.

FieldTypeRequiredDescription
categorystringyes
usestringDefault: "".

WasmInfluenceLineInput ​

Used by influence_line.

FieldTypeRequiredDescription
actionstringyes
n_pointsintegerDefault: 101.
spannumberyes
stationnumberyes
support_typestringyes

WasmInfluenceLineResult ​

Used by influence_line.

FieldTypeRequiredDescription
actionstringyes
ordinatesnumber[]yes
positionsnumber[]yes
spannumberyes
stationnumberyes
supportstringyes

WasmLapInput ​

Used by lap_check.

Cold-formed lap splice (conn_lap.rs). SI in (m, Pa, N); the core works in mm and MPa.

FieldTypeRequiredDescription
bolt_countintegeryes
bolt_dianumberyes
bolt_gradestringyes
eccentricitynumberThe ply standoff: how far the bolt line sits off the member's own axis. Default: 0.
m_starnumberDefault: 0.
n_starnumberyes
pitchnumberyes
ply1_funumberyes
ply1_tnumberyes
ply2_funumberyes
ply2_tnumberyes
v_starnumberyes

WasmLapResult ​

Used by lap_check.

FieldTypeRequiredDescription
bearingCnumberyes
componentsWasmConnComponent[]yes
govComponentstringyes
govUtilnumberyes
krnumberyes
lapLengthnumberyes
notesstring[]yes
statusstringyes

WasmLoadCase ​

FieldTypeRequiredDescription
idintegeryes
load_case_typeinteger0=Dead, 1=Live, 2=Wind, 3=Seismic, 4=Snow, 5=Other, 6=WindUltimate, 7=WindServiceability, 8=SeismicServiceability Default: 0.
namestringyes
self_weight_factornumberDefault: 0.

WasmLoadCaseResults ​

FieldTypeRequiredDescription
capacity_warningsstring[]Members the selected design code could not check (unsupported section type/class) - a missing capacity record means NOT CHECKED, never OK.
deactivatedinteger[]Members deactivated by the tension/compression-only iteration for this case: zero force, no capacity row, and THIS is what says so.
displacementsWasmNodeDisplacement[]yes
load_case_idintegeryes
member_capacitiesWasmMemberCapacity[]Default: [].
member_forcesWasmMemberForce[]yes
member_station_forcesWasmMemberStationForces[]Default: [].
plate_nodal_resultsWasmPlateNodalResult[]
plate_nodal_results_smoothedWasmPlateNodalResult[]
plate_notesstring[]Information about the plates (orthotropy, compressed plates and the buckling analysis) - NOT a self-check; see AnalysisResults::plate_notes.
plate_resultsWasmPlateResult[]Default: [].
reactionsWasmReaction[]yes
solver_warningsstring[]Numerical self-checks on the solve (equilibrium residual). Non-empty means the displacement solution itself is suspect - surface it.

WasmLoadCombination ​

FieldTypeRequiredDescription
idintegeryes
namestringyes
termsWasmComboTerm[]yesList of { load_case_id, factor } terms

WasmMaterial ​

FieldTypeRequiredDescription
alphanumberDefault: 0.000012.
enumberyes
funumberDefault: 400000000.
fynumberDefault: 250000000.
gnumberyes
idintegeryes
namestringDefault: "".
nunumberDefault: 0.3.
rhonumberDefault: 7850.

WasmMember ​

FieldTypeRequiredDescription
betanumberyes
fixity_aintegerDefault: 0.
fixity_bintegerDefault: 0.
flange_restrainedbooleanCompression flange continuously restrained (e.g. sheeting) -> no LTB. Defaults to false. Default: false.
idintegeryes
ke_xnumberEffective-length factor for major-axis buckling / LTB. Defaults to 1.0. Default: 0.
ke_ynumberEffective-length factor for minor-axis compression buckling. Defaults to 1.0. Default: 0.
material_idintegeryes
member_typeintegeryes
node_aintegeryes
node_bintegeryes
offset_anumber[]Default: [0,0,0].
offset_bnumber[]Default: [0,0,0].
section_idintegeryes

WasmMemberCapacitiesInput ​

Used by member_capacities_only.

FieldTypeRequiredDescription
member_forcesWasmMemberForce[]Optional member forces for alpha_m / utilisation update. If provided, must contain one entry per member with solved end forces. Default: [].
modelWasmModelyes

WasmMemberCapacitiesOutput ​

Used by member_capacities_only.

FieldTypeRequiredDescription
capacity_warningsstring[]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_capacitiesWasmMemberCapacity[]yes

WasmMemberCapacity ​

FieldTypeRequiredDescription
angleAngleWorking | nullAS 4100 Cl 8.4.6 parts for a single angle truss member (SA-115); absent otherwise.
assumptionsWasmCapacityAssumptionsyes
axis_xWasmAxisCapacityyes
axis_yWasmAxisCapacityyes
codestringDesign code: "AS4100" (hot-rolled) or "AS4600" (cold-formed DSM). Default: "".
compressionWasmCompressionCapacityyes
dsmDsmCapacity | nullDSM mode breakdown (local/distortional/global) when code == "AS4600".
fynumberyes
member_idintegeryes
phinumberyes
phiMoxnumberyes
phiMoynumberyes
phiMrxnumberyesThe 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.
phiMrynumberyes
phiNtnumberyes
phiVvnumberyes
phiVvMinornumberMinor-axis shear capacity (N), for Vz across the section's width (SA-39); 0 where the code path does not compute it. Default: 0.
utilBiaxialMembernumberyes
utilBiaxialSectionnumberyes
utilMaxnumberyes

WasmMemberForce ​

FieldTypeRequiredDescription
fx1numberyes
fx2numberyes
fy1numberyes
fy2numberyes
fz1numberyes
fz2numberyes
member_idintegeryes
mx1numberyes
mx2numberyes
my1numberyes
my2numberyes
my_spannumberAs mz_span, for |My| (minor axis). Default: 0.
mz1numberyes
mz2numberyes
mz_quartersnumber[]|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_spannumberThe 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 ​

FieldTypeRequiredDescription
end_rationumberDefault: 0.
load_case_idintegeryes
load_typeintegerDefault: 0.
member_idintegeryes
qxnumberyes
qx2numberDefault: 0.
qynumberyes
qy2numberDefault: 0.
qznumberyes
qz2numberDefault: 0.
start_rationumberDefault: 0.

WasmMemberStationForces ​

FieldTypeRequiredDescription
member_idintegeryes
stationsWasmStationForce[]yes

WasmModalInput ​

Used by solve_model_modal_with_options.

The input of solve_model_modal_with_options: the model and the modal options.

FieldTypeRequiredDescription
modelWasmModelyes
optionsWasmModalOptionsDefault: {"mass_matrix":"","n_modes":0}.

WasmModalMode ​

FieldTypeRequiredDescription
eigenvaluenumberyes
frequency_hznumberyes
indexintegeryes
modal_mass_kgnumberModal mass (kg) for the unity-normalised shape (largest nodal translation = 1); SCI P354's M_n. Default: 0.
mode_shapeWasmNodeDisplacement[]yes
unity_scalenumberMultiply a mode_shape translation by this to get the unity-normalised amplitude mu. Default: 1.

WasmModalOptions ​

FieldTypeRequiredDescription
mass_matrixstringDefault: "".
n_modesintegerDefault: 0.

WasmModalResults ​

Used by solve_model_modal.

FieldTypeRequiredDescription
modesWasmModalMode[]yes
warningsstring[]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.

FieldTypeRequiredDescription
cablesWasmCable[]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_codestringDesign code for member capacity checks: "AS4100" (default), "AISC360", "EC3". Default: "AS4100".
diaphragmsWasmDiaphragm[]Default: [].
double_angle_connectorsDoubleAngleConnectors[]Double-angle interconnectors (SA-156) - see model::DoubleAngleConnectors; the core type's own serde shape is the wire shape. Default: [].
end_gapsWasmEndGap[]Member-end gaps (ADR 0013 Step 2): &#123; member_id, gap_mm &#125; on truss / compression-only members. Default: [].
load_casesWasmLoadCase[]yes
load_combinationsWasmLoadCombination[]Default: [].
materialsWasmMaterial[]yes
member_loadsWasmMemberLoad[]yes
membersWasmMember[]yes
nodal_loadsWasmNodalLoad[]yes
nodesWasmNode[]yes
plate_loadsWasmPlateLoad[]Default: [].
plate_orthotropyPlateOrthotropy[]Orthotropic plates: &#123; plate_id, axis: [x, y, z], input: &#123; kind: "material", e1, e2, g12, nu12, g13, g23 &#125; | &#123; kind: "rigidities", a11, a22, a12, a66, d11, d22, d12, d66, s13, s23 &#125; &#125;. The core type's own serde shape is the wire shape; see model::PlateOrthotropy. Default: [].
platesWasmPlate[]Default: [].
sectionsWasmSection[]yes
shear_centre_loadedinteger[]Member ids loaded at the shear centre rather than on the top flange (the default) - see model::Model::shear_centre_loaded. Default: [].

WasmModeResponse ​

FieldTypeRequiredDescription
baseShearnumberyes
effectiveMassnumberyes
frequencyHznumberyes
modeIndexintegeryes
participationFactornumberyes
periodSnumberyes
spectralAccelnumberyes

WasmMomentBaseInput ​

Used by moment_base_check.

FieldTypeRequiredDescription
boltDiameternumberyes
columnBfnumberDefault: 0.
columnDnumberyes
concreteFcnumberyes
gradestringDefault: "8.8".
mStarnumberyes
nStarnumberDefault: 0.
nTensionintegeryes
plateBnumberyes
plateDnumberyes
plateFynumberyes
plateTnumberyes
vStarnumberDefault: 0.

WasmMomentBaseResult ​

Used by moment_base_check.

FieldTypeRequiredDescription
anchorTensionnumberyes
bearingLengthnumberyes
componentsWasmConnComponent[]yes
govComponentstringyes
govUtilnumberyes
notesstring[]yes
statusstringyes

WasmMovingLoadInput ​

Used by moving_load_effect.

FieldTypeRequiredDescription
actionstringyes
n_pointsintegeryes
spannumberyes
stationnumberyes
support_typestringyes
vehicleWasmVehicleyes

WasmMovingLoadResult ​

Used by moving_load_effect.

FieldTypeRequiredDescription
critical_position_maxnumberyes
critical_position_minnumberyes
max_valuenumberyes
min_valuenumberyes

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.

FieldTypeRequiredDescription
controlstringDefault: "".
dsnumber | null
fibersintegerDefault: 16.
fynumber | null
hardeningnumberDefault: 0.
load_case_idintegerDefault: 0.
materialstringDefault: "".
max_iterationsintegerDefault: 60.
n_stepsintegerDefault: 20.
tolerancenumberDefault: 0.000001.

WasmNodalLoad ​

FieldTypeRequiredDescription
fxnumberyes
fynumberyes
fznumberyes
load_case_idintegeryes
mxnumberDefault: 0.
mynumberDefault: 0.
mznumberDefault: 0.
node_idintegeryes

WasmNode ​

FieldTypeRequiredDescription
idintegeryes
massnumberDefault: 0.
restraint_flagsintegeryes
settlementnumber[]Default: [0,0,0,0,0,0].
spring_stiffnessnumber[]Default: [0,0,0,0,0,0].
support_no_tensionbooleanBears but cannot pull (ADR 0013 Step 2); honoured by the 3D nonlinear path only. Default: false.
xnumberyes
ynumberyes
znumberyes

WasmNodeDisplacement ​

FieldTypeRequiredDescription
node_idintegeryes
rxnumberyes
rynumberyes
rznumberyes
uxnumberyes
uynumberyes
uznumberyes

WasmNotionalInput ​

Used by as4100_notional_force.

FieldTypeRequiredDescription
adequately_bracedbooleanLegacy input from before the 2020 edition's single factor; accepted and ignored. Default: false.
multi_storeybooleanAS 4100 Cl 3.2.4 applies to multi-storey buildings only. Default true. Default: true.
total_gravity_loadnumberyesTotal design vertical load applied at the floor level (N).

WasmNotionalResult ​

Used by as4100_notional_force.

FieldTypeRequiredDescription
forcenumberyes

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.

FieldTypeRequiredDescription
annual_probabilitynumberyes
munumberyesStructural ductility factor mu, Cl 4.3.
n_maxnumber | nullDefault: null.
near_fault_kmnumber | nullDefault: null.
periodnumberyesT1, the largest translational period in the direction considered (Cl 4.1).
soilstringyes
spnumberyesStructural performance factor Sp, Cl 4.4.
znumberyes

WasmNzDesignCoefficientResult ​

Used by nzs1170_design_coefficient.

FieldTypeRequiredDescription
c_tnumberyes
cdnumberyes
cd_unfloorednumberyes
clausestringyes
floornumberyes
floor_governsbooleanyesTrue when Eq 5.2(2)'s floor decided the answer.
k_munumberyes
rnumberyes
r_cappedbooleanyes
spnumberyes

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.

FieldTypeRequiredDescription
annual_probabilitynumberyes
munumberyesStructural ductility factor mu, Cl 4.3.
n_maxnumber | nullDefault: null.
near_fault_kmnumber | nullDefault: null.
soilstringyes
spnumberyesStructural performance factor Sp, Cl 4.4.
znumberyes

WasmNzDesignSpectrumResult ​

Used by nzs1170_design_spectrum.

FieldTypeRequiredDescription
citationstringyesThe same sentence the UI prints beside the numbers, so the reading travels with them.
clausestringyes
flooredbooleanyesTrue when the floor decided at least one ordinate, for a one-line caveat.
floored_periodsnumber[]yesThe periods where Eq 5.2(2)'s floor decided the ordinate rather than Eq 5.2(1).
munumberyes
points[number, number][]yes(period s, Cd) pairs, one per Table 3.1 period, ascending.
rnumberyes
r_cappedbooleanyes
spnumberyes
znumberyes

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.

FieldTypeRequiredDescription
annual_probabilitynumberyes
levels[number, number][]yes(seismic weight N, height above base m) per level, in any order.
munumberyes
n_maxnumber | nullDefault: null.
near_fault_kmnumber | nullDefault: null.
periodnumberyes
soilstringyes
spnumberyes
weightnumber | nullSeismic weight Wt, newtons (Cl 4.2). Omit to have it summed from levels. Default: null.
znumberyes

WasmNzEquivalentStaticResult ​

Used by nzs1170_equivalent_static.

FieldTypeRequiredDescription
base_shearnumberyes
cdnumberyes
cd_unfloorednumberyes
clausestringyes
floor_governsbooleanyes
k_munumberyes
levelsWasmNzStoreyForce[]yes
seismic_weightnumberyes

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.

FieldTypeRequiredDescription
annual_probabilitynumberyes
cphnumberyesPart horizontal response factor C_ph, Table 8.2.
hinumberyesHeight of the part's attachment above the base, m. Below ground floor reads as ground floor.
hnnumberyesHeight from the base to the uppermost seismic mass, m.
n_maxnumber | nullDefault: null.
near_fault_kmnumber | nullDefault: null.
rpnumberyesPart risk factor R_p, Table 8.1.
soilstringyes
tpnumberyesPeriod of the part itself, seconds (Cl 8.4).
wpnumberyesWeight of the part, newtons.
znumberyes

WasmNzPartResult ​

Used by nzs1170_part_force.

FieldTypeRequiredDescription
c_hinumberyes
c_inumberyes
c_zeronumberyesC(0), from Table 3.1's BRACKETED column - not the general spectrum at zero period.
cappedbooleanyesTrue when 3.6 W_p decided the answer.
clausestringyes
cpnumberyes
forcenumberyesF_ph, newtons, after Eq 8.5(1)'s 3.6 W_p cap.
unboundednumberyes

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.

FieldTypeRequiredDescription
doubly_symmetricbooleanWhether 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.
kfnumberDefault: 1.
m_star_xnumberyes
m_star_ynumberDefault: 0.
n_starnumberyes
phi_mbxnumberyes
phi_msxnumberyes
phi_msynumberDefault: 0.
phi_ncxnumberyes
phi_ncynumberyes
phi_nsnumberyes
phi_ntnumberyes
phi_vvnumberDefault: 0.
section_classstringyes"compact" | "non-compact" | "slender", from the capacity record.
v_starnumberDefault: 0.

WasmNzs3404CombinedResult ​

Used by nzs3404_combined.

FieldTypeRequiredDescription
governed_bystringyesThe clause the governing check came from, for the report line.
higher_tierbooleanyes
phi_m_ixnumberyes
phi_m_oxnumberyes
phi_m_rxnumberyes
phi_m_rynumberyes
util_axialnumberyes
util_maxnumberyes
util_member_biaxialnumberyes
util_member_in_planenumberyes
util_member_out_of_planenumberyes
util_section_biaxialnumberyes
util_section_xnumberyes
util_section_ynumberyes
util_shearnumberyes

WasmNzs3404MemberInput ​

Used by nzs3404_member_check.

One member, one load case, in the units the studio already speaks: mm, MPa, N and N·mm.

FieldTypeRequiredDescription
agnumberyesGross area, net area (mm²) and the Cl 7.3 correction factor for eccentric end connections.
alpha_mnumberCl 5.6.1.1 moment modification factor. Pass 1.0 for uniform moment. Default: 1.
annumberDefault: 0.
bfnumberDefault: 0.
categorystringyes"1", "2", "3" or "4" - NZS 3404 Section 12. No default: see the note above.
dnumberyesOverall depth, flange width, flange thickness, web thickness (mm). For a CHS, d is the outside diameter and tw the wall.
doubly_symmetricbooleanWhether 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.
enumberElastic and shear moduli (MPa). Default to the standard's steel values. Default: 200000.
familystringyesWhich shear-area and slenderness family the outline belongs to: "hot-rolled-i", "welded-i", "rhs", "chs".
funumberyesTensile strength (MPa).
fyfnumberyesFlange yield stress (MPa) - Cl 5.2.1 reads the FLANGE value, not the lower of flange and web.
fywnumberWeb yield stress (MPa). Default: 0.
gnumberDefault: 80000.
iwnumberyes
iynumberyesSecond 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.
jnumberyes
kfnumberForm factor (Cl 6.2). 1.0 for a fully effective section. Default: 1.
ktenumberDefault: 1.
le_ltbnumberyes
lexnumberyesEffective lengths for compression about each axis, and for lateral-torsional buckling (mm).
leynumberyes
m_star_xnumberDefault: 0.
m_star_ynumberDefault: 0.
n_starnumberDesign actions for this load case. n_star is NEGATIVE in compression. Default: 0.
rxnumberyesRadii of gyration (mm).
rynumberyes
sxnumberyes
synumberyes
tfnumberDefault: 0.
twnumberyes
v_starnumberDefault: 0.
zxnumberyesElastic and plastic section moduli about each axis (mm³).
zynumberyes

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.

FieldTypeRequiredDescription
annual_probabilitynumberyesAnnual probability of exceedance, as a fraction: 1/500 is 0.002 (Table 3.5).
n_maxnumber | nullNmax(T) from Table 3.7, which this build does not carry. Default: null.
near_fault_kmnumber | nullShortest distance to a Table 3.6 fault, km. With n_max, drives Cl 3.1.6. Default: null.
periodnumberyesPeriod T, seconds. Table 3.1 stops at 4.5 s and so does this.
soilstringyesSite subsoil class A, B, C, D or E (Cl 3.1.3). A and B are one column of Table 3.1.
znumberyesHazard factor Z (Cl 3.1.4, Table 3.3).

WasmNzSiteHazardResult ​

Used by nzs1170_site_hazard.

FieldTypeRequiredDescription
c_tnumberyes
ch_tnumberyes
clausestringyes
n_t_dnumberyes
rnumberyes
r_cappedbooleanyesTrue when Cl 3.1.1's cap held Z R down to 0.7.
r_tablenumberyes
znumberyes

WasmNzStoreyForce ​

FieldTypeRequiredDescription
forcenumberyes
heightnumberyes
top_lumpnumberyesThe 0.08 V lump, which is non-zero at the top level only.
weightnumberyes

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 &#123; "error": ... &#125;, never as a zero.

FieldTypeRequiredDescription
alpha_degnumberDefault: 0.
bnumberDefault: 0.
blockagenumberDefault: 0.
cnumberDefault: 0.
casestringDefault: "".
cp_enumberDefault: 0.
dnumberDefault: 0.
enclosurestringDefault: "".
frictionstringDefault: "".
hnumberDefault: 0.
hcnumberDefault: 0.
k_lnumberDefault: 1.
kindstringyes
m_dnumberDefault: 1.
m_snumberDefault: 1.
m_tnumberDefault: 1.
parallelbooleanDefault: false.
parapet_hpnumber | nullDefault: null.
regionstringDefault: "A".
return_cornerbooleanDefault: false.
return_period_yearsnumberDefault: 500.
roofstringDefault: "".
slope_degnumberDefault: 0.
soliditynumberDefault: 1.
terrainstringDefault: "TC2".
tributary_area_m2numberDefault: 10.
wcnumberDefault: 0.
windstringDefault: "".

WasmPadFootingInput ​

Used by pad_footing_design.

FieldTypeRequiredDescription
asDowelProvidednumberDefault: 0.
asProvidedXnumberDefault: 0.
asProvidedYnumberDefault: 0.
barDiameternumberDefault: 0.
bearingBasisstringDefault: "allowable".
columnBxnumberyes
columnBynumberyes
columnExnumberDefault: 0.
columnEynumberDefault: 0.
columnPositionstringDefault: "interior".
covernumberyes
designSectionDesignSectionDefault: {"kind":"face"}.
fPrimeCnumberyes
fPrimeCColumnnumberDefault: 0.
fSynumberyes
footingBxnumberyes
footingBynumberyes
footingHnumberyes
mxServicenumberDefault: 0.
mxStarnumberyes
myServicenumberDefault: 0.
myStarnumberyes
nServicenumberDefault: 0.
nStarnumberyes
pedestalHeightnumberDefault: 0.
phiBaseDegnumberDefault: 30.
qBearingnumberyes
reinfClassReinforcementClassDefault: "n".
reinforcedbooleanDefault: true.
selfWeightnumberDefault: 0.
standardFootingCodeDefault: "as3600".
vStarnumberDefault: 0.

WasmPadFootingResult ​

Used by pad_footing_design.

FieldTypeRequiredDescription
aSDowelReqnumberyes
aStMinnumberyes
aStXProvidednumberyes
aStXReqnumberyes
aStYProvidednumberyes
aStYReqnumberyes
bearingStressCapacitynumberyes
bearingStressDemandnumberyes
checksRefusedstring[]yes
contactStatestringyes
cornerPressuresnumber[]yes
dEffnumberyes
developmentAvailableMnumberyes
developmentDetailstringyes
developmentLstMnumberyes
governingstringyes
infinitestring[]yesUtilisation fields that are +Infinity (a decided failure), which JSON would otherwise turn into null and so into "not evaluated". The JS adapter restores them.
kUoXnumberyes
kUoYnumberyes
mXDesignnumberyes
mYDesignnumberyes
notestring | null
overturningEnumberyes
overturningELimitnumberyes
phiBendingXnumberyes
phiBendingYnumberyes
phiVPunchnumberyes
phiVUcnumberyes
plainWasmPlainConcreteCheck | nullPresent only when the caller asked for an UNREINFORCED footing; null otherwise, which is what every existing caller sees.
punchingPerimeternumberyes
qAllowablenumberyes
qMaxnumberyes
slidingResistancenumberyes
thicknessRequirednumberyes
utilBearingnumberyes
utilBearingStressnumberyes
utilDevelopmentnumberyes
utilDowelDevelopmentnumberyes
utilDowelTensionnumberyes
utilMaxnumberyes
utilMomentXnumberyes
utilMomentYnumberyes
utilOverturningnumberyes
utilPedestalnumberyes
utilPunchingnumberyes
utilShearnumberyes
utilSlidingnumberyes
vPunchnumberyes
vUcnumberyes
vXnumberyes
vYnumberyes

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).

FieldTypeRequiredDescription
annual_probabilitynumber | null
ductilitystring"flexible-ductile", "rigid", "non-ductile" or "connection" (Cl 8.2). Default: "".
floor_accelerationnumber | nullCl 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_mnumber | nullCl 8.3: total height of the structure above the structural base, metres. Default: null.
hx_mnumber | nullCl 8.3: height at which the component is attached above the structural base, metres. Default: null.
importancestring"importance-level-4", "life-safety-critical" or "other" (Cl 8.2). Default: "".
locationstring | nullTable 3.2 location name, or pass z directly from Figure 3.2. Default: null.
mechanical_or_electricalbooleanCl 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.
methodstringDefault: "".
mountingstring"flexible-spring-mechanical" or "other" (Cl 8.2). Default: "".
soilstringyesSite sub-soil class Ae to Ee; Table 6.4's BRACKETED Ch(0) is the one Section 8 uses.
weight_nnumberyesW_c, the component's seismic weight, in NEWTONS.
znumber | nullDefault: null.

WasmPartResult ​

Used by as1170_part_force.

FieldTypeRequiredDescription
a_cnumberyes
a_floornumberyes
acceleration_flooredbooleanyes
boundstringyes"computed", "lower" (0.05 W_c governed) or "upper" (0.5 W_c governed).
clausestringyes
force_nnumberyes
height_amplificationnumber | null
i_cnumberyes
r_cnumberyes
unbounded_nnumberyes
vertical_nnumber | nullCl 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.

FieldTypeRequiredDescription
dDesignnumberyesDesign depth D used by Section 20, m. Not d_eff: plain concrete has no bar to measure to.
fCtFnumberyesCharacteristic flexural tensile strength, MPa (Cl 3.1.1.3, 0.6*sqrt(f'c)).
meetsMinDepthbooleanyesCl 20.2: does the pad meet the minimum depth for a plain footing?
phiMuonumberyes
phiVunumberyes
utilMomentnumberyes
utilShearnumberyes

WasmPlate ​

Input model for WASM. Quad-only: triangles are not supported by the current formulation.

FieldTypeRequiredDescription
idintegeryes
material_idintegeryes
node_idsinteger[]yesThree ids (a triangle, stored [a, b, c, c]) or four (a quad).
thicknessnumberyes

WasmPlateCompactness ​

FieldTypeRequiredDescription
lambda_enumberyes
lambda_epnumberyes
lambda_eynumberyes

WasmPlateLoad ​

FieldTypeRequiredDescription
load_case_idintegeryes
plate_idintegeryes
pressurenumberyes

WasmPlateNodalResult ​

FieldTypeRequiredDescription
mxnumberyes
mxynumberyes
mynumberyes
node_idintegeryes
plate_idintegeryes
sxnumberyes
synumberyes
txynumberyes
vonMisesnumberyes
vonMisesMembranenumbervon Mises of the membrane stresses only; vonMises is the surface peak (SA-45). Default: 0.

WasmPlateResult ​

FieldTypeRequiredDescription
bucklingFactornumber | null
material_axesMaterialAxisResult | nullOrthotropic plates only: m1/m2/m12 and n1/n2/n12 along the grain (see model::MaterialAxisResult).
mxnumberyes
mx_star_bottomnumberyes
mx_star_topnumberyes
mxynumberyes
mynumberyes
my_star_bottomnumberyes
my_star_topnumberyes
plate_idintegeryes
sigma1Bottomnumberyes
sigma1Topnumberyes
sigma2Bottomnumberyes
sigma2Topnumberyes
sxnumberyes
sxBottomnumberyes
sxTopnumberyes
synumberyes
syBottomnumberyes
syTopnumberyes
thetaPBottomnumberyes
thetaPTopnumberyes
txynumberyes
vonMisesnumberyes
vonMisesMembranenumbervon Mises of the membrane stresses only; vonMises is the surface peak (SA-45). Default: 0.

WasmPoint2 ​

FieldTypeRequiredDescription
xnumberyes
ynumberyes

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: &#123; ratio, wall: "none"\|"x0"\|"xb"\|"y0"\|"yl", at_m &#125; and trib (one frame's tributary width, m). Returns &#123; directions: [...] &#125; or &#123; error &#125;.

FieldTypeRequiredDescription
alpha_degnumberDefault: 0.
bnumberyes
dnumberyes
h_enumberyes
m_dnumberDefault: 1.
m_snumberDefault: 1.
m_tnumberDefault: 1.
open_rationumberDefault: 0.
openingDominantOpening | nullDefault: null.
regionstringyes
return_period_yearsnumberDefault: 500.
roofstringDefault: "".
terrainstringyes
tribnumberDefault: 0.

WasmPressureFieldInput ​

Used by footing_pressure_field.

FieldTypeRequiredDescription
bxnumberyes
bynumberyes
mxnumberyes
mynumberyes
nnumberyes
nxintegerDefault: 25.
nyintegerDefault: 25.

WasmPurlinCleatInput ​

Used by purlin_cleat_check.

Purlin cleat (conn_purlin.rs). SI in (m, Pa, N); the core works in mm and MPa.

FieldTypeRequiredDescription
bolt_countintegeryes
bolt_dianumberyes
bolt_gradestringyes
bolt_heightnumberyes
cleat_bnumberyes
cleat_edgenumberyes
cleat_funumberyes
cleat_fynumberyes
cleat_tnumberyes
purlin_funumberyes
purlin_tnumberyes
v_latnumberDefault: 0.
v_starnumberyes
weld_legnumberyes

WasmPurlinCleatResult ​

Used by purlin_cleat_check.

FieldTypeRequiredDescription
bearingCnumberyes
phiBoltShearnumberyes
phiCleatBearingnumberyes
phiCleatBendingnumberyes
phiCleatTearoutnumberyes
phiPurlinBearingnumberyes
phiWeldShearnumberyes
util_bolt_shearnumberyes
util_cleat_bearingnumberyes
util_cleat_bendingnumberyes
util_maxnumberyes
util_purlin_bearingnumberyes
util_weldnumberyes
v_latnumberyes
v_starnumberyes

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.

FieldTypeRequiredDescription
columnsColumnLoad[]yes
dEffnumberyes
eConcretenumberDefault: 30000000000.
fPrimeCnumberyes
fSynumberyes
fidelityMeshFidelityDefault: "light".
holesnumber[][][]Default: [].
ksnumberyes
ksHinumberyes
ksLonumberyes
nunumberDefault: 0.2.
outernumber[][]yes
selfWeightnumberDefault: 0.
thicknessnumberyes

WasmRcBarRow ​

FieldTypeRequiredDescription
countintegeryes
diameternumberyes

WasmRcBeamCapacityInput ​

Used by rc_beam_section_capacity.

FieldTypeRequiredDescription
bnumberyesSection width (m).
bottom_barsWasmRcBarRowyesBottom reinforcement row.
covernumberyesConcrete cover to bar centroid (m).
e_cnumberConcrete elastic modulus (Pa). Defaults to 30 GPa. Default: 30000000000.
e_snumberSteel elastic modulus (Pa). Defaults to 200 GPa. Default: 200000000000.
f_prime_cnumberyesConcrete compressive strength f'c (Pa).
f_synumberyesSteel yield stress fsy (Pa).
hnumberyesSection height (m).
kappa_maxnumberMaximum curvature for the M-κ curve (1/m). Default: 0.005.
mesh_sizenumberFiber mesh size (m). Smaller = more accurate but slower. Default: 0.002.
n_kappa_pointsintegerNumber of points on the M-κ curve. Default: 20.
top_barsWasmRcBarRow | nullTop reinforcement row (optional). Default: null.

WasmRcBeamCapacityOutput ​

Used by rc_beam_section_capacity.

FieldTypeRequiredDescription
area_concretenumberyesPlain concrete area, b × h (m²).
area_transformednumberyesTransformed gross area, concrete + n·A_s (m²).
d_na_crackednumberyesCracked neutral-axis depth from extreme compression fibre (m).
i_crackednumberyesCracked second moment of area about cracked neutral axis (m⁴).
i_grossnumberyesGross second moment of area about centroidal x-axis (m⁴).
k_uonumberyesNeutral-axis parameter k_uo = c / d_o at ultimate.
m_crnumberyesCracking moment (N·m).
m_unumberyesNominal ultimate moment capacity from AS 3600 stress block (N·m).
moment_curvatureWasmRcMomentCurvaturePoint[]yesMoment-curvature curve.
phinumberyesCapacity reduction factor, AS 3600 Table 2.2.2 (ductility-dependent, 0.65 to 0.85).
phi_m_unumberyesCapacity-reduced ultimate moment phi * M_u (N·m).
y_centroidnumberyesGross section centroid height from bottom (m).

WasmRcBeamInput ​

Used by as3600_rc_beam_moment.

FieldTypeRequiredDescription
a_scnumberDefault: 0.
a_stnumberyes
bnumberyes
dnumberyes
d_scnumberDefault: 0.
f_prime_cnumberyes
f_synumberyes

WasmRcBeamResult ​

Used by as3600_rc_beam_moment.

FieldTypeRequiredDescription
anumberyes
kUnumberyes
overReinforcedbooleanyes
phinumberyes
phiMunumberyes

WasmRcBeamServiceInput ​

Used by as3600_rc_beam_serviceability.

FieldTypeRequiredDescription
a_scnumberDefault: 0.
a_stnumberyes
bnumberyesSI 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)
dnumberyes
d_scnumberDefault: 0.
d_sectionnumberyes
defl_limitnumber | nullDefault: null.
e_snumber | nullDefault: null.
eps_csnumber | nullDefault: null.
f_prime_cnumberyes
gnumberyes
m_snumber | nullM_s* in N.m, required for continuous spans Default: null.
psi_lnumberyes
psi_snumberyes
qnumberyes
spannumberyes
supportBeamSupportyes"simply_supported" | "cantilever" | "continuous_end" | "continuous_interior"

WasmRcBiaxialInput ​

Used by rc_column_interaction_surface_3d.

FieldTypeRequiredDescription
bnumberyes
f_prime_cnumberyesConcrete compressive strength f'c (Pa).
f_synumberyesSteel yield stress fsy (Pa).
hnumberyes
mesh_sizenumberFiber mesh size (m). Defaults to 0.005. Default: 0.002.
n_cintegerNumber of neutral-axis depths per angle (>= 3). Default: 21.
n_thetaintegerNumber of neutral-axis angles to sweep (>= 2). Default: 8.
rebarsWasmRcRebar[]Reinforcing bars as a list of {x, y, area} (SI units). Default: [].

WasmRcBiaxialOutput ​

Used by rc_column_interaction_surface_3d.

FieldTypeRequiredDescription
n_cintegeryes
n_thetaintegeryes
pointsWasmRcBiaxialPoint[]yes

WasmRcBiaxialPoint ​

FieldTypeRequiredDescription
m_xnumberyes
m_ynumberyes
pnumberyes

WasmRcColumnCurvePoint ​

FieldTypeRequiredDescription
cnumberyes
labelstringyes
mnumberyes
nnumberyes
phinumberyes
phiMnumberyes
phiNnumberyes

WasmRcColumnCurveResult ​

Used by as3600_rc_column_interaction_curve.

FieldTypeRequiredDescription
mBalancednumberyes
nBalancednumberyes
phiMunumberyes
phiNuonumberyes
pointsWasmRcColumnCurvePoint[]yes

WasmRcColumnInput ​

Used by as3600_rc_column_capacity, as3600_rc_column_interaction_curve.

FieldTypeRequiredDescription
a_scnumberyes
a_stnumberyes
bnumberyes
dnumberyes
d_scnumberDefault: 0.
d_sectionnumberyes
f_prime_cnumberyes
f_synumberyes
m_starnumberyes
n_starnumberyes

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.

FieldTypeRequiredDescription
curveWasmRcColumnCurveResultyes
phiMNnumberyes
phiMunumberyes
phiNuonumberyes
util_interactionnumberyes
util_mnumberyes
util_maxnumberyes
util_nnumberyes

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.

FieldTypeRequiredDescription
covernumber | nullDefault: null.
f_prime_cnumberyes
f_synumber | nullDefault: null.
h_ynumberyes
h_znumberyes
lengthnumberDefault: 0.
member_idintegeryes
my_neg_znumberDefault: 0.
my_pos_znumberDefault: 0.
mz_neg_ynumberDefault: 0.
mz_pos_ynumberDefault: 0.
n_maxnumberDefault: 0.
n_minnumberDefault: 0.
v_ynumberDefault: 0.
v_znumberDefault: 0.
verticalbooleanDefault: false.

WasmRcDesignOut ​

Used by as3600_rc_design_batch.

The steel one member needs, SI: areas in m², shears in N.

FieldTypeRequiredDescription
asTotalnumberyes
astNegYnumberyes
astNegZnumberyes
astPosYnumberyes
astPosZnumberyes
fitmentsNeededbooleanyes
kUnumberyes
kindstringyes
leRnumberyes
memberIdintegeryes
notesstring[]yes
pReqnumberyes
phiVucYnumberyes
phiVucZnumberyes
rationumber | nullk_u / 0.36 (beam) or p / 4 % (column); null when the section is too small.
statusRcDesignStatusyes

WasmRcMemberInput ​

Used by as3600_rc_member_check.

FieldTypeRequiredDescription
a_scnumberDefault: 0.
a_stnumberyes
bnumberyes
dnumberyes
d_scnumberDefault: 0.
d_sectionnumberyes
f_prime_cnumberyes
f_synumberyes
m_starnumberyes
n_starnumberyes
v_starnumberyes

WasmRcMemberResult ​

Used by as3600_rc_member_check.

FieldTypeRequiredDescription
governingstringyes
phiMNnumberyes
phiMunumberyes
phiNuonumberyes
phiVucnumberyes
util_axialnumberyes
util_bendingnumberyes
util_interactionnumberyes
util_maxnumberyes
util_shearnumberyes

WasmRcMomentCurvaturePoint ​

FieldTypeRequiredDescription
kappanumberyes
mnumberyes

WasmRcRebar ​

FieldTypeRequiredDescription
areanumberyes
xnumberyes
ynumberyes

WasmRcShearInput ​

Used by as3600_rc_beam_shear.

FieldTypeRequiredDescription
a_stnumberyes
bnumberyes
dnumberyes
d_overallnumberOverall 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_cnumberyes

WasmRcShearResult ​

Used by as3600_rc_beam_shear.

FieldTypeRequiredDescription
phinumberyes
phiVucnumberyes
rhoWnumberyes
vUcnumberyes

WasmReaction ​

FieldTypeRequiredDescription
mxnumberyes
mynumberyes
mznumberyes
node_idintegeryes
rxnumberyes
rynumberyes
rznumberyes

WasmResponseSpectrumInput ​

Used by response_spectrum_analysis.

FieldTypeRequiredDescription
combination_methodstringDefault: "SRSS".
damping_rationumberDefault: 0.05.
directionstringyes
modelWasmModelyes
n_modesintegerDefault: 10.
spectrum_pointsnumber[][]yesSpectrum points as [[period_s, accel_m_s2], ...]

WasmResponseSpectrumResult ​

Used by response_spectrum_analysis.

FieldTypeRequiredDescription
combination_methodstringyes
combined_base_shearnumberyes
combined_displacementsWasmNodeDisplacement[]yes
damping_rationumberyes
directionstringyes
mode_responsesWasmModeResponse[]yes
total_effective_massnumberyes
total_massnumberyes

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.

FieldTypeRequiredDescription
auto_restrainedWasmSingularDof[]Zero-stiffness DOFs auto-restrained so the model could solve (aggregated across load cases, de-duplicated). Empty/omitted for a clean model.
combinationsWasmCombinationResults[]
combo_stations_omittedbooleanThe 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.
conditioningWasmSoftDof[]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.
envelopeWasmEnvelopeResults | null
load_casesWasmLoadCaseResults[]yes

WasmRetainingWallInput ​

Used by retaining_wall_design.

FieldTypeRequiredDescription
baseThicknessnumberyes
baseWidthnumberyes
covernumberyes
fPrimeCnumberyes
fSynumberyes
gammaSoilnumberyes
gamma_concnumberDefault: 24.
kanumberyes
phi_base_degnumberDefault: 30.
qAllowablenumberyes
stemThicknessBasenumberyes
stemThicknessTopnumberyes
toeLengthnumberyes
wallHeightnumberyes

WasmRetainingWallResult ​

Used by retaining_wall_design.

FieldTypeRequiredDescription
eccentricitynumberyes
governingstringyes
heelAstnumberyes
heelMomentnumberyes
overturningMomentnumberyes
panumberyes
paHeightnumberyes
qMaxnumberyes
qMinnumberyes
restoringMomentnumberyes
resultantXnumberyes
slidingResistancenumberyes
stemAstnumberyes
stemMomentnumberyes
utilBearingnumberyes
utilHeelnumberyes
utilMaxnumberyes
utilOverturningnumberyes
utilSlidingnumberyes
utilStemnumberyes

WasmRidgeTieInput ​

Used by ridge_tie_cleat_check.

FieldTypeRequiredDescription
bolt_diameternumberyes
bolt_gradestringDefault: "8.8".
enumberyesWeld line to the bolt group's centroid (m).
n_boltsintegeryes
n_starnumberDefault: 0.
plate_bnumberyes
plate_funumberyes
plate_fynumberyes
plate_tnumberyes
tie_endnumberDefault: 0.
tie_funumberDefault: 440000000.
tie_twnumberyes
v_starnumberDefault: 0.
weld_fuwnumberDefault: 480000000.
weld_legnumberyes

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 }

FieldTypeRequiredDescription
classstringyes
column_storey_reaction_knnumberDefault: 0.
constructionstringDefault: "".
gk_kpanumberDefault: 0.
psinumberDefault: 1.
qk_kpanumberDefault: 0.
storeysintegerDefault: 1.
tie_spacing_mnumberDefault: 0.
tie_span_mnumberDefault: 0.
wall_clear_height_mnumberDefault: 0.
wall_plan_area_mm2numberDefault: 0.
wall_thickness_mnumberDefault: 0.
z_mnumberDefault: 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.

FieldTypeRequiredDescription
bolt_countintegeryes
bolt_dianumberyes
bolt_gradestringyes
lug_edgenumberyes
lug_funumberyes
lug_tnumberyes
n_starnumberyes
n_star_boltsnumberDefault: 0.
pin_dianumberyes
pin_fynumberyes
pin_shear_planesintegerDefault: 2.
rod_dianumberyes
rod_funumberyes
rod_fynumberyes
threadedbooleanDefault: true.
v_star_boltsnumberDefault: 0.

WasmRodBraceResult ​

Used by rod_brace_check.

FieldTypeRequiredDescription
n_starnumberyes
phiBoltShearnumberyes
phiBoltTensionnumberyes
phiLugBearingnumberyes
phiLugTearoutnumberyes
phiPinBearingnumberyes
phiPinShearnumberyes
phiRodnumberyes
rodAn_mm2numberyes
util_boltsnumberyes
util_lugnumberyes
util_maxnumberyes
util_pin_bearingnumberyes
util_pin_shearnumberyes
util_rodnumberyes

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.

FieldTypeRequiredDescription
beam_dnumberyes
beam_fynumberyes
beam_tfnumberyes
beam_twnumberyes
seat_fynumberyes
seat_lennumberyes
seat_tnumberyes
seat_wnumberyes
stiff_fynumberyes
stiff_hnumberyes
stiff_tnumberyes
v_starnumberyes
weld_fuwnumberDefault: 480000000.
weld_legnumberyes
weld_lennumberyes

WasmSeatResult ​

Used by seat_check.

FieldTypeRequiredDescription
bearingWidthnumberyes
componentsWasmConnComponent[]yes
govComponentstringyes
govUtilnumberyes
notesstring[]yes
phiBearingBucklingnumberyes
phiBearingYieldnumberyes
statusstringyes

WasmSection ​

FieldTypeRequiredDescription
anumberyes
bfnumberDefault: 0.
cold_formedbooleanDefault: false.
dnumberDefault: 0.
fynumberDefault: 0.
idintegeryes
iwnumberDefault: 0.
iyynumberyes
izznumberyes
jnumberyes
lipnumberDefault: 0.
namestringDefault: "".
syynumberDefault: 0.
szznumberDefault: 0.
tfnumberDefault: 0.
twnumberDefault: 0.
x0numberDefault: 0.
zyynumberDefault: 0.
zzznumberDefault: 0.

WasmSectionBuilderInput ​

Used by section_properties.

FieldTypeRequiredDescription
loopsWasmPoint2[][]yes

WasmSectionBuilderResult ​

Used by section_properties.

FieldTypeRequiredDescription
Asxnumberyes
Asynumberyes
I1numberyes
I2numberyes
Ipnumberyes
Iwnumberyes
Ixxnumberyes
Ixynumberyes
Iyynumberyes
Japproxnumberyes
Jopennumberyes
Sxnumberyes
Synumberyes
Zxapproxnumberyes
Zyapproxnumberyes
areanumberyes
cxnumberyes
cynumberyes
rxnumberyes
rynumberyes
thetaPnumberyes

WasmSectionDimsInput ​

Used by section_props_from_dims.

FieldTypeRequiredDescription
Iw_mm6numberDefault: 0.
Ix_mm4numberDefault: 0.
Iy_mm4numberDefault: 0.
J_mm4numberDefault: 0.
Zx_mm3numberDefault: 0.
area_mm2numberDefault: 0.
categorystringyes
depth_mmnumberyes
flangeThickness_mmnumberDefault: 0.
flangeWidth_mmnumberyes
lipLength_mmnumberDefault: 0.
namestringDefault: "".
webThickness_mmnumberyes

WasmSeismicDistributionInput ​

Used by distribute_seismic_forces.

FieldTypeRequiredDescription
baseShearnumberyes
directionnumber[]yes
distributionDistributionRuleWhich 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".
eccentricityFractionnumberAS 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.
loadCaseIdintegeryes
modelWasmModelyes
periodnumberyes
storeysWasmStoreyDefinition[]Default: [].
vertical_axisstring | nullDefault: null.

WasmSeismicDistributionResult ​

Used by distribute_seismic_forces.

FieldTypeRequiredDescription
knumberyes
nodalLoadsWasmNodalLoad[]yes
storeyForcesWasmStoreyForce[]yes
sumForcesnumberyes
totalBaseShearnumberyes

WasmSeismicInput ​

Used by as1170_seismic_base_shear.

FieldTypeRequiredDescription
annual_probabilitynumber | null
height_mnumber | nullDefault: null.
ktnumber | nullDefault: null.
locationstring | nullDefault: null.
munumber | nullDefault: null.
periodnumber | nullDefault: null.
r_unumber | nullDefault: null.
s_pnumber | nullDefault: null.
soilstringyes
spnumber | nullDefault: null.
systemstring | nullDefault: null.
weightnumberyes
znumber | nullDefault: null.
zonestring | nullDefault: null.

WasmSeismicResult ​

Used by as1170_seismic_base_shear.

FieldTypeRequiredDescription
c_hnumberyes
cdnumberyes
citationstringyes
flooredbooleanyes
kpnumberyes
kp_z_usednumberyes
munumberyes
spnumberyes
t1numberyes
vnumberyes
znumberyes

WasmShearBeam ​

The supported beam, SI (m, Pa). cope: "none" | "top" | "double".

FieldTypeRequiredDescription
bfnumberDefault: 0.
copestringDefault: "".
dnumberyes
d_cbnumberDefault: 0.
d_ctnumberDefault: 0.
funumberDefault: 440000000.
fynumberDefault: 300000000.
fywnumberDefault: 0.
l_cnumberDefault: 0.
tfnumberyes
twnumberyes
weldedbooleanDefault: false.

WasmShearKeyInput ​

Used by shear_key_check.

FieldTypeRequiredDescription
boltDiameternumberDefault: 0.
concreteFcnumberyes
fuwnumberDefault: 480000000.
gradestringDefault: "8.8".
keyBnumberyes
keyFynumberyes
keyHnumberyes
keyTnumberyes
nAnchorintegerDefault: 0.
nStarnumberDefault: 0.
plateBnumberyes
plateDnumberyes
plateFynumberDefault: 0.
plateTnumberDefault: 0.
vStarnumberDefault: 0.
weldLegnumberDefault: 0.

WasmShearKeyResult ​

Used by shear_key_check.

FieldTypeRequiredDescription
componentsWasmConnComponent[]yes
govComponentstringyes
govUtilnumberyes
notesstring[]yes
statusstringyes

WasmShearPlateInput ​

Used by shear_plate_check.

FieldTypeRequiredDescription
anumberDefault: 0.
a_eh_beamnumberDefault: 0.
a_evnumberyesPlate edge distance to the end bolts (vertical).
beamWasmShearBeam | nullThe 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_bfnumberDefault: 0.
beam_copestringThe 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_dnumberDefault: 0.
beam_d_cbnumberDefault: 0.
beam_d_ctnumberDefault: 0.
beam_funumberDefault: 440000000.
beam_fynumberDefault: 300000000.
beam_l_cnumberDefault: 0.
beam_tfnumberDefault: 0.
beam_twnumberDefault: 0.
bolt_countintegerDefault: 0.
bolt_diameternumberyes
bolt_gradestringDefault: "8.8".
colsintegerDefault: 1.
gaugenumberDefault: 0.
kindstring"fep" (flexible end plate) or "wsp" (web side plate / fin plate, the default). Default: "wsp".
pitchnumberyes
plate_bnumberyes
plate_funumberyes
plate_fynumberyes
plate_tnumberyes
rowsintegerRows, or leave 0 and give the total bolt_count: rows = ceil(count / cols). Default: 0.
s_g1numberWSP: weld line to the first bolt column, the beam's end distance, beam top to the top bolt. Default: 0.
threads_includedbooleanDefault: true.
v_starnumberDefault: 0.
weld_fuwnumberDefault: 480000000.
weld_legnumberyes

WasmShearPlateResult ​

Used by shear_plate_check.

FieldTypeRequiredDescription
componentsWasmConnComponent[]yes
dInumberyes
enumberyes
govComponentstringyes
govUtilnumberyes
governingstringyes
kindstringyes
notesstring[]yes
phiVDesnumberyesLeast component capacity (N) and its key (Va..Vh), whatever the demand.
statusstringyes

WasmShearTorsionInput ​

Used by rc_shear_torsion_combined.

FieldTypeRequiredDescription
aStnumberyes
bnumberyes
dnumberyes
fPrimeCnumberyes
hnumberyes
tStarnumberyes
vStarnumberyes

WasmShearTorsionResult ​

Used by rc_shear_torsion_combined.

FieldTypeRequiredDescription
governingstringyes
phiTUcnumberyes
phiVUcnumberyes
utilCombinednumberyes
utilMaxnumberyes
utilTnumberyes
utilVnumberyes

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.

FieldTypeRequiredDescription
dofintegeryes
labelstringyes
nodeintegeryes

WasmSizableSpec ​

One member the optimiser may resize.

FieldTypeRequiredDescription
categorystringyes
current_kgnumberyes
member_idintegeryes

WasmSlabDeflectionInput ​

Used by as3600_slab_deflection.

FieldTypeRequiredDescription
dnumberyes
f_synumberyes
spannumberyes
support_typeintegerDefault: 0.
thicknessnumberDefault: 0.

WasmSlabDeflectionResult ​

Used by as3600_slab_deflection.

FieldTypeRequiredDescription
lOverDActualnumberyes
lOverDLimitnumberyes
util_deflectionnumberyes

WasmSlabInput ​

Used by as3600_slab_check.

FieldTypeRequiredDescription
a_st_per_mnumberyes
col_anumberyes
col_bnumberyes
covernumberyes
dnumberyes
f_prime_cnumberyes
f_synumberyes
m_starnumberyes
mv_starnumberMoment transferred to the support, M*v (N·m); see WasmSlabPunchingInput::mv_star. Default: 0.
n_starnumberyes
spannumberyes
support_typeintegerDefault: 0.
thicknessnumberDefault: 0.

WasmSlabPunchingInput ​

Used by as3600_slab_punching_shear.

FieldTypeRequiredDescription
col_anumberyes
col_bnumberyes
covernumberyes
dnumberyes
f_prime_cnumberyes
mv_starnumberMoment 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_starnumberyes

WasmSlabPunchingResult ​

Used by as3600_slab_punching_shear.

FieldTypeRequiredDescription
betaHnumberyesCl 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.
dnumberyes
f_cvnumberyes
phiVUonumberyes
unumberyes
util_punchingnumberyes
vStarEquivalentnumberyes
vUnumberyes
vUonumberyes

WasmSlabResult ​

Used by as3600_slab_check.

FieldTypeRequiredDescription
a_st_minnumberyes
a_st_providednumberyes
betaHnumberyes
fCvnumberyes
governingstringyes
lOverDActualnumberyes
lOverDLimitnumberyes
phiMunumberyes
phiVUonumberyes
util_deflectionnumberyes
util_maxnumberyes
util_min_steelnumberyes
util_momentnumberyes
util_punchingnumberyes
vStarEquivalentnumberyes

WasmSlabStripInput ​

Used by as3600_slab_strip_moment.

FieldTypeRequiredDescription
a_st_per_mnumberyes
covernumberyes
dnumberyes
f_prime_cnumberyes
f_synumberyes
m_starnumberyes
thicknessnumberDefault: 0.

WasmSlabStripResult ​

Used by as3600_slab_strip_moment.

FieldTypeRequiredDescription
a_st_minnumberyes
a_st_providednumberyes
phiMunumberyes
util_min_steelnumberyes
util_momentnumberyes

WasmSnowInput ​

Used by as1170_snow_load.

FieldTypeRequiredDescription
altitude_mnumberHeight above the Australian Height Datum or New Zealand mean sea level, metres. Default: 0.
annual_probabilitynumber | nullAnnual probability of exceedance, as a fraction: 1/500 is 0.002 (Table 5.1). Default: null.
exposurestringsheltered, semi-sheltered or windswept (Cl 4.2.2). Default: "".
locationstring | nullA named Table 5.2 site, which this build does not carry: refused by name if given. Default: null.
regionstringAS/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_degnumber | nullThe second slope of a duo-pitched roof; absent for a mono-pitched one. Default: null.
roof_pitch_degnumberRoof slope, degrees. Default: 0.
terrain_factornumber | nullTerrain 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.

FieldTypeRequiredDescription
dofintegeryes
labelstringyes
nodeintegeryes
stiffnessRationumberyes

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.

FieldTypeRequiredDescription
modelWasmModelyes
optionsWasmSolveOptionsDefault: {"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).

FieldTypeRequiredDescription
extrapolate_plate_resultsbooleanDefault: false.
n_stationsintegerDefault: 11.
smooth_plate_nodal_resultsbooleanDefault: false.
station_outputStationOutputHow 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.

FieldTypeRequiredDescription
annual_probabilitynumber | nullDefault: null.
locationstring | nullDefault: null.
munumber | nullDefault: null.
soilstringDefault: "".
spnumber | nullDefault: null.
systemstring | nullDefault: null.
znumber | nullDefault: null.

WasmSpliceInput ​

Used by splice_check.

FieldTypeRequiredDescription
boltDiameternumberyes
endDistnumberDefault: 0.
flangeTnumberyes
fpBnumberyes
fpFunumberyes
fpFynumberyes
fpTnumberyes
gradestringDefault: "8.8".
mStarnumberyes
nFlangeintegeryes
nStarnumberDefault: 0.
nWebintegerDefault: 0.
pitchnumberyes
sectionDnumberyes
vStarnumberDefault: 0.
wpTnumberDefault: 0.

WasmSpliceResult ​

Used by splice_check.

FieldTypeRequiredDescription
componentsWasmConnComponent[]yes
govComponentstringyes
govUtilnumberyes
notesstring[]yes
statusstringyes

WasmStationForce ​

FieldTypeRequiredDescription
dynumberyes
dznumberyes
mxnumberyes
mynumberyes
mznumberyes
nnumberyes
snumberyes
s_normnumberyes
vynumberyes
vznumberyes

WasmStoreyDefinition ​

FieldTypeRequiredDescription
elevationnumberyes
nodeIdsinteger[]yes

WasmStoreyForce ​

FieldTypeRequiredDescription
cvnumberyes
elevationnumberyes
forcenumberyes
weightnumberyes

WasmStripFootingInput ​

Used by strip_footing_design.

FieldTypeRequiredDescription
asLongProvidednumberLongitudinal steel provided EACH face, mm^2 (0 = check against max(required, minimum)). Default: 0.
asProvidednumberDefault: 0.
barDiameternumberDefault: 0.
bearingBasisstringDefault: "allowable".
covernumberyes
fPrimeCnumberyes
fSynumberyes
longitudinalBarDiameternumberDefault: 0.
longitudinalSpannumberLength of lost support the strip spans along the wall, m (0 = not designed). Default: 0.
mServicenumberDefault: 0.
mStarnumberDefault: 0.
nServicenumberDefault: 0.
nStarnumberyes
qBearingnumberyes
reinforcedbooleanfalse = an unreinforced strip, checked to AS 3600 Section 20 across its width. Default: true.
selfWeightnumberDefault: 0.
standardFootingCodeDefault: "as3600".
stripThicknessnumberyes
stripWidthnumberyes
wallThicknessnumberyes

WasmStripFootingResult ​

Used by strip_footing_design.

FieldTypeRequiredDescription
aStMinnumberyes
aStReqnumberyes
checksRefusedstring[]yes
contactStatestringyes
dEffnumberyes
developmentDetailstringyes
developmentLstnumberyes
governingstringyes
kUonumberyes
longitudinalWasmStripLongitudinal | nullThe design along the wall, present only when a span of lost support was given.
mDesignnumberyes
notestring | null
phiBendingnumberyes
phiVUcnumberyes
plainWasmPlainConcreteCheck | nullThe Section 20 checks, present only for an unreinforced strip.
qAllowablenumberyes
qMaxnumberyes
qMinnumberyes
utilBearingnumberyes
utilDevelopmentnumberyes
utilMaxnumberyes
utilMomentnumberyes
utilShearnumberyes
vDesignnumberyes

WasmStripLongitudinal ​

The strip designed along the wall over a span of lost support, in the camelCase the browser reads.

FieldTypeRequiredDescription
aStMinnumberyes
aStReqnumberyes
dnumberyes
mDesignnumberyes
phiVUcnumberyes
spannumberyes
utilMomentnumberyes
utilShearnumberyes
vDesignnumberyes
wnumberyes

WasmThroughPlateInput ​

Used by through_plate_check.

A hollow member through a gusset (conn_hollow_brace::through_plate_capacity). SI in; mm/MPa inside.

FieldTypeRequiredDescription
f_starnumberyes
n_slotsintegeryes
n_starnumberyes
plate_tnumberyes
tube_dnumberyes
tube_funumberyes
tube_fynumberyes
tube_tnumberyes
weld_legnumberyes
weld_lennumberyes

WasmThroughPlateResult ​

Used by through_plate_check.

FieldTypeRequiredDescription
f_starnumberyes
n_starnumberyes
phiTubeNetnumberyes
phiWeldnumberyes
util_maxnumberyes
util_through_weldnumberyes
util_tube_throughnumberyes

WasmTimeHistoryInput ​

Used by modal_time_history_analysis.

FieldTypeRequiredDescription
damping_rationumberDefault: 0.05.
directionnumber[]Direction vector [dx, dy, dz] Default: [1,0,0].
modelWasmModelyes
n_modesintegerDefault: 10.
recordnumber[][]yesGround motion record: [[time_s, accel_m_s2], ...]

WasmTimeHistoryResult ​

Used by modal_time_history_analysis.

FieldTypeRequiredDescription
dtnumberyes
n_modesintegeryes
n_stepsintegeryes
peakBaseShearXnumberyes
peakBaseShearYnumberyes
peakBaseShearZnumberyes
peak_displacementsWasmNodeDisplacement[]yes

WasmVehicle ​

FieldTypeRequiredDescription
axle_spacingsnumber[]yes
axle_weightsnumber[]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.

FieldTypeRequiredDescription
b_snumberyesStiff bearing length (m).
both_flanges_restrainedbooleanBoth flanges restrained against lateral movement (default true). Default: true.
d1numberyesClear web depth between flanges (m).
end_distnumberDistance from member end to the nearer edge of the bearing (m). Negative or missing = interior load. Default: -1.
fynumberyesWeb yield stress (Pa).
tfnumberyes
twnumberyes

WasmWebCleatInput ​

Used by web_cleat_check.

FieldTypeRequiredDescription
boltDiameternumberyes
dCleatnumberyes
eSupnumberDefault: 0.
eWebnumberyes
edgeDistnumberDefault: 0.
endDistnumberDefault: 0.
fuCleatnumberyes
fuWebnumberyes
fyCleatnumberyes
gradestringDefault: "8.8".
nSupintegeryes
nWebintegeryes
pitchnumberyes
tCleatnumberyes
tWebnumberyes
vStarnumberyes

WasmWebCleatResult ​

Used by web_cleat_check.

FieldTypeRequiredDescription
componentsWasmConnComponent[]yes
govComponentstringyes
govUtilnumberyes
notesstring[]yes
statusstringyes

WasmWeldedMomentInput ​

Used by welded_moment_check.

FieldTypeRequiredDescription
flangeBnumberyes
flangeCpbwbooleanDefault: true.
flangeLegnumberDefault: 0.
flangeTnumberyes
fuwnumberDefault: 480000000.
fynumberyes
mStarnumberyes
nStarnumberDefault: 0.
sectionDnumberyes
vStarnumberDefault: 0.
webLegnumberDefault: 0.
webTnumberDefault: 0.

WasmWeldedMomentResult ​

Used by welded_moment_check.

FieldTypeRequiredDescription
componentsWasmConnComponent[]yes
govComponentstringyes
govUtilnumberyes
notesstring[]yes
statusstringyes

WasmWeldGroupInput ​

Used by weld_group_check.

FieldTypeRequiredDescription
fuwnumberyes
krnumberyes
mznumberyes
segmentsWasmWeldSegmentInput[]yes
vxnumberyes
vynumberyes

WasmWeldGroupResult ​

Used by weld_group_check.

FieldTypeRequiredDescription
governingSegmentintegeryes
phiVperMmGovnumberyes
phiVtotalnumberyes
util_maxnumberyes
vPerMmGovnumberyes

WasmWeldInput ​

Used by weld_capacity.

FieldTypeRequiredDescription
fuwnumberDefault: 480000000.
krnumberDefault: 1.
leg_sizenumberyes
lengthnumberyes

WasmWeldResult ​

Used by weld_capacity.

FieldTypeRequiredDescription
phiVwnumberyes

WasmWeldSegmentInput ​

FieldTypeRequiredDescription
legSizenumberyes
x1numberyes
x2numberyes
y1numberyes
y2numberyes

WasmWindDesignInput ​

Used by as1170_wind_design.

FieldTypeRequiredDescription
alpha_degnumberDefault: 0.
bnumberyes
dnumberyes
h_enumberyes
m_dnumberDefault: 1.
m_snumberDefault: 1.
m_tnumberDefault: 1.
open_rationumberDefault: 0.
regionstringyes
return_period_yearsnumberDefault: 500.
roofstringDefault: "".
terrainstringyes

WasmWindInput ​

Used by as1170_wind_pressure.

FieldTypeRequiredDescription
heightnumberyes
regionstringyes
return_period_factornumberDefault: 1.
terrainstringyes

WasmWindResult ​

Used by as1170_wind_pressure.

FieldTypeRequiredDescription
mCnumberyes
mZcatnumberyes
pnumberyes
qnumberyes
vDesnumberyes
vRnumberyes

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.

FieldTypeRequiredDescription
standardstringyes
surfacesSurfacePressure[]yes
tablesTableStatus[]yesPer-table verification, the adapter's own statement (WindStandard::table_status).
traceStep[]yes
verifiedbooleanyesALWAYS false until an engineer cross-checks the coefficient tables against the standard.
warningsstring[]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).

FieldTypeRequiredDescription
mxBottomnumberyes
mxTopnumberyes
myBottomnumberyes
myTopnumberyes