d9/d3b/_msx_lid_reactions_8hpp_source.html

// SPDX-License-Identifier: Apache-2.0


#pragma once

#include <vector>

namespace openswmm {

struct SimulationContext;

namespace lid {

class LIDSolver;

}

namespace msxlid {

void initialize(SimulationContext&);

void initializeUnits(SimulationContext&, const lid::LIDSolver&);

void routeUnits(SimulationContext&, const lid::LIDSolver&, double dt);

void publishUnits(SimulationContext&, double dt);

const double* drainValues(const SimulationContext&, int type, int unit, int control);

void prepareNodes(SimulationContext&, double dt);

void reactNodes(SimulationContext&, double dt);

double outlet(const SimulationContext&, int node, int link, int species, double fallback);

double receive(SimulationContext&, int node, int link, double water, int species, double mass,

               double dt);

double heldMass(const SimulationContext&, int node, int species);

double mobileWater(const SimulationContext&, int node, double fallback);

bool reactedSubcatchment(const SimulationContext&, int subcatchment);

bool reactPool(SimulationContext&, int control, int layer, double volume, double* mass, double dt,

               double temperature, std::vector<double>& reacted, std::vector<double>& clamped);

} // namespace msxlid

} // namespace openswmm

openswmm::lid::LIDSolver
Definition LID.hpp:316

openswmm::lid
Definition LID.cpp:39

openswmm::msxlid
Definition MsxLidReactions.cpp:24

openswmm::msxlid::heldMass
double heldMass(const SimulationContext &c, int node, int species)
Sum one node's held layer inventory for a reaction species.
Definition MsxLidReactions.cpp:219

openswmm::msxlid::reactNodes
void reactNodes(SimulationContext &c, double dt)
React native LID-node held layer pools and weighted mobile water portions once per interval.
Definition MsxLidReactions.cpp:439

openswmm::msxlid::publishUnits
void publishUnits(SimulationContext &, double dt)
Publish conventional reactive LID surface export as accepted subcatchment runoff concentration.
Definition MsxLidUnits.cpp:274

openswmm::msxlid::prepareNodes
void prepareNodes(SimulationContext &c, double dt)
Replay accepted native LID water transfers into layer/mobile species inventories before routing.
Definition MsxLidReactions.cpp:261

openswmm::msxlid::reactedSubcatchment
bool reactedSubcatchment(const SimulationContext &c, int sc)
Test the prepared conventional-LID reactive subcatchment mask.
Definition MsxLidReactions.cpp:507

openswmm::msxlid::initialize
void initialize(SimulationContext &c)
Ensure opted-in native LID-node layer species stores exist at current seed phase.
Definition MsxLidReactions.cpp:183

openswmm::msxlid::outlet
double outlet(const SimulationContext &c, int node, int link, int species, double fallback)
Read a prepared node-layer outlet concentration for one link/species.
Definition MsxLidReactions.cpp:382

openswmm::msxlid::initializeUnits
void initializeUnits(SimulationContext &, const lid::LIDSolver &)
Initialize conventional reactive LID native species pools and full-coverage ownership mask.
Definition MsxLidUnits.cpp:64

openswmm::msxlid::routeUnits
void routeUnits(SimulationContext &, const lid::LIDSolver &, double dt)
Route/react native species through one accepted conventional LID hydraulic interval.
Definition MsxLidUnits.cpp:145

openswmm::msxlid::reactPool
bool reactPool(SimulationContext &c, int control, int layer, double volume, double *mass, double dt, double temp, std::vector< double > &reacted, std::vector< double > &clamped)
React one finite native LID water pool through scoped compiled species laws.
Definition MsxLidReactions.cpp:115

openswmm::msxlid::mobileWater
double mobileWater(const SimulationContext &c, int node, double fallback)
Read the retained native LID-node mobile water history with caller fallback.
Definition MsxLidReactions.cpp:237

openswmm::msxlid::receive
double receive(SimulationContext &c, int node, int link, double water, int species, double rate, double dt)
Capture an accepted incoming link native mass-rate share into the first matching LID port.
Definition MsxLidReactions.cpp:410

openswmm::msxlid::drainValues
const double * drainValues(const SimulationContext &, int type, int unit, int control)
Borrow the prepared conventional reactive LID drain concentration tuple.
Definition MsxLidUnits.cpp:300

openswmm
Definition ExchangeLaw.hpp:60

openswmm::SimulationContext
Central, reentrant simulation context.
Definition SimulationContext.hpp:390