1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 OUTRAM PARK contributors
//
// This file is part of OUTRAM PARK.
//
// OUTRAM PARK is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the
// Free Software Foundation, either version 3 of the License, or (at your
// option) any later version.
//
// OUTRAM PARK is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with OUTRAM PARK. If not, see <https://www.gnu.org/licenses/>.
//! **DOVER** — *Deck-based Open-source Visualisation Engine for Reactors*, the
//! low-fidelity counterpart of `dhoby-ghaut`.
//!
//! # What is here
//!
//! One worked low-fidelity case, run from a TOML deck, headless:
//! **steam methane reforming in a continuous stirred-tank reactor.**
//!
//! ```text
//! TOML deck ──► deck::Deck (validated) ──► smr::SmrCase
//! │
//! dwsim-libs Cstr ◄───────────┘
//! (Newton on the reaction extents)
//! │
//! ▼
//! headless::run_deck ──► CSV on stdout
//! ```
//!
//! ```no_run
//! use dover::headless::run_toml;
//!
//! let csv = run_toml(&std::fs::read_to_string("decks/smr_cstr.toml").unwrap()).unwrap();
//! print!("{csv}");
//! ```
//!
//! # What was reused rather than written
//!
//! Almost all of it. The workspace's "search before building" rule turned up
//! a complete reactor stack in `outram-park-fork-dwsim-libs` that this crate
//! composes rather than duplicates:
//!
//! | needed | already existed |
//! |---|---|
//! | the CSTR itself | `reactors::Cstr` — damped Newton on reaction extents, tested against `X = kτ/(1+kτ)` |
//! | reversible rate law | `reactions::Reaction::net_rate` |
//! | `K_eq(T)` from `ΔH°`/`ΔS°` | `reactions::EquilibriumConstant::GibbsVantHoff` |
//! | feed/outcome plumbing | `reactors::{ReactorFeed, ReactorOutcome}` |
//! | TOML + serde | already in the root `[workspace.dependencies]` |
//!
//! What is genuinely new here is the **deck reader** (DOVER's own
//! `CLAUDE.md` identified it as the missing piece), the **species
//! thermochemistry** ([`species`] — the workspace had critical constants for
//! three of the five species and no formation data at all), and the
//! **thermodynamic-consistency derivation** ([`smr::consistent_reverse`])
//! that `net_rate`'s independent forward/reverse pairs leave to the caller.
//!
//! # Status
//!
//! **Untrusted AI-assisted draft. No human V&V. Not declared mature.**
//! Education, research and V&V only per the workspace `RESPONSIBLE_USE.md` —
//! never process design, plant operation or a safety case.
//!
//! The model's scope and its approximations are set out in [`smr`], and
//! should be read before quoting any number it produces. In particular it is
//! **isothermal** and holds volumetric flow constant, neither of which a real
//! reformer does.