Lattice Boltzmann solver in APES. Now found at https://github.com/apes-suite/musubi
Revisión | 272081a15babecaef16aa16fe0c5f235dbe16ac9 (tree) |
---|---|
Tiempo | 2017-04-20 02:34:54 |
Autor | Harald Klimach <harald@klim...> |
Commiter | Harald Klimach |
Added the README again.
@@ -0,0 +1,99 @@ | ||
1 | +Musubi | |
2 | +====== | |
3 | + | |
4 | +Musubi is the multi-level parallel lattice Boltzmann solver within the APES | |
5 | +suite. It is working on a linearized octree and uses efficient data structures | |
6 | +allowing adaptive parallel simulations. Musubi offers several collision kernels | |
7 | +and is designed in a way to deal with huge meshes very efficiently. | |
8 | + | |
9 | +How to compile | |
10 | +-------------- | |
11 | + | |
12 | +Musubi makes use of the [waf](http://code.google.com/p/waf), to manage the | |
13 | +compilation. | |
14 | + | |
15 | +You will need to have an MPI wrapper for your Fortran compiler and have the | |
16 | +*FC* environment variable set to that, typically that is: | |
17 | + export FC=mpif90 | |
18 | + | |
19 | +You can configure your compilation with: | |
20 | + | |
21 | + ./waf configure | |
22 | + | |
23 | +and then build the executable with | |
24 | + | |
25 | + ./waf build | |
26 | + | |
27 | + | |
28 | +How to run | |
29 | +-------------------- | |
30 | + | |
31 | +Musubi comes with a collection of cases so you can start simulating right away. | |
32 | +Have a look at the testsuite/physics folder. | |
33 | + | |
34 | +Documentation | |
35 | +------------- | |
36 | + | |
37 | +For further details see the | |
38 | +[FORD documentation](https://geb.sts.nt.uni-siegen.de/doxy/musubi/index.html). | |
39 | + | |
40 | +Included Software | |
41 | +----------------- | |
42 | + | |
43 | +Note, that this source code includes some other software parts to your convenience. | |
44 | + | |
45 | +- [Treelm](https://bitbucket.org/apesteam/treelm/) is the central library | |
46 | + providing the octree infrastructure. It is available under the terms of the | |
47 | + BSD License. | |
48 | +- [Aotus](https://bitbucket.org/apesteam/aotus/) is used for configuration and header | |
49 | + files. It is released under the terms of the MIT License as the | |
50 | + [Lua library](http://www.lua.org), that it includes. | |
51 | +- [Waf](http://code.google.com/p/waf/) is used as the build system and is released | |
52 | + under the terms of the BSD license. | |
53 | +- [CoCo](http://users.erols.com/dnagle/coco.html) is used to preprocess Fortran | |
54 | + source files and is released under the terms of the GPLv2. | |
55 | + | |
56 | +License | |
57 | +======= | |
58 | + | |
59 | +Musubi is licensed under the terms of the 2-clause BSD license reproduced below. | |
60 | +This means that Seeder is free software and can be used, reproduced, modified, | |
61 | +distributed and redistributed also for commercial purposes under the conditions | |
62 | +of the BSD license. | |
63 | +The only requirement is that some credit to the authors is given by putting this | |
64 | +copyright notice somewhere in your project. | |
65 | + | |
66 | +According to good scientific practice, publications on results achieved in whole | |
67 | +or in part due to Seeder should cite at least one paper presenting the Seeder | |
68 | +software. | |
69 | + | |
70 | +--- | |
71 | +Copyright (C) 2011-2013 German Research School for Simulation Sciences GmbH, Aachen. | |
72 | +Copyright (C) 2013-2017 University of Siegen. | |
73 | +All rights reserved. | |
74 | + | |
75 | +Redistribution and use in source and binary forms, with or without modification, | |
76 | +are permitted provided that the following conditions are met: | |
77 | + | |
78 | +1. Redistributions of source code must retain the above copyright notice, this | |
79 | +list of conditions and the following disclaimer. | |
80 | + | |
81 | +2. Redistributions in binary form must reproduce the above copyright notice, | |
82 | +this list of conditions and the following disclaimer in the documentation and/or | |
83 | +other materials provided with the distribution. | |
84 | + | |
85 | +THIS SOFTWARE IS PROVIDED BY THE UNIVERSITY OF SIEGEN “AS IS” AND ANY EXPRESS | |
86 | +OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF | |
87 | +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. | |
88 | +IN NO EVENT SHALL UNIVERSITY OF SIEGEN OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, | |
89 | +INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, | |
90 | +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
91 | +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
92 | +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE | |
93 | +OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF | |
94 | +ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
95 | + | |
96 | +The views and conclusions contained in the software and documentation are those | |
97 | +of the authors and should not be interpreted as representing official policies, | |
98 | +either expressed or implied, of German Research School for Simulation Sciences | |
99 | +GmbH, Aachen or University of Siegen. |