OpenSWMM Engine  6.0.0-alpha.1
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.1)
Loading...
Searching...
No Matches
openswmm::runoff::RunoffSolver Class Reference

#include <Runoff.hpp>

Collaboration diagram for openswmm::runoff::RunoffSolver:

Public Member Functions

void init (SimulationContext &ctx)
 
void execute (SimulationContext &ctx, double dt, double evap_rate=0.0, double infil_factor=1.0, double recovery_factor=1.0, int month=-1)
 
const RunoffSoAsoa () const
 
void infil_get_state (int i, int &model, double state[6]) const noexcept
 Pack infiltration state for subcatchment i into a flat 6-element array.
 
void infil_set_state (int i, int model, const double state[6]) noexcept
 Restore infiltration state for subcatchment i from a flat 6-element array.
 

Member Function Documentation

◆ execute()

void openswmm::runoff::RunoffSolver::execute ( SimulationContext ctx,
double  dt,
double  evap_rate = 0.0,
double  infil_factor = 1.0,
double  recovery_factor = 1.0,
int  month = -1 
)
Parameters
infil_factorMonthly infiltration rate multiplier (default 1.0).
recovery_factorMonthly soil recovery multiplier (default 1.0).
Here is the call graph for this function:

◆ infil_get_state()

void openswmm::runoff::RunoffSolver::infil_get_state ( int  i,
int &  model,
double  state[6] 
) const
noexcept

Pack infiltration state for subcatchment i into a flat 6-element array.

Layout (matches legacy infil_getState() encoding):

  • Horton/ModHorton (0,1): [tp, Fe, Fmh, 0, 0, 0]
  • GA/ModGA (2,3): [IMD, F, Fu, T, sat(0/1), 0]
  • CurveNum (4): [S, Se, P, F, f, T]
Parameters
iSubcatchment index.
model[out] InfilModel enum value.
state[out] 6-element flat state array.
Here is the caller graph for this function:

◆ infil_set_state()

void openswmm::runoff::RunoffSolver::infil_set_state ( int  i,
int  model,
const double  state[6] 
)
noexcept

Restore infiltration state for subcatchment i from a flat 6-element array.

Only updates the state fields; does not reinitialise parameters. Silently ignores out-of-range i or mismatched model type.

Parameters
iSubcatchment index.
modelInfilModel enum value stored in the hot start file.
state6-element flat state array written by infil_get_state().
Here is the caller graph for this function:

◆ init()

void openswmm::runoff::RunoffSolver::init ( SimulationContext ctx)
Here is the call graph for this function:

◆ soa()

const RunoffSoA & openswmm::runoff::RunoffSolver::soa ( ) const
inline

The documentation for this class was generated from the following files: