HydrologyData.hpp

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_ENGINE_HYDROLOGY_DATA_HPP
#define OPENSWMM_ENGINE_HYDROLOGY_DATA_HPP
 
#include <vector>
#include <string>
#include <array>
 
#include "../core/FilePathPair.hpp"
 
namespace openswmm {
 
// ============================================================================
// Snowpack definitions (from [SNOWPACKS] section)
// ============================================================================

struct SnowpackStore {
    int count() const { return static_cast<int>(names.size()); }
 
    std::vector<std::string> names;
 
    // PLOWABLE surface: cmin, cmax, tbase, fwfrac, sd0, fw0, snn0
    std::vector<std::array<double, 7>> plowable;
 
    // IMPERVIOUS surface: cmin, cmax, tbase, fwfrac, sd0, fw0, snn0
    std::vector<std::array<double, 7>> impervious;
 
    // PERVIOUS surface: cmin, cmax, tbase, fwfrac, sd0, fw0, snn0
    std::vector<std::array<double, 7>> pervious;
 
    // REMOVAL: dSnow, fOut, fImp, fPerv, fImelt, fToSubcatch, subcatch_name
    std::vector<std::array<double, 6>> removal;
    std::vector<std::string>           removal_subcatch;
};
 
// ============================================================================
// Aquifer definitions (from [AQUIFERS] section)
// ============================================================================

struct AquiferStore {
    int count() const { return static_cast<int>(names.size()); }
 
    std::vector<std::string> names;
    std::vector<double>      porosity;
    std::vector<double>      wilting_point;
    std::vector<double>      field_capacity;
    std::vector<double>      conductivity;
    std::vector<double>      conduct_slope;
    std::vector<double>      tension_slope;
    std::vector<double>      upper_evap;
    std::vector<double>      lower_evap;
    std::vector<double>      lower_loss;
    std::vector<double>      bottom_elev;
    std::vector<double>      water_table_elev;
    std::vector<double>      upper_moist;
    std::vector<std::string> upper_evap_pat;   
};
 
// ============================================================================
// LID control definitions (from [LID_CONTROLS] section)
// ============================================================================

struct LidControlStore {
    int count() const { return static_cast<int>(names.size()); }
 
    std::vector<std::string> names;

    std::vector<std::string> lid_type;

    std::vector<std::array<double, 5>> surface;

    std::vector<std::array<double, 7>> soil;

    std::vector<std::array<double, 6>> pavement;

    std::vector<std::array<double, 4>> storage;

    std::vector<std::array<double, 6>> drain;

    std::vector<std::array<double, 3>> drainmat;

    std::vector<std::vector<std::pair<int, double>>> removals;
};
 
// ============================================================================
// LID usage assignments (from [LID_USAGE] section)
// ============================================================================

struct LidUsageStore {
    int count() const { return static_cast<int>(subcatch_index.size()); }
 
    std::vector<int>         subcatch_index;   
    std::vector<int>         lid_index;        
    std::vector<int>         number;           
    std::vector<double>      area;             
    std::vector<double>      width;            
    std::vector<double>      init_sat;         
    std::vector<double>      from_imperv;      
    std::vector<int>         to_perv;          
    std::vector<FilePathPair> rpt_file;
    std::vector<std::string> drain_to;         
    std::vector<double>      from_perv;        
 
    // Water balance results (ft depth, filled at end of simulation from LIDGroupSoA)
    std::vector<double>      wb_inflow;        
    std::vector<double>      wb_evap;          
    std::vector<double>      wb_infil;         
    std::vector<double>      wb_surf_flow;     
    std::vector<double>      wb_drain_flow;    
    std::vector<double>      wb_init_vol;      
    std::vector<double>      wb_final_vol;     
 
    void resize_wb(int n) {
        auto un = static_cast<std::size_t>(n);
        wb_inflow.assign(un, 0.0);
        wb_evap.assign(un, 0.0);
        wb_infil.assign(un, 0.0);
        wb_surf_flow.assign(un, 0.0);
        wb_drain_flow.assign(un, 0.0);
        wb_init_vol.assign(un, 0.0);
        wb_final_vol.assign(un, 0.0);
    }
};
 
} // namespace openswmm
 
#endif // OPENSWMM_ENGINE_HYDROLOGY_DATA_HPP