CN-AeroModels

CN-AeroModels: A C++ implementation of aerodynamic models for wind propulsion systems of cargo ships - Published in JOSS (2024)

https://gitlab.com/lheea/CN-AeroModels

Repository

https://gitlab.com/lheea/CN-AeroModels/blob/master/

![GitLab License](https://img.shields.io/gitlab/license/LHEEA%2FCN-AeroModels)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.06940/status.svg)](https://doi.org/10.21105/joss.06940)

# CN-AeroModels



`CN-AeroModels` has been developed to provide methods to compute the aerodynamic forces generated by **wind propulsion systems (WPS)** for ships. To date, it is possible to consider soft sails, rigid sails, and Flettner rotors.

The models currently available in `CN-AeroModels` are:
- a simple model based on strip theory ```strip theory```,
- a model based on the 3D nonlinear lifting line theory \[Phillips & Snyder, 2000\] ```nonlinear lifting line```,
- a model based on the ISILL method \[Malmek et al., 2024\] ```ISILL```.

`CN-AeroModels` was developed at [LHEEA](https://lheea.ec-nantes.fr/english-version?l=1) ([Ecole Centrale de Nantes](https://www.ec-nantes.fr/english-version?l=1)/CNRS). It is intended to be integrated into the ship simulator [```xdyn```](https://github.com/sirehna/xdyn). Therefore:
- it has been developed in C++,
- it relies on pieces of the code of [```xdyn```](https://github.com/sirehna/xdyn) (in particular the ```ssc``` library, the wind models, the ```Mesh``` library),
- the structure of the configuration file (YAML) is the same as that of [```xdyn```](https://github.com/sirehna/xdyn).

## Installation

### Pre-built binaries

Pre-built binaries (executables) of `CN-AeroModels` are available for Linux and Windows on [the Releases page](https://gitlab.com/lheea/CN-AeroModels/-/releases).


### Building from source

One can build `CN-AeroModels` from source using CMake:

```console
cmake -S. -Bbuild
cmake --build build
```

This requires a C++ compiler (only GCC was tested) and Git, in addition to CMake.

See [the documentation](https://lheea.gitlab.io/CN-AeroModels) for further details.


### Adding `CN-AeroModels` to the system's `PATH`

It is convenient to add `CN-AeroModels` to the system's `PATH`. This is done by adding the location of the executable to the system's `PATH`.
See [the documentation](https://lheea.gitlab.io/CN-AeroModels) for further details.


## Running `CN-AeroModels`

There is not yet a graphic user interface or Python interface for `CN-AeroModels`. Thus, it has to be run from a terminal.

Assuming the CN-AeroModels executable is in your system's PATH, the following command runs the program with the `` input file:

```console
CN-AeroModels 
```

For example, to run the elliptic planform test case, go to `examples/2- nonlinear lifting line` and run:

```console
CN-AeroModels.exe elliptic.yml
```

**Note :** On Windows, add `.exe` to the name of the executable when running in the standard command prompt (`cmd`).


## Documentation

The [documentation](https://lheea.gitlab.io/CN-AeroModels) includes:
- Detailed compilation and installation procedures
- The description of the YAML configuration file,
- The theory and implementation of the methods (```strip theory```, ```nonlinear lifting line``` and ```ISILL```),
- The description of the outputs.

## Contributing

Contributions are welcome, be it bug reporting and/or fixing, adding new features (e.g a Python interface) or examples/validations, completing the documentation, ...

## Authors

* [Aurlien BABARIT](https://gitlab.com/aurelien.babarit)
* [Moran CHARLOU](https://gitlab.com/mcharlou)

## License

This project is licensed under the Eclipse Public License version 2.0 (without Secondary Licenses) - see the [LICENSE.txt](LICENSE.txt) file for details.

Owner

JOSS Publication

CN-AeroModels: A C++ implementation of aerodynamic models for wind propulsion systems of cargo ships

Published

October 08, 2024

DOI

10.21105/joss.06940

Volume 9, Issue 102, Page 6940

Authors

Aurélien Babarit
Nantes Université, Ecole Centrale de Nantes, CNRS, LHEEA, France

Moran Charlou
Nantes Université, Ecole Centrale de Nantes, CNRS, LHEEA, France

Editor

Philip Cardiff

Tags

aerodynamics lifting line theory wind-assisted propulsion ship

View PDF Review Thread Software Archive

Committers

Last synced: 4 months ago

Issues and Pull Requests

Last synced: 4 months ago