pyflightstream 0.2.0__py3-none-any.whl

pyflightstream/commands/solver_settings.yaml

@@ -0,0 +1,120 @@
+# Chapter: Scripting reference, Solver Settings (SRC-003 pp.341-343).
+
+SET_SOLVER_STEADY:
+  layout: bare
+  phase: init
+  args: []
+  manual_ref: "SRC-003 p.341"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.340, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+
+SET_SOLVER_UNSTEADY:
+  layout: keyword_block
+  phase: init
+  args:
+    - name: time_iterations
+      type: int
+    - name: delta_time
+      type: float
+      unit: "s"
+  manual_ref: "SRC-003 p.341"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Physical time stepping. For rotary cases the manual recommends 8
+    to 12 degrees of blade rotation per time step and at least two
+    full rotations (SRC-003 p.210).
+
+SET_BOUNDARY_LAYER_TYPE:
+  layout: inline
+  phase: init
+  args:
+    - name: type
+      type: enum
+      values: [LAMINAR, TRANSITIONAL, TURBULENT]
+  manual_ref: "SRC-003 p.341"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    The default transitional-turbulent model is stated valid for chord
+    Reynolds numbers between 500000 and 1500000; outside this range
+    select LAMINAR or TURBULENT explicitly (SRC-003 p.203).
+
+SET_SOLVER_VISCOUS_COUPLING:
+  layout: inline
+  phase: init
+  args:
+    - name: mode
+      type: enum
+      values: [ENABLE, DISABLE]
+  manual_ref: "SRC-003 p.341"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Couples the semi-empirical boundary layer model to the potential
+    flow solution. Attached-flow viscosity only; stall capture also
+    needs a flow separation model assignment (SRC-003 pp.207-208).
+
+SET_VISCOUS_EXCLUDED_BOUNDARIES:
+  layout: payload_lines
+  phase: init
+  args:
+    - name: num_boundaries
+      type: int
+    - name: boundary_indices
+      type: int_list
+  manual_ref: "SRC-003 p.341"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Excludes the listed boundaries from viscous coupling; the indices
+    follow on the next line as comma-separated values.
+
+CREATE_BULK_SEPARATION:
+  layout: payload_lines
+  phase: init
+  args:
+    - name: name
+      type: str
+    - name: separation_type
+      type: enum
+      values: [CYLINDRICAL, FLAT_PLATE]
+    - name: num_boundaries
+      type: int
+    - name: diameter
+      type: float
+      unit: "simulation length units"
+    - name: boundary_indices
+      type: int_list
+      required: false
+  manual_ref: "SRC-003 p.342"
+  versions:
+    "26.100":
+      status: documented
+      note: >-
+        SRC-725 p.341 documents a three-argument form without
+        SEPARATION_TYPE. The same page's sample blocks spell the
+        command CREARE_BULK_SEPARATION while the function header
+        spells CREATE_BULK_SEPARATION; which token the 26.1 solver
+        accepts is unverified (pending probe, PLN-015)
+      args:
+        - name: name
+          type: str
+        - name: num_boundaries
+          type: int
+        - name: diameter
+          type: float
+          unit: "simulation length units"
+        - name: boundary_indices
+          type: int_list
+          required: false
+    "26.120": {status: documented}
+  notes: >
+    Assigns the bulk (bluff-body) flow-separation model to the listed
+    boundaries. NUM_BOUNDARIES takes -1 for all mesh boundaries;
+    otherwise the comma-separated indices follow on the next line
+    (SRC-003 p.342). The signature is version-sensitive: 26.12 inserts
+    SEPARATION_TYPE (CYLINDRICAL or FLAT_PLATE, matching the bulk
+    model sub-typing documented at SRC-003 p.207) as the second
+    argument, which the 26.1 grammar does not have (SRC-725 p.341).

pyflightstream/commands/streamlines.yaml

@@ -0,0 +1,63 @@
+# Chapter: Scripting reference, Post Processing, Off-body Streamlines
+# (SRC-003 pp.368-369). The on-body family (p.370) is deferred to the
+# cases that exercise it.
+
+NEW_OFF_BODY_STREAMLINE:
+  layout: keyword_block
+  phase: analysis
+  args:
+    - name: position_x
+      type: float
+    - name: position_y
+      type: float
+    - name: position_z
+      type: float
+    - name: upstream
+      type: enum
+      values: [ENABLE, DISABLE]
+  manual_ref: "SRC-003 p.368"
+  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)"}
+
+NEW_STREAMLINE_DISTRIBUTION:
+  layout: keyword_block
+  phase: analysis
+  args:
+    - name: position_1_x
+      type: float
+    - name: position_1_y
+      type: float
+    - name: position_1_z
+      type: float
+    - name: position_2_x
+      type: float
+    - name: position_2_y
+      type: float
+    - name: position_2_z
+      type: float
+    - name: subdivisions
+      type: int
+  manual_ref: "SRC-003 p.368"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    SUBDIVISIONS is N+1 for N streamlines between the start and end
+    vertices.
+
+GENERATE_ALL_OFF_BODY_STREAMLINES:
+  layout: bare
+  phase: analysis
+  args: []
+  manual_ref: "SRC-003 p.368"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+
+EXPORT_ALL_OFF_BODY_STREAMLINES:
+  layout: param_lines
+  phase: export
+  args:
+    - name: filename
+      type: path
+  manual_ref: "SRC-003 p.369"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}

pyflightstream/commands/surface_sections.yaml

@@ -0,0 +1,145 @@
+# Chapter: Scripting reference, Post Processing, Surface Sections
+# (SRC-003 pp.364-365).
+
+CREATE_NEW_SURFACE_SECTION:
+  layout: payload_lines
+  phase: analysis
+  args:
+    - name: frame
+      type: int
+    - name: plane
+      type: enum
+      values: [XY, XZ, YZ]
+    - name: offset
+      type: float
+    - name: plot_direction
+      type: enum
+      values: ["1", "2"]
+    - name: symmetry
+      type: enum
+      values: [ENABLE, DISABLE]
+    - name: surfaces
+      type: int
+    - name: surface_indices
+      type: int_list
+      separator: space
+      required: false
+  manual_ref: "SRC-003 p.364"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    SURFACES takes -1 for all boundaries; otherwise the space-separated
+    surface indices follow on the next line.
+
+NEW_SURFACE_SECTION_DISTRIBUTION:
+  layout: keyword_block
+  phase: init
+  args:
+    - name: frame
+      type: int
+    - name: plane
+      type: enum
+      values: [XY, XZ, YZ]
+    - name: num_sections
+      type: int
+    - name: plot_direction
+      type: enum
+      values: ["1", "2"]
+    - name: include_symmetry
+      type: enum
+      values: [ENABLE, DISABLE]
+      required: false
+    - name: surfaces
+      type: int
+    - name: surface_indices
+      type: int_list
+      separator: space
+      required: false
+  manual_ref: "SRC-003 p.364"
+  versions:
+    "26.120": {status: broken, report: "reports/compat/CMP-26120_2026-07-21_full.yaml", note: "the documented grammar (without INCLUDE_SYMMETRY) aborted the probe script; a working 26.120 script carries the undocumented INCLUDE_SYMMETRY keyword ahead of SURFACES (2026-07-21 legacy-case reproduction); re-probe with the extended grammar pending (PLN-012)"}
+  notes: >
+    Creates NUM_SECTIONS sections at once; the surface indices follow
+    the SURFACES line. The manual grammar (SRC-003 p.364) aborted the
+    Tier 2 probe on 26.120, while a working 26.120 script additionally
+    carries an INCLUDE_SYMMETRY keyword the manual does not list; the
+    keyword is declared optional here until the re-probe decides
+    (PLN-012). Phase init on empirical evidence (2026-07-21
+    legacy-case reproduction): the cut planes freeze at creation
+    against the current geometry pose, so distributions over moving
+    boundaries must be created before the motion runs; the working
+    legacy script creates them pre-solve, and the aborting probe ran
+    the command post-solve, making the phase a candidate abort cause.
+
+COMPUTE_SURFACE_SECTIONAL_LOADS:
+  layout: inline
+  phase: analysis
+  args:
+    - name: units_type
+      type: enum
+      values: [COEFFICIENTS, NEWTONS, KILO-NEWTONS, POUND-FORCE,
+               KILOGRAM-FORCE]
+  manual_ref: "SRC-003 p.364"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Integrates the surface section properties into per-section loads.
+    Call it only after the relevant sections are updated and before
+    EXPORT_SURFACE_SECTIONAL_LOADS (SRC-003 p.364).
+
+EXPORT_SURFACE_SECTIONAL_LOADS:
+  layout: param_lines
+  phase: export
+  args:
+    - name: filename
+      type: path
+  manual_ref: "SRC-003 pp.364-365"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Writes the sectional loads file consumed by the sectional-loads
+    parser and the FSI coupling loop.
+
+UPDATE_ALL_SURFACE_SECTIONS:
+  layout: bare
+  phase: analysis
+  args: []
+  manual_ref: "SRC-003 p.365"
+  versions:
+    "26.120": {status: documented}
+
+EXPORT_ALL_SURFACE_SECTIONS:
+  layout: param_lines
+  phase: export
+  args:
+    - name: filename
+      type: path
+  manual_ref: "SRC-003 p.365"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+
+EXPORT_SURFACE_SECTIONS:
+  layout: inline
+  phase: export
+  args:
+    - name: index
+      type: int
+  manual_ref: "SRC-003 p.365"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Exports one surface section by index (index greater than 0), with
+    no filename line documented (SRC-003 p.365). Added at 26.12; the
+    26.1 manual documents only the all-sections export, so a 26.1
+    script exports everything through EXPORT_ALL_SURFACE_SECTIONS and
+    filters afterwards (SRC-725 p.364).
+
+DELETE_SURFACE_SECTION:
+  layout: inline
+  phase: analysis
+  args:
+    - name: index
+      type: int
+  manual_ref: "SRC-003 p.365"
+  versions:
+    "26.120": {status: documented}

pyflightstream/commands/sweeper.yaml

@@ -0,0 +1,115 @@
+# Chapter: Sweeper Toolbox script commands, drafted from the worked
+# scripting example (SRC-003 p.406) and the Script Index (p.383). The
+# Sweeper chapter narrative (pp.264-279) is not deep-reviewed yet;
+# these entries record the forms shown in the example, and the
+# follow-up manual pass may widen the argument grammars.
+
+SWEEPER_SET_AOA_SWEEP:
+  layout: inline
+  phase: init
+  args:
+    - name: mode
+      type: enum
+      values: [CUSTOM, DISABLE]
+    - name: values
+      type: float_list
+      unit: "deg"
+      required: false
+  manual_ref: "SRC-003 p.406"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    CUSTOM takes the angle of attack list inline, space separated.
+
+SWEEPER_SET_BETA_SWEEP:
+  layout: inline
+  phase: init
+  args:
+    - name: mode
+      type: enum
+      values: [CUSTOM, DISABLE]
+    - name: values
+      type: float_list
+      unit: "deg"
+      required: false
+  manual_ref: "SRC-003 p.406"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+
+SWEEPER_SET_VELOCITY_SWEEP:
+  layout: inline
+  phase: init
+  args:
+    - name: mode
+      type: enum
+      values: [CUSTOM, DISABLE]
+    - name: filename
+      type: path
+      required: false
+  manual_ref: "SRC-003 p.406"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    CUSTOM imports the velocity list from a text file given inline.
+
+SWEEPER_POST_RUN_SCRIPT:
+  layout: inline
+  phase: init
+  args:
+    - name: mode
+      type: enum
+      values: [ENABLE, DISABLE]
+    - name: script_path
+      type: path
+      required: false
+  manual_ref: "SRC-003 p.406"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Per-run post-processing script executed after each sweep point,
+    for example a surface section extraction script.
+
+SWEEPER_CLEAR_SOLUTION:
+  layout: inline
+  phase: init
+  args:
+    - name: mode
+      type: enum
+      values: [ENABLE, DISABLE]
+  manual_ref: "SRC-003 p.406"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Controls solution reuse between sweep runs.
+
+SWEEPER_REF_VELOCITY_SAME:
+  layout: inline
+  phase: init
+  args:
+    - name: mode
+      type: enum
+      values: [ENABLE, DISABLE]
+  manual_ref: "SRC-003 p.406"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Keeps the reference velocity equal to the free-stream velocity at
+    every sweep point.
+
+SWEEPER_START:
+  layout: bare
+  phase: exec
+  args: []
+  manual_ref: "SRC-003 p.406"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+
+SWEEPER_EXPORT_SPREADSHEET:
+  layout: inline
+  phase: export
+  args:
+    - name: filename
+      type: path
+  manual_ref: "SRC-003 p.406"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}

pyflightstream/commands/unsteady_solver.yaml

@@ -0,0 +1,68 @@
+# Unsteady Solver chapter (SRC-003 pp.347-348): per-time-step
+# monitoring plots and their export. SET_SOLVER_UNSTEADY itself lives
+# in solver_settings.yaml with the other solver mode selectors.
+
+UNSTEADY_SOLVER_NEW_FORCE_PLOT:
+  layout: keyword_block
+  phase: setup
+  args:
+    - name: frame
+      type: int
+    - name: units
+      type: enum
+      values: [COEFFICIENTS, NEWTONS, KILO-NEWTONS, POUND-FORCE, KILOGRAM-FORCE]
+    - name: parameter
+      type: enum
+      values: [CL, CDI, CDO, CD, FORCE_X, FORCE_Y, FORCE_Z, MOMENT_X, MOMENT_Y, MOMENT_Z]
+    - name: name
+      type: str
+    - name: boundaries
+      type: int
+    - name: boundary_indices
+      type: int_list
+      required: false
+  manual_ref: "SRC-003 p.347"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Samples one force or moment parameter per solver time step, in
+    FRAME and UNITS, over the listed boundaries. BOUNDARIES -1 selects
+    every boundary and takes no index line; a positive count is
+    followed by the comma-separated boundary indices on the next line.
+    Plots must exist before the solver runs to record its steps.
+
+UNSTEADY_SOLVER_NEW_FLUID_PLOT:
+  layout: keyword_block
+  phase: setup
+  args:
+    - name: frame
+      type: int
+    - name: parameter
+      type: enum
+      values: [CP_FREE, CP_REF, MACH, VELOCITY, VX, VY, VZ, STATIC_PRESSURE_RATIO]
+    - name: name
+      type: str
+    - name: vertex
+      type: str
+  manual_ref: "SRC-003 p.347"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Samples one fluid property per solver time step at a fixed vertex.
+    VERTEX takes the three coordinates preformatted on one line
+    ("X Y Z", reference units of FRAME); the typed triple validation
+    lives in the caller, the same preformatted-token convention as the
+    per-surface lines of INITIALIZE_SOLVER.
+
+UNSTEADY_SOLVER_EXPORT_PLOTS:
+  layout: param_lines
+  phase: export
+  args:
+    - name: filename
+      type: path
+  manual_ref: "SRC-003 p.347"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Exports every unsteady solver plot (force and fluid) with one
+    column per plot and one row per time step.

pyflightstream/commands/volume_sections.yaml

@@ -0,0 +1,148 @@
+# Chapter: Scripting reference, Post Processing, Volume Sections
+# (SRC-003 pp.366-367). Volume sections are the flow-field planes the
+# flux integration work extracts.
+
+CREATE_NEW_RECTANGLE_VOLUME_SECTION:
+  layout: inline
+  phase: analysis
+  args:
+    - name: frame
+      type: int
+    - name: plane
+      type: enum
+      values: [XY, XZ, YZ]
+    - name: offset
+      type: float
+    - name: refinement_layers
+      type: int
+    - name: x1
+      type: float
+    - name: y1
+      type: float
+    - name: x2
+      type: float
+    - name: y2
+      type: float
+    - name: prisms_type
+      type: enum
+      values: [NONE, PRISMS, PRISMS_ONLY]
+    - name: thickness
+      type: float
+    - name: layers
+      type: int
+    - name: growth_rate
+      type: float
+  manual_ref: "SRC-003 p.366"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Rectangular flow-field section between two diagonal corners, with
+    optional near-wall prism cell layers.
+
+CREATE_NEW_CIRCLE_VOLUME_SECTION:
+  layout: inline
+  phase: analysis
+  args:
+    - name: frame
+      type: int
+    - name: plane
+      type: enum
+      values: [XY, XZ, YZ]
+    - name: offset
+      type: float
+    - name: ipts
+      type: int
+    - name: jpts
+      type: int
+    - name: r1
+      type: float
+    - name: r2
+      type: float
+    - name: prisms_type
+      type: enum
+      values: [NONE, PRISMS]
+    - name: thickness
+      type: float
+    - name: layers
+      type: int
+    - name: growth_rate
+      type: float
+  manual_ref: "SRC-003 p.366"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Annular flow-field section with IPTS radial and JPTS azimuth
+    segments between the inner and outer radii; the natural plane for
+    slipstream surveys behind an actuator disc.
+
+VOLUME_SECTION_BOUNDARY_LAYER:
+  layout: inline
+  phase: analysis
+  args:
+    - name: index
+      type: int
+    - name: mode
+      type: enum
+      values: [ENABLE, DISABLE]
+  manual_ref: "SRC-725 p.365"
+  versions:
+    "26.100": {status: documented}
+    "26.120":
+      status: removed
+      note: >-
+        absent from the 26.12 manual: the Volume Sections family
+        (SRC-003 pp.366-367) no longer lists the command and the
+        Script Index does not carry it; no replacement documented
+  notes: >
+    Toggles boundary-layer induction on one volume section (index
+    greater than 0). Documented in 26.1 only (SRC-725 p.365); the
+    command disappeared from the manual at 26.12 with no successor in
+    the Volume Sections family.
+
+UPDATE_ALL_VOLUME_SECTIONS:
+  layout: bare
+  phase: analysis
+  args: []
+  manual_ref: "SRC-003 p.366"
+  versions:
+    "26.120": {status: documented}
+
+EXPORT_VOLUME_SECTION_VTK:
+  layout: inline
+  phase: export
+  args:
+    - name: index
+      type: int
+    - name: filename
+      type: path
+      own_line: true
+  manual_ref: "SRC-003 pp.366-367"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    The file path follows on the line after the section index.
+
+EXPORT_VOLUME_SECTION_TECPLOT:
+  layout: inline
+  phase: export
+  args:
+    - name: index
+      type: int
+    - name: filename
+      type: path
+      own_line: true
+  manual_ref: "SRC-003 p.367"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    The file path follows on the line after the section index.
+
+DELETE_VOLUME_SECTION:
+  layout: inline
+  phase: analysis
+  args:
+    - name: index
+      type: int
+  manual_ref: "SRC-003 p.367"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}