openswmm_transport.h

Go to the documentation of this file.

/* SPDX-License-Identifier: Apache-2.0
 *
 * Copyright 2026 Caleb Buahin
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

 
#ifndef OPENSWMM_TRANSPORT_H
#define OPENSWMM_TRANSPORT_H
 
#include "openswmm_engine.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum SWMM_TransportDispersionMode {
    SWMM_DISPERSION_OFF = 0,     
    SWMM_DISPERSION_FISCHER = 1, 
    SWMM_DISPERSION_VALUE = 2    
} SWMM_TransportDispersionMode;

SWMM_ENGINE_API int swmm_transport_get_configured(SWMM_Engine engine, int* configured);

SWMM_ENGINE_API int swmm_transport_get_dispersion_mode(SWMM_Engine engine, int* mode);

SWMM_ENGINE_API int swmm_transport_set_dispersion_mode(SWMM_Engine engine, int mode);

SWMM_ENGINE_API int swmm_transport_get_dispersion_value(SWMM_Engine engine, double* value);

SWMM_ENGINE_API int swmm_transport_set_dispersion_value(SWMM_Engine engine, double value);

SWMM_ENGINE_API int swmm_transport_get_target_dx(SWMM_Engine engine, double* dx);

SWMM_ENGINE_API int swmm_transport_set_target_dx(SWMM_Engine engine, double dx);

SWMM_ENGINE_API int swmm_transport_conduit_disp_count(SWMM_Engine engine, int* count);

SWMM_ENGINE_API int swmm_transport_get_conduit_disp(SWMM_Engine engine, int index, int* link_index,
                                                    double* value);

SWMM_ENGINE_API int swmm_transport_boundary_count(SWMM_Engine engine, int* count);

SWMM_ENGINE_API int swmm_transport_get_boundary(SWMM_Engine engine, int index, char* element,
                                                int elem_len, char* species, int spec_len,
                                                int* is_ts, double* value, char* ts_name,
                                                int ts_len);

SWMM_ENGINE_API int swmm_transport_source_count(SWMM_Engine engine, int* count);

SWMM_ENGINE_API int swmm_transport_get_source(SWMM_Engine engine, int index, char* element,
                                              int elem_len, char* species, int spec_len, int* is_ts,
                                              double* value, char* ts_name, int ts_len);
 
/* =========================================================================
 * Authoring (closed C-API gaps 2026-10-11)
 *
 * The setters below edit the transport.ard configuration that the
 * serializer writes back to the component file, so API edits persist on
 * save. They are accepted while the model is being edited (BUILDING or
 * OPENED) and return SWMM_ERR_LIFECYCLE afterwards. Each edit marks the
 * configuration as present (swmm_transport_get_configured() == 1).
 * ========================================================================= */

SWMM_ENGINE_API int swmm_transport_get_detailed_output(SWMM_Engine engine, char* buf, int buflen);

SWMM_ENGINE_API int swmm_transport_set_detailed_output(SWMM_Engine engine, const char* path);

SWMM_ENGINE_API int swmm_transport_set_conduit_disp(SWMM_Engine engine, int link_index,
                                                    double value);

SWMM_ENGINE_API int swmm_transport_remove_conduit_disp(SWMM_Engine engine, int index);

SWMM_ENGINE_API int swmm_transport_set_boundary(SWMM_Engine engine, const char* element,
                                                const char* species, int is_ts, double value,
                                                const char* ts_name);

SWMM_ENGINE_API int swmm_transport_remove_boundary(SWMM_Engine engine, int index);

SWMM_ENGINE_API int swmm_transport_set_source(SWMM_Engine engine, const char* element,
                                              const char* species, int is_ts, double value,
                                              const char* ts_name);

SWMM_ENGINE_API int swmm_transport_remove_source(SWMM_Engine engine, int index);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OPENSWMM_TRANSPORT_H */