File io¶
Commands of the file_io chapter of the database, 8 entries. The status words are defined once, on the compatibility matrix, which says what each rests on and what the script builder does with it. Read it before this page: broken and removed are refusals, so a row here can be telling you the emitter will not write that command for that version.
CLEAR_LOG¶
Phase control, layout bare. Manual: SRC-003 p.283.
Empties the log window. Phase control, as EXPORT_LOG is: it acts on the application's output rather than on the simulation. A SCRIPT THAT CLEARS THE LOG DISCARDS ITS OWN EVIDENCE. This package reads the log to identify the solver build, to detect refusals and to find the probe sentinels, so a clear in the middle of a managed run removes what the run record is built from. Nothing here refuses it; the warning is stated where a reader meets the command.
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.336, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.273, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.272, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.277, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.282, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.283 |
| 26.121 | documented | SRC-740 p.286, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.287, unchanged from SRC-750 p.287 |
| 26.124 | documented | SRC-752 p.287, the SRC-751 file, carried from 26.123; not run on 26.124 |
CLOSE_FLIGHTSTREAM¶
Phase control, layout bare. Manual: SRC-003 p.282.
Closes FlightStream and exits; the natural last command of a headless batch script.
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.337, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.272, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.271, same grammar as 26.120 |
| 26.100 | verified | reports/compat/CMP-26100_2026-08-08_full.yaml |
| 26.101 | verified | reports/compat/CMP-26101_2026-08-08_full.yaml |
| 26.120 | verified | reports/compat/CMP-26120_2026-08-08_full.yaml |
| 26.121 | verified | reports/compat/CMP-26121_2026-08-08_full.yaml |
| 26.122 | verified | reports/compat/CMP-26122_2026-08-11_full.yaml |
| 26.123 | verified | reports/compat/CMP-26123_2026-08-17_full-sim.yaml; SRC-751 p.286, unchanged from SRC-750 p.286 |
| 26.124 | verified | reports/compat/CMP-26124_2026-09-14_full-sim.yaml; SRC-752 p.286, the SRC-751 file, carried from 26.123 |
EXPORT_LOG¶
Phase control, layout param_lines. Manual: SRC-003 p.283.
Exports the log window messages to a text file; the probe harness reads it for sentinel markers and error patterns.
| Argument | Specification |
|---|---|
filename |
path |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.336, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.273, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.272, same grammar as 26.120 |
| 26.100 | verified | reports/compat/CMP-26100_2026-08-08_full.yaml |
| 26.101 | verified | reports/compat/CMP-26101_2026-08-08_full.yaml |
| 26.120 | verified | reports/compat/CMP-26120_2026-08-08_full.yaml |
| 26.121 | verified | reports/compat/CMP-26121_2026-08-08_full.yaml |
| 26.122 | verified | reports/compat/CMP-26122_2026-08-11_full.yaml |
| 26.123 | verified | reports/compat/CMP-26123_2026-08-17_full-sim.yaml; SRC-751 p.287, unchanged from SRC-750 p.287 |
| 26.124 | verified | reports/compat/CMP-26124_2026-09-14_full-sim.yaml; SRC-752 p.287, the SRC-751 file, carried from 26.123 |
NEW_SIMULATION¶
Phase geometry, layout bare. Manual: SRC-003 p.282.
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.253, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.272, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.271, same grammar as 26.120 |
| 26.100 | verified | reports/compat/CMP-26100_2026-08-08_full.yaml |
| 26.101 | verified | reports/compat/CMP-26101_2026-08-08_full.yaml |
| 26.120 | verified | reports/compat/CMP-26120_2026-08-08_full.yaml |
| 26.121 | verified | reports/compat/CMP-26121_2026-08-08_full.yaml |
| 26.122 | verified | reports/compat/CMP-26122_2026-08-11_full.yaml |
| 26.123 | verified | reports/compat/CMP-26123_2026-08-17_full-sim.yaml; SRC-751 p.286, unchanged from SRC-750 p.286 |
| 26.124 | verified | reports/compat/CMP-26124_2026-09-14_full-sim.yaml; SRC-752 p.286, the SRC-751 file, carried from 26.123 |
OPEN¶
Phase geometry, layout param_lines. Manual: SRC-003 p.282.
Opens an existing simulation (.fsm) file. The optional LOAD_SOLVER_INITIALIZATION ENABLE line loads the solver initialization stored in the opened file.
| Argument | Specification |
|---|---|
filename |
path |
load_solver_initialization |
enum in {ENABLE, DISABLE} (optional) |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.253, this edition's own grammar; see the note below |
| 25.100 | documented | SRC-748 p.272, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.271, same grammar as 26.120 |
| 26.100 | verified | reports/compat/CMP-26100_2026-08-08_full.yaml |
| 26.101 | verified | reports/compat/CMP-26101_2026-08-08_full.yaml |
| 26.120 | verified | reports/compat/CMP-26120_2026-08-08_full.yaml |
| 26.121 | verified | reports/compat/CMP-26121_2026-08-08_full.yaml |
| 26.122 | verified | reports/compat/CMP-26122_2026-08-11_full.yaml |
| 26.123 | verified | reports/compat/CMP-26123_2026-08-17_full-sim.yaml; SRC-751 p.286, unchanged from SRC-750 p.286 |
| 26.124 | verified | reports/compat/CMP-26124_2026-09-14_full-sim.yaml; SRC-752 p.286, the SRC-751 file, carried from 26.123 |
OUTPUT_SETTINGS_AND_STATUS¶
Phase control, layout param_lines. Manual: SRC-003 p.283.
Writes the fluid properties and solver status to a file.
| Argument | Specification |
|---|---|
filename |
path |
| Version | Status | Evidence |
|---|---|---|
| 25.100 | documented | SRC-748 p.273, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.272, same grammar as 26.120 |
| 26.100 | verified | reports/compat/CMP-26100_2026-08-08_full.yaml |
| 26.101 | verified | reports/compat/CMP-26101_2026-08-08_full.yaml |
| 26.120 | verified | reports/compat/CMP-26120_2026-08-08_full.yaml |
| 26.121 | verified | reports/compat/CMP-26121_2026-08-08_full.yaml |
| 26.122 | verified | reports/compat/CMP-26122_2026-08-11_full.yaml |
| 26.123 | verified | reports/compat/CMP-26123_2026-08-17_full-sim.yaml; SRC-751 p.287, unchanged from SRC-750 p.287 |
| 26.124 | verified | reports/compat/CMP-26124_2026-09-14_full-sim.yaml; SRC-752 p.287, the SRC-751 file, carried from 26.123 |
OUTPUT_SURFACE_INDICES¶
Phase control, layout inline. Manual: SRC-003 p.283.
Writes the name and index of every mesh boundary, to a file if a path follows and to the log window if none does. The manual states the path is OPTIONAL in as many words, which is why it is the rare own_line argument that is not required. IT IS THE ANSWER TO A QUESTION THIS DATABASE RAISES CONSTANTLY. Dozens of commands take a boundary index and nothing in a script says what those indices are; this is the command that reports them. A caller writing indices by hand should run it first.
| Argument | Specification |
|---|---|
file |
path (optional) |
| Version | Status | Evidence |
|---|---|---|
| 26.100 | documented | SRC-741 p.277, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.282, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.283 |
| 26.121 | documented | SRC-740 p.286, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.287, unchanged from SRC-750 p.287 |
| 26.124 | documented | SRC-752 p.287, the SRC-751 file, carried from 26.123; not run on 26.124 |
SAVEAS¶
Phase control, layout param_lines. Manual: SRC-003 p.282.
Saves the current simulation to the given .fsm path.
| Argument | Specification |
|---|---|
filename |
path |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.253, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.272, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.271, same grammar as 26.120 |
| 26.100 | verified | reports/compat/CMP-26100_2026-08-08_full.yaml |
| 26.101 | verified | reports/compat/CMP-26101_2026-08-08_full.yaml |
| 26.120 | verified | reports/compat/CMP-26120_2026-08-08_full.yaml |
| 26.121 | verified | reports/compat/CMP-26121_2026-08-08_full.yaml |
| 26.122 | verified | reports/compat/CMP-26122_2026-08-11_full.yaml |
| 26.123 | verified | reports/compat/CMP-26123_2026-08-17_full-sim.yaml; SRC-751 p.286, unchanged from SRC-750 p.286 |
| 26.124 | verified | reports/compat/CMP-26124_2026-09-14_full-sim.yaml; SRC-752 p.286, the SRC-751 file, carried from 26.123 |