sepehr
3358b74342
Ship the Next.js cycle editor with CAD chrome, technical HX symbols, Fixed/Free boundary guidance, and secondary water/air pressure drop support in the solver stack. Co-authored-by: Cursor <cursoragent@cursor.com>
5.4 KiB
Entropyk Component Documentation / Documentation des composants Entropyk
Bilingual reference (EN + FR) for every component usable from the CLI JSON config and the web UI.
Référence bilingue (EN + FR) pour chaque composant CLI / UI.Each page documents: physical model, correlations (if any), residual equations,
n_equations(), ports, system vs rating secondary, calibration Z-factors, and JSON parameters with defaults.Chaque fiche documente : modèle, corrélations, résidus, ports, modes système/rating, facteurs Z, paramètres JSON.
Last major doc refresh: 2026-07-17 — dual-mode HX Newton, compressor maps (AHRI / SST–SDT), correlation inventory, UI Fixed/Free, fallback solver.
Full correlation & map inventory
→ correlations-and-maps.md — AHRI 540, screw bilinear presets, Longo/Shah/…, ε-NTU, pumps/fans, ΔP.
Conventions
State / État
- State per edge:
(ṁ, P, h). Series branches share one ṁ unknown (same_branch_m, CM1.4). - État par arête :
(ṁ, P, h). Branches en série → un seul ṁ.
DoF (degrees of freedom)
A real-machine solve requires n_equations = n_unknowns.
- FIX = impose a quantity (boundary T/P/ṁ, outlet SH/SC, quality residual, measured calib target…) → +equation or pin.
- FREE = solver unknown (emergent pressure, free opening, free
z_ua, …).
CLI hard-fails on imbalance (validate_system_dof). Web UI: Fixed checkboxes + balance bar.
System vs rating secondary (HX)
| Mode | Secondary definition | Secondary unknowns | Newton duty |
|---|---|---|---|
| System | Live ports secondary_inlet / secondary_outlet + Source/Sink |
yes | ε-NTU Q from edge state |
| Rating | Scalars secondary_inlet_temp_* + ṁ·cp or C_sec |
no | ε-NTU Q from scalars in residuals |
Both modes are first-class for Condenser / Evaporator / FloodedEvaporator.
Scalars are not limited to offline rate() only.
Zero flow
Valid state. HX use flow_regularization (smooth |ṁ|, activity, Δh hold). See flow-regularization.md.
Emergent pressure
emergent_pressure: true lets condensing/evaporating pressure float from HX ↔ secondary energy balance instead of a fixed design pin.
Calibration Z-factors (BOLT)
Default 1.0 = no correction. Typical range ~0.2–3 for inverse calib; production often ~0.8–1.2.
| Entropyk | BOLT | Effect |
|---|---|---|
z_flow |
Z_flow_suc, … |
ṁ_eff = z_flow × ṁ_nom |
z_dp |
Z_dpc, … |
ΔP_eff = z_dp × ΔP_nom |
z_ua |
Z_UA, Z_Uev, Z_Ucd |
UA_eff = z_ua × UA_nom |
z_power |
Z_power |
Ẇ_eff = z_power × Ẇ_nom |
z_etav |
— | η_v scale |
Legacy f_* and BOLT Z_* spellings accepted in JSON.
Recommended order: z_flow → z_dp → z_ua → z_power → z_etav.
UI calibration pattern: Fixed on measure (SST/SDT) + Free on z_ua (do not require the Advanced “Regulation loop” node for simple Z_UA calib).
Solver strategies (CLI)
solver.strategy |
Behaviour |
|---|---|
newton |
Newton–Raphson |
picard |
Sequential substitution |
fallback |
Intelligent Newton → Picard (FallbackSolver) |
Compressors / Compresseurs
Heat exchangers / Échangeurs
| Component | Model / correlations | Notes |
|---|---|---|
| Condenser | ε-NTU phase-change | dual secondary modes |
| Evaporator | ε-NTU DX + SH | dual secondary modes |
| FloodedEvaporator | ε-NTU + sat-vapor / quality | dual secondary modes |
| FloodedCondenser | inner ε-NTU + SC control | prefer Condenser in production |
| BphxEvaporator / BphxCondenser | Longo / Shah → UA + ε-NTU | geometry + correlation |
| AirCooledCondenser | air-side coil | |
| FinCoilCondenser | finned coil | |
| MchxCondenserCoil | microchannel | |
| HeatExchanger (generic) | generic ε-NTU / LMTD | |
| FreeCoolingExchanger | free cooling | |
| Economizer | internal LMTD HX | not always a CLI leaf |
| MovingBoundaryHX | multi-zone UA ID | research path |
| Flow regularization | zero-flow helpers | shared |
Valves & expansion
Flow network
Rotating machines
Boundaries
Inline nodes
Inter-circuit coupling
See also: system capability notes under docs/ and example machines in crates/cli/examples/.