openswmm_sq2d.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_SQ2D_H
#define OPENSWMM_SQ2D_H
 
#include "openswmm_engine.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define SWMM_SQ2D_SCOPE_GLOBAL 0 
#define SWMM_SQ2D_SCOPE_TAG 1    
#define SWMM_SQ2D_SCOPE_CELL 2   
 
/* =========================================================================
 * [2D_COVERAGES]
 * ========================================================================= */

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

SWMM_ENGINE_API int swmm_2d_coverage_set(SWMM_Engine engine, int scope, const char* tag, int cell,
                                         const char* const* landuses, const double* percents,
                                         int n);

SWMM_ENGINE_API int swmm_2d_coverage_row_size(SWMM_Engine engine, int index, int* n);

SWMM_ENGINE_API int swmm_2d_coverage_get(SWMM_Engine engine, int index, int k, int* scope,
                                         char* tag, int taglen, int* cell, char* landuse, int lulen,
                                         double* percent);

SWMM_ENGINE_API int swmm_2d_coverage_remove(SWMM_Engine engine, int index);
 
/* =========================================================================
 * [2D_LOADINGS]
 * ========================================================================= */

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

SWMM_ENGINE_API int swmm_2d_loading_set(SWMM_Engine engine, int scope, const char* tag, int cell,
                                        const char* species, double value);

SWMM_ENGINE_API int swmm_2d_loading_get(SWMM_Engine engine, int index, int* scope, char* tag,
                                        int taglen, int* cell, char* species, int splen,
                                        double* value);

SWMM_ENGINE_API int swmm_2d_loading_remove(SWMM_Engine engine, int index);
 
/* =========================================================================
 * [2D_CURB_LENGTH]
 * ========================================================================= */

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

SWMM_ENGINE_API int swmm_2d_curb_length_set(SWMM_Engine engine, int scope, const char* tag,
                                            int cell, double length);

SWMM_ENGINE_API int swmm_2d_curb_length_get(SWMM_Engine engine, int index, int* scope, char* tag,
                                            int taglen, int* cell, double* length);

SWMM_ENGINE_API int swmm_2d_curb_length_remove(SWMM_Engine engine, int index);
 
/* =========================================================================
 * Buildup store (running model)
 * ========================================================================= */

SWMM_ENGINE_API int swmm_2d_get_buildup_bulk(SWMM_Engine engine, const char* species, double* out,
                                             int n);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OPENSWMM_SQ2D_H */