README

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