README.adoc · Veenxz/elmerfem

Elmer FEM

This is the official source code repository for the Elmer FEM software suite.

GitHub contributors

GitHub last commit GitHub language count

Elmer is a finite element software for numerical solution of partial differential equations. Elmer is capable of handling any number of equations and is therefore ideally suited for the simulation of multiphysical problems. It includes models, for example, of structural mechanics, fluid dynamics, heat transfer and electromagnetics. Users can also write their own equations that can be dynamically linked with the main program.

Elmer consists of several parts. The most important ones are ElmerSolver the finite element solver, ElmerGUI the graphical user interface, and ElmerGrid the mesh creation and manipulation tool. Also a visualization tool, ElmerPost, is included in the package but it is no longer developed.

Download binaries

You may download binaries and virtual machines from here.

Docker

nwrichmond/elmerice: Docker Hub, more info
unifem/Elmer-desktop: GitHub
CoSci-LLC/docker-elmerice: Docker Hub, GitHub

Documentation

You may find the PDFs for the documentation here.

Compiling

macOS

Download this repository either az a zip file via GitHub or using git clone https://github.com/ElmerCSC/elmerfem.git
Go to the downloaded directory mkdir build and cd build
Install Homebrew
Install GCC brew install gcc
Install CMake brew install cmake
Without MPI:
- cmake .. -D WITH_OpenMP:BOOLEAN=TRUE
With MPI:
- Install OpenMPI brew install open-mpi
- cmake .. -D WITH_OpenMP:BOOLEAN=TRUE -D WITH_MPI:BOOLEAN=TRUE
With ElmerGUI:
- install qt4 with brew install cartr/qt4/qt@4
- install qwt with brew install cartr/qt4/qwt-qt4
- cmake .. -D WITH_OpenMP:BOOLEAN=TRUE -D WITH_MPI:BOOLEAN=TRUE -D WITH_ELMERGUI:BOOLEAN=TRUE
With ElmerPost:
- brew cask install xquartz
- ….
make
make install

Ubuntu

Download the source code and create build directory as above
Install the dependencies sudo apt install git cmake build-essential gfortran libopenmpi-dev libblas-dev liblapack-dev
Without MPI:
- cmake .. -DWITH_OpenMP:BOOLEAN=TRUE
With MPI:
- cmake .. -DWITH_OpenMP:BOOLEAN=TRUE -DWITH_MPI:BOOLEAN=TRUE
With ElmerGUI:
- sudo apt install libqt4-dev libqwt-dev
- cmake .. -DWITH_OpenMP:BOOLEAN=TRUE -DWITH_MPI:BOOLEAN=TRUE -DWITH_ELMERGUI:BOOLEAN=TRUE
With Elmer/Ice (enabling netcdf and MUMPS):
- sudo apt install libnetcdf-dev libnetcdff-dev libmumps-dev
- cmake .. -DWITH_OpenMP:BOOLEAN=TRUE -DWITH_MPI:BOOLEAN=TRUE -DWITH_ElmerIce:BOOLEAN=TRUE -DWITH_Mumps:BOOL=TRUE
make
sudo make install
The executables are in /usr/local/bin folder, you may add this to your PATH if you will

Licensing

Elmer software is licensed under GPL except for the ElmerSolver library which is licensed under LGPL license. Elmer is mainly developed at CSC - IT Center for Science, Finland. However, there have been numerous contributions from other organizations and developers as well, and the project is open for new contributions. More information about Elmer’s licensing here.