TransportPolicy.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_POLICY_HPP
#define OPENSWMM_ENGINE_TRANSPORT_POLICY_HPP
 
#include <string>
#include <vector>
 
namespace openswmm {
struct SimulationContext;
}
 
namespace openswmm::transport {

enum class Domain : int {
    RUNOFF      = 0,  
    GROUNDWATER = 1,  
    NETWORK_1D  = 2,  
    SURFACE_2D  = 3,  
    COUNT       = 4
};

enum class SpeciesClass : int {
    POLLUTANTS  = 0,  
    MSX         = 1,  
    AGE         = 2,  
    TEMPERATURE = 3,  
    COUNT       = 4
};

enum class CellState : int {
    ENABLED          = 0,  
    DISABLED_BY_USER = 1,  
    UNAVAILABLE      = 2   
};
 
struct Cell {
    CellState   state  = CellState::UNAVAILABLE;
    int         count  = 0;      
    std::string reason;          
};

struct ClassEnables {
    int  n_pollut     = 0;
    int  n_msx        = 0;
    bool age          = false;
    bool temperature  = false;
    bool msx_has_wall = false;
    int  total() const noexcept { return n_pollut + n_msx + (age ? 1 : 0) + (temperature ? 1 : 0); }
};

ClassEnables network1DEnables(const SimulationContext& ctx) noexcept;

ClassEnables surface2DEnables(const SimulationContext& ctx) noexcept;

struct RowLayout {
    int n_pollut = 0;
    int n_msx    = 0;
    int age_row  = -1;
    int temp_row = -1;
    int ns       = 0;
    std::vector<std::string> names;   
};
RowLayout canonicalRows(const SimulationContext& ctx, const ClassEnables& e);
 
struct Matrix {
    Cell cells[static_cast<int>(Domain::COUNT)][static_cast<int>(SpeciesClass::COUNT)];
    const Cell& at(Domain d, SpeciesClass c) const noexcept {
        return cells[static_cast<int>(d)][static_cast<int>(c)];
    }
    Cell& at(Domain d, SpeciesClass c) noexcept {
        return cells[static_cast<int>(d)][static_cast<int>(c)];
    }
};

Matrix resolve(const SimulationContext& ctx);
 
const char* domainName(Domain d) noexcept;
const char* speciesClassName(SpeciesClass c) noexcept;
const char* cellStateName(CellState s) noexcept;

std::string formatReportBlock(const Matrix& m);
 
}  // namespace openswmm::transport
 
#endif  // OPENSWMM_ENGINE_TRANSPORT_POLICY_HPP