openswmm::HeatElement Struct Reference

Which element a flux evaluator is being called for. More...

#include <HeatOverrideData.hpp>

Collaboration diagram for openswmm::HeatElement:

Static Public Member Functions
static HeatElement	node (int i)
	Construct a NODE heat-element descriptor.
static HeatElement	link (int i)
	Construct a LINK heat-element descriptor.
static HeatElement	subcatch (int i)
	Construct a SUBCATCH heat-element descriptor.
static HeatElement	cell2d (int i)
	Construct a CELL2D heat-element descriptor.

Public Attributes
HeatElemKind	kind = HeatElemKind::LINK
int	index = -1

Detailed Description

Which element a flux evaluator is being called for.

Default-constructs to an INVALID index deliberately: a binding that forgets to pass a real element gets the global config (the accessors treat index < 0 as "no override"), which is the safe answer, while a gate that pins per-element behaviour still catches the omission. The alternative — defaulting to index 0 — would silently give every element the FIRST link's attributes.

Member Function Documentation

cell2d()

static HeatElement openswmm::HeatElement::cell2d ( int i )

inlinestatic

Construct a CELL2D heat-element descriptor.

Parameters

[in]

i

Stored index copied without bounds checking; negative denotes no usable element.

Returns

Value descriptor; does not resolve names, allocate storage or enable overrides.

Here is the caller graph for this function:

link()

static HeatElement openswmm::HeatElement::link ( int i )

inlinestatic

Construct a LINK heat-element descriptor.

Parameters

[in]

i

Stored index copied without bounds checking; negative denotes no usable element.

Returns

Value descriptor; does not resolve names, allocate storage or enable overrides.

Here is the caller graph for this function:

node()

static HeatElement openswmm::HeatElement::node ( int i )

inlinestatic

Construct a NODE heat-element descriptor.

Parameters

[in]

i

Stored index copied without bounds checking; negative denotes no usable element.

Returns

Value descriptor; does not resolve names, allocate storage or enable overrides.

Here is the caller graph for this function:

subcatch()

static HeatElement openswmm::HeatElement::subcatch ( int i )

inlinestatic

Construct a SUBCATCH heat-element descriptor.

Parameters

[in]

i

Stored index copied without bounds checking; negative denotes no usable element.

Returns

Value descriptor; does not resolve names, allocate storage or enable overrides.

Here is the caller graph for this function:

Member Data Documentation

index

int openswmm::HeatElement::index = -1

kind

HeatElemKind openswmm::HeatElement::kind = HeatElemKind::LINK

---

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

• /home/runner/work/openswmm.engine/openswmm.engine/src/engine/data/HeatOverrideData.hpp