pyflightstream 0.2.0__py3-none-any.whl

pyflightstream/commands/actuators.yaml

@@ -0,0 +1,167 @@
+# Chapter: Scripting reference, Actuators (SRC-003 pp.323-324).
+# Actuator discs are the linearized propeller slipstream surrogate
+# (SRC-003 pp.185-187); they are defined before solver initialization.
+
+CREATE_NEW_ACTUATOR:
+  layout: inline
+  phase: setup
+  args:
+    - name: type
+      type: enum
+      values: [PROPELLER]
+    - name: subtype
+      type: enum
+      values: [CUSTOM, ELLIPTICAL]
+      required: false
+    - name: name
+      type: str
+  manual_ref: "SRC-003 p.323"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    SUBTYPE selects the thrust profile model and applies only to the
+    PROPELLER type. CUSTOM imports a radial force distribution;
+    ELLIPTICAL is specified by net thrust and RPM (SRC-003 p.185).
+
+SET_ACTUATOR_NAME:
+  layout: inline
+  phase: setup
+  args:
+    - name: actuator_index
+      type: int
+    - name: name
+      type: str
+  manual_ref: "SRC-003 p.323"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+
+SET_ACTUATOR_AXIS:
+  layout: inline
+  phase: setup
+  args:
+    - name: actuator_index
+      type: int
+    - name: frame
+      type: int
+    - name: axis
+      type: enum
+      values: [X, Y, Z]
+    - name: offset
+      type: float
+      unit: "simulation length units"
+  manual_ref: "SRC-003 p.323"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Places the actuator disc on an axis of a local coordinate system
+    (frame index greater than 1); the frame must exist before this
+    call, which is the pre-solver definition discipline the builder
+    enforces at M2.
+
+SET_ACTUATOR_RADIUS:
+  layout: inline
+  phase: setup
+  args:
+    - name: actuator_index
+      type: int
+    - name: r_tip
+      type: float
+      unit: "simulation length units"
+    - name: r_hub
+      type: float
+      unit: "simulation length units"
+  manual_ref: "SRC-003 p.323"
+  versions:
+    "26.120": {status: documented}
+
+SET_PROP_ACTUATOR_RPM:
+  layout: inline
+  phase: setup
+  args:
+    - name: actuator_index
+      type: int
+    - name: rpm
+      type: float
+      unit: "rev/min"
+  manual_ref: "SRC-003 p.323"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Sign selects the rotation direction about the actuator axis.
+
+SET_PROP_ACTUATOR_PROFILE:
+  layout: inline
+  phase: setup
+  args:
+    - name: actuator_index
+      type: int
+    - name: units_type
+      type: enum
+      values: [NEWTONS, KILO-NEWTONS, POUND-FORCE, KILOGRAM-FORCE]
+    - name: n_blades
+      type: int
+    - name: file_name
+      type: path
+      own_line: true
+  manual_ref: "SRC-003 pp.323-324"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Imports a custom radial thrust profile; the TXT file path follows
+    on the line after the inline arguments. UNITS_TYPE gives the force
+    unit used inside the file.
+
+SET_PROP_ACTUATOR_THRUST:
+  layout: inline
+  phase: setup
+  args:
+    - name: actuator_index
+      type: int
+    - name: ct
+      type: float
+    - name: thrust_type
+      type: enum
+      values: [COEFFICIENT, NEWTONS, POUNDS]
+  manual_ref: "SRC-003 p.324"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Net thrust of the disc. The manual warns to verify that the
+    coefficient convention matches the solver formulation and
+    recommends dimensional thrust to avoid ambiguity (SRC-003 p.187).
+
+SET_PROP_ACTUATOR_SWIRL:
+  layout: inline
+  phase: setup
+  args:
+    - name: actuator_index
+      type: int
+    - name: swirl_factor
+      type: float
+  manual_ref: "SRC-003 p.324"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Fraction between 0 and 1 of the swirl velocity kept downstream;
+    values below 1 mimic a stator de-swirling the slipstream
+    (SRC-003 p.186).
+
+ENABLE_ACTUATOR:
+  layout: inline
+  phase: setup
+  args:
+    - name: actuator_index
+      type: int
+  manual_ref: "SRC-003 p.324"
+  versions:
+    "26.120": {status: documented}
+
+DELETE_ACTUATOR:
+  layout: inline
+  phase: setup
+  args:
+    - name: actuator_index
+      type: int
+  manual_ref: "SRC-003 p.324"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}

pyflightstream/commands/advanced_settings.yaml

@@ -0,0 +1,136 @@
+# Chapter: Scripting reference, Advanced Settings (SRC-003
+# pp.344-346). Only the entries needed by the core steady path are
+# drafted at M1; the remaining toggles of the chapter await the cases
+# that exercise them.
+
+SET_SOLVER_CONVERGENCE_ITERATIONS:
+  layout: inline
+  phase: init
+  args:
+    - name: value
+      type: int
+  manual_ref: "SRC-003 p.344"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Number of iterations the solver must remain below the convergence
+    threshold before convergence is declared.
+
+SOLVER_MINIMUM_CP:
+  layout: inline
+  phase: init
+  args:
+    - name: cp
+      type: float
+  manual_ref: "SRC-003 p.345"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Lower limiter on the pressure coefficient; the solver default is
+    -20 (SRC-003 p.221).
+
+REYNOLDS_AVERAGED_DRAG_FORCES:
+  layout: inline
+  phase: init
+  args:
+    - name: mode
+      type: enum
+      values: [ENABLE, DISABLE]
+  manual_ref: "SRC-003 p.344"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Toggles the Reynolds-averaged (flat plate) boundary layer
+    calculations.
+
+SOLVER_SET_MESH_INDUCED_WAKE_VELOCITY:
+  layout: inline
+  phase: init
+  args:
+    - name: mode
+      type: enum
+      values: [ENABLE, DISABLE]
+  manual_ref: "SRC-003 p.344"
+  versions:
+    "26.120": {status: documented}
+
+SOLVER_SET_FARFIELD_LAYERS:
+  layout: inline
+  phase: init
+  args:
+    - name: layers
+      type: int
+  manual_ref: "SRC-003 p.344"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Far-field agglomeration layer count, integer between 1 and 5;
+    the solver default is 3.
+
+SOLVER_UNSTEADY_PRESSURE_AND_KUTTA:
+  layout: inline
+  phase: init
+  args:
+    - name: mode
+      type: enum
+      values: [ENABLE, DISABLE]
+  manual_ref: "SRC-003 p.344"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Toggles the unsteady Bernoulli and Kutta terms of the unsteady
+    solver.
+
+SET_WAKE_TERMINATION_TIME_STEPS:
+  layout: inline
+  phase: init
+  args:
+    - name: time_steps
+      type: int
+  manual_ref: "SRC-003 p.344"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Number of time steps after which a wake vortex filament edge that
+    lost all of its strength is removed from the simulation.
+
+SET_WAKE_ON_WAKE_INDUCTION:
+  layout: inline
+  phase: init
+  args:
+    - name: mode
+      type: enum
+      values: [ENABLE, DISABLE]
+  manual_ref: "SRC-003 pp.344-345"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Toggles the wake-on-wake induced velocity computation.
+
+ADDITIONAL_WAKE_RELAXATION_ITERATION:
+  layout: inline
+  phase: init
+  args:
+    - name: mode
+      type: enum
+      values: [ENABLE, DISABLE]
+  manual_ref: "SRC-003 p.345"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Performs one additional wake relaxation iteration.
+
+AEROELASTIC_RBF_TYPE:
+  layout: inline
+  phase: init
+  args:
+    - name: rbf_type
+      type: enum
+      values: [WENDLAND_C2, GAUSSIAN, THIN_PLATE_SPLINE, MULTI_QUADRATIC, INV_MULTI_QUADRATIC]
+  manual_ref: "SRC-003 p.345"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    RBF mesh morphing algorithm of the aeroelastic coupling; the
+    solver also accepts the numeric labels 1 to 5 documented on the
+    same page, the emitter uses the names.

pyflightstream/commands/aeroelastic_coupling.yaml

@@ -0,0 +1,172 @@
+# Aeroelastic Coupling Toolbox scripting commands (SRC-003 pp.375-376;
+# new in 26.1 per the release notes). This is the command family the
+# solver actually implements for FSI coupling: the SET_MOTION_FSI pair
+# of the motion chapter (SRC-003 pp.335-336) is rejected as
+# unrecognized by build 7012026 (WP1 dry run evidence,
+# reports/RPT-005_fsi-dry-run_2026-07-21.md). All eleven commands of
+# this family were exercised successfully in that dry run on 26.120;
+# formal Tier 2 promotion follows the next validity sweep (PLN-019).
+#
+# Behavior finding on build 7012026 (WP7 probes,
+# reports/RPT-007_soft-pilot-morphing-investigation_2026-07-21.md):
+# the coupling loop runs end to end, and FSIDisp.txt is read every
+# step, but the mesh morphing is silently NOT applied to boundaries
+# attached to a rotary motion definition; a motionless boundary morphs
+# correctly with the same command sequence. Two-way rotor FSI is
+# therefore blocked in this build (candidate solver defect; the
+# documented workflow at SRC-003 p.273 names rotors). A malformed
+# FSIDisp.txt crashes the solver (access violation) instead of
+# raising an error.
+
+EXECUTE_AEROELASTIC_ANALYSIS:
+  layout: bare
+  phase: exec
+  args: []
+  manual_ref: "SRC-003 p.375"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Runs the steady-state aeroelastic analysis. For unsteady coupling
+    the manual instructs the regular solver execution with
+    SET_AEROELASTIC_COUPLING_IN_UNSTEADY enabled instead (SRC-003
+    p.275).
+
+ASSIGN_AEROELASTIC_SURFACES:
+  layout: payload_lines
+  phase: init
+  args:
+    - name: num_boundaries
+      type: int
+    - name: boundary_indices
+      type: int_list
+      separator: newline
+      required: false
+  manual_ref: "SRC-003 p.375"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Mesh boundaries whose deflections the toolbox interpolates; one
+    index per line after the count, -1 selects all boundaries with no
+    index lines.
+
+ASSIGN_AEROELASTIC_COORDINATE_SYSTEMS:
+  layout: payload_lines
+  phase: init
+  args:
+    - name: num_index
+      type: int
+    - name: frame_indices
+      type: int_list
+      separator: newline
+      required: false
+  manual_ref: "SRC-003 p.375"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Links user-defined coordinate systems for the aeroelastic
+    interpolation, one index per line after the count; index 1 (the
+    reference frame) is rejected by the solver per the manual.
+
+IMPORT_AEROELASTIC_STRUCTURAL_NODES:
+  layout: inline
+  phase: init
+  args:
+    - name: structural_coordinate_system
+      type: int
+    - name: delete_existing
+      type: enum
+      values: [ENABLE, DISABLE]
+    - name: nodes_path
+      type: path
+      own_line: true
+  manual_ref: "SRC-003 p.375"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Imports the structural node list; the file is three comma
+    separated columns X,Y,Z per node (SRC-003 p.274), interpreted in
+    the given coordinate system. The node order fixes the FSIDisp.txt
+    displacement order.
+
+DELETE_AEROELASTIC_STRUCTURAL_NODES:
+  layout: bare
+  phase: init
+  args: []
+  manual_ref: "SRC-003 p.375"
+  versions:
+    "26.120": {status: documented}
+  notes: Deletes all imported structural nodes.
+
+SET_AEROELASTIC_WORKING_DIRECTORY:
+  layout: inline
+  phase: init
+  args:
+    - name: directory_path
+      type: path
+      own_line: true
+  manual_ref: "SRC-003 p.375"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Runtime folder of the coupling: FlightStream writes FSIDisp.txt
+    and the loads exports there and executes the runtime command
+    there (SRC-003 pp.274-275). The dry run confirmed it is the
+    working directory of the external executable's process.
+
+SET_AEROELASTIC_POST_PROCESSING_SCRIPT:
+  layout: inline
+  phase: init
+  args:
+    - name: script_path
+      type: path
+      own_line: true
+  manual_ref: "SRC-003 p.376"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    FlightStream script executed between FSI iterations, before the
+    external executable; the documented mechanism for exporting the
+    aerodynamic forces the executable consumes (SRC-003 p.275), for
+    example the surface section loads export.
+
+SET_AEROELASTIC_STRUCTURAL_EXECUTION_COMMAND:
+  layout: inline
+  phase: init
+  args:
+    - name: command
+      type: str
+      own_line: true
+  manual_ref: "SRC-003 p.376"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Full command executed per coupling iteration in the working
+    directory. The dry run observed a bare invocation: no arguments
+    are appended by the solver.
+
+SET_AEROELASTIC_ITERATIONS:
+  layout: inline
+  phase: init
+  args:
+    - name: num_iterations
+      type: int
+  manual_ref: "SRC-003 p.376"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Two-way coupling iterations: the total count in steady mode, the
+    count per time step in unsteady mode (SRC-003 p.275).
+
+SET_AEROELASTIC_COUPLING_IN_UNSTEADY:
+  layout: inline
+  phase: init
+  args:
+    - name: state
+      type: enum
+      values: [ENABLE, DISABLE]
+  manual_ref: "SRC-003 p.376"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Toggles the FSI execution inside the unsteady solver; with ENABLE
+    the coupling runs on the regular solver start.

pyflightstream/commands/boundary_conditions.yaml

@@ -0,0 +1,153 @@
+# Chapter: Scripting reference, Boundary Conditions families used by
+# the core steady path: Trailing Edges (SRC-003 pp.319-320), Wake
+# Termination Nodes (p.321), Free-Stream Velocity (p.322), Fluid
+# Properties (p.328).
+
+AUTO_DETECT_TRAILING_EDGES:
+  layout: bare
+  phase: setup
+  args: []
+  manual_ref: "SRC-003 p.319"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.318, same grammar as 26.120"}
+    "26.120": {status: documented}
+  notes: >
+    Finds and marks all trailing edge nodes in the geometry. Trailing
+    edge marking controls where the wake is shed, so it must precede
+    solver initialization.
+
+SET_TRAILING_EDGE_TYPE:
+  layout: inline
+  phase: setup
+  args:
+    - name: te_index
+      type: int
+    - name: type
+      type: enum
+      values: [STANDARD, RELAXED, JET_OUTFLOW, VORTEX_SHEDDING]
+  manual_ref: "SRC-003 pp.319-320"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    STANDARD sheds the full net circulation (Kutta factor 1.0);
+    RELAXED sheds half, approximating body carryover at non-lifting
+    trailing edges such as wing-fuselage junctions (SRC-003 p.164).
+
+DISABLE_WAKE_NODES_ON_TRAILING_EDGE:
+  layout: inline
+  phase: setup
+  args:
+    - name: te_index
+      type: int
+  manual_ref: "SRC-003 p.320"
+  versions:
+    "26.120": {status: documented}
+
+AUTO_DETECT_WAKE_TERMINATION_NODES:
+  layout: bare
+  phase: setup
+  args: []
+  manual_ref: "SRC-003 p.321"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.320, same grammar as 26.120"}
+    "26.120": {status: documented}
+  notes: >
+    Finds and marks all wake termination nodes in the geometry.
+
+SET_FREESTREAM:
+  layout: inline
+  phase: setup
+  args:
+    - name: type
+      type: enum
+      values: [CONSTANT, CUSTOM, ROTATION]
+    - name: filetype
+      type: enum
+      values: [STRUCTURED, UNSTRUCTURED]
+      required: false
+    - name: frame
+      type: int
+      required: false
+    - name: axis
+      type: enum
+      values: [X, Y, Z]
+      required: false
+    - name: angular_velocity
+      type: float
+      unit: "rev/min"
+      required: false
+    - name: filename
+      type: path
+      required: false
+      own_line: true
+  manual_ref: "SRC-003 p.322"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.321, same grammar as 26.120"}
+    "26.120": {status: documented}
+  notes: >
+    CONSTANT needs no further input. CUSTOM appends a FILETYPE token
+    (STRUCTURED or UNSTRUCTURED) and takes the profile file path on
+    the next line. ROTATION appends frame index, axis (X, Y or Z) and
+    angular velocity in RPM. Which optional arguments each type takes
+    is conditional; the free_stream helper enforces the valid
+    combinations (SRC-003 p.322).
+
+FLUID_PROPERTIES:
+  layout: keyword_block
+  phase: setup
+  args:
+    - name: density
+      type: float
+      unit: "kg/m^3"
+    - name: pressure
+      type: float
+      unit: "Pa"
+    - name: temperature
+      type: float
+      unit: "K"
+    - name: viscosity
+      type: float
+      unit: "Pa s"
+    - name: specific_heat_ratio
+      type: float
+  manual_ref: "SRC-003 p.328"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.327, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Sets the working fluid state as KEY VALUE lines. Sonic velocity is
+    derived from temperature and specific heat ratio; it is no longer
+    an independent input (SRC-003 p.328).
+
+AIR_ALTITUDE:
+  layout: inline
+  phase: setup
+  args:
+    - name: value
+      type: float
+    - name: units
+      type: enum
+      values: [FEET, METERS]
+  manual_ref: "SRC-003 p.328"
+  versions:
+    "26.120": {status: broken, report: "reports/compat/CMP-26120_2026-07-21_full.yaml", note: "the command ran (script processing continued past it) but its effect was not observed; expected: the settings dump reports the 5000 m standa"}
+  notes: >
+    Sets the air properties from a standard-atmosphere altitude.
+
+SONIC_VELOCITY:
+  layout: inline
+  phase: setup
+  args:
+    - name: value
+      type: float
+      unit: "m/s"
+  manual_ref: "SRC-003 p.328"
+  versions:
+    "26.100": {status: removed, note: "Already deprecated in 26.1: the solver warns and ignores the value (SRC-725 p.327)."}
+    "26.120":
+      status: removed
+      successor: null
+      note: >
+        No longer supported; the solver throws a deprecation warning
+        and ignores the value. Sonic velocity now follows from
+        temperature and specific heat ratio (SRC-003 p.328).

pyflightstream/commands/ccs_wing_mesh.yaml

@@ -0,0 +1,74 @@
+# Chapter: Scripting reference, CCS Wing Mesh (SRC-003 pp.297-299).
+# Only the gapped control-surface command is drafted so far: it is the
+# family member whose grammar is version-sensitive (the SPACE and AXIS
+# parameters added at 26.12); the remaining family entries await a
+# dedicated chapter pass.
+
+NEW_CCS_WING_CONTROL_SURFACE:
+  layout: inline
+  phase: geometry
+  args:
+    - name: name
+      type: str
+    - name: v0
+      type: float
+    - name: v1
+      type: float
+    - name: u0
+      type: float
+    - name: u1
+      type: float
+    - name: hinge_height
+      type: float
+    - name: angle
+      type: float
+      unit: "deg"
+    - name: slot_gap
+      type: float
+      unit: "percent of span"
+    - name: space
+      type: enum
+      values: [REAL, PARAMETRIC]
+      required: false
+    - name: axis
+      type: enum
+      values: [X, Y, Z]
+      required: false
+  manual_ref: "SRC-003 p.299"
+  versions:
+    "26.100":
+      status: documented
+      note: >-
+        SRC-725 p.298: eight-argument form; the SPACE and AXIS
+        parameters do not exist in 26.1, so spanwise placement is
+        parametric only
+      args:
+        - name: name
+          type: str
+        - name: v0
+          type: float
+        - name: v1
+          type: float
+        - name: u0
+          type: float
+        - name: u1
+          type: float
+        - name: hinge_height
+          type: float
+        - name: angle
+          type: float
+          unit: "deg"
+        - name: slot_gap
+          type: float
+          unit: "percent of span"
+    "26.120": {status: documented}
+  notes: >
+    Creates a gapped control surface on a CCS wing component. V0 and
+    V1 are the spanwise limits, U0 and U1 the chordwise depths from
+    the trailing edge, all parametric in 0 to 1; HINGE_HEIGHT is the
+    parametric hinge location through the airfoil thickness, ANGLE the
+    deflection, and SLOT_GAP a percentage of span. The optional SPACE
+    and AXIS pair exists only from 26.12: SPACE selects REAL or
+    PARAMETRIC interpretation of the spanwise coordinates, and AXIS
+    names the Reference-frame axis used when SPACE is REAL (SRC-003
+    p.299). The 26.1 grammar has neither parameter (SRC-725 p.298).