openswmm_water_age.h

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_WATER_AGE_H
#define OPENSWMM_WATER_AGE_H
 
#include "openswmm_engine.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum SWMM_WaterAgeSource {
    SWMM_AGE_SRC_RAINFALL        = 0,
    SWMM_AGE_SRC_DWF             = 1,
    SWMM_AGE_SRC_GW              = 2,
    SWMM_AGE_SRC_RDII            = 3,
    SWMM_AGE_SRC_EXTERNAL_INFLOW = 4,
    SWMM_AGE_SRC_IFACE           = 5,
    SWMM_AGE_SRC_INITIAL_STATE   = 6,
    SWMM_AGE_SRC_COUNT           = 7
} SWMM_WaterAgeSource;

SWMM_ENGINE_API int swmm_water_age_get_enabled(SWMM_Engine engine,
                                               int* enabled);

SWMM_ENGINE_API int swmm_water_age_get_global_source(SWMM_Engine engine,
                                                     int source,
                                                     double* hours);

SWMM_ENGINE_API int swmm_water_age_set_global_source(SWMM_Engine engine,
                                                     int source,
                                                     double hours);

SWMM_ENGINE_API int swmm_water_age_override_count(SWMM_Engine engine,
                                                  int* count);

SWMM_ENGINE_API int swmm_water_age_get_override(SWMM_Engine engine, int index,
                                                int* source, int* node_index,
                                                double* hours);

SWMM_ENGINE_API int swmm_water_age_set_override(SWMM_Engine engine,
                                                int source, int node_index,
                                                double hours);

SWMM_ENGINE_API int swmm_water_age_remove_override(SWMM_Engine engine,
                                                   int source,
                                                   int node_index);

SWMM_ENGINE_API int swmm_water_age_save(SWMM_Engine engine,
                                        const char* path);
 
#ifdef __cplusplus
}
#endif
 
#endif  // OPENSWMM_WATER_AGE_H