OpenSWMM Engine  6.0.0-alpha.4
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
ArdConfigData.hpp File Reference

Parsed configuration of the Eulerian ARD transport component (org.hydrocouple.openswmm.transport.ard, config file model.ard). More...

#include <string>
#include <vector>
Include dependency graph for ArdConfigData.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  openswmm::ArdTransportRow
 One raw [TRANSPORT_BOUNDARIES] or [TRANSPORT_SOURCES] row (E5a). More...
 
struct  openswmm::ArdConfigData
 Parsed model.ard state consumed by ArdEngine::init (phase E3). More...
 

Namespaces

namespace  openswmm
 

Enumerations

enum class  openswmm::ArdDispersionMode : int {
  openswmm::OFF = 0 ,
  openswmm::FISCHER = 1 ,
  openswmm::VALUE = 2
}
 Global dispersion coefficient model ([TRANSPORT_OPTIONS] DISPERSION). More...
 

Variables

constexpr double openswmm::kLitersPerFt3 = 28.316846592
 

Detailed Description

Parsed configuration of the Eulerian ARD transport component (org.hydrocouple.openswmm.transport.ard, config file model.ard).

Phase E3 of the Eulerian ARD plan activates the dispersion subset of the component config (D-UT8 placement: these options live in the external component file, NOT in [OPTIONS]):

``` [TRANSPORT_OPTIONS] DISPERSION OFF | FISCHER |

; global coefficient model

[CONDUIT_DISPERSION] <conduit_name>

; per-conduit override ```

Values are entered in project display units (len²/s — m²/s under SI flow units, ft²/s under US); the engine converts to internal ft²/s at init, mirroring the FV_DISPERSION treatment in Router::initFv. Per-conduit overrides win over the global model in their conduit regardless of mode (including OFF). The remaining [TRANSPORT_OPTIONS] keys and the shared 1D sections ([TRANSPORT_BOUNDARIES]/[TRANSPORT_SOURCES]/[STORAGE_MIXING]) arrive with plan phases E5/E2b and are refused with precise deferral errors until then.

See also
plans/transport/EULERIAN_ARD_TRANSPORT_PLAN.md §4, §6 E3
plans/transport/TRANSPORT_IO_PLUGIN_CONFIG_PLAN.md §3.2
Author
Caleb Buahin caleb.nosp@m..bua.nosp@m.hin@g.nosp@m.mail.nosp@m..com
License\n Apache-2.0