FEniCS-preCICE adapter is a preCICE adapter for the open source computing platform FEniCS.
preCICE-adapter for the open source computing platform FEniCS. Note: The adapter currently only supports 2D simulations in FEniCS.
Installing the package
Using pip3 to install from PyPI
It is recommended to install fenicsprecice from PyPI via
pip3 install --user fenicsprecice
This should work out of the box, if all dependencies are installed correctly. If you face problems during installation or you want to run the tests, see below for a list of dependencies and alternative installation procedures
Clone this repository and use pip3
Make sure to install the following dependencies:
- python3 (this adapter only supports python3)
- the python language bindings for preCICE
- FEniCS (with python interface, installed by default)
- and scipy (
pip3 install scipy)
Build and install the adapter
After cloning this repository and switching to the root directory (
pip3 install --user . from your shell.
Test the adapter
As a first test, try to import the adapter via
python3 -c "import fenicsprecice".
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_write
FEniCS is suddenly broken: There are two known issues with preCICE, fenicsprecice and FEniCS:
- If you see
ImportError: cannot import name 'sub_forms_by_domain'run
pip3 uninstall -y fenics-ufl. For details, refer to issue #103.
- If you see
ModuleNotFoundError: No module named 'dolfin'and have installed PETSc from source, refer to this forum post. Short version: Try to use the PETSc that comes with your system, if possible. Note that you can also compile preCICE without PETSc, if necessary.
Use the adapter
Please refer to our website.
To create and install the
fenicsprecice python package the following instructions were used: How To Package Your Python Code from python-packaging.readthedocs.io.
If you are using this adapter, please refer to the citing information on the FEniCS adapter.
H.-J. Bungartz, F. Lindner, B. Gatzhammer, M. Mehl, K. Scheufele, A. Shukaev, and B. Uekermann: preCICE - A Fully Parallel Library for Multi-Physics Surface Coupling. Computers and Fluids, 141, 250–258, 2016.
If you are using FEniCS, please also consider the information on the official FEniCS website on citing.
Ishaan Desai improved the user interface and extended the adapter to also allow for parallel FEniCS computations.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size fenicsprecice-1.2.0.tar.gz (38.6 kB)||File type Source||Python version None||Upload date||Hashes View|