A streamlined OpenFOAM generation tool
Ampersand is designed to provide users a simple and streamlined workflow for generating their OpenFOAM case files.
You can use Ampersand for external and internal incompressible flows. The case file generation procedure is very simple. You need to locate your STL file and answer a few YES/NO and multiple choice questions. Ampersand will take care of the rest including mesh size and y+, boundary conditions and numerical schemes.
-
Requirements: OpenFOAM (ESI version), Python 3.x, additional dependencies (list here).
-
Installation: Clone the repository and install dependencies.
-
OpenFOAM Version: Currently Ampersand only supports OpenFOAM ESI versions (OpenFOAM.com) such as v2206, v2212 and later. Earlier versions such as v1912 or v2006 should work too, although these versions were not tested yet.
git clone https://github.com/thawtar/ampersandCFD.git
cd ampersandCFD
pip install -r requirements.txt- Setup: Configure paths as needed, then verify with a test case.
- Case generation: Go inside ampersandCFD/src directory and run:
python main.py --create- Modifying generated case: Go inside ampersandCFD/src directory and run:
python main.py --open-
Streamlined workflow for external and internal flows An easy to follow series of prompts and questions to create your OpenFOAM casefiles and meshes. You can choose whether external aerodynamics or internal flows inside various machinery and Ampersand will help you generate a suitable case directory for you.
-
Boundary conditions and simulation settings Easily configure boundaries, geometry and physics. Stable and accurate discretization schemes and linear solvers are chosen for your simulations!
The user guide and related documentations are under construction. We will provide more detailed guides later.
Contributions are welcome! Please see our contribution guide for details.
For questions or support, contact Thaw Tar (mr.thaw.tar1990@gmail.com) or open an issue.
You can see the demonstration of this code in this following YouTube video: https://www.youtube.com/watch?v=KoiBxDwSiP0&t=248s
The OpenFOAM case files for the following meshes and CFD simulations are created using Ampersand.
Multi-region mesh of a tank (Internal flow problem)
DrivAer simulation (External flow)
Formula One car (External flow)