Skip to content

Commit 19f0444

Browse files
committed
Update README.md
1 parent 9922006 commit 19f0444

File tree

1 file changed

+45
-8
lines changed

1 file changed

+45
-8
lines changed

README.md

Lines changed: 45 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,23 +31,60 @@ pkg"test VortexStepMethod"
3131
```
3232

3333
## Input
34-
- geometry, defined by section
34+
Three kinds of input data is needed:
35+
36+
- The wing geometry, defined by section:
3537
- rec wing two section, two point + polars
3638
- kite: model of polars included, n sections to define
3739

38-
- flow
40+
- The airflow:
3941
- v_app vector
4042

41-
- config
42-
- how many panels
43-
-> two sections make a panel
43+
- The configuration:
44+
- how many panels
45+
--> two sections make a panel.
46+
47+
There is no input file yet, the input has to be defined in the code.
48+
49+
### Example for defining the required input:
50+
```julia
51+
52+
# Step 1: Define wing parameters
53+
n_panels = 20 # Number of panels
54+
span = 20.0 # Wing span [m]
55+
chord = 1.0 # Chord length [m]
56+
Umag = 20.0 # Magnitude of inflow velocity [m/s]
57+
density = 1.225 # Air density [kg/m³]
58+
alpha_deg = 30.0 # Angle of attack [degrees]
59+
alpha = deg2rad(alpha_deg)
60+
61+
# Step 2: Create wing geometry with linear panel distribution
62+
wing = Wing(n_panels, spanwise_panel_distribution="linear")
63+
64+
# Add wing sections - defining only tip sections with inviscid airfoil model
65+
add_section!(wing,
66+
[0.0, span/2, 0.0], # Left tip LE
67+
[chord, span/2, 0.0], # Left tip TE
68+
"inviscid")
69+
add_section!(wing,
70+
[0.0, -span/2, 0.0], # Right tip LE
71+
[chord, -span/2, 0.0], # Right tip TE
72+
"inviscid")
73+
74+
# Step 3: Initialize aerodynamics
75+
wa = WingAerodynamics([wing])
76+
77+
# Set inflow conditions
78+
vel_app = [cos(alpha), 0.0, sin(alpha)] .* Umag
79+
set_va!(wa, (vel_app, 0.0)) # Second parameter is yaw rate
80+
```
4481

4582
Surfplan output file can be converted to an input for the vortex step method with a tool that is in this repo.
4683

4784
## Output
48-
- cl, cd, cs (side force coefficient)
49-
- spanwise distribution of forces
50-
-> moment coefficients (not yet implemented)
85+
- CL, CD, CS (side force coefficient)
86+
- the spanwise distribution of forces
87+
--> moment coefficients (not yet implemented)
5188

5289
## Citation
5390
If you use this project in your research, please consider citing it.

0 commit comments

Comments
 (0)