Documentation
    Preparing search index...

    Interface Header

    Small structured-clone header fields — everything else in CarapaceInputV1 is a bulk table.

    interface Header {
        engineVersion: string;
        ndm: number;
        recordInitial?: boolean;
        schemaVersion: number;
    }
    Index
    engineVersion ndm recordInitial? schemaVersion
    engineVersion: string

    carapace-core's version, recorded for run provenance.

    ndm: number

    Model dimension: 2 (NDM=2/NDF=3) or 3 (NDM=3/NDF=6). [decode] rejects any other value.

    recordInitial?: boolean

    Record one sample of every supported recorder at the start of each Static/Transient stage, before its first step (the stage's initial conditions, at load factor/time 0). Off by default: every stage's samples are then only the ones its steps produce.

    schemaVersion: number

    The wire format's own version, independent of engine_version.

    Settings
    Member Visibility

    On This Page
    Properties