1 FreeFOAM README for Version {fullver}
2 =====================================
3 Michael Wild <themiwi@users.sourceforge.net>
5 v{fullver}, {localdate}
6 http://freefoam.sourceforge.net
10 FreeFOAM is free software; you can redistribute it and/or modify it under the
11 terms of the GNU General Public License as published by the Free Software
12 Foundation; either version 2 of the License, or (at your option) any later
13 version. See the file COPYING in this directory, for a description of the GNU
14 General Public License terms under which you can copy the files.
18 FreeFOAM is developed and tested on Linux, but should work with other Unix style
19 systems, notably Mac OS X (C). The support for Microsoft Windows is a goal,
20 which, however, is still far off.
22 Required software to build FreeFOAM
23 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25 In order to build FreeFOAM you need to have CMake with version 2.6.2 or
26 newer installed. http://cmake.org
27 [[build_system]]Build system::
28 CMake requires a native build system. On Unix like platforms GNU Make is
29 recommended. http://www.gnu.org/software/make
30 [[cxx_compiler]]C++ compiler::
31 In order to build FreeFOAM you need a C\++ compiler with good support for
32 template expressions. The g++ compiler from GCC-4.3 and above will do
33 fine. http://gcc.gnu.org
35 The flex lexer generator. Version 2.5.33 is known to work. For more recent
36 versions there have been reports of problems. http://flex.sourceforge.net
38 zlib compression library. http://www.zlib.net
40 The METIS graph partitioning library, version 5.0pre2. If your package manager
41 doesn't contain it, you can also have FreeFOAM build it automatically for you
42 (see the <<installation,installation section>>).
43 http://glaros.dtc.umn.edu/gkhome/metis/metis/overview
48 To check out a current development version of FreeFOAM, git is required.
50 [[parlib]]Parallel Communications Library::
51 In order to run FreeFOAM in parallel, a communications library is required.
52 The following list gives an overview of the available options:
53 - MPI (_Message Passing Interface_): There are many implementations of the MPI
54 standard. The one that has been tested and is known to work with FreeFOAM
55 is http://www.open-mpi.org[OpenMPI].
56 - PVM (_Parallel Virtual Machine_) is available from
57 http://www.csm.ornl.gov/pvm.
58 - GAMMA (_Genoa Active Message MAchine_) is available from
59 http://www.disi.unige.it/project/gamma.
60 [[parmetis]]ParMetis::
61 If you use an MPI library, the ParMetis library is required. If your package
62 manager doesn't contain this library, FreeFOAM can build it automatically for
63 you (refer to the <<installation,installation notes>> below).
64 http://glaros.dtc.umn.edu/gkhome/metis/parmetis/overview
65 [[mgridgen]]MGRIDGEN:: MGRIDGEN is a grid coarsening library for multi-grid
66 solvers. FreeFOAM can build this automatically for you. Please refer to the
67 link:INSTALL.html#enable-parmgridgen[INSTALL] file for license restrictions.
68 http://glaros.dtc.umn.edu/gkhome/mgridgen/overview
69 [[libccmio]]libccmio::
70 pro-STAR (C) input/output library. FreeFOAM can build this automatically for
71 you. Please refer to the link:INSTALL.html#enable-ccmio[INSTALL] file for
73 https://wci.llnl.gov/codes/visit/3rd_party/libccmio-2.6.1.tar.gz
74 [[paraview]]ParaView::
75 If you want to build the http://paraview.org[ParaView] plug-ins, you need a
76 ParaView with the development headers *and* the corresponding CMake configuration
77 files ('ParaViewConfig.cmake', 'ParaViewUse.cmake', 'ParaViewLibraryDepends*.cmake').
78 Most likely this means that you have to build ParaView yourself.
81 Some of the provided tutorial cases require the M4 macro processor.
82 http://www.gnu.org/software/m4/
84 Automatic API-documentation generator. Required to build the source
85 documentation. http://www.doxygen.org
89 For installation and basic usage instructions, refer to the
90 link:INSTALL.html[INSTALL] file.
94 All the applications and the frequently used script utilities come with a brief
95 man-page. Unfortunately, most of them are little more than stubs and need more
96 work. The man-pages _freefoam(7)_ gives a short overview over all applications
97 and utilities, and _freefoam-config(7)_ documents the FreeFOAM configuration
100 API-documentation is available from
101 http://freefoam.sourceforge.net/doc/Doxygen/html
103 Further, most FreeFOAM applications and utilities support the '-doc' and
104 '-srcDoc' options, which will automatically display the API-documentation and
105 the source code of the application, respectively.
109 - http://freefoam.sourceforge.net
110 - https://freefoam.wiki.sourceforge.net/MailingLists
111 - http://www.cfd-online.com/Forums/openfoam/ *please only ask questions related
112 to _OpenFOAM_ there*.
114 Reporting Bugs in FreeFOAM
115 --------------------------
116 https://sourceforge.net/tracker/?group_id=215833
118 ////////////////////////////////////////////////////////
119 Process with: asciidoc -a toc README
121 Vim users, this is for you:
122 vim: ft=asciidoc sw=2 expandtab fenc=utf-8
123 ////////////////////////////////////////////////////////