LidLayerCommon.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_TRANSPORT_LID_LAYER_COMMON_HPP
#define OPENSWMM_ENGINE_TRANSPORT_LID_LAYER_COMMON_HPP
 
#include <vector>
 
#include "../../data/LidLayerSpeciesData.hpp"
#include "../../hydrology/LID.hpp"
 
namespace openswmm::transport {
 
constexpr int kNL = LidLayerSpeciesState::kLayerCount;

constexpr int kExternal = -1;
constexpr int kAbsent   = -2;
 
constexpr int kSurf = static_cast<int>(LidLayer::SURFACE);
constexpr int kPave = static_cast<int>(LidLayer::PAVEMENT);
constexpr int kSoil = static_cast<int>(LidLayer::SOIL);
constexpr int kStor = static_cast<int>(LidLayer::STORAGE);

struct Donors { int surface, pavement, soil, storage; };
 
Donors donorsFor(lid::LIDType t, bool has_soil);

void layerVolumes(const lid::LIDGroupSoA& g, std::size_t ui,
                  double (&v)[kNL]);

std::vector<int> buildOffsets(const lid::LIDSolver& solver);
 
}  // namespace openswmm::transport
 
#endif  // OPENSWMM_ENGINE_TRANSPORT_LID_LAYER_COMMON_HPP