HeatOverrides.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_HEAT_OVERRIDES_HPP
#define OPENSWMM_ENGINE_TRANSPORT_HEAT_OVERRIDES_HPP
 
#include <string>
#include <vector>
 
#include "../../../data/HeatData.hpp"
 
namespace openswmm {
struct SimulationContext;
}
 
namespace openswmm::transport::heat {

std::vector<std::string> resolveHeatOverrides(SimulationContext& ctx);

const RadiativeConfig& radiativeFor(const SimulationContext& ctx,
                                    const HeatElement& e) noexcept;

const SedimentConfig& sedimentFor(const SimulationContext& ctx,
                                  const HeatElement& e) noexcept;
 
// The NaN sentinel on `landcover_temp` ("use air temperature") is resolved
// in exactly one place: `netRadiativeFluxOut`, which receives the resolved
// per-element RadiativeConfig and is the only reader of the field. The
// handoff's draft declared a `landcoverTempC` accessor here instead — and no
// call site ever used it, which left the key parsed, validated, serialized
// and physically inert. The check deleted the accessor and moved the
// resolution to the reader.
 
}  // namespace openswmm::transport::heat
 
#endif  // OPENSWMM_ENGINE_TRANSPORT_HEAT_OVERRIDES_HPP