openswmm_gw2d.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_GW2D_H
#define OPENSWMM_GW2D_H
 
#include "openswmm_engine.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ---- Scopes (same encoding as the [GW_*] transport API) ------------------ */
 
#define SWMM_GW2D_SCOPE_GLOBAL 0   
#define SWMM_GW2D_SCOPE_TAG    1   
#define SWMM_GW2D_SCOPE_CELL   2   
 
/* ---- Soil-characteristic laws ------------------------------------------- */
 
#define SWMM_GW2D_SOIL_RUSSO         0
#define SWMM_GW2D_SOIL_GARDNER       1
#define SWMM_GW2D_SOIL_BROOKS_COREY  2
#define SWMM_GW2D_SOIL_VAN_GENUCHTEN 3
 
/* ---- Unsaturated-zone closures ------------------------------------------ */
 
#define SWMM_GW2D_CLOSURE_AUTO        (-1)
#define SWMM_GW2D_CLOSURE_CLOSED_FORM 0
#define SWMM_GW2D_CLOSURE_ENSLAVED    1
#define SWMM_GW2D_CLOSURE_SIGMA       2
 
/* ---- Per-cell state selectors ------------------------------------------- */
 
#define SWMM_GW2D_VAR_HG        0   
#define SWMM_GW2D_VAR_HU        1   
#define SWMM_GW2D_VAR_TABLE_EL  2   
#define SWMM_GW2D_VAR_Q0        3   
#define SWMM_GW2D_VAR_QLAT      4   
#define SWMM_GW2D_VAR_QNODE     5   
#define SWMM_GW2D_VAR_QDEEP     6   
#define SWMM_GW2D_VAR_QET       7   
#define SWMM_GW2D_VAR_DUNNE     8   
#define SWMM_GW2D_VAR_QPLUS     9   
#define SWMM_GW2D_VAR_DT_CELL   10  
#define SWMM_GW2D_VAR_TIER      11  
#define SWMM_GW2D_VAR_CLOSURE   12  
 
/* ---- Ledger selectors (m3, cumulative) ---------------------------------- */
 
#define SWMM_GW2D_LED_RECHARGE      0
#define SWMM_GW2D_LED_LATERAL       1
#define SWMM_GW2D_LED_DEEP          2
#define SWMM_GW2D_LED_NODE          3
#define SWMM_GW2D_LED_DUNNE         4
#define SWMM_GW2D_LED_CAPRISE       5
#define SWMM_GW2D_LED_ET            6
#define SWMM_GW2D_LED_INFIL_IN      7
#define SWMM_GW2D_LED_INIT_STORAGE  8
#define SWMM_GW2D_LED_STORAGE       9   
 
/* =========================================================================
 * [2D_AQUIFER_OPTIONS]
 * ========================================================================= */

SWMM_ENGINE_API int swmm_gw2d_option_get(SWMM_Engine engine, const char* key,
                                         char* buf, int buflen);

SWMM_ENGINE_API int swmm_gw2d_option_set(SWMM_Engine engine, const char* key,
                                         const char* value);
 
/* =========================================================================
 * [2D_AQUIFER] rows
 * ========================================================================= */

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

SWMM_ENGINE_API int swmm_gw2d_row_add(SWMM_Engine engine, int scope,
                                      const char* tag, int cell,
                                      double ks, double zs,
                                      double theta_s, double theta_r,
                                      double alpha);

SWMM_ENGINE_API int swmm_gw2d_row_get(SWMM_Engine engine, int index,
                                      int* scope, char* tag, int taglen,
                                      int* cell, double* ks, double* zs,
                                      double* theta_s, double* theta_r,
                                      double* alpha);

SWMM_ENGINE_API int swmm_gw2d_row_set_property(SWMM_Engine engine, int index,
                                               const char* key, double value);

SWMM_ENGINE_API int swmm_gw2d_row_get_property(SWMM_Engine engine, int index,
                                               const char* key, double* value);

SWMM_ENGINE_API int swmm_gw2d_row_remove(SWMM_Engine engine, int index);
 
/* =========================================================================
 * [2D_AQUIFER_NODE] beds
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_gw2d_node_count(SWMM_Engine engine, int* count);

SWMM_ENGINE_API int swmm_gw2d_node_add(SWMM_Engine engine, const char* node,
                                       int cell, double kc, double dc,
                                       double area);
 
SWMM_ENGINE_API int swmm_gw2d_node_get(SWMM_Engine engine, int index,
                                       char* node, int nodelen, int* cell,
                                       double* kc, double* dc, double* area);
 
SWMM_ENGINE_API int swmm_gw2d_node_remove(SWMM_Engine engine, int index);
 
/* =========================================================================
 * Running state — SI throughout
 * ========================================================================= */

SWMM_ENGINE_API int swmm_gw2d_is_active(SWMM_Engine engine, int* active);

SWMM_ENGINE_API int swmm_gw2d_get_dimensions(SWMM_Engine engine,
                                             int* n_cells, int* m_layers);

SWMM_ENGINE_API int swmm_gw2d_get_cell(SWMM_Engine engine, int cell, int var,
                                       double* value);

SWMM_ENGINE_API int swmm_gw2d_get_cell_bulk(SWMM_Engine engine, int var,
                                            double* out, int len,
                                            int* written);

SWMM_ENGINE_API int swmm_gw2d_get_column(SWMM_Engine engine, int cell,
                                         double* theta, int len,
                                         int* written);

SWMM_ENGINE_API int swmm_gw2d_get_ledger(SWMM_Engine engine, int term,
                                         double* value);

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

SWMM_ENGINE_API int swmm_gw2d_get_tier_histogram(SWMM_Engine engine,
                                                 long* out, int len,
                                                 int* written);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OPENSWMM_GW2D_H */