openswmm_infil2d.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_INFIL2D_H
#define OPENSWMM_INFIL2D_H
 
#include "openswmm_engine.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* =========================================================================
 * Codes and limits
 * ========================================================================= */

#define SWMM_INFIL2D_MAX_PARAMS 5

#define SWMM_INFIL2D_HORTON         0  
#define SWMM_INFIL2D_MOD_HORTON     1  
#define SWMM_INFIL2D_GREEN_AMPT     2  
#define SWMM_INFIL2D_MOD_GREEN_AMPT 3  
#define SWMM_INFIL2D_CURVE_NUMBER   4  
#define SWMM_INFIL2D_CONSTANT       5  

#define SWMM_INFIL2D_DEST_LOST             0  
#define SWMM_INFIL2D_DEST_SUBCATCH_AQUIFER 1  
#define SWMM_INFIL2D_DEST_AQUIFER_2D       2  
 
/* =========================================================================
 * Value types
 * ========================================================================= */

typedef struct SWMM_Infil2DOptions {
    double infil_step;
} SWMM_Infil2DOptions;

typedef struct SWMM_Infil2DRow {
    int    has_method;
    int    method;
    double p[SWMM_INFIL2D_MAX_PARAMS];
    int    dest;
} SWMM_Infil2DRow;
 
/* =========================================================================
 * Options — `[2D_INFILTRATION_OPTIONS]`
 * ========================================================================= */

SWMM_ENGINE_API int swmm_infil2d_get_options(SWMM_Engine engine,
                                             SWMM_Infil2DOptions* options);

SWMM_ENGINE_API int swmm_infil2d_set_options(SWMM_Engine engine,
                                             const SWMM_Infil2DOptions* options);
 
/* =========================================================================
 * Tag defaults — `[2D_INFILTRATION_DEFAULTS]`
 * ========================================================================= */

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

SWMM_ENGINE_API int swmm_infil2d_get_default(SWMM_Engine engine, int idx,
                                             SWMM_Infil2DRow* row);

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

SWMM_ENGINE_API int swmm_infil2d_set_default(SWMM_Engine engine,
                                             const char* tag,
                                             const SWMM_Infil2DRow* row);

SWMM_ENGINE_API int swmm_infil2d_remove_default(SWMM_Engine engine,
                                                const char* tag);
 
/* =========================================================================
 * Per-cell overrides — `[2D_INFILTRATION]`
 * ========================================================================= */

SWMM_ENGINE_API int swmm_infil2d_get_cell(SWMM_Engine engine, int tri,
                                          SWMM_Infil2DRow* row,
                                          int* is_override);

SWMM_ENGINE_API int swmm_infil2d_set_cell(SWMM_Engine engine, int tri,
                                          const SWMM_Infil2DRow* row);

SWMM_ENGINE_API int swmm_infil2d_set_cells(SWMM_Engine engine,
                                           const int* tris, int n,
                                           const SWMM_Infil2DRow* row);
 
/* =========================================================================
 * State readback (SI, like the rest of the 2D API)
 * ========================================================================= */

SWMM_ENGINE_API int swmm_infil2d_get_rate_bulk(SWMM_Engine engine,
                                               double* f, int n);

SWMM_ENGINE_API int swmm_infil2d_get_cum_bulk(SWMM_Engine engine,
                                              double* F, int n);

SWMM_ENGINE_API int swmm_infil2d_get_total_volume(SWMM_Engine engine,
                                                  double* volume);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OPENSWMM_INFIL2D_H */