Gage.hpp

Go to the documentation of this file.

 
#ifndef OPENSWMM_GAGE_HPP
#define OPENSWMM_GAGE_HPP
 
#include "../data/SubcatchData.hpp"
#include <cstddef>
#include <vector>
 
namespace openswmm {
 
struct SimulationContext;
 
namespace gage {
 
// ============================================================================
// Constants
// ============================================================================
 
constexpr double ONE_SECOND    = 1.1574074e-5;  
constexpr int    MAXPASTRAIN   = 48;             
 
// ============================================================================
// Rain type codes
// ============================================================================
 
enum class RainType : int {
    INTENSITY  = 0,
    VOLUME     = 1,
    CUMULATIVE = 2
};
 
// ============================================================================
// Per-gage state
// ============================================================================
 
struct GageState {
    double rainfall      = 0.0;   
    double snowfall      = 0.0;   
    double total_precip  = 0.0;   
    double rain_accum    = 0.0;   
    double api_rainfall  = -1.0;  
    double snow_factor   = 1.0;   
    double scale_factor  = 1.0;   
    double units_factor  = 1.0;   
    double adjust_factor = 1.0;   
    double rain_interval = 0.0;   
    RainType rain_type   = RainType::INTENSITY;
 
    double past_rain[MAXPASTRAIN] = {}; 
    double past_rain_accum = 0.0;       
    double past_rain_time  = 0.0;       
};
 
// ============================================================================
// Functions
// ============================================================================

double convertRainfall(double raw_value, GageState& state);

struct PrecipSplit {
    double rainfall = 0.0;  
    double snowfall = 0.0;  
};

PrecipSplit splitPrecip(const SimulationContext& ctx, std::size_t sub);

void updatePastRain(GageState& state, double current_time);

double getPastRain(const GageState& state, int hours);

void updateAllGages(SimulationContext& ctx, double current_time);

double getReportRainfall(const SimulationContext& ctx, int gage_idx,
                         double report_date);
 
} // namespace gage
} // namespace openswmm
 
#endif // OPENSWMM_GAGE_HPP