openswmm_hotstart.h

Go to the documentation of this file.

 
#ifndef OPENSWMM_ENGINE_HOTSTART_H
#define OPENSWMM_ENGINE_HOTSTART_H
 
#include "openswmm_engine.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef void* SWMM_HotStart;
 
#define OPENSWMM_HOTSTART_MAGIC    "OPENSWMM_HS_V1\0"
 
#define OPENSWMM_HOTSTART_VERSION  1
 
/* =========================================================================
 * Create / save
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_hotstart_save(SWMM_Engine engine, const char* path);
 
/* =========================================================================
 * Open / read
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_hotstart_open(const char* path, SWMM_HotStart* hs);
 
/* =========================================================================
 * Apply
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_hotstart_apply(SWMM_Engine engine, SWMM_HotStart hs);
 
/* =========================================================================
 * Modify hot start data
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_hotstart_set_node_depth(
    SWMM_HotStart hs,
    const char*   node_id,
    double        depth
);
 
SWMM_ENGINE_API int swmm_hotstart_set_node_head(
    SWMM_HotStart hs,
    const char*   node_id,
    double        head
);
 
SWMM_ENGINE_API int swmm_hotstart_set_link_flow(
    SWMM_HotStart hs,
    const char*   link_id,
    double        flow
);
 
SWMM_ENGINE_API int swmm_hotstart_set_link_depth(
    SWMM_HotStart hs,
    const char*   link_id,
    double        depth
);
 
SWMM_ENGINE_API int swmm_hotstart_set_subcatch_runoff(
    SWMM_HotStart hs,
    const char*   subcatch_id,
    double        runoff
);
 
/* =========================================================================
 * Query hot start metadata
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_hotstart_get_sim_time(SWMM_HotStart hs, double* sim_time);
 
SWMM_ENGINE_API int swmm_hotstart_get_crs(SWMM_HotStart hs, char* buf, int buflen);
 
SWMM_ENGINE_API int swmm_hotstart_node_count(SWMM_HotStart hs);
 
SWMM_ENGINE_API int swmm_hotstart_link_count(SWMM_HotStart hs);
 
/* =========================================================================
 * Warning access (populated after swmm_hotstart_apply())
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_hotstart_warning_count(SWMM_HotStart hs);
 
SWMM_ENGINE_API const char* swmm_hotstart_warning(SWMM_HotStart hs, int index);
 
/* =========================================================================
 * Close
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_hotstart_close(SWMM_HotStart hs);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OPENSWMM_ENGINE_HOTSTART_H */