Skip to content
Snippets Groups Projects
Verified Commit 3e588b91 authored by Thomas Lambert's avatar Thomas Lambert :helicopter:
Browse files

doc: clarify function examples (import)

parent 7d3dea7d
No related branches found
No related tags found
No related merge requests found
......@@ -92,6 +92,7 @@ This function can either aggregate multiple polar files into a single structure
data into a Matlab-ready structure.
```matlab
import af_tools.xf2mat
Polar = xf2mat
Polar = xf2mat(autosave, trimAoas, inputDir, inputFiles)
```
......@@ -126,6 +127,7 @@ propellers in off-design configuration (with the Blade Element Momentum Theory
for instance).
```matlab
import af_tools.extendpolar
[alphaExt, clExt, cdExt] = extendpolar
[alphaExt, clExt, cdExt] = extendpolar(method, limit, Polar)
[alphaExt, clExt, cdExt] = extendpolar(method, limit, alpha, cl, cd)
......@@ -145,6 +147,7 @@ for instance).
Determines the camber line of a NACA 4 or 5 digits airfoil.
```matlab
import af_tools.nacacamber
[xc, yc, gradY] = nacacamber
[xc, yc, gradY] = nacacamber(digits, nPoints, spacing)
```
......@@ -160,6 +163,7 @@ Determines the camber line of a NACA 4 or 5 digits airfoil.
Generates the full coordinates of a NACA 4 or 5 digits airfoil.
```matlab
import af_tools.nacaairfoil
[x, y] = nacaairfoil
[x, y] = nacaairfoil(digits, nPoints, spacing, finiteTrail)
```
......@@ -173,15 +177,11 @@ Generates the full coordinates of a NACA 4 or 5 digits airfoil.
### plotpolars
Plots the different polars:
- $`C_l--\alpha`$
- $`C_d--\alpha`$
- $`C_m--\alpha`$
- $`C_l/C_d--\alpha`$
- $`C_l--C_d`$
Plots the following polars: $`C_l-\alpha`$, $`C_d-\alpha`$, $`C_m-\alpha`$
$`C_l/C_d-\alpha`$, $`C_l-C_d`$.
```matlab
import af_tools.plotpolars
plotpolars
plotpolars(Polar)
plotpolars(alpha, cl, cd, cm)
......@@ -200,6 +200,7 @@ plotpolars(alpha, cl, cd, cm)
Finds the stall angle of attack and the associated $`C_l`$ and $`C_d`$.
```matlab
import af_tools.findstall
[alpha_s, cl_s, cd_s] = findstall
[alpha_s, cl_s, cd_s] = findstall(Polar)
[alpha_s, cl_s, cd_s] = findstall(alpha, cl, cd)
......@@ -217,6 +218,7 @@ Finds the stall angle of attack and the associated $`C_l`$ and $`C_d`$.
Finds the zero-lift angle of attack and the associated $`C_d`$.
```matlab
import af_tools.findzerolift
[alpha_zeroL, cd_zeroL] = findzerolift
[alpha_zeroL, cd_zeroL] = findzerolift(Polar)
[alpha_zeroL, cd_zeroL] = findzerolift(alpha, cl, cd)
......@@ -235,6 +237,7 @@ Finds the range of angles of attack for which the $`C_l`$ can be considered
linear.
```matlab
import af_tools.findcllinearrange
[alphaRange, clRange, clSlope] = findcllinearrange
[alphaRange, clRange, clSlope] = findcllinearrange(Polar)
[alphaRange, clRange, clSlope] = findcllinearrange(alpha,cl)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment