OpenFOAM README for version 1.6
Table of Contents
1 Copyright
OpenFOAM 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 2 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.
2 System requirements
OpenFOAM is developed and tested on Linux, but should work with other POSIX systems. To check your system setup, execute the foamSystemCheck script in the bin/ directory of the OpenFOAM installation.
3 Installation
The environment variable settings are contained in files in an etc/ directory in the OpenFOAM release. e.g. in
- $HOME/OpenFOAM/OpenFOAM-1.6/etc/
-
EITHER, if running bash or ksh (if in doubt type 'echo $SHELL'), source the
etc/bashrc file by adding the following line to the end of your
$HOME/.bashrc file:
- . $HOME/OpenFOAM/OpenFOAM-1.6/etc/bashrc
Update the environment variables by sourcing the $HOME/.bashrc file by typing in the terminal:
- . $HOME/.bashrc
-
OR, if running tcsh or csh, source the etc/cshrc file by adding the
following line to the end of your $HOME/.cshrc file:
- source $HOME/OpenFOAM/OpenFOAM-1.6/etc/cshrc
Update the environment variables by sourcing the $HOME/.cshrc file by typing in the terminal:
- source $HOME/.cshrc
4 Building
You will first need to compile or obtain a recent version of gcc (we recommend gcc-4.3.?) for your platform, which may be obtained from http://gcc.gnu.org/.
Install the compiler in $WM_PROJECT_INST_DIR/ThirdParty/gcc-<GCC_VERSION>/platforms/$WM_ARCH$WM_COMPILER_ARCH/ and change the gcc version number in $WM_PROJECT_DIR/etc/settings.sh and $WM_PROJECT_DIR/etc/settings.csh appropriately and finally update the environment variables as in section 3.
Go to the top-level source directory $WM_PROJECT_DIR and execute the build script './Allwmake'. This should build everything, but if problems occur with the build order it may be necessary to update the environment variables and re-execute 'Allwmake'.
If you experience difficulties with building the source-pack, or your platform is not currently supported, please contact <enquiries@OpenCFD.co.uk> to negotiate a support contract and we will do the port and maintain it for future releases.
4.1 Building in 32-bit mode on 64-bit machines
The 64-bit is the default mode on a 64-bit machine. To build a 32-bit version, the user must set the environment variable WM_ARCH_OPTION to 32 before sourcing the etc/bashrc (or etc/cshrc) file.
5 Documentation
6 Training and Help
7 Reporting Bugs in OpenFOAM
Date: July 2009
HTML generated by org-mode 6.28trans in emacs 23