chore: update documentation to reflect recent architectural changes and improve clarity

This commit is contained in:
Sepehr
2026-03-10 22:59:04 +01:00
parent d88914a44f
commit 891c4ba436
530 changed files with 2544 additions and 1513 deletions

View File

@@ -154,14 +154,15 @@ impl ScrewPerformanceCurves {
/// - `port_discharge` (index 1): High-pressure outlet
/// - `port_economizer` (index 2): Intermediate-pressure injection inlet
///
/// **State variables (5 total):**
/// - `state[0]`: ṁ_suction (kg/s)
/// - `state[1]`: ṁ_eco (kg/s)
/// - `state[2]`: h_suction (J/kg)
/// - `state[3]`: h_discharge (J/kg)
/// - `state[4]`: W_shaft (W)
/// **Internal state variables (3 total, via `internal_state_len()`):**
/// - `state[offset+0]`: ṁ_suction (kg/s)
/// - `state[offset+1]`: ṁ_eco (kg/s)
/// - `state[offset+2]`: W_shaft (W)
///
/// **Equations (5 total):**
/// Note: h_suction and h_discharge are read from the connected port enthalpies
/// (graph state), not from the component's internal state block.
///
/// **Equations (5 total, via `n_equations()`):**
/// 1. Mass flow suction: ṁ_suc_calc ṁ_suc_state = 0
/// 2. Economizer mass flow: ṁ_eco_calc ṁ_eco_state = 0
/// 3. Energy balance: ṁ_suc×h_suc + ṁ_eco×h_eco + W = ṁ_total×h_dis