PyPI - gmshairfoil2d - Versions diffs - 0.1.4__tar.gz → 0.2__tar.gz - Mend

gmshairfoil2d 0.1.4tar.gz → 0.2tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (21) hide show

gmshairfoil2d-0.2/PKG-INFO ADDED Viewed

@@ -0,0 +1,141 @@
+Metadata-Version: 2.4
+Name: gmshairfoil2d
+Version: 0.2
+Summary: Python tool to generate 2D mesh around an airfoil
+Home-page: https://github.com/cfsengineering/GMSH-Airfoil-2D
+Author: Giacomo Benedetti
+Author-email: giacomo.benedetti@cfse.ch
+License: Apache License 2.0
+Keywords: airfoil,2D,mesh,cfd,gmsh
+Classifier: Programming Language :: Python :: 3.11
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.11.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: gmsh>=4.14
+Requires-Dist: numpy>=1.20.3
+Requires-Dist: pytest==7.1.3
+Requires-Dist: requests==2.26.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+[![Pytest](https://github.com/cfsengineering/GMSH-Airfoil-2D/actions/workflows/pytest.yml/badge.svg?branch=main)](https://github.com/cfsengineering/GMSH-Airfoil-2D/actions/workflows/pytest.yml)
+[![PyPi version](https://img.shields.io/pypi/v/gmshairfoil2d.svg)](https://pypi.python.org/pypi/gmshairfoil2d)
+[![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://github.com/cfsengineering/GMSH-Airfoil-2D/blob/main/LICENSE)
+[![Black code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+# GMSH-Airfoil-2D
+Python tool to genreate 2D unstructured, hybrid and structured mesh around an airfoil with [GMSH](https://gmsh.info/) in one command line.
+## Installation
+You can install this package from PyPi:
+```bash
+pip install gmshairfoil2d
+```
+Or you can clone and install this repository with the following commands:
+```bash
+git clone https://github.com/cfsengineering/GMSH-Airfoil-2D.git
+cd GMSH-Airfoil-2D
+pip install -e .
+```
+## Usage
+```text
+gmshairfoil2d -h
+optional arguments:
+  -h, --help                  Show this help message and exit
+  --list                      Display all airfoil available in the database :
+                              https://m-selig.ae.illinois.edu/ads/coord_database.html
+  --naca [4DIGITS]            NACA airfoil 4 digit
+  --airfoil [NAME]            Name of an airfoil profile in the database (database available with
+                              the --list argument)
+  --aoa [AOA]                 Angle of attack [deg] (default: 0 [deg])
+  --farfield [RADIUS]         Create a circular farfield mesh of given radius [m] (default 10m)
+  --box [LENGTHxWIDTH]        Create a box mesh of dimensions [length]x[height] [m]
+  --airfoil_mesh_size [SIZE]  Mesh size of the airfoil contour [m] (default 0.01m)
+  --ext_mesh_size [SIZE]      Mesh size of the external domain [m] (default 0.2m) (for normal, bl
+                              and structural)
+  --no_bl                     Do the unstructured meshing (with triangles), without a boundary
+                              layer
+  --first_layer [HEIGHT]      Height of the first layer [m] (default 3e-5m) (for bl and structural)
+  --ratio [RATIO]             Growth ratio of layers (default 1.2) (for bl and structural)
+  --nb_layers [INT]           Total number of layers in the boundary layer (default 35)
+  --format [FORMAT]           Format of the mesh file, e.g: msh, vtk, wrl, stl, mesh, cgns, su2,
+                              dat (default su2)
+  --structural                Generate a structural mesh
+  --arg_struc [LxLxL]         Parameters for the structural mesh [leading (axis x)]x[wake (axis
+                              x)]x[total height (axis y)] [m] (default 1x10x10)
+  --output [PATH]             Output path for the mesh file (default : current dir)
+  --ui                        Open GMSH user interface to see the mesh
+```
+## Examples of use
+To check all airfoil available in the [database](https://m-selig.ae.illinois.edu/ads/coord_database.html):
+```bash
+gmshairfoil2d --list
+```
+For all the following examples, the defauld chord lenght is 1 meter.
+To create a circular farfield mesh around a NACA0012 of 10m of radius and see the result with GMSH user interface:
+```bash
+gmshairfoil2d --naca 0012 --farfield 10 --ui --no_bl
+```
+![GMSH user interface with the 2D mesh](images/example_mesh.png)
+To create a circular farfield mesh with boudary layer around a Drela DAE11 airfoil (the name in the database is "dae11") of 4m or radius with a mesh size of 0.005m on the airfoil (but to not open on the interface):
+```bash
+gmshairfoil2d --airfoil dae11 --farfield 4 --airfoil_mesh_size 0.005
+```
+To create mesh around a Eppler E220 airfoil (the name in the database is "e211") with an angle of attack of 8 degree in a box of 12x4m (lenght x height) and save it as a vtk mesh and see the result with GMSH user interface:
+```bash
+gmshairfoil2d --airfoil e211 --aoa 8 --box 12x4 --format vtk --ui --no_bl
+```
+![GMSH user interface with the 2D mesh, rectangular box](images/example_mesh_box.png)
+To create a boxed mesh around a Chuch Hollinger CH 10-48-13 smoothed airfoil (the name in the database is "ch10sm"), using the boundary layer with default parameters (first layer of height 3e-5, 35 layers and growth ratio of 1.2) :
+```bash
+gmshairfoil2d --airfoil ch10sm --ui --box 2x1.4
+```
+![GMSH result with 2D mesh with boundary layer, rectangular box](images/example_ch10sm_bl.png)
+To create a structural mesh around a Naca 4220 airfoil (the 4 digits code is obviously "4220"), with first layer height of 0.01, mesh_size of 0.08 wake length of 6, height of 7, and angle of attack of 6 degrees :
+```bash
+ gmshairfoil2d --naca 4220 --airfoil_mesh_size 0.08 --ui --structural --first_layer 0.01 --arg_struc 6x7 --aoa 6
+```
+![GMSH result with 2D structural mesh](images/example_structural_naca4220.png)

gmshairfoil2d-0.1.4/PKG-INFO → gmshairfoil2d-0.2/README.md RENAMED Viewed

@@ -1,25 +1,3 @@
-Metadata-Version: 2.1
-Name: gmshairfoil2d
-Version: 0.1.4
-Summary: Python tool to genreate 2D mesh around an airfoil
-Home-page: https://github.com/cfsengineering/GMSH-Airfoil-2D
-Author: Aidan Jungo
-Author-email: aidan.jungo@cfse.ch
-License: Apache License 2.0
-Keywords: airfoil,2D,mesh,cfd,gmsh
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Operating System :: OS Independent
-Classifier: Intended Audience :: Developers
-Requires-Python: >=3.6.0
-Description-Content-Type: text/markdown
-License-File: LICENSE
 [![Pytest](https://github.com/cfsengineering/GMSH-Airfoil-2D/actions/workflows/pytest.yml/badge.svg?branch=main)](https://github.com/cfsengineering/GMSH-Airfoil-2D/actions/workflows/pytest.yml)
 [![PyPi version](https://img.shields.io/pypi/v/gmshairfoil2d.svg)](https://pypi.python.org/pypi/gmshairfoil2d)
 [![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://github.com/cfsengineering/GMSH-Airfoil-2D/blob/main/LICENSE)
@@ -27,7 +5,7 @@ License-File: LICENSE
 # GMSH-Airfoil-2D
-Python tool to genreate 2D unstructured mesh around an airfoil with [GMSH](https://gmsh.info/) in one command line.
+Python tool to genreate 2D unstructured, hybrid and structured mesh around an airfoil with [GMSH](https://gmsh.info/) in one command line.
 ## Installation
@@ -51,20 +29,29 @@ pip install -e .
 gmshairfoil2d -h
 optional arguments:
-  -h, --help                  show this help message and exit
+  -h, --help                  Show this help message and exit
   --list                      Display all airfoil available in the database :
                               https://m-selig.ae.illinois.edu/ads/coord_database.html
-  --naca [4DIGITS]            NACA airfoil 4 digit (default 0012)
+  --naca [4DIGITS]            NACA airfoil 4 digit
   --airfoil [NAME]            Name of an airfoil profile in the database (database available with
                               the --list argument)
   --aoa [AOA]                 Angle of attack [deg] (default: 0 [deg])
   --farfield [RADIUS]         Create a circular farfield mesh of given radius [m] (default 10m)
   --box [LENGTHxWIDTH]        Create a box mesh of dimensions [length]x[height] [m]
-  --airfoil_mesh_size [SIZE]  Mesh size of the airfoil countour [m] (default 0.01m)
-  --ext_mesh_size [SIZE]      Mesh size of the external domain [m] (default 0.2m)
-  --format [FORMAT]           format of the mesh file, e.g: msh, vtk, wrl, stl, mesh, cgns, su2,
+  --airfoil_mesh_size [SIZE]  Mesh size of the airfoil contour [m] (default 0.01m)
+  --ext_mesh_size [SIZE]      Mesh size of the external domain [m] (default 0.2m) (for normal, bl
+                              and structural)
+  --no_bl                     Do the unstructured meshing (with triangles), without a boundary
+                              layer
+  --first_layer [HEIGHT]      Height of the first layer [m] (default 3e-5m) (for bl and structural)
+  --ratio [RATIO]             Growth ratio of layers (default 1.2) (for bl and structural)
+  --nb_layers [INT]           Total number of layers in the boundary layer (default 35)
+  --format [FORMAT]           Format of the mesh file, e.g: msh, vtk, wrl, stl, mesh, cgns, su2,
                               dat (default su2)
-  --output [PATH]             output path for the mesh file (default : current dir)
+  --structural                Generate a structural mesh
+  --arg_struc [LxLxL]         Parameters for the structural mesh [leading (axis x)]x[wake (axis
+                              x)]x[total height (axis y)] [m] (default 1x10x10)
+  --output [PATH]             Output path for the mesh file (default : current dir)
   --ui                        Open GMSH user interface to see the mesh
 ```
@@ -82,21 +69,40 @@ For all the following examples, the defauld chord lenght is 1 meter.
 To create a circular farfield mesh around a NACA0012 of 10m of radius and see the result with GMSH user interface:
 ```bash
-gmshairfoil2d --naca 0012 --farfield 10 --ui
+gmshairfoil2d --naca 0012 --farfield 10 --ui --no_bl
 ```
 ![GMSH user interface with the 2D mesh](images/example_mesh.png)
-To create a circular farfield mesh around a Drela DAE11 airfoil (the name in the database is "dae11") of 20m or radius with a mesh size of 0.005m on the airfoil:
+To create a circular farfield mesh with boudary layer around a Drela DAE11 airfoil (the name in the database is "dae11") of 4m or radius with a mesh size of 0.005m on the airfoil (but to not open on the interface):
 ```bash
-gmshairfoil2d --airfoil dae11 --farfield 20 --airfoil_mesh_size 0.005
+gmshairfoil2d --airfoil dae11 --farfield 4 --airfoil_mesh_size 0.005
 ```
-To create mesh around a Eppler E220 airfoil (the name in the database is "e211") with an angle of attack of 8 degree in a box of 12x4m (lenght x hight) and save it as a vtk mesh and see the result with GMSH user interface:
+To create mesh around a Eppler E220 airfoil (the name in the database is "e211") with an angle of attack of 8 degree in a box of 12x4m (lenght x height) and save it as a vtk mesh and see the result with GMSH user interface:
 ```bash
-gmshairfoil2d --airfoil e211 --aoa 8 --box 12x4 --format vtk --ui
+gmshairfoil2d --airfoil e211 --aoa 8 --box 12x4 --format vtk --ui --no_bl
 ```
 ![GMSH user interface with the 2D mesh, rectangular box](images/example_mesh_box.png)
+To create a boxed mesh around a Chuch Hollinger CH 10-48-13 smoothed airfoil (the name in the database is "ch10sm"), using the boundary layer with default parameters (first layer of height 3e-5, 35 layers and growth ratio of 1.2) :
+```bash
+gmshairfoil2d --airfoil ch10sm --ui --box 2x1.4
+```
+![GMSH result with 2D mesh with boundary layer, rectangular box](images/example_ch10sm_bl.png)
+To create a structural mesh around a Naca 4220 airfoil (the 4 digits code is obviously "4220"), with first layer height of 0.01, mesh_size of 0.08 wake length of 6, height of 7, and angle of attack of 6 degrees :
+```bash
+ gmshairfoil2d --naca 4220 --airfoil_mesh_size 0.08 --ui --structural --first_layer 0.01 --arg_struc 6x7 --aoa 6
+```
+![GMSH result with 2D structural mesh](images/example_structural_naca4220.png)

gmshairfoil2d 0.1.4__tar.gz → 0.2__tar.gz

gmshairfoil2d 0.1.4tar.gz → 0.2tar.gz