# orgsailingvlm/pysailingvlm architecture

> Architecture diagram of the GitHub repository orgsailingvlm/pysailingvlm, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/orgsailingvlm/pysailingvlm
- Repository: https://github.com/orgsailingvlm/pysailingvlm

## Overview

pySailingVLM is a low-fidelity Vortex Lattice Method package for estimating upwind-sail aerodynamics. Users configure yacht, sail and wind conditions through the CLI or Python/Jupyter workflow; the runtime builds sail geometry and inlet conditions, solves the flow, derives forces and moments, and can save or visualize results. The graph preserves the documented analysis and plotting capabilities. Some links are supported only by the SOURCE INDEX or README, so unsampled behavior is not inferred beyond those references.

Main entry points: [`pySailingVLM/runner/cli.py`](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/runner/cli.py) (CLI), [`pySailingVLM/solver/vlm.py`](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/solver/vlm.py) (VLM solver), [`pySailingVLM/runner/sail.py`](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/runner/sail.py) (Python entry), [`pySailingVLM/results/inviscid_flow.py`](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/results/inviscid_flow.py) (Flow results)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["User entry"]
  node_cli["CLI<br/>[cli.py]"]
  node_python["Python entry<br/>[sail.py]"]
  node_rig["Run configuration<br/>[container.py]"]
end

subgraph group_setup["Conditions and geometry"]
  node_wind["Wind profiles<br/>[winds.py]"]
  node_inlet["Inlet conditions"]
  node_sailfactory["Sail factory<br/>[sail_factory.py]"]
  node_sailgeom["Sail geometry<br/>[sail_geometry.py]"]
  node_hull["Hull geometry<br/>[hull_geometry.py]"]
  node_transforms["Coordinate transforms"]
end

subgraph group_flow["VLM flow solver"]
  node_mesher["Panel meshing<br/>[mesher.py]"]
  node_panels["Panel geometry<br/>[panels.py]"]
  node_airfoil["Thin-airfoil model<br/>[vlm_airfoil.py]"]
  node_vlm["VLM solver<br/>[vlm.py]"]
  node_coefs["Flow coefficients<br/>[coefs.py]"]
  node_velocity["Induced velocity<br/>[velocity.py]"]
  node_forces["Force calculation<br/>[forces.py]"]
end

subgraph group_outputs["Results and visualization"]
  node_results["Flow results<br/>[inviscid_flow.py]"]
  node_save["Result export<br/>[save_utils.py]"]
  node_plot["Plots and panels<br/>[panels_plotter.py]"]
end

node_user(("Analyst"))

node_user -->|"runs"| node_cli
node_user -->|"configures"| node_python
node_cli -->|"dispatches"| node_python
node_cli -->|"configures"| node_rig
node_cli -->|"invokes"| node_vlm
node_cli -->|"loads"| node_hull
node_python -->|"uses"| node_rig
node_python -->|"selects"| node_wind
node_python -->|"creates sails"| node_sailfactory
node_python -->|"assembles"| node_sailgeom
node_sailfactory -->|"builds"| node_sailgeom
node_wind -->|"uses"| node_transforms
node_inlet -->|"samples"| node_wind
node_inlet -->|"converts"| node_transforms
node_sailgeom -->|"transforms"| node_transforms
node_sailgeom -->|"uses"| node_panels
node_mesher -->|"uses"| node_airfoil
node_panels -->|"meshes"| node_mesher
node_vlm -->|"creates"| node_inlet
node_vlm -->|"solves with"| node_coefs
node_vlm -->|"calculates"| node_velocity
node_vlm -->|"calculates"| node_forces
node_vlm -->|"uses"| node_panels
node_results -->|"reads"| node_vlm
node_results -->|"calculates moments"| node_forces
node_results -->|"aggregates by sail"| node_sailgeom
node_cli -->|"creates"| node_results
node_cli -->|"exports"| node_save
node_cli -->|"visualizes"| node_plot
node_save -->|"serializes"| node_results
node_plot -->|"plots"| node_results
node_plot -->|"displays"| node_hull

click node_cli "https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/runner/cli.py"
click node_python "https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/runner/sail.py"
click node_rig "https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/runner/container.py"
click node_wind "https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/inlet/winds.py"
click node_inlet "https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/inlet/inlet_conditions.py"
click node_sailfactory "https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/yacht_geometry/sail_factory.py"
click node_sailgeom "https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/yacht_geometry/sail_geometry.py"
click node_hull "https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/yacht_geometry/hull_geometry.py"
click node_transforms "https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/rotations/csys_transformations.py"
click node_mesher "https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/solver/mesher.py"
click node_panels "https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/solver/panels.py"
click node_airfoil "https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/thin_airfoil/vlm_airfoil.py"
click node_vlm "https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/solver/vlm.py"
click node_coefs "https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/solver/coefs.py"
click node_velocity "https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/solver/velocity.py"
click node_forces "https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/solver/forces.py"
click node_results "https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/results/inviscid_flow.py"
click node_save "https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/results/save_utils.py"
click node_plot "https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/solver/panels_plotter.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_python,node_rig toneBlue
class node_wind,node_inlet,node_sailfactory,node_sailgeom,node_hull,node_transforms toneAmber
class node_mesher,node_panels,node_airfoil,node_vlm,node_coefs,node_velocity,node_forces toneMint
class node_results,node_save,node_plot toneRose
class node_user toneIndigo
```

## Components

### User entry

- [CLI](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/runner/cli.py): `pySailingVLM/runner/cli.py`
- [Python entry](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/runner/sail.py): `pySailingVLM/runner/sail.py`
- [Run configuration](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/runner/container.py): `pySailingVLM/runner/container.py`

### Conditions and geometry

- [Wind profiles](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/inlet/winds.py): `pySailingVLM/inlet/winds.py`
- [Inlet conditions](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/inlet/inlet_conditions.py): `pySailingVLM/inlet/inlet_conditions.py`
- [Sail factory](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/yacht_geometry/sail_factory.py): `pySailingVLM/yacht_geometry/sail_factory.py`
- [Sail geometry](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/yacht_geometry/sail_geometry.py): `pySailingVLM/yacht_geometry/sail_geometry.py`
- [Hull geometry](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/yacht_geometry/hull_geometry.py): `pySailingVLM/yacht_geometry/hull_geometry.py`
- [Coordinate transforms](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/rotations/csys_transformations.py): `pySailingVLM/rotations/csys_transformations.py`

### VLM flow solver

- [Panel meshing](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/solver/mesher.py): `pySailingVLM/solver/mesher.py`
- [Panel geometry](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/solver/panels.py): `pySailingVLM/solver/panels.py`
- [Thin-airfoil model](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/thin_airfoil/vlm_airfoil.py): `pySailingVLM/thin_airfoil/vlm_airfoil.py`
- [VLM solver](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/solver/vlm.py): `pySailingVLM/solver/vlm.py`
- [Flow coefficients](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/solver/coefs.py): `pySailingVLM/solver/coefs.py`
- [Induced velocity](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/solver/velocity.py): `pySailingVLM/solver/velocity.py`
- [Force calculation](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/solver/forces.py): `pySailingVLM/solver/forces.py`

### Results and visualization

- [Flow results](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/results/inviscid_flow.py): `pySailingVLM/results/inviscid_flow.py`
- [Result export](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/results/save_utils.py): `pySailingVLM/results/save_utils.py`
- [Plots and panels](https://github.com/orgsailingvlm/pysailingvlm/blob/main/pySailingVLM/solver/panels_plotter.py): `pySailingVLM/solver/panels_plotter.py`

### Other components

- **Analyst**

## Connections

- Analyst → CLI: runs (evidence: `README.md`)
- Analyst → Python entry: configures (evidence: `README.md`)
- CLI → Python entry: dispatches (evidence: `pySailingVLM/runner/cli.py`)
- CLI → Run configuration: configures (evidence: `pySailingVLM/runner/cli.py`)
- CLI → VLM solver: invokes (evidence: `pySailingVLM/runner/cli.py`)
- CLI → Hull geometry: loads (evidence: `pySailingVLM/runner/cli.py`)
- Python entry → Run configuration: uses (evidence: `pySailingVLM/runner/sail.py`)
- Python entry → Wind profiles: selects (evidence: `pySailingVLM/runner/sail.py`)
- Python entry → Sail factory: creates sails (evidence: `pySailingVLM/runner/sail.py`)
- Python entry → Sail geometry: assembles (evidence: `pySailingVLM/runner/sail.py`)
- Sail factory → Sail geometry: builds (evidence: `pySailingVLM/yacht_geometry/sail_factory.py`)
- Wind profiles → Coordinate transforms: uses (evidence: `pySailingVLM/inlet/winds.py`)
- Inlet conditions → Wind profiles: samples (evidence: `pySailingVLM/inlet/inlet_conditions.py`)
- Inlet conditions → Coordinate transforms: converts (evidence: `pySailingVLM/inlet/inlet_conditions.py`)
- Sail geometry → Coordinate transforms: transforms (evidence: `pySailingVLM/yacht_geometry/sail_geometry.py`)
- Sail geometry → Panel geometry: uses (evidence: `pySailingVLM/yacht_geometry/sail_geometry.py`)
- Panel meshing → Thin-airfoil model: uses (evidence: `pySailingVLM/solver/mesher.py`)
- Panel geometry → Panel meshing: meshes (evidence: `pySailingVLM/solver/panels.py`)
- VLM solver → Inlet conditions: creates (evidence: `pySailingVLM/solver/vlm.py`)
- VLM solver → Flow coefficients: solves with (evidence: `pySailingVLM/solver/vlm.py`)
- VLM solver → Induced velocity: calculates (evidence: `pySailingVLM/solver/vlm.py`)
- VLM solver → Force calculation: calculates (evidence: `pySailingVLM/solver/vlm.py`)
- VLM solver → Panel geometry: uses (evidence: `pySailingVLM/solver/vlm.py`)
- Flow results → VLM solver: reads (evidence: `pySailingVLM/results/inviscid_flow.py`)
- Flow results → Force calculation: calculates moments (evidence: `pySailingVLM/results/inviscid_flow.py`)
- Flow results → Sail geometry: aggregates by sail (evidence: `pySailingVLM/results/inviscid_flow.py`)
- CLI → Flow results: creates (evidence: `pySailingVLM/runner/cli.py`)
- CLI → Result export: exports (evidence: `pySailingVLM/runner/cli.py`)
- CLI → Plots and panels: visualizes (evidence: `pySailingVLM/runner/cli.py`)
- Result export → Flow results: serializes (evidence: `pySailingVLM/results/save_utils.py`)
- Plots and panels → Flow results: plots (evidence: `pySailingVLM/solver/panels_plotter.py`)
- Plots and panels → Hull geometry: displays (evidence: `pySailingVLM/solver/panels_plotter.py`)
