Tree [88402e] master merge-OpenFOAM-2.2.x /
 History

HTTPS access


File Date Author Commit
 CMake 2013-09-05 Michael Wild Michael Wild [93faef] ENH: Added FOAM_DEPENDS_ONLY flag to only gener...
 ThirdParty 2013-08-23 Michael Wild Michael Wild [d91bfe] FIX: Quote STREQUAL arguments in CMake-code
 applications 2014-11-13 Gerber van der Graaf Gerber van der Graaf [dfe721] added mixerVesselAMI
 bin 2013-03-17 Henry Henry [d92fc6] foamInstallationTest: Update min gcc version
 data 2013-09-06 Michael Wild Michael Wild [a2430a] ENH: Do not abort on error in postProcFreeFOAMD...
 doc 2014-10-23 Gerber van der Graaf Gerber van der Graaf [a15755] Compilation bugs & cleanup
 etc 2012-11-29 mattijs mattijs [fd7618] ENH: multiLevel: switch off debug
 src 2014-10-23 Gerber van der Graaf Gerber van der Graaf [a15755] Compilation bugs & cleanup
 tutorials 2013-04-09 Sergio Ferraris Sergio Ferraris [e478e8] BUG: Adding entry to the table for solidChemist...
 .gitattributes 2012-03-29 Michael Wild Michael Wild [ec0c7d] ENH: Add helper for easier diff against upstream
 .gitignore 2011-06-16 OpenFOAM-admin OpenFOAM-admin [931a91] Initial commit for version 2.0.x patch release
 .mailmap 2012-01-12 Michael Wild Michael Wild [dfd55e] ENH: Added utility to update ChangeLog from GIT
 CMakeLists.txt 2014-10-23 Gerber van der Graaf Gerber van der Graaf [a15755] Compilation bugs & cleanup
 COPYING 2011-09-26 Michael Wild Michael Wild [595fa9] DOC: Add author-line to COPYING
 CTestConfig.cmake 2012-01-17 Michael Wild Michael Wild [df5c96] FIX: Set CTEST_NIGTHLY_START_TIME in CTestConfi...
 ChangeLog 2012-02-24 Michael Wild Michael Wild [6b7a23] ENH: Updated ChangeLog for v0.1.0
 FOAMConfig.h.in 2012-01-13 Michael Wild Michael Wild [b6d50e] ENH: Update FreeFOAM contributions to GPL v3
 HACKING 2012-02-17 Michael Wild Michael Wild [b708d0] FIX: Require and use Python-2 to run AsciiDoc
 INSTALL 2013-09-01 Michael Wild Michael Wild [177eeb] DOC: Update ThirdParty instructions
 README 2013-09-01 Michael Wild Michael Wild [68c376] ENH: Disable automatic libccmio download, updat...
 README-OpenFOAM.html unknown
 README-OpenFOAM.org unknown
 ReleaseNotes 2012-02-24 Michael Wild Michael Wild [e7f153] DOC: Updated ReleaseNotes to Ubuntu 11.10 and r...

Read Me

{project} README for Version {fullver}
======================================
Michael Wild <themiwi@users.sourceforge.net>
:Author Initials: MW
v{fullver}, {localdate}
{homepage}

:apidoc: {homepage}/doc/v{fullver}/API
:asciidoc: http://www.methods.co.nz/asciidoc
:apachev2: http://www.apache.org/licenses/LICENSE-2.0[Apache Version 2.0]
:aymptote: http://asymptote.sourceforge.net
:bison: http://gnu.org/s/bison
:boost: http://www.boost.org
:bugreport: http://sourceforge.net/apps/mantisbt/freefoam
:cgal: http://www.cgal.org
:cmake: http://cmake.org
:dblatex: http://dblatex.sourceforge.net
:doxygen: http://www.doxygen.org
:flex: http://flex.sourceforge.net
:fop: http://xmlgraphics.apache.org/fop
:gcc: http://gcc.gnu.org
:git: http://git.or.cz
:gmp: http://gmplib.org
:graphviz: http://graphviz.org
:latex: http://latex-project.org
:leda: http://www.algorithmic-solutions.com/leda/index.htm[LEDA]
:m4: http://www.gnu.org/software/m4/
:make: http://www.gnu.org/software/make
:mathjax: http://www.mathjax.org
:metis: http://glaros.dtc.umn.edu/gkhome/metis/metis/overview
:mgridgen: http://glaros.dtc.umn.edu/gkhome/mgridgen/overview
:mpfr: http://mpfr.org
:openfoamforum: http://www.cfd-online.com/Forums/openfoam
:openmpi: http://www.open-mpi.org[OpenMPI]
:paraview: http://www.paraview.org
:readline: http://gnu.org/s/readline
:scotch: http://www.labri.fr/perso/pelegrin/scotch
:trilinos: http://trilinos.sandia.gov[Trilinos]
:zlib: http://www.zlib.net
:zoltan: http://www.cs.sandia.gov/Zoltan

Copyright
---------
{project} is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation; either version 3 of the License, or (at your option) any later
version.  See the file COPYING in this directory, for a description of the GNU
General Public License terms under which you can copy the files.

System requirements
-------------------
{project} is developed and tested on Linux, but should work with other Unix
style systems, notably Mac OS X (C). The support for Microsoft Windows is a
goal, which, however, is still far off.

Required software to build {project}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[[cmake]]CMake::
  In order to build {project} you need to have CMake with version 2.8.2 or
  newer installed. In order to follow the link:INSTALL.html[INSTALL]
  instructions, make sure that you also install the package contain the curses
  GUI ccmake if using a package manager (e.g. on Linux systems. For Debian
  and Ubuntu the package is called _cmake-curses-gui_). {cmake}
[[build_system]]Build system::
  CMake requires a native build system. On Unix-like platforms GNU Make is
  recommended. {make}
[[cxx_compiler]]{cpp} compiler::
  In order to build {project} you need a {cpp} compiler with good support for
  template expressions. The g++ compiler from GCC-4.3 and above will do
  fine. {gcc}
[[flex]]flex::
  The flex lexer generator. Version 2.5.33 is known to work. For more recent
  versions there have been reports of problems. {flex}
[[zlib]]zlib::
  zlib compression library. {zlib}
[[scotch]]SCOTCH::
  The SCOTCH graph partitioning library. Version 5.1.7 is know to work.
  {scotch}
[[python]]Python::
  The Python interpreter. Version 2.6 is known to work, but care has been taken
  to make {project} work with versions from 2.4 on, including 3.x.
+
[NOTE]
In order to build the man pages or the user guide, AsciiDoc is required
which has not yet been ported to Python 3. This is why Python version 2 is also
required (only at build-time for the documentation) if a Python 3 interpreter
is used.

Optional software
~~~~~~~~~~~~~~~~~
[[fop]]Apache FOP::
  If you want to build the PDF version of the user guide but can't or don't
  want to install <<dblatex,dblatex>>, Apache FOP can be used instead. It's
  output, however, is inferior to that of dblatex, especially that of the
  formulas. {fop}
[[asciidoc]]AsciiDoc::
  In order to create the man-pages or the XHTML and PDF documentation you need
  to have a fully working AsciiDoc toolchain installed. Versions newer than 8.5
  are known to work. AsciiDoc itself needs Python 2.4 or newer (but not 3.x),
  xsltproc, xmllint from libxml2, the DocBook XML DTD's and the DocBook XSL
  stylesheets. Refer to the AsciiDoc installation instructions for the details.
  Also note, that AsciiDoc versions 8.6.5 and 8.6.6 contain a bug which makes
  it depend on Python 2.5 and newer. {asciidoc}
[[asymptote]]Asymptote::
  Asymptote, the powerful descriptive vector-graphics language, is used to
  generate many of the graphics in the User Guide. Note that Asymptote
  itself depends on a <<latex,LaTeX>> installation. {asymptote}
[[bison]]Bison::
  If you choose to build <<scotch,SCOTCH>> locally by enabling
  link:INSTALL.html#private-scotch[+FOAM_BUILD_PRIVATE_SCOTCH+], the Bison
  parser generator is required. {bison}
[[boost]]Boost::
  Required if you choose to build the 'SloanRenumber' method for the
  'renumberMesh' utility or the 'surfaceFeatureExtract' with surface curvature
  support provided by the <<cgal,CGAL>> library by enabling
  link:INSTALL.html#enable_boost[+FOAM_ENABLE_BOOST+] and
  link:INSTALL.html#enable_cgal[+FOAM_ENABLE_CGAL+], respectively. In
  particular, 'Boost.Graph' and 'Boost.Thread' are required, where the latter
  is not header-only and requires the 'boost_thread' library. {boost}
[[cgal]]CGAL::
  Required for surface curvature support in the 'surfaceFeatureExtract'
  utility. Requires <<boost,Boost>>, <<eigen,Eigen>>, <<gmp,GMP>> and
  <<mpfr,MPFR>>. If the latter two are not found, CGAL is also able to use
  {leda} exact number types, or alternatively, its own internal implementation
  (both options have not been tested by the {project} project. {cgal}
[[dblatex]]dblatex::
  If you want to build the PDF version of the user guide, it is recommended
  that you have dblatex installed, as the generated output is superior to that
  generated with the alternative, Apache FOP. Since dblatex uses LaTeX as its
  rendering backend, it depends on a <<latex,LaTeX>> installation. {dblatex}
[[doxygen]]Doxygen::
  Automatic API-documentation generator. Required to build the source
  documentation. {doxygen}
[[eigen]]Eigen::
  The Eigen high-performance linear algebra library, version 3 or newer, is
  required by <<cgal,CGAL>>. {project} can download this header-only library
  for you if you don't have it installed already. {eigen}.
[[git]]git::
  To check out a current development version of {project}, git is required.
  {git}
[[gmp]]GMP::
  Multi-precision floating point library. Required by <<mpfr,MPFR>>, which in
 turn is required by <<cgal,CGAL>>. Most, if not all, Linux operating systems
 have this library in their repositories. {gmp}
[[readline]]GNU Readline::
  The 'setSet' utility can be used in an interactive mode which is greatly
  improved if using the GNU Readline library for history and command line
  editing support. {readline}
[[graphviz]]Graphviz::
  The graphs in the User Guide and the API documentation are require the
  Graphviz package for their generation. {graphviz}
[[latex]]LaTeX::
  Both, <<dblatex,dblatex>> and <<asymptote,Asymptote>> require a decent LaTeX
  installation. If you install LaTeX via a package manager, make sure that you
  also install the packages providing the 'units.sty' LaTeX package and the
  extra fonts. On Debian and Ubuntu systems, they are called
  'texlive-latex-extra' and 'texlive-fonts-recommended', respectively. {latex}
[[libccmio]]libccmio::
  pro-STAR (C) input/output library. The license of 'libccmio' (C) is
  proprietary and users should contact CD-Adapco for download instructions and
  terms of use.
[[m4]]M4::
  Some of the provided tutorial cases require the M4 macro processor. {m4}
[[mathjax]]MathJax::
  If you enable MathJax for math-rendering in the XHTML version of the user
  guide, but don't want to use the shared installation over the network, you
  can install MathJax locally. {mathjax}
[[metis]]METIS::
  The METIS graph partitioning library, version 5.0.1. If your package
  manager doesn't contain it, you can also have {project} build it
  automatically for you (see the <<installation,installation section>>).
  {metis}
[[mgridgen]]MGRIDGEN:: MGRIDGEN is a grid coarsening library for multi-grid
  solvers. {project} can build this automatically for you. Please refer to the
  link:INSTALL.html#enable-parmgridgen[INSTALL] file for license restrictions.
  {mgridgen}
[[parlib]]Parallel Communications Library::
  In order to run {project} in parallel, a communications library is required.
  Currently the only available options is MPI (_Message Passing Interface_).
  There are many implementations of the MPI standard. The one that has been
  tested and is known to work with {project} is {openmpi}.
[[paraview]]ParaView::
  The {project} utility 'para' requires this visualization application, version
  3.8 or later. {paraview}
[[metis]]METIS::
  The METIS graph partitioning library, version 5.0.1 or later. Notice that
  as of version 5.0.3, METIS is distributed under the {apachev2} license,
  replacing the previous non-free license, greatly simplifying redistribution.
  If your package manager doesn't contain it, you can also have {project} build
  it automatically for you (see the <<installation,installation section>>).
  {metis}
[[mgridgen]]MGRIDGEN::
  MGRIDGEN is a grid coarsening library for multi-grid solvers. {project} can
  build this automatically for you. Please refer to the
  link:INSTALL.html#enable-parmgridgen[INSTALL] file for license restrictions.
  {mgridgen}
[[mpfr]]MPFR::
  Multi-preision floating point library with correct rounding. Required by
  <<cgal,CGAL>>. Most, if not all, Linux operating systems have this library in
  their repositories. {mpfr}
[[paraview]]ParaView::
  The {project} utility 'para' requires this visualization application, version
  3.8 or later. {paraview}
[[parmetis]]ParMetis::
  If you use an MPI library, the ParMetis library is required. If your package
  manager doesn't contain this library, {project} can build it automatically
  for you (refer to the <<installation,installation notes>> below). {parmetis}
[[zoltan]]Zoltan::
  Zoltan is a parallel partitioning and load balancing library which can be
  used by the 'renumberMesh' utility. It is normally part of {trilinos}, but
  can also be built as a stand-alone package. {project} can build it
  automatically for you (see the <<installation,installation section>>).
  {zoltan}

[[installation]]
Installation
------------
For exhaustive installation and basic usage instructions, refer to the
link:INSTALL.html[INSTALL] file.

Documentation
-------------
All the applications and the frequently used script utilities come with a brief
man-page. Unfortunately, most of them are little more than stubs and need more
work. The man-page _freefoam(1)_ gives a short overview over all applications
and utilities and documents the {project} configuration options.

API-documentation is available from {apidoc}.

Further, most {project} applications and utilities support the '-doc' and
'-srcDoc' options, which will automatically display the API-documentation and
the source code of the application, respectively.

Help
----
- {homepage}/support
- {openfoamforum} *please only ask questions related to _OpenFOAM_ there*.

Reporting Bugs in {project}
---------------------------
{bugreport}

///////////////////////////////////////////////////////////////////
Process with: asciidoc -a toc -f data/asciidoc/html.conf README

Vim users, this is for you:
vim: ft=asciidoc sw=2 expandtab fenc=utf-8
///////////////////////////////////////////////////////////////////

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks