pyflightstream 0.2.0__py3-none-any.whl

pyflightstream/commands/runtime_settings.yaml

@@ -0,0 +1,160 @@
+# Chapter: Scripting reference, Runtime Settings (SRC-003
+# pp.339-340). These commands configure the initialized solver and are
+# re-emitted between campaign points.
+
+SOLVER_SET_AOA:
+  layout: inline
+  phase: init
+  args:
+    - name: angle
+      type: float
+      unit: "deg"
+  manual_ref: "SRC-003 p.339"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.338, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Angle of attack; magnitude must stay below 90 degrees.
+
+SOLVER_SET_SIDESLIP:
+  layout: inline
+  phase: init
+  args:
+    - name: angle
+      type: float
+      unit: "deg"
+  manual_ref: "SRC-003 p.339"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Side-slip angle; magnitude must stay below 90 degrees.
+
+SOLVER_SET_VELOCITY:
+  layout: inline
+  phase: init
+  args:
+    - name: velocity
+      type: float
+      unit: "m/s"
+  manual_ref: "SRC-003 p.339"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.338, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Free-stream velocity magnitude.
+
+SOLVER_SET_MACH_NUMBER:
+  layout: inline
+  phase: init
+  args:
+    - name: mach
+      type: float
+  manual_ref: "SRC-003 p.339"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+
+SOLVER_SET_ITERATIONS:
+  layout: inline
+  phase: init
+  args:
+    - name: num_iterations
+      type: int
+  manual_ref: "SRC-003 p.339"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.338, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+
+SOLVER_SET_CONVERGENCE:
+  layout: inline
+  phase: init
+  args:
+    - name: threshold
+      type: float
+  manual_ref: "SRC-003 p.339"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.338, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Residual threshold on surface velocity and pressure below which
+    the run is declared converged (SRC-003 p.200).
+
+SOLVER_SET_FORCED_ITERATIONS:
+  layout: inline
+  phase: init
+  args:
+    - name: mode
+      type: enum
+      values: [ENABLE, DISABLE]
+  manual_ref: "SRC-003 p.339"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    When enabled the solver runs the full iteration count regardless
+    of the convergence threshold.
+
+SOLVER_SET_REF_VELOCITY:
+  layout: inline
+  phase: init
+  args:
+    - name: velocity
+      type: float
+      unit: "m/s"
+  manual_ref: "SRC-003 p.339"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.338, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Reference velocity for coefficient normalization. For steady runs
+    it should equal the free-stream velocity; for rotary or hover
+    cases the manual instructs using the largest characteristic
+    velocity, such as the rotor tip speed (SRC-003 p.201).
+
+SOLVER_SET_REF_MACH_NUMBER:
+  layout: inline
+  phase: init
+  args:
+    - name: mach
+      type: float
+  manual_ref: "SRC-003 p.339"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+
+SOLVER_SET_REF_AREA:
+  layout: inline
+  phase: init
+  args:
+    - name: area
+      type: float
+      unit: "simulation length units squared"
+  manual_ref: "SRC-003 pp.339-340"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 pp.338-339, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Reference area S_ref used in Q*S_ref force normalization
+    (coefficient definitions, SRC-003 p.223).
+
+SOLVER_SET_REF_LENGTH:
+  layout: inline
+  phase: init
+  args:
+    - name: length
+      type: float
+      unit: "simulation length units"
+  manual_ref: "SRC-003 p.340"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.339, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Reference length L_ref used in Q*S_ref*L_ref moment normalization
+    (coefficient definitions, SRC-003 p.223).
+
+SET_MAX_PARALLEL_THREADS:
+  layout: inline
+  phase: init
+  args:
+    - name: num_cores
+      type: int
+  manual_ref: "SRC-003 p.340"
+  versions:
+    "26.120": {status: documented}

pyflightstream/commands/scenes.yaml

@@ -0,0 +1,14 @@
+# Scenes chapter (SRC-003 p.355): scripted view and scene switching.
+# Only the commands with observed scripted use are drafted; the
+# remaining scene and colormap commands await a need.
+
+CHANGE_SCENE_TO_PLOTS:
+  layout: bare
+  phase: control
+  args: []
+  manual_ref: "SRC-003 p.355"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Switches the active scene to the plots view; scene switching is a
+    display action and may appear anywhere in a script.

pyflightstream/commands/script_controls.yaml

@@ -0,0 +1,39 @@
+# Chapter: Scripting, Script Controls (SRC-003 p.281).
+# Control commands run at any point of a script; the builder exempts
+# the control phase from phase ordering.
+
+STOP:
+  layout: bare
+  phase: control
+  args: []
+  manual_ref: "SRC-003 p.281"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Halts script processing at this location; the manual suggests it
+    for debugging partial scripts (SRC-003 p.280).
+
+PRINT:
+  layout: inline
+  phase: control
+  args:
+    - name: message
+      type: str
+  manual_ref: "SRC-003 p.281"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Writes a user-defined message to the log window; useful as a
+    sentinel marker in probe scripts.
+
+RUN_SCRIPT:
+  layout: param_lines
+  phase: control
+  args:
+    - name: script_path
+      type: path
+  manual_ref: "SRC-003 p.281"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Calls another script file from within the running script.

pyflightstream/commands/simulation_controls.yaml

@@ -0,0 +1,30 @@
+# Chapter: Scripting, Simulation Controls (SRC-003 p.284).
+
+SET_SIMULATION_LENGTH_UNITS:
+  layout: inline
+  phase: setup
+  args:
+    - name: units
+      type: enum
+      values: [INCH, MILLIMETER, OTHER, FEET, MILE, METER, KILOMETER,
+               MILS, MICRON, CENTIMETER, MICROINCH]
+  manual_ref: "SRC-003 p.284"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.283, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Selects the simulation length scale unit; geometry dimensions and
+    length-typed command arguments are interpreted in this unit.
+
+SET_SIGNIFICANT_DIGITS:
+  layout: inline
+  phase: setup
+  args:
+    - name: digits
+      type: int
+  manual_ref: "SRC-003 p.284"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Output precision, integer between 1 and 8; applies to the values
+    the solver writes into its exports.

pyflightstream/commands/solver_analysis.yaml

@@ -0,0 +1,118 @@
+# Chapter: Scripting reference, Solver Analysis (SRC-003 pp.350-351).
+
+SET_VORTICITY_DRAG_BOUNDARIES:
+  layout: payload_lines
+  phase: analysis
+  args:
+    - name: num_boundaries
+      type: int
+    - name: boundary_indices
+      type: int_list
+      required: false
+  manual_ref: "SRC-003 p.350"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.349, same grammar as 26.120"}
+    "26.120": {status: documented}
+  notes: >
+    Boundaries whose induced drag is computed from surface vorticity
+    circulation integration; -1 selects all boundaries. Boundaries
+    without trailing-edge boundary conditions on this list silently
+    report zero induced drag (SRC-003 p.202); bluff bodies belong to
+    surface-pressure integration instead, which is why the results
+    layer refuses blind per-boundary drag aggregation.
+
+DELETE_VORTICITY_DRAG_BOUNDARIES:
+  layout: bare
+  phase: analysis
+  args: []
+  manual_ref: "SRC-003 p.350"
+  versions:
+    "26.120": {status: documented}
+
+SET_SOLVER_ANALYSIS_LOADS_FRAME:
+  layout: inline
+  phase: analysis
+  args:
+    - name: load_frame
+      type: int
+  manual_ref: "SRC-003 p.350"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Coordinate system used for evaluating aerodynamic loads and
+    moments; index 1 is the reference frame.
+
+SET_ANALYSIS_MOMENTS_MODEL:
+  layout: inline
+  phase: analysis
+  args:
+    - name: model
+      type: enum
+      values: [PRESSURE, VORTICITY]
+  manual_ref: "SRC-003 p.350"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    PRESSURE is the solver default.
+
+SET_ANALYSIS_SYMMETRY_LOADS:
+  layout: inline
+  phase: init
+  args:
+    - name: mode
+      type: enum
+      values: [ENABLE, DISABLE]
+  manual_ref: "SRC-003 p.350"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.349, same grammar as 26.120"}
+    "26.120": {status: documented}
+  notes: >
+    Includes the loads of symmetry boundaries in the analysis; relevant
+    to half-model and periodic runs. Phase init on empirical evidence
+    (2026-07-21 legacy-case reproduction on build 7012026): the
+    unsteady per-step force plots consume this setting during the
+    solve, and leaving it at the post-PERIODIC default ENABLE recorded
+    six-fold symmetric-copy sums while the export-time loads were
+    unaffected; the setting therefore precedes START_SOLVER. The
+    post-MIRROR default is also ENABLE (HND-013 calibration).
+
+SET_LOADS_AND_MOMENTS_UNITS:
+  layout: inline
+  phase: analysis
+  args:
+    - name: unit_type
+      type: enum
+      values: [COEFFICIENTS, NEWTONS, KILO-NEWTONS, POUND-FORCE,
+               KILOGRAM-FORCE]
+  manual_ref: "SRC-003 pp.350-351"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 pp.349-350, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+
+SET_SOLVER_ANALYSIS_BOUNDARIES:
+  layout: payload_lines
+  phase: analysis
+  args:
+    - name: num_boundaries
+      type: int
+    - name: boundary_indices
+      type: int_list
+  manual_ref: "SRC-003 p.351"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Enables the listed boundaries in the analysis tab; boundaries not
+    listed are disabled in the analysis (SRC-003 p.351).
+
+SET_INVISCID_LOADS:
+  layout: inline
+  phase: analysis
+  args:
+    - name: mode
+      type: enum
+      values: [ENABLE, DISABLE]
+  manual_ref: "SRC-003 p.351"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Restricts the analysis to inviscid loads and moments only.

pyflightstream/commands/solver_export.yaml

@@ -0,0 +1,138 @@
+# Chapter: Scripting reference, Solver Data Export (SRC-003
+# pp.352-354).
+
+EXPORT_SOLVER_ANALYSIS_SPREADSHEET:
+  layout: param_lines
+  phase: export
+  args:
+    - name: filename
+      type: path
+  manual_ref: "SRC-003 p.352"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.351, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Exports the aerodynamic loads and moments spreadsheets; the
+    primary quantitative output of a steady polar run.
+
+EXPORT_SOLVER_ANALYSIS_TECPLOT:
+  layout: param_lines
+  phase: export
+  args:
+    - name: filename
+      type: path
+  manual_ref: "SRC-003 p.352"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Exports the Tecplot .dat file for all initialized boundaries.
+
+EXPORT_SOLVER_ANALYSIS_VTK:
+  layout: param_lines
+  phase: export
+  args:
+    - name: filename
+      type: path
+    - name: surfaces
+      type: int
+    - name: boundary_indices
+      type: int_list
+      separator: newline
+      required: false
+  manual_ref: "SRC-003 p.352"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Exports the VTK file. SURFACES takes -1 for all boundaries or a
+    count followed by one index per line.
+
+SET_VTK_EXPORT_VARIABLES:
+  layout: payload_lines
+  phase: export
+  args:
+    - name: num_variables
+      type: int
+    - name: export_wake
+      type: enum
+      values: [ENABLE, DISABLE]
+    - name: variables
+      type: enum_list
+      separator: newline
+      required: false
+      values: [X, Y, Z, CF, CP, CP_REFERENCE, CP_FREESTREAM, MACH,
+               VX, VY, VZ, VTOT, PSTATIC, BLMOM, BLDISP, BLTHICK,
+               SHAPEFACTOR, TRANS, SEP, BLLENGTH, AREA, VORTICITY]
+  manual_ref: "SRC-003 p.352"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    NUM_VARIABLES takes -1 for all variables; otherwise one variable
+    name follows per line. The CP argument is flagged for depreciation
+    in favor of CP_REFERENCE and CP_FREESTREAM (SRC-003 p.352); the
+    emitter warns when CP is requested.
+
+EXPORT_SOLVER_ANALYSIS_CSV:
+  layout: param_lines
+  phase: export
+  args:
+    - name: filename
+      type: path
+    - name: format
+      type: enum
+      values: [CP-FREESTREAM, CP-REFERENCE, PRESSURE]
+    - name: units
+      type: enum
+      values: [PASCALS, MEGAPASCALS, BAR, ATMOSPHERES, PSI]
+    - name: frame
+      type: int
+    - name: surfaces
+      type: int
+    - name: boundary_indices
+      type: int_list
+      separator: newline
+      required: false
+  manual_ref: "SRC-003 p.353"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Exports the FEM CSV file. The path follows on the line after the
+    command name; FORMAT, UNITS, FRAME and SURFACES follow as KEY
+    VALUE lines, with the boundary indices one per line after
+    SURFACES when it is not -1.
+
+EXPORT_SOLVER_ANALYSIS_PLOAD_BDF:
+  layout: param_lines
+  phase: export
+  args:
+    - name: filename
+      type: path
+    - name: surfaces
+      type: int
+    - name: boundary_indices
+      type: int_list
+      separator: newline
+      required: false
+  manual_ref: "SRC-003 p.353"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Exports the NASTRAN PLOAD .bdf file based on the solver results.
+
+EXPORT_SOLVER_ANALYSIS_FORCE_DISTRIBUTIONS:
+  layout: param_lines
+  phase: export
+  args:
+    - name: filename
+      type: path
+    - name: surfaces
+      type: int
+    - name: boundary_indices
+      type: int_list
+      separator: newline
+      required: false
+  manual_ref: "SRC-003 pp.353-354"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Exports the force distribution vectors file for the initialized
+    boundaries.

pyflightstream/commands/solver_initialization.yaml

@@ -0,0 +1,95 @@
+# Chapter: Scripting reference, Solver Initialization / Execution
+# (SRC-003 pp.337-338).
+
+INITIALIZE_SOLVER:
+  layout: keyword_block
+  phase: init
+  args:
+    - name: solver_model
+      type: enum
+      values: [INCOMPRESSIBLE, SUBSONIC_PRANDTL_GLAUERT,
+               TRANSONIC_FIELD_PANEL, TANGENT_CONE, MODIFIED_NEWTONIAN]
+    - name: surfaces
+      type: int
+    - name: surface_toggles
+      type: str_list
+      separator: newline
+      required: false
+    - name: wake_termination_x
+      type: str
+    - name: symmetry
+      type: enum
+      values: [NONE, MIRROR, PERIODIC]
+    - name: symmetry_copies
+      type: int
+      required: false
+      joins_previous: true
+    - name: wall_collision_avoidance
+      type: enum
+      values: [ENABLE, DISABLE]
+      required: false
+  manual_ref: "SRC-003 p.337"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.336, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    SURFACES takes -1 for all boundaries or a count followed by one
+    line per surface with the surface index and the quad mesher toggle
+    (SURFACE_TOGGLES lines of the form index,ENABLE; the count check
+    ties them to SURFACES). WAKE_TERMINATION_X takes an X location in
+    the reference frame or DEFAULT for auto-computation. PERIODIC
+    symmetry appends the number of copies on the SYMMETRY line
+    (SYMMETRY_COPIES). WALL_COLLISION_AVOIDANCE applies to solver
+    models 1 to 3. The initialize_solver helper builds both extended
+    forms from typed arguments. Initializing MIRROR symmetry with a
+    full (non-half) model diverges instantly (SRC-003 p.217); case
+    metadata declaring a full model triggers a build-time warning when
+    cases/ lands.
+
+SOLVER_PROXIMAL_BOUNDARIES:
+  layout: payload_lines
+  phase: init
+  args:
+    - name: count
+      type: int
+    - name: boundary_indices
+      type: int_list
+      separator: newline
+  manual_ref: "SRC-003 pp.337-338"
+  versions:
+    "26.120": {status: documented}
+  notes: >
+    Enables solver proximity checking for the listed boundaries, one
+    index per line. Must be called before INITIALIZE_SOLVER
+    (SRC-003 p.338).
+
+REMOVE_INITIALIZATION:
+  layout: bare
+  phase: init
+  args: []
+  manual_ref: "SRC-003 p.338"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+
+START_SOLVER:
+  layout: bare
+  phase: exec
+  args: []
+  manual_ref: "SRC-003 p.338"
+  versions:
+    "26.100": {status: documented, note: "SRC-725 p.337, same grammar as 26.120"}
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Runs the solver with the current runtime settings; convergence is
+    declared against the SOLVER_SET_CONVERGENCE threshold.
+
+CLEAR_SOLUTION:
+  layout: bare
+  phase: exec
+  args: []
+  manual_ref: "SRC-003 p.338"
+  versions:
+    "26.120": {status: verified, report: "reports/compat/CMP-26120_2026-07-21_full.yaml"}
+  notes: >
+    Clears the existing solution while keeping the initialization;
+    used between sweep points when solution reuse is not wanted.