README.md 2.21 KB
Newer Older
Kirill Terekhov's avatar
Kirill Terekhov committed
1 2 3 4
INMOST
======

A toolkit for distributed mathematical modeling
5

Alexander Danilov's avatar
Alexander Danilov committed
6 7
## New address
INMOST was moved to the new address: https://github.com/INMOST-DEV/INMOST
8

Alexander Danilov's avatar
Alexander Danilov committed
9
Please update your bookmarks, if you used `git clone` before then refer to https://github.com/INMOST-DEV/INMOST/issues/7#issuecomment-70378751
10

Alexander Danilov's avatar
Alexander Danilov committed
11 12
## Install Guide
Refer to https://github.com/INMOST-DEV/INMOST/wiki/0100-Compilation
13

14
## Examples
15 16 17 18 19 20 21

Several representative examples are provided in source archive.
Here we will try three parallel steps: grid generation, FVM discretization and linear matrix solution.
Each example may be executed in serial or parallel ways.

### Parallel Grid Generation

22
This example creates simple cubic or prismatic mesh. You can use ParaView to view the meshes.
23 24
```
cd examples/GridGen
25
mpirun -np 4 ./GridGen 4 32 32 32
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
```
Generator parameters are: `ng nx ny nz`
where `ng=3` stands for Prismatic generator and
`ng=4` for Cubic one,
while `nx ny nz` are the mesh dimensions.

File grid.pvtk (as well as grid_X.vtk with X=0,1,2,3) will appear in the current directory.
Run
`paraview --data=grid.pvtk`
and try the following tags in objects to display:
- `P_OWNER_PROCESSOR` – partitioning to processors
- `GLOBAL_ID` – global cell ID number

### Parallel Finite Volume Discretization

This example uses simple two-point FVM scheme to solve Laplace's equation in unit cube domain.
```
cd ../FVDiscr
44
mpirun -np 4 ./FVDiscr ../GridGen/grid.pvtk A.mtx b.rhs
45 46 47
```
Files result.pvtk (as well as result_X.vtk with X=0,1,2,3) and A.mtx b.rhs will appear in the current directory.
Run
48
`paraview --data=result.pvtk`
49 50 51 52 53 54 55 56
and try the following tags in objects to display:
- `Solution` – the solution to the problem
- `K` – tensor K (constant equal to 1 in this example)

### Solve the Matrix stored in mtx format

This example solves the linear system using different solvers.
```
57 58
cd ../MatSolve
mpirun -np 4 ./MatSolve 0 ../FVDiscr/A.mtx ../FVDiscr/b.rhs
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
```
Solution time and the true residual will output to the screen.
The first parameter selects the solver:
- `0` – INMOST ILU2
- `1` – INMOST MLILUC
- `2` – ANI3D
- `3` – PETSc

### Other Examples

There are other examples:
```
DrawGrid
DrawMatrix
OctreeCutcell
OldDrawGrid
Solver
```
which can be used without warranty.