/EasyFsi

Library for FSI or other multi-physics coupling problem

Primary LanguageC++MIT LicenseMIT


Logo

EasyFsi Library

An flexable toolkit for solving FSI or multi-physics coupling problem!
Explore the docs »

View Demo Report Bug Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This library provides a flexible toolkit for integrating different solvers to solve fluid-structure interaction and other multiphysics coupling problems. It can be used to solve aeroelastic, aerothermoelastic, etc.

Why use this library?

  • Suitable for MPI parallel computing, which automatically assembles distributed boundary
  • Implement many interpolation methods such as spline interpolation, ISO-parameteric inversion, geometric mapping, etc.
  • Communication between different solvers based on socket
  • No dependencies except pybind11
  • Easily integrated into C/C++, Fortran, Python, MATLAB solvers.

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

  • Visual Studio, make sure C++20 is supported
  • pybind11, if you need python binding

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

  1. Clone the repo 
    git clone https://github.com/ZHBHFUT/EasyFsi.git
  2. Open EasyFsi.sln and build all projects.
  3. Include EasyFsi.h to your C/C++ project, see demo.cpp for usage.
  4. Use import EasyFsi in your python script, see demo.py for usage.

(back to top)

Usage

See demo.cpp and demo.py to find out how to use this library.

More documents please see EasyFsi.md.

(back to top)

Roadmap

  • Add Changelog
  • Add MATLAB binding
  • Implement the CoupledRegion class
  • Add additional interpolation method
  • Add document

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

ZHANG Bing - zhangbing@hfut.edu.cn

Project Link: https://github.com/ZHBHFUT/EasyFsi

(back to top)

Acknowledgments

TBD

(back to top)