SWMM_ChannelGroundPreview Struct Reference

#include <openswmm_heat.h>

Collaboration diagram for SWMM_ChannelGroundPreview:

Public Attributes
unsigned int	struct_size
int	link
int	valid
int	contact_cells
int	contact_intervals
double	length_m
double	covered_length_m
double	uncovered_length_m
char	reason [256]

Detailed Description

Pre-run, read-only XY coverage preview for one routed channel. Contact intervals use whole-polyline fractions, have layer=-1, and may be returned even when valid is false so uncovered geometry remains visible. A valid result means the complete polyline lies in the mesh; soil-profile, invert, bed-thickness and thermal-owner checks still run at initialization. Initialize struct_size and pass contacts=null/capacity=0 to query the required interval count. If capacity is too small, status and required are returned but the contact array is left untouched. Only OPENED/BUILDING engines with a parsed mesh are accepted.

Member Data Documentation

contact_cells

int SWMM_ChannelGroundPreview::contact_cells

contact_intervals

int SWMM_ChannelGroundPreview::contact_intervals

covered_length_m

double SWMM_ChannelGroundPreview::covered_length_m

length_m

double SWMM_ChannelGroundPreview::length_m

link

int SWMM_ChannelGroundPreview::link

reason

char SWMM_ChannelGroundPreview::reason[256]

struct_size

unsigned int SWMM_ChannelGroundPreview::struct_size

uncovered_length_m

double SWMM_ChannelGroundPreview::uncovered_length_m

valid

int SWMM_ChannelGroundPreview::valid

---

The documentation for this struct was generated from the following file:

• /home/runner/work/openswmm.engine/openswmm.engine/include/openswmm/engine/openswmm_heat.h