AutoMovie API
    Preparing search index...

    Interface IAutoMovieFluidDomain

    One independent deterministic fluid computation domain.

    A domain is independent of architecture: IAutoMovieWaterFeature binds it to a logical basin, while a building-free production can use the same domain directly. The grid, state and flow model do not depend on which record owns its placement.

    The fixed-grid, fixed-step shallow-water state stores cell depths/bed elevations and horizontal face velocities. It does not resolve 3D Navier-Stokes flow, breaking waves, vertical recirculation or surface tension. simulateFluidDomain's CPU state is normative; GPU projection supplies no byte-identity guarantee.

    Cell arrays are row-major at row * grid.columns + column, with columns increasing along +X and rows along +Z.

    Authored initial depths sit over the bed with zero face velocity. An uneven free surface, declared flow or open rim drives subsequent motion; this record exposes no initial velocity field.

    The solver assumes caller-run validateFluidDomain admission for version 1, metre units, identity, array lengths, finite authored values, initial depths within design depth, nonsolid flow sites and count budgets. It does not repeat those checks. The Courant comparison uses the initial design depth and can miss derived NaN; integration and surface/spray arithmetic retain separate finite-result and representation limits.

    interface IAutoMovieFluidDomain {
        bed: number[];
        boundaries: IAutoMovieFluidBoundaries;
        depth: number[];
        drains: IAutoMovieFluidDrain[];
        grid: IAutoMovieFluidGrid;
        id: string;
        solid: boolean[];
        solver: IAutoMovieFluidSolver;
        sources: IAutoMovieFluidSource[];
        sprays: IAutoMovieFluidSpray[];
        units: "meter";
        version: 1;
    }
    Index
    bed: number[]

    Finite cell bed elevations in metres above grid.origin.y, row-major with grid.columns * grid.rows entries. Dry ground's world height is grid.origin.y + bed[k].

    Which side of the lattice reflects and which lets water leave.

    depth: number[]

    Initial cell water depths in metres, row-major, each finite and within [0, solver.referenceDepth]. The free surface's world height is grid.origin.y + bed[k] + depth[k].

    Declared outflows such as a return or overflow, at most 256, whose removed volume is counted.

    Fixed computational lattice.

    id: string

    Stable, nonblank identity; validateWaterFeatures also rejects duplicate domain ids in the supplied binding population.

    solid: boolean[]

    Solid-cell flags in row-major order, with grid.columns * grid.rows booleans. A solid cell must have zero depth, touching faces reflect, and no source, drain or spray may occupy it.

    Fixed-step integration settings and declared budgets.

    Declared inflows, at most 256, whose added volume is counted.

    Decorative spray emitters, at most 32, sampled on the same clock outside the conserved depth field. Their particle mass is not added to or removed from water depth.

    units: "meter"

    All authored lengths are measured in metres.

    version: 1

    Schema version; the validator accepts only 1.