README

   1 #                            -*- mode: org; -*-
   2 #
   3 #+TITLE:             *OpenFOAM README for version 1.6-ext*
   4 #+AUTHOR:                      Hrvoje Jasak.
   5 #+DATE:                       12 November 2010
   6 #+LINK:                    http://www.extend-project.de
   7 #+OPTIONS: author:nil
   8
   9 * License
  10   OpenFOAM 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
  14   the GNU General Public License terms under which you can copy the files.
  15
  16 * System requirements
  17   OpenFOAM is developed and tested on Linux and Mac OS X.
  18   Experimental Microsoft Windows port is currently not released - please follow
  19   the user forum and annoucements
  20
  21   * Linux
  22   To check your system setup, execute the foamSystemCheck script
  23   in the bin/ directory of the OpenFOAM installation. If no problems are
  24   reported, proceed to "3. Installation"; otherwise contact your system
  25   administrator.
  26
  27   If the user wishes to run OpenFOAM in 32/64-bit mode they should consult the
  28   section "Running OpenFOAM in 32-bit mode".
  29
  30   * Apple Mac OS X
  31   The recommended way of running OpenFOAM on the Mac is to download sparse disk
  32   images, mount them on your system and link them into
  33
  34   ~/OpenFOAM/OpenFOAM-<VERSION>
  35   ~/OpenFOAM/ThirdParty-<VERSION>
  36
  37   Both disk images support case-sensitive file names.  If you wish to compile
  38   OpenFOAM and Third Party packs from scratch, please create a case-sensitive
  39   disk image using the Disk Utility, mount them as above and unpack the sources
  40   at appropriate places.  The remainder of build instructions is identical
  41   to Linux.
  42
  43 * Installation
  44   Download and unpack the files in the $HOME/OpenFOAM directory as described in:
  45   http://www.extend-project.de/
  46
  47   The environment variable settings are contained in files in an etc/ directory
  48   in the OpenFOAM release. e.g. in
  49
  50   + $HOME/OpenFOAM/OpenFOAM-<VERSION>/etc/
  51   + where <VERSION> corresponds to the version 1.6-ext etc
  52
  53   1) EITHER, if running bash or ksh (if in doubt type 'echo $SHELL'), source the
  54     etc/bashrc file by adding the following line to the end of your
  55     $HOME/.bashrc file:
  56
  57     + . $HOME/OpenFOAM/OpenFOAM-<VERSION>/etc/bashrc
  58
  59     Then update the environment variables by sourcing the $HOME/.bashrc file by
  60     typing in the terminal:
  61
  62     + . $HOME/.bashrc
  63
  64   2) OR, if running tcsh or csh, source the etc/cshrc file by adding the
  65     following line to the end of your $HOME/.cshrc file:
  66
  67     + source $HOME/OpenFOAM/OpenFOAM-<VERSION>/etc/cshrc
  68
  69     Then update the environment variables by sourcing the $HOME/.cshrc file by
  70     typing in the terminal:
  71
  72     + source $HOME/.cshrc
  73
  74 *** Installation in alternative locations
  75     OpenFOAM may also be installed in alternative locations. However, the
  76     installation directory should be network available (e.g., NFS) if parallel
  77     calculations are planned.
  78
  79     The environment variable 'FOAM_INST_DIR' can be used to find and source the
  80     appropriate resource file. Here is a bash/ksh/sh example:
  81
  82     + export FOAM_INST_DIR=/data/app/OpenFOAM
  83         + foamDotFile=$FOAM_INST_DIR/OpenFOAM-<VERSION>/etc/bashrc
  84         + [ -f $foamDotFile ] && . $foamDotFile
  85
  86     and a csh/tcsh example:
  87
  88     + setenv FOAM_INST_DIR /data/app/OpenFOAM
  89         + set foamDotFile=$FOAM_INST_DIR/OpenFOAM-<VERSION>/etc/cshrc
  90         + if ( -f $foamDotFile ) source $foamDotFile
  91
  92     The value set in '$FOAM_INST_DIR' will be used to locate the remaining parts
  93     of the OpenFOAM installation.
  94
  95 * Building the ThirdParty packages from Sources
  96    A new way of compiling and installing the ThirdParty suite of packages is proposed with OpenFOAM-1.6-ext.
  97    Please consult the file ThirdParty/README.ThirdParty a for more information.
  98
  99 * Building from Sources (Optional)
 100   If you cannot find an appropriate binary pack for your platform, you can
 101    build the complete OpenFOAM from the source-pack.  You will first need to
 102    compile or obtain a recent version of gcc (we recomend native gcc,
 103    coming with your operating system) for your platform,
 104   which may be obtained from http://gcc.gnu.org/.
 105
 106   Install the compiler in
 107   $WM_PROJECT_INST_DIR/ThirdParty/gcc-<GCC_VERSION>/platforms/$WM_ARCH$WM_COMPILER_ARCH/
 108   and change the gcc version number in $WM_PROJECT_DIR/etc/settings.sh and
 109   $WM_PROJECT_DIR/etc/settings.csh appropriately and finally update the
 110   environment variables as in section 3.
 111
 112   Now go to the top-level source directory $WM_PROJECT_DIR and execute the
 113   top-level build script './Allwmake'.  In principle this will build everything,
 114   but if problems occur with the build order it may be necessary to update the
 115   environment variables and re-execute 'Allwmake'. If you experience
 116   difficulties with building the source-pack, or your platform is not currently
 117   supported, please contact <enquiries@wikki.co.uk> to negotiate a support
 118   contract and we will do the port and maintain it for future releases.
 119
 120 * Testing the installation
 121   To check your installation setup, execute the 'foamInstallationTest' script
 122   (in the bin/ directory of the OpenFOAM installation). If no problems are
 123   reported, proceed to getting started with OpenFOAM; otherwise, go back and
 124   check you have installed the software correctly and/or contact your system
 125   administrator.
 126
 127 * Getting Started
 128   Create a project directory within the $HOME/OpenFOAM directory named
 129   <USER>-<VERSION> (e.g. 'jasak-1.6-ext' for user jasak and OpenFOAM
 130   version 1.6-ext)
 131   and create a directory named 'run' within it, e.g. by typing:
 132
 133   + mkdir -p $HOME/OpenFOAM/${USER}-${WM_PROJECT_VERSION}/run
 134
 135   Copy the 'tutorial' examples directory in the OpenFOAM distribution to the
 136   'run' directory.  If the OpenFOAM environment variables are set correctly,
 137   then the following command will be correct:
 138
 139   + cp -r $WM_PROJECT_DIR/tutorials
 140     $HOME/OpenFOAM/${USER}-${WM_PROJECT_VERSION}/run
 141
 142   Run the first example case of incompressible laminar flow in a cavity:
 143
 144   + cd $HOME/OpenFOAM/${USER}-${WM_PROJECT_VERSION}/run/tutorials/incompressible/icoFoam/cavity
 145   + blockMesh
 146   + icoFoam
 147   + paraFoam
 148
 149 * Documentation and Community resources
 150   http://www.extend-project.de/
 151   http://openfoamwiki.net/
 152   http://www.cfd-online.com/  Software->OpenFOAM
 153
 154
 155 * Reporting Bugs in OpenFOAM
 156   Please report all bugs and feature requests using our bug tracking system:
 157   http://sourceforge.net/apps/mantisbt/openfoam-extend/main_page.php or
 158   http://www.extend-project.de/project-final/openfoam-extend-bug-tracker
 159   Please also report bugs at the CFD-Online User Forum.
 160
 161 * Running OpenFOAM in 32-bit mode on 64-bit machines
 162   Linux users with a 64-bit machine may install either the OpenFOAM 32-bit
 163   version (linux) or the OpenFOAM 64-bit version (linux64), or both.  The 64-bit
 164   is the default mode on a 64-bit machine.  To use an installed 32-bit version,
 165   the user must set the environment variable $WM_32 (to anything, e.g. "on")
 166   before sourcing the etc/bashrc (or etc/cshrc) file.
 167
 168 * Instructions on how to contribute
 169   http://www.extend-project.de/project-final/how-to-contribute
 170
 171 * List of Contributors
 172     Henry Weller
 173     Hrvoje Jasak
 174     Mattijs Janssens
 175     Zeljko Tukovic
 176     Bernhard Gschaider
 177     Tommaso Lucchini
 178     Martin Beaudoin
 179     Sandeep Menon
 180     Niklas Nordin
 181     Eugene De Villiers
 182     Henrik Rusche
 183     Ivor Clifford
 184     Philiposse Rajan
 185     Gavin Tabor
 186     Jovani Favero
 187     Frank Bos
 188     David Hill
 189     Niklas Wikstrom
 190     Dubravko Matijasevic
 191     Darrin Stephens
 192     Christian Beck
 193     Oliver Borm
 194     James Criner
 195     Hua Shan
 196     David Boner
 197     Pierre-Olivier Dallaire
 198     Norman Del Puppo
 199     Dennis Kingsley
 200     Frank Albina
 201     Flavio Galeazzo
 202     Hannes Kroger
 203     Olivier Petit
 204     David Schmidt
 205     Andreas Feymark
 206     Luca Mangani
 207     Daniel Schmode
 208     Christoph Goniva
 209     Takuya Oshima
 210     Juho Peltola
 211     Eric Paterson
 212     Fabian Peng Karrholm
 213     Aleksandar Karac
 214     Maria Garcia Camprubi
 215     Chris Greenshields
 216     Mark Olesen
 217     Hilary Spencer
 218     Andy Heather
 219 #                            -*- mode: org; -*-
 220 #
 221 #+TITLE:             *OpenFOAM README for version 1.6-ext*
 222 #+AUTHOR:                      Hrvoje Jasak.
 223 #+DATE:                       12 November 2010
 224 #+LINK:                    http://www.extend-project.de
 225 #+OPTIONS: author:nil
 226
 227 * Copyright
 228   OpenFOAM is free software; you can redistribute it and/or modify it under the
 229   terms of the GNU General Public License as published by the Free Software
 230   Foundation; either version 2 of the License, or (at your option) any later
 231   version.  See the file COPYING in this directory, for a description of
 232   the GNU General Public License terms under which you can copy the files.
 233
 234 * System requirements
 235   OpenFOAM is developed and tested on Linux and Mac OS X.
 236   E