README

   1 FreeFOAM README for Version {fullver}
   2 =====================================
   3 Michael Wild <themiwi@users.sourceforge.net>
   4 :Author Initials: MW
   5 v{fullver}, {localdate}
   6 http://freefoam.sourceforge.net
   7
   8 Copyright
   9 ---------
  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.
  15
  16 System requirements
  17 -------------------
  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.
  21
  22 Required software to build FreeFOAM
  23 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 [[cmake]]CMake::
  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
  34 [[flex]]flex::
  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
  37 [[zlib]]zlib::
  38   zlib compression library. http://www.zlib.net
  39 [[metis]]METIS::
  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
  44
  45 Optional software
  46 ~~~~~~~~~~~~~~~~~
  47 [[git]]git::
  48   To check out a current development version of FreeFOAM, git is required.
  49   http://git.or.cz
  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   - GAMMA (_Genoa Active Message MAchine_) is available from
  57     http://www.disi.unige.it/project/gamma.
  58 [[parmetis]]ParMetis::
  59   If you use an MPI library, the ParMetis library is required. If your package
  60   manager doesn't contain this library, FreeFOAM can build it automatically for
  61   you (refer to the <<installation,installation notes>> below).
  62   http://glaros.dtc.umn.edu/gkhome/metis/parmetis/overview
  63 [[mgridgen]]MGRIDGEN:: MGRIDGEN is a grid coarsening library for multi-grid
  64   solvers. FreeFOAM can build this automatically for you. Please refer to the
  65   link:INSTALL.html#enable-parmgridgen[INSTALL] file for license restrictions.
  66   http://glaros.dtc.umn.edu/gkhome/mgridgen/overview
  67 [[libccmio]]libccmio::
  68   pro-STAR (C) input/output library. FreeFOAM can build this automatically for
  69   you. Please refer to the link:INSTALL.html#enable-ccmio[INSTALL] file for
  70   license restrictions.
  71   https://wci.llnl.gov/codes/visit/3rd_party/libccmio-2.6.1.tar.gz
  72 [[paraview]]ParaView::
  73   If you want to build the http://paraview.org[ParaView] plug-ins, you need a
  74   ParaView with the development headers *and* the corresponding CMake configuration
  75   files ('ParaViewConfig.cmake', 'ParaViewUse.cmake', 'ParaViewLibraryDepends*.cmake').
  76   Most likely this means that you have to build ParaView yourself.
  77   http://paraview.org
  78 [[m4]]M4::
  79   Some of the provided tutorial cases require the M4 macro processor.
  80   http://www.gnu.org/software/m4/
  81 [[doxygen]]Doxygen::
  82   Automatic API-documentation generator. Required to build the source
  83   documentation. http://www.doxygen.org
  84
  85 Installation
  86 ------------
  87 For installation and basic usage instructions, refer to the
  88 link:INSTALL.html[INSTALL] file.
  89
  90 Documentation
  91 -------------
  92 All the applications and the frequently used script utilities come with a brief
  93 man-page. Unfortunately, most of them are little more than stubs and need more
  94 work. The man-pages _freefoam(7)_ gives a short overview over all applications
  95 and utilities, and _freefoam-config(7)_ documents the FreeFOAM configuration
  96 options.
  97
  98 API-documentation is available from
  99 http://freefoam.sourceforge.net/doc/Doxygen/html
 100
 101 Further, most FreeFOAM applications and utilities support the '-doc' and
 102 '-srcDoc' options, which will automatically display the API-documentation and
 103 the source code of the application, respectively.
 104
 105 Help
 106 ----
 107 - http://freefoam.sourceforge.net
 108 - https://freefoam.wiki.sourceforge.net/MailingLists
 109 - http://www.cfd-online.com/Forums/openfoam/ *please only ask questions related
 110   to _OpenFOAM_ there*.
 111
 112 Reporting Bugs in FreeFOAM
 113 --------------------------
 114 https://sourceforge.net/tracker/?group_id=215833
 115
 116 ////////////////////////////////////////////////////////
 117 Process with: asciidoc -a toc README
 118
 119 Vim users, this is for you:
 120 vim: ft=asciidoc sw=2 expandtab fenc=utf-8
 121 ////////////////////////////////////////////////////////