HeatOverrideData.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_DATA_HEAT_OVERRIDE_DATA_HPP
#define OPENSWMM_ENGINE_DATA_HEAT_OVERRIDE_DATA_HPP
 
#include <cstddef>
#include <cstdint>
#include <string>
#include <vector>
 
namespace openswmm {

enum class HeatElemKind : std::uint8_t {
    NODE = 0,
    LINK = 1,
    SUBCATCH = 2,
    LID = 3,
    CELL2D = 4
};

struct HeatElement {
    HeatElemKind kind = HeatElemKind::LINK;
    int index = -1;

    static HeatElement node(int i) { return {HeatElemKind::NODE, i}; }
    static HeatElement link(int i) { return {HeatElemKind::LINK, i}; }
    static HeatElement subcatch(int i) { return {HeatElemKind::SUBCATCH, i}; }
    static HeatElement cell2d(int i) { return {HeatElemKind::CELL2D, i}; }
};

enum class HeatScope : std::uint8_t {
    GLOBAL = 0,
    TAG = 1,
    NODE = 2,
    LINK = 3,
    // 4/5 remain reserved for the effective-value API's air/series sources.
    CELL2D = 6,
    MESH_TAG = 7
};

enum class HeatAttr : int {
    // RadiativeConfig
    ALBEDO = 0,
    SHADE_FACTOR,
    SKY_VIEW,
    EMISS_WATER,
    EMISS_LANDCOVER,
    LANDCOVER_TEMP, 
    // SedimentConfig
    SED_THERMAL_DIFFUSIVITY,
    SED_SOLUTE_DIFFUSIVITY,
    SED_BED_THICKNESS,
    SED_GROUND_DEPTH,
    SED_GROUND_TEMP,
    SED_HYPORHEIC_VELOCITY,
    SED_DENSITY,
    SED_SPECIFIC_HEAT,
    SED_MESH_POROSITY,
    SED_GROUND_SOURCE,
    COUNT_
};

inline bool isSedimentAttr(HeatAttr a) noexcept {
    return static_cast<int>(a) >= static_cast<int>(HeatAttr::SED_THERMAL_DIFFUSIVITY);
}

struct HeatOverrideRow {
    HeatAttr attr = HeatAttr::ALBEDO;
    HeatScope scope = HeatScope::GLOBAL;
    std::string name; 
    double value = 0.0;
};
 
// The dense storage that these rows resolve into lives in HeatData.hpp, as
// `HeatOverrideData`, because it holds real `RadiativeConfig` /
// `SedimentConfig` values and those are declared there. Keeping the TOKENS
// here lets BedExchange.hpp and the flux evaluators take a `HeatElement`
// without pulling in the whole heat-config header.
 
} // namespace openswmm
 
#endif // OPENSWMM_ENGINE_DATA_HEAT_OVERRIDE_DATA_HPP