Skip to content

Latest commit

 

History

History
290 lines (222 loc) · 16 KB

README.md

File metadata and controls

290 lines (222 loc) · 16 KB
Raw

Python Geometrical Morphing

Software License Build Status Coverage Status Codacy Badge Docker Pulls

PyGeM (Python Geometrical Morphing) is a python package that allows you to deform a given geometry or mesh with different deformation techniques such as FFD, RBF and IDW.

Table of contents

Description

PyGeM is a python package using Free Form Deformation, Radial Basis Functions and Inverse Distance Weighting to parametrize and morph complex geometries. It is ideally suited for actual industrial problems, since it allows to handle:

  • Computer Aided Design files (in .iges, .step, and .stl formats)
  • Mesh files (in .unv, Elmer, and OpenFOAM formats)
  • Output files (in .vtk format)
  • LS-Dyna Keyword files (.k format)

By now, it has been used with meshes with up to 14 milions of cells. Try with more and more complicated input files! See the Examples section below and the Tutorials to have an idea of the potential of this package.

Dependencies and installation

PyGeM requires numpy, scipy, matplotlib, sphinx (for the documentation) and pytest (for local test). They can be easily installed via pip. The code has been tested with Python3.7 version, but it should be compatible with a generic Python3.x. The Python2 support is no longer maintained. To enable the CAD submodule, the module pythonocc-core is required to deal with IGES files. This requirement cannot be satisfied through pip, but the precompiled binaries are available on conda using the command:

conda install -c conda-forge pythonocc-core=7.4.0

For additional information about the compilation and installation of pythonocc, we refer the original repository.

The official distribution is on GitHub, and you can clone the repository using

> git clone https://github.com/mathLab/PyGeM

To install the package just type:

> python setup.py install

To uninstall the package you have to rerun the installation and record the installed files in order to remove them:

> pip uninstall pygem

Docker

Alternatively, a way to run the PyGeM library is to use our prebuilt and high-performance Docker images. Docker containers are extremely lightweight, secure, and are based on open standards that run on all major Linux distributions, macOS and Microsoft Windows platforms.

Install Docker for your platform by following these instructions. If using the Docker Toolbox (macOS versions < 10.10 or Windows versions < 10), make sure you run all commands inside the Docker Quickstart Terminal.

Now we will pull the sissamathlab/pygem image from our cloud infrastructure:

>  docker pull sissamathlab/pygem:latest

Docker will pull the latest tag of the image pygemdocker/pygem from docker.io. The download is around 3.246 GB. The image is a great place to start experimenting with PyGeM and includes all dependencies already compiled for you. Once the download is complete you can start PyGeM for the first time. Just run:

>  docker run -ti  sissamathlab/pygem:latest

To facilitate the devoloping, using the text editor,version control and other tools already installed on your computers, it is possible to share files from the host into the container:

>  docker run -ti -v $(pwd):/home/PyGeM/shared  sissamathlab/pygem:latest

To allow the X11 forwarding in the container, on Linux system just run:

>  docker run -ti --rm -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix  -v $(pwd):/home/PyGeM/shared  sissamathlab/pygem:latest

For Windows system, you need to install Cygwin/X version and running the command in Cygwin terminal. While for mac system, you need to install xquartz.

Documentation

PyGeM uses Sphinx for code documentation. You can view the documentation online here. To build the html versions of the docs locally simply:

> cd docs
> make html

The generated html can be found in docs/build/html. Open up the index.html you find there to browse.

Testing

We are using Github Actions for continuous intergration testing. You can check out the current status here.

To run tests locally (the package pytest is required):

> pytest

Examples

You can find useful tutorials on how to use the package in the tutorials folder. Here we show three applications, taken from the naval, nautical and automotive engineering fields. On the other hand, the provided tutorials are related to easier geometries.

DTMB-5415 hull: morphing of the bulbous bow starting from an industrial .iges CAD file.

MCY hull: morphing of the exhaust gasses devices starting from an industrial .stl file.

DrivAer model: morphing of the bumper starting from an OpenFOAM mesh file.

How to cite

If you use this package in your publications please cite the package as follows:

@article{TezzeleDemoMolaRozza2020PyGeM,
author = {Marco Tezzele and Nicola Demo and Andrea Mola and Gianluigi Rozza},
title = {{PyGeM: Python Geometrical Morphing}},
journal = {Software Impacts},
pages = {100047},
year = {2020},
issn = {2665-9638},
doi = {10.1016/j.simpa.2020.100047},
url = {http://www.sciencedirect.com/science/article/pii/S2665963820300385}
}

References

The deformations implemented are taken from the following papers:

  • Sieger, Menzel, Botsch. On Shape Deformation Techniques for Simulation-based Design Optimization. SEMA SIMAI Springer Series, 2015. [DOI], [pdf], [bibitem].

  • Forti, Rozza. Efficient geometrical parametrisation techniques of interfaces for reduced-order modelling: application to fluid–structure interaction coupling problems. International Journal of Computational Fluid Dynamics, 2014. [DOI], [bibitem].

  • Sieger, Menzel, Botsch. RBF Morphing Techniques for Simulation-based Design Optimization. M. Engineering with Computers, 2014. [DOI], [pdf], [bibitem].

  • Lombardi, Parolini, Quarteroni, Rozza. Numerical Simulation of Sailing Boats: Dynamics, FSI, and Shape Optimization. Springer Optimization and Its Applications, 2012. [DOI], [pdf], [bibitem].

Recent works with PyGeM

Here there is a list of the scientific works involving PyGeM you can consult and/or cite. If you want to add one, please open a PR.

  • Jiang, Mayeur, Patrouix, Cirette, Witz, Dumont, Brieu. Patient-Specific Modeling of Pelvic System from MRI for Numerical Simulation: Validation Using a Physical Model. Computational Biomechanics for Medicine. MICCAI 2019. [DOI].

  • Tezzele, Demo, Rozza. Shape optimization through proper orthogonal decomposition with interpolation and dynamic mode decomposition enhanced by active subspaces. In Proceedings of MARINE 2019: VIII International Conference on Computational Methods in Marine Engineering, pages 122-133, 2019. [DOI], [arXiv], [bibitem].

  • Demo, Tezzele, Mola, Rozza. A complete data-driven framework for the efficient solution of parametric shape design and optimisation in naval engineering problems. In Proceedings of MARINE 2019: VIII International Conference on Computational Methods in Marine Engineering, pages 111-121, 2019. [DOI], [arXiv], [bibitem].

  • Tezzele, Demo, Mola, Rozza. An integrated data-driven computational pipeline with model order reduction for industrial and applied mathematics. Submitted, 2018. [arXiv], [bibitem].

  • Tezzele, Salmoiraghi, Mola, Rozza. Dimension reduction in heterogeneous parametric spaces with application to naval engineering shape design problems. Advanced Modeling and Simulation in Engineering Sciences, 2018. [DOI], [arXiv], [bibitem].

  • Tezzele, Ballarin, Rozza. Combined parameter and model reduction of cardiovascular problems by means of active subspaces and POD-Galerkin methods. In Mathematical and Numerical Modeling of the Cardiovascular System and Applications. SEMA SIMAI Springer Series vol. 16, 2018. [DOI], [arXiv], [bibitem].

  • Salmoiraghi, Scardigli, Telib, Rozza. Free-form deformation, mesh morphing and reduced-order methods: enablers for efficient aerodynamic shape optimisation. International Journal of Computational Fluid Dynamics, 2018. [DOI], [arXiv], [bibitem].

  • Demo, Tezzele, Gustin, Lavini, Rozza. Shape optimization by means of proper orthogonal decomposition and dynamic mode decomposition. In Technology and Science for the Ships of the Future: Proceedings of NAV 2018: 19th International Conference on Ship & Maritime Research, 2018. [DOI], [arXiv], [bibitem].

  • Tezzele, Demo, Gadalla, Mola, Rozza. Model Order Reduction by means of Active Subspaces and Dynamic Mode Decomposition for Parametric Hull Shape Design Hydrodynamics. In Technology and Science for the Ships of the Future: Proceedings of NAV 2018: 19th International Conference on Ship & Maritime Research, 2018. [DOI], [arXiv], [bibitem].

  • Demo, Tezzele, Mola, Rozza. An efficient shape parametrisation by free-form deformation enhanced by active subspace for hull hydrodynamic ship design problems in open source environment. The 28th International Ocean and Polar Engineering Conference, 2018. [arXiv], [bibitem].

  • Bergmann, Ferrero, Iollo, Lombardi, Scardigli, Telib. A zonal Galerkin-free POD model for incompressible flows. Journal of Computational Physics, 2018. [DOI], [bibitem].

  • Salmoiraghi, Ballarin, Corsi, Mola, Tezzele, Rozza. Advances in geometrical parametrization and reduced order models and methods for computational fluid dynamics problems in applied sciences and engineering: overview and perspectives. ECCOMAS 2016 proceedings. [DOI], [bibitem].

Authors and contributors

PyGeM is currently developed and mantained at SISSA mathLab by

under the supervision of Prof. Gianluigi Rozza. We thank Filippo Salmoiraghi for the original idea behind this package and the major contributions.

Contact us by email for further information or questions about PyGeM, or suggest pull requests. Contributions improving either the code or the documentation are welcome!

How to contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Submitting a patch

  1. It's generally best to start by opening a new issue describing the bug or feature you're intending to fix. Even if you think it's relatively minor, it's helpful to know what people are working on. Mention in the initial issue that you are planning to work on that bug or feature so that it can be assigned to you.

  2. Follow the normal process of forking the project, and setup a new branch to work in. It's important that each group of changes be done in separate branches in order to ensure that a pull request only includes the commits related to that bug or feature.

  3. To ensure properly formatted code, please make sure to use 4 spaces to indent the code. The easy way is to run on your bash the provided script: ./code_formatter.sh. You should also run pylint over your code. It's not strictly necessary that your code be completely "lint-free", but this will help you find common style issues.

  4. Any significant changes should almost always be accompanied by tests. The project already has good test coverage, so look at some of the existing tests if you're unsure how to go about it. We're using coveralls that is an invaluable tools for seeing which parts of your code aren't being exercised by your tests.

  5. Do your best to have well-formed commit messages for each change. This provides consistency throughout the project, and ensures that commit messages are able to be formatted properly by various git tools.

  6. Finally, push the commits to your fork and submit a pull request. Please, remember to rebase properly in order to maintain a clean, linear git history.

License

See the LICENSE file for license rights and limitations (MIT).