OpenSWMM Engine  6.0.0-alpha.4
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
openswmm::transport::RxStepReport Struct Reference

#include <ReactionIntegrator.hpp>

Collaboration diagram for openswmm::transport::RxStepReport:

Public Attributes

bool ok = true
 
int substeps = 0
 RATE substeps actually taken.
 
int newton_iters = 0
 EQUIL + implicit-solver Newton iterations.
 
std::string error
 set when !ok
 

Detailed Description

Outcome of one reaction step. ok == false is a HARD failure (Newton divergence, non-finite state) — the caller decides fatality; soft adaptivity (substepping) is internal and only reported.

Member Data Documentation

◆ error

std::string openswmm::transport::RxStepReport::error

set when !ok

◆ newton_iters

int openswmm::transport::RxStepReport::newton_iters = 0

EQUIL + implicit-solver Newton iterations.

◆ ok

bool openswmm::transport::RxStepReport::ok = true

◆ substeps

int openswmm::transport::RxStepReport::substeps = 0

RATE substeps actually taken.


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