docs(uiuccleaner): All latest changes to the docs

+af_tools/uiuccleaner.m

@@ -2,8 +2,8 @@ function Dat = uiuccleaner(varargin)
 % UIUCCLEANER Cleans airfoil data from UIUC Airfoil Database.
 %   The UIUC airfoil database from the University of Illinois gathers the
 %   coordinates for more than 1600 airfoils. However, there is a few
-%   discrepencies between the format and ordering of these coordinates. This
-%   scipts alleviates that by re-formatting any input file from the original
+%   discrepancies between the format and ordering of these coordinates. This
+%   script alleviates that by re-formatting any input file from the original
 %   database.
 %
 % Format:
@@ -61,8 +61,7 @@ function Dat = uiuccleaner(varargin)
 % See also: NACAAIRFOIL.
 
 % -----
-% XFOIL: http://web.mit.edu/drela/Public/web/xfoil/
-% XFLR5: https://www.xflr5.tech/xflr5.htm
+% UIUC Airfoil Database: https://m-selig.ae.illinois.edu/ads/coord_database.html
 % -----
 % Copyright 2022 Thomas Lambert <t.lambert@uliege.be>
 % ULiege - Aeroelasticity and Experimental Aerodynamics

CHANGELOG.md

@@ -9,12 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Added save to dat file for _nacaairfoil_
-
 ### Changed
 
-- Coordinates of nacaairfoil start at TE, go along upper side to LE, then TE
-
 ### Deprecated
 
 ### Removed
@@ -23,9 +19,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Security
 
+## [1.1.0] - 2022-04-10
+
+### Added
+
+- Added `savedat` option for _nacaairfoil_
+- **Added uiuccleaner function**
+
+### Changed
+
+- Coordinates outputted by _nacaairfoil_ now start at TE, go along upper side to
+  LE, then go along lower side back to TE
+- Refactor input parsing for xf2mat
+
 ## [1.0.0] - 2022-04-08
 
 - Initial release
 
 [Unreleased]: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/compare/v1.0.0...master
+[1.1.0]: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/compare/v1.0.0...v1.1.0
 [1.0.0]: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/releases/v1.0.0

README.md

@@ -84,6 +84,8 @@ af_tools.xf2mat(args)
 List of functions:
 
 - [xf2mat](#xf2mat): Aggregates multiple XFOIL or XFLR5 polar results into a single structure.
+- [uiuccleaner](#uiuccleaner): Re-formats airfoil coordinates obtained from UIUC
+  Airfoil database.
 - [Airfoil generation](#airfoil-generation)
   - [nacacamber](#nacacamber): Generates the coordinates of the camberline for a NACA 4 or 5 digits airfoil.
   - [nacaairfoil](#nacaairfoil): Generates the full coordinates of a NACA 4 or 5 digits airfoil.
@@ -134,6 +136,36 @@ angles of attack and N is the number of input files.
 | `cd`         | Drag coefficient                                 | [M x N] |
 | `cm`         | Moment coefficient                               | [M x N] |
 
+### uiuccleaner
+
+The [UIUC airfoil database][uiuc-af-db] from the University of Illinois gathers the
+coordinates for more than 1600 airfoils. However, there is a few
+discrepancies between the format and ordering of these coordinates. This
+scripts alleviates that by re-formatting any input file from the original
+database. The main use of this function is to make the coordinates files
+compliant with other existing tools, such as [XFOIL][xfoil].
+
+The output format of this script follows the "labeled coordinates" file, used
+originally by Selig on the UIUC Airfoil Database. The first line contains the
+name of the airfoil, and each line after that is a set of coordinates. The
+coordinates are ordered from the trailing edge, along the upper surface to the
+leading edge and back around the lower surface to trailing edge.
+
+```matlab
+import af_tools.xf2mat
+Polar = uiuccleaner
+Polar = uiuccleaner(inputDir, inputFiles, 'autosave', true)
+Polar = uiuccleaner(inputDir, inputFiles, 'overwrite', true)
+```
+
+| Input        | Example                                        | Default |
+|------------- | ---------------------------------------------- | --------|
+| `inputDir`   | `'.'`, `'xf_results'`                          | -       |
+| `inputFiles` | `'*'`, `'*0012*'`, `'{'*0012_1*', '*0012_2*'}` | `'*'`   |
+|              |                                                |         |
+| 'autosave'   | `false`, `true`                                | `false` |
+| 'overwrite'  | `false`, `true`                                | `false` |
+
 ### Airfoil generation
 
 The following functions use the same two main input arguments.
@@ -269,6 +301,7 @@ All functions and scripts of the **af_tools** code are licensed under the
 
 [xfoil]: http://web.mit.edu/drela/Public/web/xfoil/
 [xflr5]: https://www.xflr5.tech/xflr5.htm
+[uiuc-af-db]: https://m-selig.ae.illinois.edu/ads/coord_database.html
 [tlambert]: <https://tlambert.xyz>
 [gitlab_issues]: https://gitlab.uliege.be/am-dept/matlab_airfoil_toolbox/-/issues
 [matlabDoc_packages]: <https://www.mathworks.com/help/matlab/matlab_oop/scoping-classes-with-packages.html>