preCICE-adapter for the open source computing platform FEniCSx.
This adapter is based on the FEniCS-preCICE adapter. This adapter works with dolfinx v0.9.0.
It is recommended to install fenicsxprecice from PyPI (TODO link to https://pypi.org/project/fenicsxprecice/ as soon as released) via
pip install fenicsxpreciceThis should work out of the box, if all dependencies are installed correctly and if your FEniCSx installation version matches the one supported by the adapter. If you face problems during installation or you want to run the tests, see below for a list of dependencies and alternative installation procedures
Make sure to install the following dependencies:
- preCICE
- python3 (this adapter only supports python3)
- the python language bindings for preCICE
- 🚧 FEniCSx (with python interface, installed by default) (under construction refer to notes on FEniCSx below) 🚧
- and scipy (
pip3 install scipy)
After cloning this repository and switching to the root directory (fenicsx-adapter), run pip3 install --user . from your shell.
As a first test, try to import the adapter via python3 -c "import fenicsxprecice".
You can run the other tests via python3 setup.py test.
Single tests can be also be run. For example the test test_vector_write in the file test_write_read.py can be run as follows:
python3 -m unittest tests.test_write_read.TestWriteandReadData.test_vector_writePlease refer to our website 🚧 Refers to the FEniCS version of the adapter 🚧.
- FEniCSx-preCICE: If you are using this adapter (
fenicsx-adapter), please consider citing the thesis of Philip Hildebrand. Additionally, you can refer to the citing information on the (very similar) FEniCS adapter. - preCICE: preCICE is an academic project, developed at the Technical University of Munich and at the University of Stuttgart. If you use preCICE, please cite preCICE.
- FEniCSx: If you are using FEniCSx, please also consider the information on the official FEniCS website on citing.