This is the first step you may want to try if you are new to preCICE: install preCICE and some solvers, and run a simple coupled case.
To get a feeling what preCICE does, watch a short presentation, a longer talk on the fundamentals, or click through a tutorial in your browser.
Get and install preCICE. For Ubuntu 20.04 (Focal Fossa), this is pretty easy: download and install our binary package by clicking on it or using the following commands:
wget https://github.com/precice/precice/releases/download/v2.5.0/libprecice2_2.5.0_focal.deb sudo apt install ./libprecice2_2.5.0_focal.deb
- Are you using something else? Just pick what suits you best on this overview page.
- Facing any problems? Ask for help.
We will use OpenFOAM here and in many of our tutorial cases, so install OpenFOAM:
# Add the signing key, add the repository, update (check this): wget -q -O - https://dl.openfoam.com/add-debian-repo.sh | sudo bash # Install OpenFOAM v2206: sudo apt install openfoam2206-dev # Enable OpenFOAM by default in your system and apply now: echo "source /usr/lib/openfoam/openfoam2206/etc/bashrc" >> ~/.bashrc source ~/.bashrc
Install a few common dependencies that we will need later:
sudo apt install build-essential pkg-config cmake git
Download and install the OpenFOAM-preCICE adapter:
git clone --branch=master --depth 1 https://github.com/precice/openfoam-adapter cd openfoam-adapter ./Allwmake cd ..
Get the quickstart tutorial case:
git clone --branch=master --depth 1 https://github.com/precice/tutorials.git cd tutorials/quickstart
If you prefer to easily try everything in an isolated environment, you may prefer using our demo virtual machine.
We will couple OpenFOAM with a C++ rigid body solver for fluid-structure interaction. The rigid body has only a single degree of freedom, namely the deflection angle of the flap in the channel. It is also fixed in the origin at (0,0) and the force exerted by the fluid on the rigid body structure causes an oscillatory rotation of the body. The simulation runs for 2.5 seconds.
In order to gain more control over the rigid body oscillation, a rotational spring is applied at the rigid body origin. After 1.5 seconds we increase the spring constant by a factor of 8 to stabilize the coupled problem. Feel free to modify these parameters (directly in
rigid_body_solver.cpp) and increase the simulation time (in
Building the rigid body solver
Before starting the coupled simulation, we need to build the rigid body solver. You can run the following commands from the
solid-cpp directory to build the
cd tutorials/quickstart/solid-cpp cmake . && make
Running the coupled simulation
You may run the two simulations in two different terminals and watch their output on the screen using
./run.sh from inside the directory of each participant:
# Terminal window 1 cd tutorials/quickstart/solid-cpp ./run.sh
# Terminal window 2 cd tutorials/quickstart/fluid-openfoam ./run.sh # Alternative, in parallel: ./run.sh -parallel
You can also run OpenFOAM in parallel:
In serial, the simulation should take less than a minute to compute (simulated time: 2.5s).
Visualizing the results
You can visualize the simulation results of the
Fluid participant using ParaView and loading the (empty) file
fluid-openfoam/fluid-openfoam.foam. The rigid body does not generate any readable output files, but the OpenFOAM data should be enough for now: click “play” in ParaView, the flap should already be moving! 🎉
You may be curious what displacements OpenFOAM received from the rigid body solver. We can actually easily visualize the coupling meshes, including the exchanged coupling data: preCICE generates the relevant files during the simulation and stores them in the directory
solid-cpp/coupling-meshes. Load these VTK files in ParaView and apply a
Glyph filter with
Glyph Type: Arrow,
Orientation Array: Displacement, and
Scale Array: No scale array. You can further add a
Warp By Vector filter with
Displacement to deform the coupling data. The result should look as follows:
Running again (and again, and again)
Now that you have a first working example, experiment! For example, how can you tell preCICE to simulate for a longer maximum time?
Before running the simulation again, cleanup the results and temporary files using
To become a preCICE pro:
- Get an overview of the preCICE docs.
- See what users talk about in the preCICE forum.
- Run tutorials with other coupled solvers.
- Watch some preCICE videos.
- Meet our community.
- Find out how to couple your own solver.
- Tell us your story.
Are you just starting with simulation software on Linux? Note that much of the complexity for partitioned simulations comes from working with multiple software packages and some new tools. These resources may help your first steps:
- E-book Research Software Engineering with Python.
- Material of the course Simulation Software Engineering (University of Stuttgart).
- Material of the course The Missing Semester of Your CS Education (MIT).