Climate.hpp

Go to the documentation of this file.

 
#ifndef OPENSWMM_CLIMATE_HPP
#define OPENSWMM_CLIMATE_HPP
 
namespace openswmm {
 
struct SimulationContext;
 
namespace climate {
 
// ============================================================================
// Constants
// ============================================================================
 
constexpr double MM_PER_INCH = 25.40;
 
// ============================================================================
// Evaporation method
// ============================================================================
 
enum class EvapMethod : int {
    CONSTANT    = 0,
    MONTHLY     = 1,
    TIMESERIES  = 2,
    TEMPERATURE = 3,   
    PAN         = 4
};
 
// ============================================================================
// Daily climate state (scalar — broadcast to all subcatchments)
// ============================================================================
 
struct ClimateState {
    double temperature  = 70.0;  
    double temp_range   = 0.0;   
    double evap_rate    = 0.0;   
    double wind_speed   = 0.0;   
    double humidity     = 50.0;  
 
    // Derived values
    double gamma        = 0.0;   
    double ea           = 0.0;   
 
    // Hargreaves parameters
    double latitude     = 0.0;   
 
    // Monthly evaporation table (for MONTHLY method)
    double monthly_evap[12] = {};
 
    // Monthly adjustment factors
    double adjust_evap[12] = {1,1,1,1,1,1,1,1,1,1,1,1};
    double adjust_temp[12] = {0,0,0,0,0,0,0,0,0,0,0,0};
    double adjust_rain[12] = {1,1,1,1,1,1,1,1,1,1,1,1};
 
    EvapMethod evap_method = EvapMethod::CONSTANT;
 
    // Monthly adjustment for infiltration capacity (scales f0/fmin/Ks)
    // @see Legacy: InfilFactor (set from hydcon adjustment pattern)
    double infil_factor = 1.0;
 
    // Recovery factor for infiltration models
    // @see Legacy: Evap.recoveryFactor (set from recovery adjustment pattern)
    double recovery_factor = 1.0;
};
 
// ============================================================================
// Functions
// ============================================================================
 
double hargreaves(double latitude, int day_of_year, double t_avg, double t_range);
 
void updateDailyClimate(ClimateState& state, int day_of_year, int month);
 
void batchDistributeEvap(double evap_rate, const double* ponded_depth,
                         double* evap_out, int n, double dt);
 
} // namespace climate
} // namespace openswmm
 
#endif // OPENSWMM_CLIMATE_HPP