Commit 939ed403 authored by Jan Zapletal's avatar Jan Zapletal

working on readme

parent 71bbef63
# heatDtN - Dirichlet-to-Neumann map for the Laplace equation in 3D
# **heatDtN** - Dirichlet-to-Neumann map for the Laplace equation in 3D
## About the program
......@@ -6,11 +6,11 @@ The purpose of the library is to generate the Dirichlet-to-Neumann (Steklov-Poin
## Mathematical background
![Omega](manual/omega.svg)
## Compilation
The Makefile for heatDtN have been derived from a NetBeans project, the project compiles as a dynamic library in `./dist/heatdtn_lib/libheatdtn.so`. The user should only modify the Makefile in the root of heatDtN. The library relies on Eigen (tested with, e.g. version 3.3.6) and Intel MKL (or possibly another BLAS/LAPACK implementation) which are NOT distributed in this repository. The user is required to download both and set the `EIGEN_INC` variable in `./Makefile`, e.g.
A Makefile to compile the project as a dynamic library `./dist/libheatdtn.so` is provided. The library relies on Eigen (tested with, e.g. version 3.3.6) and Intel MKL (or possibly another BLAS/LAPACK implementation) which are **not** distributed within this repository. The user is required to download both and set the `EIGEN_INC` variable in `./Makefile`, e.g.
```
EIGEN_INC=/home/zap150/eigen-eigen-b3f3d4950030
```
......@@ -34,7 +34,7 @@ LDLIBSOPTIONS=-fopenmp -L${MKLROOT}/lib/intel64 -Wl,-rpath,'${MKLROOT}/lib/intel
### Examples
A simple program linking against `libheatdtn.so` is provided in the directory `./Examples`. Modify `./Examples/Makefile` to suit your needs and run `make` to compile `./Examples/testHeatDtN`. Run the program to test the library.
A simple program linking against `libheatdtn.so` is provided in the directory `./Examples`. Modify `./Examples/Makefile` to suit your needs and run `make` to compile `./Examples/dist/testHeatDtN`. Run the program to test the library.
## heatDtN API
......
This source diff could not be displayed because it is too large. You can view the blob instead.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment