WatershedCommon.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_WATERSHED_COMMON_HPP
#define OPENSWMM_ENGINE_TRANSPORT_WATERSHED_COMMON_HPP
 
#include <cstddef>
 
namespace openswmm {
struct SimulationContext;
}
 
namespace openswmm::transport {

constexpr int kSubIMPERV0 = 0;
constexpr int kSubIMPERV1 = 1;
constexpr int kSubPERV    = 2;

double arrivingPrecipRate(const SimulationContext& ctx, std::size_t ui,
                          int subarea) noexcept;

double arrivingMeltFraction(const SimulationContext& ctx, std::size_t ui,
                            int subarea) noexcept;

double arrivingPrecipTemperature(const SimulationContext& ctx, std::size_t ui,
                                 int subarea) noexcept;

double arrivingPrecipAge(const SimulationContext& ctx, std::size_t ui,
                         int subarea) noexcept;

inline constexpr double kMeltwaterTempC = 0.0;
 
}  // namespace openswmm::transport
 
#endif  // OPENSWMM_ENGINE_TRANSPORT_WATERSHED_COMMON_HPP