diff --git a/README.md b/README.md index 3d001ed56d47b5a574354ec516b3cc7ce838ccf6..2cef7a98bb411248f7e0321236534c058a2a15d5 100644 --- a/README.md +++ b/README.md @@ -1,91 +1,11 @@ # LDD simulation for two-phase flow systems (R–R, TP–TP, TP–R coupling) This project provides a Fenics based 2D domain decomposition code implementing an LDD solver for two-phase flow systems. -Two-phase flow systems means, that each subdomain can either adopt the full two-phase flow equations or the Richards/Richardson. +Two-phase flow systems means, that each subdomain can either adopt the full two-phase flow equations or the Richards/Richardson equation. Flexible domain substructurings are possible so long as each subdomain has polygonal boundary. -## Manual how to set up latest fenix image in Docker -Pull the latest fenics Docker image - - docker pull quay.io/fenicsproject/stable:latest - - -## Create docker container named LDD-TPR with graphical display, share folder `pwd` - - docker run --dns=129.69.252.252 -it --env HOST_UID=$(id -u $USER) --env HOST_GID=$(id -g $USER) --env DISPLAY=unix$DISPLAY --device /dev/dri --volume /tmp/.X11-unix:/tmp/.X11-unix:rw --volume $(pwd):/home/fenics/shared --name LDD-TPR-fenics2019 quay.io/fenicsproject/stable:latest /bin/bash - - -If you want the container do be automatically deleted after exiting add `--rm` option. - - -If you have trouble with internet connection inside the container use - - --dns=YOUR_DNS_SERVER - - -## Start LDD-TPR container and step into the container - - docker start LDD-TPR & docker exec -ti -u fenics LDD-TPR /bin/bash -l - - -## Usefull docker commands - -List all docker container - - docker ps -a - - -Remove container - - docker rm $container - - -Remove all stopped container - - docker container prune - - -List all images - - docker images - - -Remove image - - docker rmi $image - - -# Troubleshooting - -**Problem** -1. I can't install packages via `apt-get install` inside the container - -2. I cannot create files or folders (no write permissions) - -**Solution** - -1. If the package is not found first `apt-get update` and then try again. If there is no connection -check your dns settings. - -2. In the container, execute once the script `Rechtesetup/setpermissions.sh` to gain write access in `/home/fenics/shared` - - cd /home/fenics/shared/Rechtesetup & sudo ./setpermissions.sh - -## Nützliche FEniCS Links - - -- Forum, viele Fragen wurden evtl. schon gestellt, bzw. können ggf. gestellt werden: - - https://www.allanswered.com/community/s/fenics-project/ - - -- Python API reference (die von der neuesten Version existiert quasi noch nicht): - - https://fenicsproject.org/docs/dolfin/2017.2.0/python/programmers-reference/index.html - - -- Fenics git wenn man wirklich mal in die source files schauen möchte: - - https://bitbucket.org/fenics-project/ - +## Setup and Installation +To use this module, start by cloning the repository by running + git clone https://gitlab.mathematik.uni-stuttgart.de/seusdd/ldd-for-two-phase-flow-systems.git +The folder [Setup](./Setup/README.md) instructions contains instructions on how to get `Fenics` up and running inside a docker container. \ No newline at end of file