https://github.com/precice/openfast-adapter
Couples the wind energy engineering tool OpenFAST to CFD solvers via the coupling library preCICE
https://github.com/precice/openfast-adapter
cfd coupling multiphysics openfast windenergy
Last synced: about 1 year ago
JSON representation
Couples the wind energy engineering tool OpenFAST to CFD solvers via the coupling library preCICE
- Host: GitHub
- URL: https://github.com/precice/openfast-adapter
- Owner: precice
- License: lgpl-2.1
- Created: 2024-01-24T10:33:30.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-10T09:50:24.000Z (about 1 year ago)
- Last Synced: 2025-02-10T10:39:02.519Z (about 1 year ago)
- Topics: cfd, coupling, multiphysics, openfast, windenergy
- Language: C++
- Homepage:
- Size: 4.21 MB
- Stars: 8
- Watchers: 6
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# preCICE-Openfast Adapter
[](https://doi.org/10.5281/zenodo.14809780)
⚠️ The state of the adapter is experimental.
[OpenFAST](https://openfast.readthedocs.io/en/dev/index.html) is a multi-physics engineering tool for the aero-servo-elastic simulation of wind turbines. It includes modules for the modeling of aerodynamic, structural, and electrical behaviour of on- and offshore wind turbines.
This project aims to couple OpenFAST with CFD simulation tools with the coupling library [preCICE](https://precice.org/). Therefore, a preCICE-OpenFAST Adapter is being developed. The Adapter calls OpenFAST via the C++ API to drive the turbine simulation. Additionally, it calls the preCICE library to communicate and coordinate with CFD solvers like OpenFOAM.
As a first test case, the Adapter should be able to perform the coupled simulation of a single NREL5MW onshore turbine. OpenFAST calculates the forces and internal state of the turbine, while OpenFOAM is used as CFD solver to compute the inflow (see image).
Source: [OpenFAST documentation](https://ganesh-openfast.readthedocs.io/en/latest/_images/actuatorLine_illustrationViz.pdf), visited on 07.11.2023
## Dependencies
- [OpenFAST v3.5.0](https://openfast.readthedocs.io/en/main/source/install/index.html), with the C++ API enabled
- Building from source: `cmake -DBUILD_OPENFAST_CPP_API=ON .. && make`
- Getting from Spack: `spack install openfast+cxx` (but build with an MPI compiler, see [issue](https://github.com/precice/openfast-adapter/issues/2))
- [preCICE v3.0.0](https://precice.org/installation-overview.html) or later v3.x.
> [!NOTE]
> If you are using a different version of OpenFAST and want to run the provided cases, make sure to check if the OpenFAST input files are [suitable](https://openfast.readthedocs.io/en/main/source/user/api_change.html) for your version
## Run a simulation
- Install the adapter
- Select a [simulation case](https://github.com/LeonardWilleke/openfast-adapter/tree/main/cases)
- Compile the necessary scripts
- Run the coupled simulation
Instructions on how to compile the files and run the simulation are given in each case.
## Installation
Clone the repository and switch to the source directory:
```bash
git clone https://github.com/precice/openfast-adapter.git
cd openfast-adapter/src
```
We use **cmake** for the compilation by invoking a make script:
```bash
bash Allmake
```
The adapter is built locally in the `bin` folder. To make it accessible on the whole system, you need to export the installation path after compilation.
Open the `.bashrc` file
```bash
cd ~
nano .bashrc
```
and add the following line:
```bash
export PATH={path_to_repository}/openfast-adapter/bin:$PATH
```
Now run
```bash
source .basrhc
```
and restart your terminal.
You're good to go! If you want to re-compile the adapter, make sure to clean the old installation first by running `src/Allclean`.
## References
A more detailed description of the concept behind the adapter can be found in this [report](https://doi.org/10.5281/zenodo.14809779). Please consider citing the report if you are using the adapter.
## License and attribution
Parts of the code in `src/openfast-adapter` were reused from a [OpenFAST C++ API example](https://github.com/OpenFAST/openfast/tree/v3.5.0/glue-codes/openfast-cpp/src/FAST_Prog.cpp), which is licensed under the [Apache 2 license](https://github.com/precice/openfast-adapter/tree/main/thirdparty).
## Development contribution
The initial version of this adapter was developed by [Leonard Willeke](https://github.com/LeonardWilleke) during his research stay at Delft University of Technology in the group for [Wind Energy](https://www.tudelft.nl/en/ae/organisation/departments/flow-physics-and-technology/wind-energy) in collaboration with Evert Wiegant.