openswmm_node_coupling_2d_impl.cpp File Reference

Public C API implementation for node-to-surface coupling. More...

#include "openswmm_api_common.hpp"
#include "NodeCoupling2D.hpp"
#include "../../../include/openswmm/engine/openswmm_2d.h"
#include <cmath>
#include <cstring>
#include <string>

Include dependency graph for openswmm_node_coupling_2d_impl.cpp:

Functions
SWMM_ENGINE_API int	swmm_node_get_2d_coupling_type (SWMM_Engine engine, int node_idx, int *type, int *authored)
	Effective coupling type of a node.
SWMM_ENGINE_API int	swmm_node_get_2d_coupling_default_type (SWMM_Engine engine, int node_idx, int *type)
	Class default coupling type of a node (what it has without a row).
SWMM_ENGINE_API int	swmm_node_set_2d_coupling_type (SWMM_Engine engine, int node_idx, int type)
	Author a node's coupling type. Parameters that do not apply to the new type are dropped.
SWMM_ENGINE_API int	swmm_node_reset_2d_coupling (SWMM_Engine engine, int node_idx)
	Remove a node's [2D_NODE_COUPLING] row (back to the class default).
SWMM_ENGINE_API int	swmm_node_get_2d_coupling_param (SWMM_Engine engine, int node_idx, const char *key, char *value, int value_len)
	Read an authored coupling parameter as its section token, e.g. key "D" → "1.2", key "CREST" → "MESH_BED". Empty when not authored. Keys: D, PERIMETER, AREA, CHAMBER_AREA, LID_OPEN_FRACTION, CREST, COEFFS, CW, CSW, COI, COO, LAW, SPREAD, TAILWATER_RELAX. Lengths and areas are in project units, TAILWATER_RELAX in seconds.
SWMM_ENGINE_API int	swmm_node_set_2d_coupling_param (SWMM_Engine engine, int node_idx, const char *key, const char *value)
	Author a coupling parameter from its section token; NULL or "" clears it. A node without a row gets one at its class default type.

Detailed Description

Public C API implementation for node-to-surface coupling.

Author

Caleb Buahin caleb.nosp@m..bua.nosp@m.hin@g.nosp@m.mail.nosp@m..com

Copyright

Copyright (c) 2026 Caleb Buahin. All rights reserved.

License

Apache-2.0