openswmm::surface::ueb::HeldState Struct Reference

#include <UebHeld.hpp>

Collaboration diagram for openswmm::surface::ueb::HeldState:

Public Member Functions
bool	pending () const noexcept
	Test whether the prepared forcing window has unconsumed duration.

Public Attributes
LumpedState	accepted
LumpedState	begin
LumpedState	end
LumpedFluxes	flux
double	duration = 0
double	elapsed = 0

Member Function Documentation

pending()

bool openswmm::surface::ueb::HeldState::pending ( ) const

inlinenoexcept

Test whether the prepared forcing window has unconsumed duration.

Returns

elapsed<duration exactly, without validating finite/nonnegative clock invariants. Does not expose predicted end water as accepted or mutate history.

Here is the caller graph for this function:

Member Data Documentation

accepted

LumpedState openswmm::surface::ueb::HeldState::accepted

begin

LumpedState openswmm::surface::ueb::HeldState::begin

duration

double openswmm::surface::ueb::HeldState::duration = 0

elapsed

double openswmm::surface::ueb::HeldState::elapsed = 0

end

LumpedState openswmm::surface::ueb::HeldState::end

flux

LumpedFluxes openswmm::surface::ueb::HeldState::flux

---

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

• /home/runner/work/openswmm.engine/openswmm.engine/src/engine/hydrology/surface/UebHeld.hpp