gageblend.h

Go to the documentation of this file.

 
#ifndef OPENSWMMVIS_CORE_GAGEBLEND_H
#define OPENSWMMVIS_CORE_GAGEBLEND_H
 
#include <QString>
#include <QVector>
 
#include <QtGlobal>
 
namespace GageBlend
{
 
enum class RainType
{
    Intensity  = 0,  
    Volume     = 1,  
    Cumulative = 2   
};
 
constexpr int kMaxGridCells = 200000;
 
constexpr double kVolumeTolerance = 1e-9;
 
struct SeriesPoint
{
    qint64 t     = 0;    
    double value = 0.0;  
};
 
struct SourceGage
{
    QVector<SeriesPoint> points;                     
    qint64               intervalSec = 0;            
    RainType             rainType    = RainType::Intensity;
    double               scaleFactor = 1.0;          
    QString              name;                       
};
 
struct Box
{
    qint64 t0 = 0;
    qint64 t1 = 0;
    double intensity = 0.0;
};
 
struct BlendResult
{
    QVector<SeriesPoint> points;            
    qint64               intervalSec = 0;   
 
    double blendedDepth   = 0.0;   
    double referenceDepth = 0.0;   
    double relativeError  = 0.0;   
 
    double peakBlended   = 0.0;    
    double peakReference = 0.0;    
 
    QString error;                 
 
    [[nodiscard]] bool volumeOk() const
    {
        return error.isEmpty() && relativeError <= kVolumeTolerance;
    }
 
    [[nodiscard]] double peakRetention() const
    {
        return peakReference > 0.0 ? peakBlended / peakReference : 1.0;
    }
};
 
[[nodiscard]] QVector<Box> toBoxes(const SourceGage &source);
 
[[nodiscard]] double boxDepth(const QVector<Box> &boxes);
 
[[nodiscard]] double engineDepth(const QVector<SeriesPoint> &points,
                                 qint64 intervalSec,
                                 RainType rainType   = RainType::Intensity,
                                 double   scaleFactor = 1.0);
 
[[nodiscard]] BlendResult blend(const QVector<SourceGage> &sources,
                                const QVector<double> &weights);
 
} // namespace GageBlend
 
#endif // OPENSWMMVIS_CORE_GAGEBLEND_H