Layered LID node storage, water exchange, and lifecycle operations. More...

#include "../data/LidNodeData.hpp"
#include <string>

Include dependency graph for LidNode.hpp:

This graph shows which files directly or indirectly include this file:

Namespaces
namespace	openswmm

namespace	openswmm::lidnode

Functions
bool	openswmm::lidnode::richardsMode (const SimulationContext &ctx, int node)
	Read the initialized LID Richards mode flag for a node.

LidNodeBottom	openswmm::lidnode::bottomMode (const SimulationContext &c, int node)
	Read the assigned bottom-boundary policy for a node.

double	openswmm::lidnode::exchangeRichardsPorts (SimulationContext &ctx, int link, double flow, double dt)
	Limit and book a link transfer involving Richards or mixed retained-water ports.

void	openswmm::lidnode::prepareRichardsStep (SimulationContext &ctx, double dt, double evaporation, bool mesh_prepared=false)
	Advance non-Mesh Richards owners privately, then publish the whole successful batch.

void	openswmm::lidnode::refreshRichardsState (SimulationContext &ctx, int row)
	Recompute one initialized Richards row pressure, moisture and retained inventory.

void	openswmm::lidnode::readRichards (SimulationContext &ctx, const std::vector< std::string > &lines)
	Parse node-LID Richards numerical options and layer retention/storage materials.

std::vector< LidNodeLayer >	openswmm::lidnode::layers (const SimulationContext &ctx, int control)
	Copy an authored node layer stack or adapt a supported conventional LID control.

bool	openswmm::lidnode::validLayer (const LidNodeLayer &l)
	Check one authored node-layer material record.

std::string	openswmm::lidnode::validateStack (const std::vector< LidNodeLayer > &stack)
	Validate layer material/order and optional Richards requirements.

double	openswmm::lidnode::thickness (const std::vector< LidNodeLayer > &stack)
	Sum all physical layer thicknesses while excluding the bottom boundary record.

void	openswmm::lidnode::validate (SimulationContext &ctx)
	Validate node-LID model references, layers, supported physics and anchored geometry.

void	openswmm::lidnode::sync (SimulationContext &ctx, int control)
	Synchronize dependent storage depth and authored outlet anchors after a control edit.

void	openswmm::lidnode::initialize (SimulationContext &ctx)
	Build node-LID hydraulic cells and initial retained/mobile water state.

void	openswmm::lidnode::initializeInfiltration (SimulationContext &ctx, int node)
	Initialize/reconstruct node-LID surface Green-Ampt history from physical moisture.

void	openswmm::lidnode::prepareStep (SimulationContext &ctx, double dt, double evaporation)
	Prepare one node-LID moisture/routing interval before hydraulic mutation.

void	openswmm::lidnode::prepareStepAfterMesh (SimulationContext &ctx, double dt, double evaporation)
	Prepare mixed-mode LID rows after Mesh Richards owners accepted this interval.

void	openswmm::lidnode::finishStep (SimulationContext &ctx)
	Finish all node-LID port transfers at a common accepted boundary.

void	openswmm::lidnode::finishRichardsNodes (SimulationContext &ctx, double start, double end, const std::vector< int > &nodes)
	Finish exactly one connected accepted Mesh Richards owner cohort.

bool	openswmm::lidnode::validateRichardsRouting (const SimulationContext &ctx, double dt)
	Preflight the common accepted Mesh Richards routing interval without mutation.

void	openswmm::lidnode::resetPorts (SimulationContext &ctx)
	Clear trial port-transfer accumulators before a fresh hydraulic iteration.

double	openswmm::lidnode::portOffset (const SimulationContext &ctx, int link, int node)
	Resolve the actual hydraulic port elevation relative to a selected node invert.

int	openswmm::lidnode::portCell (const LidNodeState &state, double offset)
	Map a hydraulic port offset to a physical LID cell with stable interface ownership.

double	openswmm::lidnode::portDepth (const SimulationContext &ctx, int node, double offset)
	Read the port hydraulic head as a node-relative depth.

double	openswmm::lidnode::exchangePorts (SimulationContext &ctx, int link, double flow, double dt)
	Limit and book one trial link transfer through LID mobile/retained ports.

double	openswmm::lidnode::bottomConductivity (const SimulationContext &c, int storage_row)
	Select the authored conductivity driving native storage bottom exfiltration.

double	openswmm::lidnode::bottomCloggingFactor (const SimulationContext &c, int storage_row)
	Evaluate the node-LID bottom clogging multiplier from cumulative treated water.

double	openswmm::lidnode::heldVolume (const SimulationContext &ctx, int node)
	Read retained node-LID water outside the mobile hydraulic volume.

bool	openswmm::lidnode::active (const SimulationContext &ctx, int node)
	Check whether a node has initialized physical LID cells.

bool	openswmm::lidnode::validTreatment (const SimulationContext &ctx, const LidLayerTreatment &rule, std::string &error)
	Validate a layer pollutant rule and optional legacy treatment expression.

void	openswmm::lidnode::readTreatment (SimulationContext &ctx, const std::vector< std::string > &lines)
	Parse authored node-LID layer treatment rows.

void	openswmm::lidnode::prepareQuality (SimulationContext &ctx, double dt)
	Apply accepted LID vertical/retained-port transfers and resident decay to pollutant mass.

void	openswmm::lidnode::prepareOutletQuality (SimulationContext &ctx, double dt, bool book_reaction)
	Refresh mobile outlet treatment against the current coupled node mixture.

bool	openswmm::lidnode::receiveQuality (SimulationContext &ctx, int node, int link, double volume, int pollutant, double mass, double dt)
	Divert the retained fraction of an arriving pollutant load into its LID port cell.

double	openswmm::lidnode::outletQuality (const SimulationContext &ctx, int node, int link, int pollutant, double fallback)
	Read a cached treated outlet concentration with a caller fallback.

double	openswmm::lidnode::heldMass (const SimulationContext &ctx, int node, int pollutant)
	Sum retained pollutant inventory across all initialized LID cells.

void	openswmm::lidnode::readNodes (SimulationContext &ctx, const std::vector< std::string > &lines)
	Parse LID storage-node assignments and bottom-boundary modes.

void	openswmm::lidnode::readOutlets (SimulationContext &ctx, const std::vector< std::string > &lines)
	Parse hydraulic outlet anchors to numbered LID layer interfaces.

Detailed Description

Layered LID node storage, water exchange, and lifecycle operations.

Author: Caleb Buahin caleb.nosp@m..bua.nosp@m.hin@g.nosp@m.mail.nosp@m..com

License: Apache-2.0

Namespaces

Functions

Detailed Description