Merge pull request #35 from mtezzele/readme

Readme

Author: mtezzele

README.md

@@ -100,6 +100,15 @@ Here we show a bottom-up parametrized construction of the [Potsdam Propeller Tes
 <em>PPTC blade generation according to the radial distribution of the pitch, rake, skew. The generated blade is then exported to .iges and .stl formats.</em>
 </p>
 
+Two possible deformed geometry configurations, to show the capabilities of the package, are presented here:
+
+<p align="center">
+<img src="readme/blade_deformations.png" alt>
+</p>
+<p align="center">
+<em>Undeformed reference blade on the left, and a couple of deformed configurations obtained by moving some control points defining the skew and chord length radial distributions.</em>
+</p>
+
 ## How to cite
 
 ### Recent works with BladeX

joss-paper/paper.bib

@@ -0,0 +1,28 @@
+%% This BibTeX bibliography file was created using BibDesk.
+%% http://bibdesk.sourceforge.net/
+
+
+%% Created for Marco Tezzele at 2018-01-29 10:21:30 +0100 
+
+
+%% Saved with string encoding Unicode (UTF-8) 
+
+
+@book{carlton2012marine,
+  title={Marine propellers and propulsion},
+  author={Carlton, John},
+  year={2012},
+  publisher={Butterworth-Heinemann}
+}
+
+
+@paper{tezzele2018ecmi,
+	Author = {Tezzele, M. and Demo, N. and Mola, A. and Rozza, G.},
+	Preprint = {https://arxiv.org/abs/1810.12364}
+	Journal = {Submitted, Special Volume ECMI},
+	Title = {{An integrated data-driven computational pipeline with model order reduction for industrial and applied mathematics}},
+	Year = {2018}}
+
+@url{bladex,
+	Title = {{BladeX: Python Blade Deformation. Available at: \url{https://github.com/mathLab/BladeX}}},
+	Urldate = {2019-01}}

joss-paper/paper.md

@@ -0,0 +1,48 @@
+---
+title: 'BladeX: Python Blade Deformation'
+tags:
+ - Python
+ - Blade construction
+ - Blade morphing
+ - CAD files
+authors:
+ - name: Mahmoud Gadalla
+   orcid: 0000-0001-9507-9468
+   affiliation: 1
+ - name: Marco Tezzele
+   orcid: 0000-0001-9747-6328
+   affiliation: 1
+ - name: Andrea Mola
+   orcid: 0000-0002-4483-0212
+   affiliation: 1
+ - name: Gianluigi Rozza
+   orcid: 0000-0002-0810-8812
+   affiliation: 1
+affiliations:
+ - name: International School of Advanced Studies, SISSA, Trieste, Italy
+   index: 1
+date: 15 January 2019
+bibliography: paper.bib
+---
+
+# Summary
+
+Marine propeller blade shape is constantly studied by engineers to obtain designs which allow for enhanced hydrodynamic performance while reducing vibrations and noise emissions. In such framework, shape parametrization and morphing algorithms are crucial elements of the numerical simulation and prototipation environment required for the evaluation of new blade geometries. By a practical standpoint, the propeller blade is uniquely described by the following parameters: the shape of a certain number of sectional profile shapes, complemented by the pitch, skew, rake, and chord length values corresponding to each section along the radial direction. Taking such parameters into account we are able to construct a blade and, parametrizing the aforementioned quantities by spline reconstruction, we are able to morph every single section. This results in a morphing tool that expand in a non-intrusive way the naval engineering consolidated design techniques. In particular
+we followed [@carlton2012marine] for marine propeller blades construction, conventions, and terminology. 
+
+In the BladeX Python package [@bladex] we implemented the bottom-up construction of blades given the radial distribution of pitch, skew, rake, chord, and camber of the sectional profiles. We also provide several tutorials showing how to construct or import sectional profiles in 2D and then how to generate the desired 3D representation of the blade. It is also possible to export the final design in CAD files such as iges and stl. Even if the focus is on marine propeller blades, the software is general enough to produce, for instance, aircraft wings or wind turbine blades. It is particularly suited for simulation driven design shape optimization.
+
+The package has already been used within the research project PRELICA, “Advanced methodologies for hydro-acoustic design of naval propulsion”, with both industrial and academic partners, and some results can be found in [@tezzele2018ecmi]. This highlights that the target user of this package is either a numerical analyst working in academia or a skilled engineer working in the naval construction field.
+
+As an example, we show below a bottom-up construction of a benchmark blade called PPTC, and the resulted iges and stl file formats.
+
+![PPTC](../readme/PPTC.png)
+
+Here we have the undeformed reference blade and a couple of deformed configurations obtained by moving some control points defining the skew and chord length radial distributions.
+
+![Deformations](../readme/blade_deformations.png)
+
+# Acknowledgements
+This work was partially supported by the project PRELICA, “Advanced methodologies for hydro-acoustic design of naval propulsion”, supported by Regione FVG, POR-FESR 2014-2020, Piano Operativo Regionale Fondo Europeo per lo Sviluppo Regionale, and by European Union Funding for Research and Innovation — Horizon 2020 Program — in the framework of European Research Council Executive Agency: H2020 ERC CoG 2015 AROMA-CFD project 681447 “Advanced Reduced Order Methods with Applications in Computational Fluid Dynamics” P.I. Gianluigi Rozza.
+
+# References