openswmm_coupling.h

Go to the documentation of this file.

/* SPDX-License-Identifier: Apache-2.0 */

 
#ifndef OPENSWMM_COUPLING_H
#define OPENSWMM_COUPLING_H
#include "openswmm_engine.h"
#ifdef __cplusplus
extern "C" {
#endif
#define SWMM_COUPLING_SURFACE 0
#define SWMM_COUPLING_GROUNDWATER 1
typedef struct SWMM_CouplingSource {
    unsigned struct_size;
    const char* id;
    int domain;
    int cell;
    double flow_m3_s;
    double heat_w;
    double until_seconds;
    int species_count;
    const double* concentrations;
    const double* rates;
} SWMM_CouplingSource;

typedef struct SWMM_CouplingReceipt {
    double requested_m3, applied_m3, rejected_m3;
    double requested_heat_j, applied_heat_j, rejected_heat_j;
    double last_applied_m3_s, last_interval_seconds;
} SWMM_CouplingReceipt;
#define SWMM_COUPLING_FRAME_VERSION 1
#define SWMM_COUPLING_RAINFALL 1
#define SWMM_COUPLING_EVAPORATION 2
#define SWMM_COUPLING_INFILTRATION 3
#define SWMM_COUPLING_RAIN_QUALITY 4
typedef struct SWMM_CouplingBoundary {
    unsigned struct_size;
    int domain, cell, edge, kind;
    double value;
    int species_count;
    const double* concentrations;
} SWMM_CouplingBoundary;

typedef struct SWMM_CouplingForcing {
    unsigned struct_size;
    int channel, cell, mode;
    double rate_m_s, until_seconds;
    int species_count;
    const double* concentrations;
} SWMM_CouplingForcing;
typedef struct SWMM_CouplingClear {
    int domain, cell; /* cell=-1 clears all cells for this source ID. */
    const char* id;
} SWMM_CouplingClear;

typedef struct SWMM_CouplingFrame {
    unsigned struct_size, version;
    const char* provider;
    int source_count;
    const SWMM_CouplingSource* sources;
    int boundary_count;
    const SWMM_CouplingBoundary* boundaries;
    int forcing_count;
    const SWMM_CouplingForcing* forcings;
    int clear_count;
    const SWMM_CouplingClear* clears;
} SWMM_CouplingFrame;

SWMM_ENGINE_API int swmm_coupling_apply_frame(SWMM_Engine engine, const SWMM_CouplingFrame* frame);
SWMM_ENGINE_API int swmm_coupling_clear_source_cell(SWMM_Engine engine, int domain, const char* id,
                                                    int cell);
SWMM_ENGINE_API int swmm_coupling_get_receipts(SWMM_Engine engine, int domain, const char* id,
                                               const int* cells, int count,
                                               SWMM_CouplingReceipt* out, double* requested_species,
                                               double* applied_species, int species_count);
SWMM_ENGINE_API int swmm_coupling_get_boundary_receipt(SWMM_Engine engine, int domain, int cell,
                                                       int edge, SWMM_CouplingReceipt* out,
                                                       double* requested_species,
                                                       double* applied_species, int species_count);
SWMM_ENGINE_API int swmm_coupling_get_infiltration_receipt(SWMM_Engine engine, int cell,
                                                           SWMM_CouplingReceipt* out,
                                                           double* requested_species,
                                                           double* applied_species,
                                                           int species_count);
SWMM_ENGINE_API int swmm_2d_get_species_ledger(SWMM_Engine engine, int species, int term,
                                               double* value);

SWMM_ENGINE_API int swmm_coupling_set_source(SWMM_Engine engine, const char* id, int domain,
                                             int cell, double flow_m3_s, double heat_w,
                                             const double* concentrations, const double* rates,
                                             int species_count, double until_seconds);
SWMM_ENGINE_API int swmm_gw2d_set_runtime_boundary(SWMM_Engine engine, int cell, int edge, int kind,
                                                   double value, const double* concentrations,
                                                   int species_count);
SWMM_ENGINE_API int swmm_gw2d_clear_runtime_boundary(SWMM_Engine engine, int cell, int edge);
SWMM_ENGINE_API int swmm_gw2d_get_runtime_boundary_flow(SWMM_Engine engine, int cell, int edge,
                                                        double* flow_m3_s);
SWMM_ENGINE_API int swmm_2d_set_runtime_boundary(SWMM_Engine engine, int cell, int edge, int kind,
                                                 double value, const double* concentrations,
                                                 int species_count);
SWMM_ENGINE_API int swmm_coupling_set_sources(SWMM_Engine engine,
                                              const SWMM_CouplingSource* sources, int count);
SWMM_ENGINE_API int swmm_coupling_clear_source(SWMM_Engine engine, int domain, const char* id);
SWMM_ENGINE_API int swmm_coupling_get_receipt(SWMM_Engine engine, int domain, const char* id,
                                              int cell, SWMM_CouplingReceipt* out,
                                              double* requested_species, double* applied_species,
                                              int capacity);
SWMM_ENGINE_API int swmm_coupling_get_water_totals(SWMM_Engine engine, int domain,
                                                   double* incoming_m3, double* outgoing_m3);
SWMM_ENGINE_API int swmm_coupling_advance_to(SWMM_Engine engine, double target_seconds,
                                             double* actual_seconds);
SWMM_ENGINE_API int swmm_coupling_capabilities(SWMM_Engine engine, unsigned* flags);
#ifdef __cplusplus
}
#endif
#endif