openswmm_quality.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_QUALITY_H
#define OPENSWMM_QUALITY_H
 
#include "openswmm_engine.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* =========================================================================
 * Landuse API
 * ========================================================================= */

SWMM_ENGINE_API int swmm_landuse_count(SWMM_Engine engine);

SWMM_ENGINE_API int swmm_landuse_index(SWMM_Engine engine, const char* id);

SWMM_ENGINE_API const char* swmm_landuse_id(SWMM_Engine engine, int idx);

SWMM_ENGINE_API int swmm_landuse_add(SWMM_Engine engine, const char* id);

SWMM_ENGINE_API int swmm_landuse_rename(SWMM_Engine engine, int idx, const char* new_id);

SWMM_ENGINE_API int swmm_landuse_set_sweep_interval(SWMM_Engine engine, int idx, double days);

SWMM_ENGINE_API int swmm_landuse_get_sweep_interval(SWMM_Engine engine, int idx, double* days);

SWMM_ENGINE_API int swmm_landuse_set_sweep_removal(SWMM_Engine engine, int idx, double frac);

SWMM_ENGINE_API int swmm_landuse_get_sweep_removal(SWMM_Engine engine, int idx, double* frac);
 
/* =========================================================================
 * Buildup API — indexed by (landuse_idx, pollutant_idx)
 * ========================================================================= */

SWMM_ENGINE_API int swmm_buildup_set(SWMM_Engine engine, int lu_idx, int pollut_idx, int func_type,
                                     double c1, double c2, double c3, int normalizer);

SWMM_ENGINE_API int swmm_buildup_get(SWMM_Engine engine, int lu_idx, int pollut_idx, int* func_type,
                                     double* c1, double* c2, double* c3, int* normalizer);
 
/* =========================================================================
 * Washoff API — indexed by (landuse_idx, pollutant_idx)
 * ========================================================================= */

SWMM_ENGINE_API int swmm_washoff_set(SWMM_Engine engine, int lu_idx, int pollut_idx, int func_type,
                                     double coeff, double expon, double sweep_effic,
                                     double bmp_effic);

SWMM_ENGINE_API int swmm_washoff_get(SWMM_Engine engine, int lu_idx, int pollut_idx, int* func_type,
                                     double* coeff, double* expon, double* sweep_effic,
                                     double* bmp_effic);
 
/* =========================================================================
 * Treatment API — indexed by (node_idx, pollutant_idx)
 * ========================================================================= */

SWMM_ENGINE_API int swmm_treatment_set(SWMM_Engine engine, int node_idx, int pollut_idx,
                                       const char* expression);

SWMM_ENGINE_API int swmm_treatment_get(SWMM_Engine engine, int node_idx, int pollut_idx, char* buf,
                                       int buflen);

SWMM_ENGINE_API int swmm_treatment_clear(SWMM_Engine engine, int node_idx, int pollut_idx);

SWMM_ENGINE_API int swmm_treatment_validate_expression(SWMM_Engine engine, const char* expr,
                                                       char* errbuf, int buflen, int* col_out);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OPENSWMM_QUALITY_H */