pyflightstream 0.2.0__py3-none-any.whl

pyflightstream/commands/coordinate_systems.yaml

@@ -0,0 +1,123 @@
+# Chapter: Scripting reference, Coordinate Systems (SRC-003
+# pp.329-331). Frame index 1 is the reference frame; local frames use
+# indices greater than 1. Auxiliary frames for actuators and motions
+# must exist before solver initialization.
+
+CREATE_NEW_COORDINATE_SYSTEM:
+  layout: bare
+  phase: setup
+  args: []
+  manual_ref: "SRC-003 p.329"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Appends a new local coordinate system; configure it afterwards
+    with the SET_COORDINATE_SYSTEM commands or EDIT_COORDINATE_SYSTEM.
+
+EDIT_COORDINATE_SYSTEM:
+  layout: keyword_block
+  phase: setup
+  args:
+    - name: frame
+      type: int
+    - name: name
+      type: str
+    - name: origin_x
+      type: float
+    - name: origin_y
+      type: float
+    - name: origin_z
+      type: float
+    - name: vector_x_x
+      type: float
+    - name: vector_x_y
+      type: float
+    - name: vector_x_z
+      type: float
+    - name: vector_y_x
+      type: float
+    - name: vector_y_y
+      type: float
+    - name: vector_y_z
+      type: float
+    - name: vector_z_x
+      type: float
+    - name: vector_z_y
+      type: float
+    - name: vector_z_z
+      type: float
+  manual_ref: "SRC-003 p.329"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Full edit of a local frame: origin and the three axis vectors,
+    all expressed in the reference frame.
+
+SET_COORDINATE_SYSTEM_ORIGIN:
+  layout: inline
+  phase: setup
+  args:
+    - name: frame
+      type: int
+    - name: x
+      type: float
+    - name: y
+      type: float
+    - name: z
+      type: float
+    - name: units
+      type: enum
+      values: [INCH, MILLIMETER, OTHER, FEET, MILE, METER, KILOMETER,
+               MILS, MICRON, CENTIMETER, MICROINCH]
+  manual_ref: "SRC-003 pp.329-330"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Origin position relative to the reference coordinate system.
+
+SET_COORDINATE_SYSTEM_AXIS:
+  layout: inline
+  phase: setup
+  args:
+    - name: frame
+      type: int
+    - name: axis
+      type: enum
+      values: [X, Y, Z]
+    - name: nx
+      type: float
+    - name: ny
+      type: float
+    - name: nz
+      type: float
+    - name: normalize_frame
+      type: enum
+      values: ["TRUE", "FALSE"]
+  manual_ref: "SRC-003 p.330"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Sets one axis direction vector of a local frame; the vector is
+    normalized automatically, and NORMALIZE_FRAME TRUE renormalizes
+    the whole frame after the update.
+
+ROTATE_COORDINATE_SYSTEM:
+  layout: keyword_block
+  phase: setup
+  args:
+    - name: frame
+      type: int
+    - name: rotation_frame
+      type: int
+    - name: rotation_axis
+      type: enum
+      values: [X, Y, Z, "1", "2", "3"]
+    - name: angle
+      type: float
+      unit: "deg"
+  manual_ref: "SRC-003 p.330"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Rotates the local coordinate system FRAME about ROTATION_AXIS of
+    ROTATION_FRAME by ANGLE degrees.

pyflightstream/commands/file_io.yaml

@@ -0,0 +1,82 @@
+# Chapter: Scripting, Opening, Closing and Saving (SRC-003 p.282) and
+# Output Status (p.283).
+
+OPEN:
+  layout: param_lines
+  phase: geometry
+  args:
+    - name: filename
+      type: path
+    - name: load_solver_initialization
+      type: enum
+      values: [ENABLE, DISABLE]
+      required: false
+  manual_ref: "SRC-003 p.282"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.281, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Opens an existing simulation (.fsm) file. The optional
+    LOAD_SOLVER_INITIALIZATION ENABLE line loads the solver
+    initialization stored in the opened file.
+
+SAVEAS:
+  layout: param_lines
+  phase: control
+  args:
+    - name: filename
+      type: path
+  manual_ref: "SRC-003 p.282"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.281, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Saves the current simulation to the given .fsm path.
+
+NEW_SIMULATION:
+  layout: bare
+  phase: geometry
+  args: []
+  manual_ref: "SRC-003 p.282"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.281, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+
+CLOSE_FLIGHTSTREAM:
+  layout: bare
+  phase: control
+  args: []
+  manual_ref: "SRC-003 p.282"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.281, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Closes FlightStream and exits; the natural last command of a
+    headless batch script.
+
+EXPORT_LOG:
+  layout: param_lines
+  phase: control
+  args:
+    - name: filename
+      type: path
+  manual_ref: "SRC-003 p.283"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.282, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Exports the log window messages to a text file; the probe harness
+    reads it for sentinel markers and error patterns.
+
+OUTPUT_SETTINGS_AND_STATUS:
+  layout: param_lines
+  phase: control
+  args:
+    - name: filename
+      type: path
+  manual_ref: "SRC-003 p.283"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.282, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Writes the fluid properties and solver status to a file.

pyflightstream/commands/mesh_import_export.yaml

@@ -0,0 +1,72 @@
+# Chapter: Mesh Import / Export (SRC-003 pp.307-308).
+
+IMPORT:
+  layout: keyword_block
+  phase: geometry
+  args:
+    - name: units
+      type: enum
+      values: [INCH, MILLIMETER, OTHER, FEET, MILE, METER, KILOMETER, MILS, MICRON, CENTIMETER, MICROINCH]
+    - name: file_type
+      type: enum
+      values: [STL, TRI, P3D, INP, STRUCTURED_QUAD, UNSTRUCTURED_QUAD, LAWGS, VTK, AC, FAC, OBJ]
+    - name: file
+      type: path
+    - name: clear
+      type: bool
+      required: false
+  manual_ref: "SRC-003 p.307"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.306, same grammar as 26.120"}
+    "26.120": {status: documented}
+  notes: >
+    Imports a surface mesh into the simulation as a KEY VALUE block:
+    length units of the mesh file, one of eleven mesh formats, and the
+    file path. The optional bare CLEAR keyword deletes every existing
+    geometry boundary before the import (SRC-003 p.307).
+
+CCS_IMPORT:
+  layout: keyword_block
+  phase: geometry
+  args:
+    - name: close_component_ends
+      type: enum
+      values: [ENABLE, DISABLE]
+    - name: update_properties
+      type: enum
+      values: [ENABLE, DISABLE]
+    - name: clear_existing
+      type: enum
+      values: [ENABLE, DISABLE]
+    - name: file
+      type: path
+  manual_ref: "SRC-003 p.307"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.306, same grammar as 26.120"}
+    "26.120": {status: documented}
+  notes: >
+    Imports a Component Cross-Section (CCS) geometry file. The toggles
+    control hole-filling at component ends, whether the simulation
+    properties stored in the file are applied, and whether existing
+    geometry boundaries are deleted first (SRC-003 p.307).
+
+EXPORT_SURFACE_MESH:
+  layout: inline
+  phase: geometry
+  args:
+    - name: file_type
+      type: enum
+      values: [STL, TRI, OBJ]
+    - name: surface
+      type: int
+    - name: file
+      type: path
+      own_line: true
+  manual_ref: "SRC-003 pp.307-308"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 pp.306-307, same grammar as 26.120"}
+    "26.120": {status: documented}
+  notes: >
+    Exports one geometry surface (first surface is index 1) or all
+    surfaces (-1) to STL, TRI, or OBJ; the destination path follows on
+    the next line (SRC-003 pp.307-308).

pyflightstream/commands/motion_definitions.yaml

@@ -0,0 +1,185 @@
+# Chapter: Scripting reference, Motion Definitions (SRC-003
+# pp.332-336). M1 drafts the rotary motion path and the FSI seam
+# commands (FR-23); the 6DOF family and custom motion tables await the
+# cases that exercise them.
+
+CREATE_NEW_MOTION:
+  layout: inline
+  phase: setup
+  args:
+    - name: type
+      type: enum
+      values: [ROTARY, 6DOF, CUSTOM]
+  manual_ref: "SRC-003 p.332"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Rotary motion is the blade-resolved alternative to the actuator
+    disc surrogate (SRC-003 p.234); it requires the unsteady solver.
+
+SET_MOTION_BOUNDARIES:
+  layout: payload_lines
+  phase: setup
+  args:
+    - name: motion_id
+      type: int
+    - name: num_boundaries
+      type: int
+    - name: boundary_indices
+      type: int_list
+      required: false
+  manual_ref: "SRC-003 p.332"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Assigns geometry boundaries to the motion; the comma-separated
+    index line follows. NUM_BOUNDARIES -1 selects all boundaries and
+    takes no index line.
+
+SET_MOTION_MOVING_FRAMES:
+  layout: payload_lines
+  phase: setup
+  args:
+    - name: motion_id
+      type: int
+    - name: num_frames
+      type: int
+    - name: frame_indices
+      type: int_list
+      required: false
+  manual_ref: "SRC-003 p.332"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Attaches user-defined local frames to the motion; -1 selects all
+    local coordinate systems and takes no index line.
+
+SET_MOTION_COORDINATE_SYSTEM:
+  layout: inline
+  phase: setup
+  args:
+    - name: motion_id
+      type: int
+    - name: coordinate_system_id
+      type: int
+  manual_ref: "SRC-003 p.332"
+  versions:
+    "26.120": {status: documented}
+
+SET_MOTION_START_TIME:
+  layout: inline
+  phase: setup
+  args:
+    - name: motion_id
+      type: int
+    - name: start_time
+      type: float
+      unit: "s"
+  manual_ref: "SRC-003 p.332"
+  versions:
+    "26.120": {status: broken, report: "reports/compat/CMP-26120_2026-07-21_full.yaml", note: "script processing aborted at the command: the log exported before it exists, the one after it never appeared (END sentinel missing)"}
+  notes: >
+    Start of the motion within the solver physical time; enables
+    converging a steady base flow before the motion begins.
+
+SET_MOTION_ROTOR_AXIS:
+  layout: inline
+  phase: setup
+  args:
+    - name: motion_id
+      type: int
+    - name: axis
+      type: enum
+      values: [X, Y, Z, "1", "2", "3"]
+  manual_ref: "SRC-003 p.333"
+  versions:
+    "26.120": {status: documented}
+
+SET_MOTION_ROTOR_RPM:
+  layout: inline
+  phase: setup
+  args:
+    - name: motion_id
+      type: int
+    - name: rpm
+      type: float
+      unit: "rev/min"
+  manual_ref: "SRC-003 p.333"
+  versions:
+    "26.120": {status: documented}
+
+SET_MOTION_SLIPSTREAM_WAKE_STABILIZATION:
+  layout: inline
+  phase: setup
+  args:
+    - name: motion_id
+      type: int
+    - name: wake_stabilization
+      type: enum
+      values: [ENABLE, DISABLE]
+    - name: num_blades
+      type: int
+  manual_ref: "SRC-003 p.333"
+  versions:
+    "26.120": {status: documented}
+
+SET_MOTION_FSI_EXECUTABLE:
+  layout: inline
+  phase: setup
+  args:
+    - name: motion_id
+      type: int
+    - name: show_console
+      type: enum
+      values: [ENABLE, DISABLE]
+    - name: export_load_distributions
+      type: enum
+      values: [ENABLE, DISABLE]
+    - name: executable_path
+      type: path
+      own_line: true
+  manual_ref: "SRC-003 pp.335-336"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    FSI seam (FR-23): FlightStream calls the external structural
+    executable per coupling step; the executable path follows on the
+    line after the inline arguments. EXPORT_LOAD_DISTRIBUTIONS also
+    writes the aerodynamic load distributions file alongside the
+    default interpolated loads file. Dry run finding (2026-07-21,
+    reports/RPT-005): build 7012026 rejects this command as
+    unrecognized despite the manual-exact grammar; the implemented
+    interface is the Aeroelastic Coupling Toolbox family (SRC-003
+    pp.375-376, aeroelastic_coupling.yaml). Candidate broken;
+    promotion via the next validity sweep (PLN-019).
+
+SET_MOTION_FSI_STRUCTURAL_NODES:
+  layout: inline
+  phase: setup
+  args:
+    - name: motion_id
+      type: int
+    - name: nodes_path
+      type: path
+      own_line: true
+  manual_ref: "SRC-003 p.336"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Imports the structural displacement node set; the file path
+    follows on the line after the motion index. Dry run finding
+    (2026-07-21, reports/RPT-005): build 7012026 rejects this command
+    as unrecognized; the implemented import is
+    IMPORT_AEROELASTIC_STRUCTURAL_NODES (SRC-003 p.375,
+    aeroelastic_coupling.yaml). Candidate broken; promotion via the
+    next validity sweep (PLN-019).
+
+DELETE_MOTION:
+  layout: inline
+  phase: setup
+  args:
+    - name: motion_id
+      type: int
+  manual_ref: "SRC-003 p.336"
+  versions:
+    "26.120": {status: documented}

pyflightstream/commands/probe_points.yaml

@@ -0,0 +1,116 @@
+# Chapter: Scripting reference, Post Processing, Probe Points
+# (SRC-003 pp.362-363). Probe exports carry velocity components, both
+# pressure coefficient forms, Mach and the boundary layer state flags
+# together (SRC-003 p.249), which is what the flux integration work
+# consumes downstream.
+
+NEW_PROBE_POINT:
+  layout: inline
+  phase: analysis
+  args:
+    - name: type
+      type: enum
+      values: [VOLUME, SURFACE]
+    - name: x
+      type: float
+    - name: y
+      type: float
+    - name: z
+      type: float
+  manual_ref: "SRC-003 p.362"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.361, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+
+NEW_PROBE_LINE:
+  layout: inline
+  phase: analysis
+  args:
+    - name: numpts
+      type: int
+    - name: x1
+      type: float
+    - name: y1
+      type: float
+    - name: z1
+      type: float
+    - name: x2
+      type: float
+    - name: y2
+      type: float
+    - name: z2
+      type: float
+  manual_ref: "SRC-003 p.362"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.361, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Survey line with NUMPTS probe vertices between the start and end
+    coordinates.
+
+UPDATE_PROBE_POINTS:
+  layout: bare
+  phase: analysis
+  args: []
+  manual_ref: "SRC-003 p.362"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.361, same grammar as 26.120"}
+    "26.120": {status: documented}
+  notes: >
+    Refreshes the probe values from the current solution; run it
+    before exporting.
+
+PROBE_POINTS_IMPORT:
+  layout: param_lines
+  phase: analysis
+  args:
+    - name: units
+      type: enum
+      values: [INCH, MILLIMETER, OTHER, FEET, MILE, METER, KILOMETER,
+               MILS, MICRON, CENTIMETER, MICROINCH]
+    - name: frame
+      type: int
+    - name: filename
+      type: path
+  manual_ref: "SRC-003 pp.362-363"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 pp.361-362, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Imports a probe lattice from a CSV file whose rows are
+    X,Y,Z,TYPE with TYPE 0 for surface and 1 for volume probes; the
+    first line holds the point count. This is the programmatic path
+    for probe lattice generation. The 26.120 round trip verified that
+    the export preserves the imported row order and count
+    (reports/RPT-004_probe-roundtrip-order_2026-07-21.md), the
+    loading contract of the probe planner.
+
+EXPORT_PROBE_POINTS:
+  layout: param_lines
+  phase: export
+  args:
+    - name: filename
+      type: path
+  manual_ref: "SRC-003 p.363"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.362, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Rows follow the probe creation order, preserved from an imported
+    lattice (26.120 build 7012026 round trip,
+    reports/RPT-004_probe-roundtrip-order_2026-07-21.md). The
+    boundary-layer columns are populated for near-surface probes
+    regardless of the viscous toggles (REYNOLDS_AVERAGED_DRAG_FORCES,
+    SET_SOLVER_VISCOUS_COUPLING, SET_INVISCID_LOADS; author's
+    correction and control experiment, same report): their inertness
+    is geometric, probes away from the wall export zeros. Parsed by
+    results.parse_probe_points.
+
+DELETE_PROBE_POINTS:
+  layout: bare
+  phase: analysis
+  args: []
+  manual_ref: "SRC-003 p.363"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.362, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}