functions.md

CurrentModule = VortexStepMethod

Functions for creating the geometry

add_section!
refine!
calculate_span
calculate_projected_area

Surface aero (contour + Cp + cf) tables

The per-section surface aero table type and its loader live in the core package; the generation and CSV/dat writing (from XFoil/NeuralFoil) live in AirfoilAero.

SectionAero
section_surface
read_section_aero

Airfoil aerodynamics (AirfoilAero)

These live in the AirfoilAero submodule of VortexStepMethod, which converts airfoil coordinates to polars and Cp tables. Load it with using VortexStepMethod.AirfoilAero.

CurrentModule = VortexStepMethod.AirfoilAero

fit_kulfan_parameters
kulfan_to_coordinates
KulfanFitMethod
LeastSquaresFit
ShrinkWrap
shrink_wrap
AbstractAirfoilSolver
XFoilSolver
NeuralFoilSolver
SectionSolution
DeformedSection
deform_section
analyze_section
analyze_sweep
neuralfoil_aero
deform_kulfan
chord_residual
chord_line
control_point_deflection
panel_kulfan_parameters
refresh_live_polars!
deform_live_shapes!
apply_live_shapes!
polar_drift
compare_live_polar
refresh_live_pressure!
live_surface_friction!
contour_shape_matrix
live_shape_offset!
generate_aero_matrices
generate_polar_from_coordinates
generate_polar_from_dat
generate_airfoil_aero
generate_section_aero
generate_airfoils
write_section_aero

OBJ mesh conversion (ObjAdapter)

These live in the ObjAdapter submodule of VortexStepMethod, which converts a 3D wing .obj mesh to the native YAML/CSV geometry format. Load it with using VortexStepMethod.ObjAdapter.

CurrentModule = VortexStepMethod.ObjAdapter

obj_to_yaml
write_yaml
perpendicular_sections
plot_airfoils
plot_slices_3d

Surfplan conversion (SurfplanAdapter)

These live in the SurfplanAdapter submodule of VortexStepMethod, which converts the output of the (Python) SurfplanAdapter export into the native, VSM-loadable YAML/CSV geometry format. Load it with using VortexStepMethod.SurfplanAdapter.

CurrentModule = VortexStepMethod.SurfplanAdapter

surfplan_to_aero_yaml

CurrentModule = VortexStepMethod

Setting the inflow conditions and solving

set_va!
apparent_wind
section_pitch_rate
solve
solve!
solve_base!
reinit!(body_aero::BodyAerodynamics{P, W, T}) where {P, W, T}
linearize
stability_derivatives
trim_angle
calculate_results

Main Plotting Functions

The plotting functions are implemented as package extensions. They are available once a Makie backend (GLMakie or CairoMakie) and MakieControlPlots are loaded before VortexStepMethod. The examples use GLMakie.

plot_geometry
plot_distribution
plot_polars
plot_polar_data
plot_combined_analysis
plot_section_polars

Settings to arguments

The blocks a vsm_settings.yaml carries, turned into the arguments the slicer, the polar generator and the live polars take.

airfoil_solver
alpha_range
delta_range
reynolds
rotation_matrix
slice_args
preview_args

Helper Functions

save_plot
show_plot