|
| int | swmm_2d_is_active (SWMM_Engine engine, int *active) |
| | Check whether the 2D module is active for this simulation.
|
| |
| int | swmm_2d_prepare_for_edit (SWMM_Engine engine) |
| | Make the parsed 2D mesh editable without a full initialize().
|
| |
| int | swmm_2d_vertex_count (SWMM_Engine engine, int *count) |
| | Get the number of mesh vertices.
|
| |
| int | swmm_2d_triangle_count (SWMM_Engine engine, int *count) |
| | Get the number of mesh triangles.
|
| |
| int | swmm_2d_vertex_get_xyz (SWMM_Engine engine, int idx, double *x, double *y, double *z) |
| | Get vertex coordinates.
|
| |
| int | swmm_2d_vertex_get_xyz_bulk (SWMM_Engine engine, double *x, double *y, double *z) |
| | Bulk get vertex coordinates.
|
| |
| int | swmm_2d_set_vertex_z (SWMM_Engine engine, int idx, double z) |
| | Set vertex Z (ground elevation).
|
| |
| int | swmm_2d_set_vertex_z_bulk (SWMM_Engine engine, const double *z, int count) |
| | Set EVERY vertex Z in one call.
|
| |
| int | swmm_2d_triangle_get_vertices (SWMM_Engine engine, int idx, int *v0, int *v1, int *v2) |
| | Get triangle connectivity (3 vertex indices).
|
| |
| int | swmm_2d_cell_count (SWMM_Engine engine, int *count) |
| | Number of cells (triangles + quads) — same value as swmm_2d_triangle_count.
|
| |
| int | swmm_2d_quad_count (SWMM_Engine engine, int *count) |
| | Number of quadrilateral cells (0 for an all-triangle mesh).
|
| |
| int | swmm_2d_edge_stride (SWMM_Engine engine, int *stride) |
| | Edge-slot stride of the bulk edge arrays (swmm_2d_get_edge_flux_bulk, swmm_2d_edge_get_geometry_bulk, swmm_2d_get_edge_conveyance_bulk): 3 for an all-triangle mesh (the historical [tri*3 + localEdge] layout, byte-compatible), 4 once the mesh holds any quad ([cell*4 + localEdge], padding slots of a triangle row are 0). Size every bulk buffer as triangle_count * stride.
|
| |
| int | swmm_2d_cell_vertex_count (SWMM_Engine engine, int idx, int *nv) |
| | Vertices (== edges) of a cell: 3 or 4.
|
| |
| int | swmm_2d_cell_get_vertices (SWMM_Engine engine, int idx, int *v, int *nv) |
| | Cell connectivity for any shape.
|
| |
| int | swmm_2d_cell_get_neighbours (SWMM_Engine engine, int idx, int *n, int *nv) |
| | Neighbour cell across each local edge, any shape.
|
| |
| int | swmm_2d_triangle_get_area (SWMM_Engine engine, int idx, double *area) |
| | Get triangle area.
|
| |
| int | swmm_2d_triangle_get_centroid (SWMM_Engine engine, int idx, double *cx, double *cy, double *cz) |
| | Get triangle centroid coordinates.
|
| |
| int | swmm_2d_set_triangle_mannings (SWMM_Engine engine, int idx, double n) |
| | Set triangle Manning's roughness coefficient.
|
| |
| int | swmm_2d_triangle_get_init_depth (SWMM_Engine engine, int idx, double *d) |
| | Get triangle initial water depth ([2D_TRIANGLES] INIT_DEPTH column, default 0 = dry). Value is in MESH length units — feet on a US-FLOW_UNITS project, metres on SI or on a mesh file that declared ;; UNITS: SI (m) — the same convention as the vertex Z column.
|
| |
| int | swmm_2d_set_triangle_init_depth (SWMM_Engine engine, int idx, double d) |
| | Set triangle initial water depth (mesh length units, >= 0; SWMM_ERR_BADPARAM otherwise — see the getter for the unit convention). Converted to SI and applied to the solver state when the 2D surface initializes, and persisted in the INIT_DEPTH column of [2D_TRIANGLES] on save (written before TAG).
|
| |
| int | swmm_2d_triangle_get_init_velocity (SWMM_Engine engine, int idx, double *u, double *v) |
| | Get triangle initial velocity (u, v in m/s; [2D_INITIAL_VELOCITY] rows, default 0,0).
|
| |
| int | swmm_2d_set_triangle_init_velocity (SWMM_Engine engine, int idx, double u, double v) |
| | Set triangle initial velocity (u, v in m/s; finite values; SWMM_ERR_BADPARAM otherwise). Projected onto the explicit marcher's face normals as (h*u, h*v) when the 2D surface initializes (t = 0 only — hotstart/reinitialize still zeroes face momentum), and persisted as sparse [2D_INITIAL_VELOCITY] rows on save.
|
| |
| int | swmm_2d_set_vertex_tag (SWMM_Engine engine, int idx, const char *tag) |
| | Set the descriptive tag of a vertex (the [2D_VERTICES] TAG column). Distinct from the 1D<->2D coupling node. Empty / NULL clears it.
|
| |
| int | swmm_2d_set_triangle_tag (SWMM_Engine engine, int idx, const char *tag) |
| | Set the descriptive tag of a triangle (the [2D_TRIANGLES] TAG column, e.g. a region / subcatchment id). Empty / NULL clears it.
|
| |
| int | swmm_2d_get_vertex_tag (SWMM_Engine engine, int idx, char *buf, int buflen) |
| | Get the descriptive tag of a vertex (the [2D_VERTICES] TAG column). Copies up to buflen-1 bytes into buf and always NUL-terminates; empty string when the vertex has no tag.
|
| |
| int | swmm_2d_get_triangle_tag (SWMM_Engine engine, int idx, char *buf, int buflen) |
| | Get the descriptive tag of a triangle (the [2D_TRIANGLES] TAG column). Copies up to buflen-1 bytes into buf and always NUL-terminates; empty string when the triangle has no tag.
|
| |
| int | swmm_2d_triangle_get_mannings (SWMM_Engine engine, int idx, double *n) |
| | Get triangle Manning's roughness.
|
| |
| int | swmm_2d_triangle_get_neighbours (SWMM_Engine engine, int idx, int *n0, int *n1, int *n2) |
| | Get triangle neighbour indices (-1 = boundary edge).
|
| |
| int | swmm_2d_vertex_coupling_count (SWMM_Engine engine, int *count) |
| | Get the number of vertex-to-node coupling points.
|
| |
| int | swmm_2d_triangle_coupling_count (SWMM_Engine engine, int *count) |
| | Get the number of triangle-to-node coupling points.
|
| |
| int | swmm_2d_vertex_get_coupled_node (SWMM_Engine engine, int vertex_idx, int *node_idx) |
| | Get vertex coupling: which SWMM node is coupled to this vertex.
|
| |
| int | swmm_2d_triangle_get_coupled_node (SWMM_Engine engine, int tri_idx, int *node_idx) |
| | Get triangle coupling: which SWMM node is coupled to this triangle.
|
| |
| int | swmm_2d_set_vertex_coupled_node (SWMM_Engine engine, int vertex_idx, const char *node_name) |
| | Set (or clear) the SWMM node a vertex is coupled to, by name.
|
| |
| int | swmm_2d_add_triangle_coupling (SWMM_Engine engine, int tri_idx, const char *node_name, double cd, double area) |
| | Append one node→cell coupling row ([2D_TRIANGLE_NODE_MAP] repeated-row form).
|
| |
| int | swmm_2d_clear_triangle_couplings (SWMM_Engine engine) |
| | Remove every authored node→cell coupling row (all triangles).
|
| |
| int | swmm_2d_triangle_coupling_rows (SWMM_Engine engine, int *count) |
| | Number of authored node→cell coupling rows.
|
| |
| int | swmm_2d_get_triangle_coupling_row (SWMM_Engine engine, int row_idx, int *tri_idx, int *node_idx, double *cd, double *area) |
| | Read one authored node→cell coupling row by row index.
|
| |
| int | swmm_2d_get_vertex_coupling_cd (SWMM_Engine engine, int vertex_idx, double *cd) |
| | Get the coupling discharge coefficient of a vertex ([2D_VERTEX_NODE_MAP] CD column; default 0.65).
|
| |
| int | swmm_2d_set_vertex_coupling_cd (SWMM_Engine engine, int vertex_idx, double cd) |
| | Set the coupling discharge coefficient of a vertex ([2D_VERTEX_NODE_MAP] CD column). Persisted by the .inp writer.
|
| |
| int | swmm_2d_get_vertex_coupling_area (SWMM_Engine engine, int vertex_idx, double *area) |
| | Get the coupling exchange area of a vertex ([2D_VERTEX_NODE_MAP] AREA column; default 1.0).
|
| |
| int | swmm_2d_set_vertex_coupling_area (SWMM_Engine engine, int vertex_idx, double area) |
| | Set the coupling exchange area of a vertex ([2D_VERTEX_NODE_MAP] AREA column). Persisted by the .inp writer. Same units convention as the getter: mesh length units² (project units before initialize, m² after).
|
| |
| int | swmm_2d_get_depth (SWMM_Engine engine, int idx, double *depth) |
| | Get water depth at a triangle.
|
| |
| int | swmm_2d_get_head (SWMM_Engine engine, int idx, double *head) |
| | Get total head at a triangle (z + depth).
|
| |
| int | swmm_2d_get_coupling_flux (SWMM_Engine engine, int idx, double *flux) |
| | Get coupling exchange flux at a triangle (m/s, + = into 2D).
|
| |
| int | swmm_2d_get_rainfall (SWMM_Engine engine, int idx, double *rainfall) |
| | Get rainfall intensity at a triangle (m/s).
|
| |
| int | swmm_2d_get_net_source (SWMM_Engine engine, int idx, double *net_source) |
| | Get net source/sink rate at a triangle (m/s).
|
| |
| int | swmm_2d_get_depths_bulk (SWMM_Engine engine, double *depths) |
| | Bulk get depths for all triangles.
|
| |
| int | swmm_2d_get_rainfall_bulk (SWMM_Engine engine, double *rainfall) |
| | Bulk get the rainfall intensity (m/s) applied to every triangle this step — the same field the HDF5 Mesh2_face_rainfall dataset carries. Output pre-allocated to triangle_count.
|
| |
| int | swmm_2d_get_rain_volume_bulk (SWMM_Engine engine, double *volumes) |
| | Bulk get the cumulative rainfall VOLUME (m³) booked onto every triangle since the start of the run — the Mesh2_face_rain_cum field; sums over cells to the 2D mass balance's rainfall inflow. Output pre-allocated to triangle_count.
|
| |
| int | swmm_2d_get_coupling_volume_bulk (SWMM_Engine engine, double *volumes) |
| | Bulk get the SIGNED cumulative 1D↔2D coupling exchange VOLUME (m³) per triangle since the start of the run.
|
| |
| int | swmm_2d_get_heads_bulk (SWMM_Engine engine, double *heads) |
| | Bulk get heads for all triangles.
|
| |
| int | swmm_2d_get_coupling_fluxes_bulk (SWMM_Engine engine, double *fluxes) |
| | Bulk get coupling fluxes for all triangles.
|
| |
| int | swmm_2d_get_edge_conveyance (SWMM_Engine engine, int tri, int edge, double *conveyance) |
| | Get the per-edge conveyance factor for one edge.
|
| |
| int | swmm_2d_set_edge_conveyance (SWMM_Engine engine, int tri, int edge, double conveyance) |
| | Set the per-edge conveyance factor for one edge.
|
| |
| int | swmm_2d_get_edge_conveyance_bulk (SWMM_Engine engine, double *conveyance) |
| | Bulk get conveyance factor at every edge of every triangle.
|
| |
| int | swmm_2d_reset_edge_conveyance (SWMM_Engine engine) |
| | Reset every edge's conveyance factor to 1.0 (unrestricted).
|
| |
| int | swmm_2d_get_edge_flux_bulk (SWMM_Engine engine, double *flux) |
| | Bulk get normal edge flux at every edge of every triangle.
|
| |
| int | swmm_2d_edge_get_geometry_bulk (SWMM_Engine engine, double *length, double *nx, double *ny) |
| | Bulk get edge geometry — time-invariant edge length and outward unit normal components, indexed [tri*3 + localEdge].
|
| |
| int | swmm_2d_vertex_get_head (SWMM_Engine engine, int idx, double *head) |
| | Get reconstructed head at a vertex.
|
| |
| int | swmm_2d_vertex_get_heads_bulk (SWMM_Engine engine, double *heads) |
| | Bulk get reconstructed heads at all vertices.
|
| |
| int | swmm_2d_vertex_get_render_depths_bulk (SWMM_Engine engine, double *depths) |
| | Bulk get render-oriented SIGNED vertex depths (m) at all vertices.
|
| |
| int | swmm_2d_get_max_depth (SWMM_Engine engine, double *max_depth) |
| | Get the maximum depth across all triangles.
|
| |
| int | swmm_2d_get_total_volume (SWMM_Engine engine, double *volume) |
| | Get total 2D surface volume (sum of depth * area).
|
| |
| int | swmm_2d_get_total_exchange_flow (SWMM_Engine engine, double *flow) |
| | Get total exchange flow rate (sum of all coupling flows, m³/s). Positive = net flow from 2D into 1D network.
|
| |
| int | swmm_2d_get_solver_steps (SWMM_Engine engine, long *steps) |
| | Get number of explicit-marcher sub-steps taken in the last advance. (Renamed from swmm_2d_get_cvode_steps with the D2 CVODE/ARKODE retirement.)
|
| |
| int | swmm_2d_get_solver_last_step (SWMM_Engine engine, double *h_last) |
| | Get the explicit marcher's last sub-step size (s). (Renamed from swmm_2d_get_cvode_last_step with the D2 CVODE/ARKODE retirement.)
|
| |
| int | swmm_2d_get_run_stats (SWMM_Engine engine, SWMM_2DRunStats *stats) |
| | Read the cumulative marcher statistics and backend of the 2D run. Counters are zero (and n_tiers 0) before the first advance and again once the solver has been finalised at swmm_engine_end; backend stays filled.
|
| |
| int | swmm_2d_get_stat_max_depths (SWMM_Engine engine, double *max_depths) |
| | Get per-triangle max depth statistics (cumulative).
|
| |
| int | swmm_2d_get_stat_max_velocities (SWMM_Engine engine, double *max_velocities) |
| | Get per-triangle max velocity-magnitude statistics (cumulative, m/s).
|
| |
| int | swmm_2d_get_stat_max_continuity_err (SWMM_Engine engine, double *max_errs) |
| | Get per-triangle max |continuity residual| statistics (cumulative, m3/s).
|
| |
| int | swmm_2d_get_continuity_error (SWMM_Engine engine, double *err) |
| | Get the global 2D surface continuity error (fraction).
|
| |
| int | swmm_2d_get_mass_balance (SWMM_Engine engine, double *init_storage, double *final_storage, double *rainfall_in, double *coupling_1d_to_2d_in, double *coupling_2d_to_1d_out, double *outfall_in, double *outfall_out, double *boundary_in, double *boundary_out, double *evap_out) |
| | Get the global 2D mass-balance terms (all m3). Any pointer may be NULL.
|
| |
| int | swmm_2d_force_rainfall (SWMM_Engine engine, int idx, double value, int mode, int persist) |
| | Force rainfall on a specific triangle.
|
| |
| int | swmm_2d_force_rainfall_uniform (SWMM_Engine engine, double value, int mode, int persist) |
| | Force rainfall on all triangles (uniform).
|
| |
| int | swmm_2d_force_evap (SWMM_Engine engine, int idx, double value, int mode, int persist) |
| | Force evaporation on a specific triangle.
|
| |
| int | swmm_2d_force_evap_uniform (SWMM_Engine engine, double value, int mode, int persist) |
| | Force evaporation on all triangles (uniform).
|
| |
| int | swmm_2d_force_coupling_flux (SWMM_Engine engine, int idx, double value, int mode, int persist) |
| | Force coupling flux on a specific triangle (override computed exchange).
|
| |
| int | swmm_2d_force_clear_all (SWMM_Engine engine) |
| | Clear all 2D forcings.
|
| |
| int | swmm_2d_get_dry_depth (SWMM_Engine engine, double *dry_depth) |
| | Get the dry depth threshold (m).
|
| |
| int | swmm_2d_set_dry_depth (SWMM_Engine engine, double dry_depth) |
| | Set the dry depth threshold (m).
|
| |
| int | swmm_2d_boundary_edge_count (SWMM_Engine engine, int *count) |
| | Get the number of boundary edges (edges with no neighbour).
|
| |
| int | swmm_2d_get_edge_bc_type (SWMM_Engine engine, int tri_idx, int edge, int *bc_type) |
| | Get boundary condition type for an edge.
|
| |
| int | swmm_2d_set_edge_bc_type (SWMM_Engine engine, int tri_idx, int edge, int bc_type) |
| | Set boundary condition type for an edge.
|
| |
| int | swmm_2d_get_edge_bc_head (SWMM_Engine engine, int tri_idx, int edge, double *head) |
| | Get specified stage boundary head for an edge.
|
| |
| int | swmm_2d_set_edge_bc_head (SWMM_Engine engine, int tri_idx, int edge, double head) |
| | Set specified stage boundary head for an edge (same units convention as the getter).
|
| |
| int | swmm_2d_get_edge_bc_slope (SWMM_Engine engine, int tri_idx, int edge, double *slope) |
| | Get normal flow boundary slope for an edge.
|
| |
| int | swmm_2d_set_edge_bc_slope (SWMM_Engine engine, int tri_idx, int edge, double slope) |
| | Set normal flow boundary slope for an edge.
|
| |
| int | swmm_2d_get_edge_bc_cum_flux (SWMM_Engine engine, int tri_idx, int edge, double *cum_flux) |
| | Get cumulative boundary flux at an edge (m³, + = outflow).
|
| |
| int | swmm_2d_set_edge_bc_tseries_name (SWMM_Engine engine, int tri_idx, int edge, const char *name) |
| | Set the timeseries NAME to drive a SPECIFIED_STAGE edge.
|
| |
| int | swmm_2d_get_edge_bc_flow (SWMM_Engine engine, int tri_idx, int edge, double *flow) |
| | Get prescribed flow per metre of edge for a SPECIFIED_FLOW edge. V-E4.
|
| |
| int | swmm_2d_get_edge_bc_tseries_name (SWMM_Engine engine, int tri_idx, int edge, char *buf, int buflen) |
| | Get the timeseries NAME driving a SPECIFIED_STAGE edge.
|
| |
| int | swmm_2d_get_edge_bc_flow_tseries_name (SWMM_Engine engine, int tri_idx, int edge, char *buf, int buflen) |
| | Get the timeseries NAME driving a SPECIFIED_FLOW edge. SVBC A8 — same contract as swmm_2d_get_edge_bc_tseries_name.
|
| |
| int | swmm_2d_get_edge_bc_rating_curve_name (SWMM_Engine engine, int tri_idx, int edge, char *buf, int buflen) |
| | Get the curve NAME driving a RATING_CURVE edge. SVBC A8 — same contract as swmm_2d_get_edge_bc_tseries_name.
|
| |
| int | swmm_2d_set_edge_bc_flow (SWMM_Engine engine, int tri_idx, int edge, double flow) |
| | Set prescribed flow per metre of edge (same units convention as the getter: display flow units/m before initialize, m³/s/m after). V-E4.
|
| |
| int | swmm_2d_set_edge_bc_flow_tseries_name (SWMM_Engine engine, int tri_idx, int edge, const char *name) |
| | Set the timeseries NAME to drive a SPECIFIED_FLOW edge. V-E4 — same resolution contract as swmm_2d_set_edge_bc_tseries_name.
|
| |
| int | swmm_2d_set_edge_bc_rating_curve_name (SWMM_Engine engine, int tri_idx, int edge, const char *name) |
| | Set the curve NAME to drive a RATING_CURVE edge.
|
| |
| int | swmm_2d_output_variable_count (void) |
| |
| const char * | swmm_2d_output_variable_name (int i) |
| |
| unsigned | swmm_2d_output_variable_mask (const char *text) |
| |
| const char * | swmm_2d_output_variable_text (unsigned mask) |
| |
1.13.2