Types Reference

pyFlightscript.types.BaseRegionType

Base region types.

alias of Literal[‘EMPIRICAL’, ‘USER’, ‘CUSTOM’]

pyFlightscript.types.RunOptions

Enable/disable options used across most API functions.

alias of Literal[‘ENABLE’, ‘DISABLE’]

pyFlightscript.types.VALID_FORCE_UNITS_LIST = ['COEFFICIENTS', 'NEWTONS', 'KILO-NEWTONS', 'POUND-FORCE', 'KILOGRAM-FORCE']

Runtime validation list matching ValidForceUnits.

pyFlightscript.types.VALID_RUN_OPTIONS = ['ENABLE', 'DISABLE']

Runtime validation list matching RunOptions.

pyFlightscript.types.VALID_SOLVER_MODEL_LIST = ['INCOMPRESSIBLE', 'SUBSONIC_PRANDTL_GLAUERT', 'TRANSONIC_FIELD_PANEL', 'SUPERSONIC_LINEAR_DOUBLET', 'TANGENT_CONE', 'MODIFIED_NEWTONIAN']

Valid solver models for FlightStream analysis.

pyFlightscript.types.VALID_STABILITY_DENOMINATOR_LIST = ['AOA', 'BETA', 'ROTX', 'ROTY', 'ROTZ']

Valid denominator variables for stability coefficients.

pyFlightscript.types.VALID_STABILITY_NUMERATOR_LIST = ['CL', 'CDI', 'CDO', 'CD', 'FORCE_X', 'FORCE_Y', 'FORCE_Z', 'MOMENT_X', 'MOMENT_Y', 'MOMENT_Z']

Valid numerator variables for stability coefficients.

pyFlightscript.types.VALID_STABILITY_UNITS_LIST = ['PER_RADIAN', 'PER_DEGREE']

Valid units for stability coefficient calculations.

pyFlightscript.types.VALID_SYMMETRY_LIST = ['XY', 'XZ', 'YZ', 'NONE']

Runtime validation list matching ValidSymmetry.

pyFlightscript.types.VALID_UNITS_LIST = ['INCH', 'MILLIMETER', 'OTHER', 'FEET', 'MILE', 'METER', 'KILOMETER', 'MILS', 'MICRON', 'CENTIMETER', 'MICROINCH']

Runtime validation list matching ValidUnits.

pyFlightscript.types.ValidAxis

Valid coordinate axes.

alias of Literal[‘X’, ‘Y’, ‘Z’]

pyFlightscript.types.ValidCadMesh

Valid CAD/mesh selection options.

alias of Literal[‘CAD’, ‘MESH’]

pyFlightscript.types.ValidDimensions

Valid dimensions for geometry operations.

alias of Literal[‘2D’, ‘3D’]

pyFlightscript.types.ValidExportFormat

Valid export formats for surface data.

alias of Literal[‘CP-FREESTREAM’, ‘CP-REFERENCE’, ‘PRESSURE’, ‘DIFFERENCE-PRESSURE’]

pyFlightscript.types.ValidExportMeshFileTypes

Valid file types for mesh export.

alias of Literal[‘STL’, ‘TRI’, ‘OBJ’]

pyFlightscript.types.ValidForceUnits

Valid units for force and moment measurements.

alias of Literal[‘COEFFICIENTS’, ‘NEWTONS’, ‘KILO-NEWTONS’, ‘POUND-FORCE’, ‘KILOGRAM-FORCE’]

pyFlightscript.types.ValidFreestreamType

Valid freestream types.

alias of Literal[‘CONSTANT’, ‘CUSTOM’, ‘ROTATION’]

pyFlightscript.types.ValidGrowthScheme

Valid growth schemes for meshing.

alias of Literal[1, 2, 3, 4]

pyFlightscript.types.ValidImportMeshFileTypes

Valid file types for mesh import.

alias of Literal[‘STL’, ‘TRI’, ‘P3D’, ‘CSV’, ‘INP’, ‘STRUCTURED_QUAD’, ‘UNSTRUCTURED_QUAD’, ‘LAWGS’, ‘VTK’, ‘AC’, ‘FAC’, ‘OBJ’]

pyFlightscript.types.ValidPlanes

Valid coordinate planes.

alias of Literal[‘XY’, ‘XZ’, ‘YZ’, ‘ZX’]

pyFlightscript.types.ValidPressureUnits

Valid pressure units.

alias of Literal[‘PASCALS’, ‘MEGAPASCALS’, ‘BAR’, ‘ATMOSPHERES’, ‘PSI’]

pyFlightscript.types.ValidQuadrant

Valid quadrant numbers.

alias of Literal[1, 2, 3, 4]

pyFlightscript.types.ValidRanges

Valid range specifications.

alias of Literal[‘ABOVE_MIN’, ‘BELOW_MAX’, ‘ABOVE_MIN_BELOW_MAX’]

pyFlightscript.types.ValidRotationAxis

Valid rotation axes (numeric or named).

alias of Literal[‘X’, ‘Y’, ‘Z’, ‘1’, ‘2’, ‘3’]

pyFlightscript.types.ValidSubsets

Valid subset selections.

alias of Literal[‘ALL_FACES’, ‘VISIBLE_FACES’, ‘SELECTED_FACES’]

pyFlightscript.types.ValidSymmetry

Valid symmetry planes.

alias of Literal[‘XY’, ‘XZ’, ‘YZ’, ‘NONE’]

pyFlightscript.types.ValidThresholds

Valid threshold types for mesh operations.

alias of Literal[‘AREA’, ‘QUALITY’, ‘X’, ‘Y’, ‘Z’, ‘VELOCITY’, ‘VX’, ‘VY’, ‘VZ’, ‘CP’, ‘MACH’, ‘SOLVER_QUALITY’]

pyFlightscript.types.ValidTranslationTypes

Valid translation types.

alias of Literal[‘ABSOLUTE’, ‘TRANSLATION’]

pyFlightscript.types.ValidUnits

Valid units for length measurements.

alias of Literal[‘INCH’, ‘MILLIMETER’, ‘OTHER’, ‘FEET’, ‘MILE’, ‘METER’, ‘KILOMETER’, ‘MILS’, ‘MICRON’, ‘CENTIMETER’, ‘MICROINCH’]

pyFlightscript.types.RunOptions

Enable/disable options used across most API functions.

alias of Literal[‘ENABLE’, ‘DISABLE’]

pyFlightscript.types.VALID_RUN_OPTIONS

Runtime validation list matching RunOptions.

pyFlightscript.types.ValidUnits

Valid units for length measurements.

alias of Literal[‘INCH’, ‘MILLIMETER’, ‘OTHER’, ‘FEET’, ‘MILE’, ‘METER’, ‘KILOMETER’, ‘MILS’, ‘MICRON’, ‘CENTIMETER’, ‘MICROINCH’]

pyFlightscript.types.VALID_UNITS_LIST

Runtime validation list matching ValidUnits.

pyFlightscript.types.ValidForceUnits

Valid units for force and moment measurements.

alias of Literal[‘COEFFICIENTS’, ‘NEWTONS’, ‘KILO-NEWTONS’, ‘POUND-FORCE’, ‘KILOGRAM-FORCE’]

pyFlightscript.types.VALID_FORCE_UNITS_LIST

Runtime validation list matching ValidForceUnits.

pyFlightscript.types.VALID_SOLVER_MODEL_LIST

Valid solver models for FlightStream analysis.

pyFlightscript.types.VALID_SYMMETRY_LIST

Runtime validation list matching ValidSymmetry.

pyFlightscript.types.VALID_UNSTEADY_FORCE_PLOT_PARAMETER_LIST

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

pyFlightscript.types.VALID_UNSTEADY_FLUID_PLOT_PARAMETER_LIST

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

# Add more as needed…