openswmm_climate.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_CLIMATE_H
#define OPENSWMM_CLIMATE_H
 
#include "openswmm_engine.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define SWMM_CLIMATE_MONTHS 12

#define SWMM_CLIMATE_ADC_POINTS 10

typedef enum SWMM_TempSource {
    SWMM_TEMP_NONE = 0,       
    SWMM_TEMP_TIMESERIES = 1, 
    SWMM_TEMP_FILE = 2        
} SWMM_TempSource;

typedef enum SWMM_EvapType {
    SWMM_EVAP_CONSTANT = 0,    
    SWMM_EVAP_MONTHLY = 1,     
    SWMM_EVAP_TIMESERIES = 2,  
    SWMM_EVAP_TEMPERATURE = 3, 
    SWMM_EVAP_FILE = 4         
} SWMM_EvapType;

typedef enum SWMM_EvapPreviewStatus {
    SWMM_EVAP_PREVIEW_AVAILABLE = 0, 
    SWMM_EVAP_PREVIEW_HELD = 1,      
    SWMM_EVAP_PREVIEW_MISSING = 2,   
    SWMM_EVAP_PREVIEW_ESTIMATED = 3  
} SWMM_EvapPreviewStatus;

typedef struct SWMM_EvapPreviewSample {
    double date;           
    double source_rate;    
    double adjustment;     
    double effective_rate; 
    int status;            
} SWMM_EvapPreviewSample;

typedef struct SWMM_EvapPreviewSummary {
    int source_type; 
    int available_count;
    int held_count;
    int missing_count;
    int estimated_count;
    int runtime_forcing_unknown; 
    double minimum_rate;         
    double maximum_rate;         
} SWMM_EvapPreviewSummary;

typedef struct SWMM_EvapPreviewConfig {
    int evap_type;
    double evap_monthly[SWMM_CLIMATE_MONTHS];
    double pan_coeff[SWMM_CLIMATE_MONTHS];
    double adjust_evaporation[SWMM_CLIMATE_MONTHS];
    const char* evap_timeseries;
    int temp_source;
    const char* temp_timeseries;
    const char* climate_file_path;
    double climate_file_start;
    int climate_file_temp_units;
    double latitude;
    double longitude_correction_minutes;
    double adjust_temperature[SWMM_CLIMATE_MONTHS];
} SWMM_EvapPreviewConfig;

typedef enum SWMM_WindType {
    SWMM_WIND_MONTHLY = 0, 
    SWMM_WIND_FILE = 1     
} SWMM_WindType;

typedef enum SWMM_HumidityType {
    SWMM_HUMIDITY_CONSTANT = 0,  
    SWMM_HUMIDITY_MONTHLY = 1,   
    SWMM_HUMIDITY_TIMESERIES = 2 
} SWMM_HumidityType;

typedef enum SWMM_HumidityVar {
    SWMM_HUMIDITY_RELATIVE = 0, 
    SWMM_HUMIDITY_DEWPOINT = 1  
} SWMM_HumidityVar;
 
/* =========================================================================
 * Temperature  ([TEMPERATURE])
 * ========================================================================= */

SWMM_ENGINE_API int swmm_climate_get_temp_source(SWMM_Engine engine, int* source);
SWMM_ENGINE_API int swmm_climate_set_temp_source(SWMM_Engine engine, int source);

SWMM_ENGINE_API int swmm_climate_get_temp_timeseries(SWMM_Engine engine, char* buf, int buflen);
SWMM_ENGINE_API int swmm_climate_set_temp_timeseries(SWMM_Engine engine, const char* ts_id);

SWMM_ENGINE_API int swmm_climate_get_temp_file_start(SWMM_Engine engine, double* date);
SWMM_ENGINE_API int swmm_climate_set_temp_file_start(SWMM_Engine engine, double date);

SWMM_ENGINE_API int swmm_climate_get_temp_units(SWMM_Engine engine, int* units);
SWMM_ENGINE_API int swmm_climate_set_temp_units(SWMM_Engine engine, int units);

SWMM_ENGINE_API int swmm_climate_get_elevation(SWMM_Engine engine, double* elev);
SWMM_ENGINE_API int swmm_climate_set_elevation(SWMM_Engine engine, double elev);

SWMM_ENGINE_API int swmm_climate_get_latitude(SWMM_Engine engine, double* latitude);
SWMM_ENGINE_API int swmm_climate_set_latitude(SWMM_Engine engine, double latitude);

SWMM_ENGINE_API int swmm_climate_get_longitude_correction(SWMM_Engine engine, double* minutes);
SWMM_ENGINE_API int swmm_climate_set_longitude_correction(SWMM_Engine engine, double minutes);
 
/* =========================================================================
 * Evaporation  ([EVAPORATION])
 * ========================================================================= */

SWMM_ENGINE_API int swmm_climate_get_evap_type(SWMM_Engine engine, int* type);
SWMM_ENGINE_API int swmm_climate_set_evap_type(SWMM_Engine engine, int type);

SWMM_ENGINE_API int swmm_climate_get_evap_monthly(SWMM_Engine engine, double* buf, int count);
SWMM_ENGINE_API int swmm_climate_set_evap_monthly(SWMM_Engine engine, const double* values,
                                                  int count);

SWMM_ENGINE_API int swmm_climate_get_evap_timeseries(SWMM_Engine engine, char* buf, int buflen);
SWMM_ENGINE_API int swmm_climate_set_evap_timeseries(SWMM_Engine engine, const char* ts_id);

SWMM_ENGINE_API int swmm_climate_preview_evaporation(SWMM_Engine engine, double start_date,
                                                     double end_date, double sample_interval_days,
                                                     SWMM_EvapPreviewSample* samples, int capacity,
                                                     int* sample_count,
                                                     SWMM_EvapPreviewSummary* summary,
                                                     char* diagnostic, int diagnostic_capacity);

SWMM_ENGINE_API int swmm_climate_preview_evaporation_with_config(
    SWMM_Engine engine, const SWMM_EvapPreviewConfig* config, double start_date, double end_date,
    double sample_interval_days, SWMM_EvapPreviewSample* samples, int capacity, int* sample_count,
    SWMM_EvapPreviewSummary* summary, char* diagnostic, int diagnostic_capacity);

SWMM_ENGINE_API int swmm_climate_get_pan_coeff(SWMM_Engine engine, double* buf, int count);
SWMM_ENGINE_API int swmm_climate_set_pan_coeff(SWMM_Engine engine, const double* values, int count);

SWMM_ENGINE_API int swmm_climate_get_evap_recovery(SWMM_Engine engine, char* buf, int buflen);
SWMM_ENGINE_API int swmm_climate_set_evap_recovery(SWMM_Engine engine, const char* pattern_id);
 
/* =========================================================================
 * Wind speed  ([TEMPERATURE] WINDSPEED)
 * ========================================================================= */

SWMM_ENGINE_API int swmm_climate_get_wind_type(SWMM_Engine engine, int* type);
SWMM_ENGINE_API int swmm_climate_set_wind_type(SWMM_Engine engine, int type);

SWMM_ENGINE_API int swmm_climate_get_wind_monthly(SWMM_Engine engine, double* buf, int count);
SWMM_ENGINE_API int swmm_climate_set_wind_monthly(SWMM_Engine engine, const double* values,
                                                  int count);
 
/* =========================================================================
 * Humidity  ([TEMPERATURE] HUMIDITY) — heat-model met input
 * ========================================================================= */

SWMM_ENGINE_API int swmm_climate_get_humidity_type(SWMM_Engine engine, int* type);
SWMM_ENGINE_API int swmm_climate_set_humidity_type(SWMM_Engine engine, int type);

SWMM_ENGINE_API int swmm_climate_get_humidity_variable(SWMM_Engine engine, int* var);
SWMM_ENGINE_API int swmm_climate_set_humidity_variable(SWMM_Engine engine, int var);

SWMM_ENGINE_API int swmm_climate_get_humidity_monthly(SWMM_Engine engine, double* buf, int count);
SWMM_ENGINE_API int swmm_climate_set_humidity_monthly(SWMM_Engine engine, const double* values,
                                                      int count);

SWMM_ENGINE_API int swmm_climate_get_humidity_timeseries(SWMM_Engine engine, char* buf, int buflen);
SWMM_ENGINE_API int swmm_climate_set_humidity_timeseries(SWMM_Engine engine, const char* ts_id);
 
/* =========================================================================
 * Snowmelt globals  ([TEMPERATURE] SNOWMELT)
 * ========================================================================= */

SWMM_ENGINE_API int swmm_climate_get_snow_temp(SWMM_Engine engine, double* divide_temp);
SWMM_ENGINE_API int swmm_climate_set_snow_temp(SWMM_Engine engine, double divide_temp);

SWMM_ENGINE_API int swmm_climate_get_ati_weight(SWMM_Engine engine, double* tipm);
SWMM_ENGINE_API int swmm_climate_set_ati_weight(SWMM_Engine engine, double tipm);

SWMM_ENGINE_API int swmm_climate_get_neg_melt_ratio(SWMM_Engine engine, double* rnm);
SWMM_ENGINE_API int swmm_climate_set_neg_melt_ratio(SWMM_Engine engine, double rnm);
 
/* =========================================================================
 * Areal-depletion curves  ([TEMPERATURE] ADC)
 * ========================================================================= */

SWMM_ENGINE_API int swmm_climate_get_adc_impervious(SWMM_Engine engine, double* buf, int count);
SWMM_ENGINE_API int swmm_climate_set_adc_impervious(SWMM_Engine engine, const double* values,
                                                    int count);

SWMM_ENGINE_API int swmm_climate_get_adc_pervious(SWMM_Engine engine, double* buf, int count);
SWMM_ENGINE_API int swmm_climate_set_adc_pervious(SWMM_Engine engine, const double* values,
                                                  int count);
 
/* =========================================================================
 * Monthly adjustments  ([ADJUSTMENTS])
 * ========================================================================= */

SWMM_ENGINE_API int swmm_climate_get_adjust_temperature(SWMM_Engine engine, double* buf, int count);
SWMM_ENGINE_API int swmm_climate_set_adjust_temperature(SWMM_Engine engine, const double* values,
                                                        int count);

SWMM_ENGINE_API int swmm_climate_get_adjust_evaporation(SWMM_Engine engine, double* buf, int count);
SWMM_ENGINE_API int swmm_climate_set_adjust_evaporation(SWMM_Engine engine, const double* values,
                                                        int count);

SWMM_ENGINE_API int swmm_climate_get_adjust_rainfall(SWMM_Engine engine, double* buf, int count);
SWMM_ENGINE_API int swmm_climate_set_adjust_rainfall(SWMM_Engine engine, const double* values,
                                                     int count);

SWMM_ENGINE_API int swmm_climate_get_adjust_conductivity(SWMM_Engine engine, double* buf,
                                                         int count);
SWMM_ENGINE_API int swmm_climate_set_adjust_conductivity(SWMM_Engine engine, const double* values,
                                                         int count);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OPENSWMM_CLIMATE_H */