==================================== About OpenFOAM Windows Version 3.0.0 ==================================== This OpenFOAM Windows version benefits from useful comments in the Social Media to improve the installation procedure, multiple version management and compilation environment following the first Windows environment release by OpenCFD Ltd of v2.4.0. It is based on Linux container technology. It enables Windows users to run Linux pre-compiled or user-compiled executables of OpenFOAM, thereby guaranteeing identical results in both Linux and Windows environments. The Installer creates an OpenFOAM working environment "C:\Program Files(x86)\ESI\OpenFOAM" The file "OF_Windows_Guide.pdf" in \Document contains details about the setup and additional guidance. --------- Paraview: --------- Paraview is a freely available post-processing tool, and can be used to post-process OpenFOAM results. Please note that ParaView is not bundled with this OpenFOAM Installer, but can be downloaded directly from http://www.paraview.org/download/ --------------- Pre-requisites: --------------- 1) Hardware assisted virtualization should be enabled. If not already done, please enable it from the BIOS mode (see below),then reboot your system twice before proceeding with this Installation. In Windows7, check if hardware-assisted Virtualization is switched on by running the Windows utility https://www.microsoft.com/en-us/download/details.aspx?id=592#filelist In Windows8, it can be checked via the Task Manager. Windows10 environment for OpenFOAM is not guaranteed, but we aim future versions of this installation to support Windows10. 2) Powershell version 2 and above should be installed. (It comes by default in Windows7 and Windows8). Please make sure that any image in VirtualBox is in "Powered off" mode. ---------------------------------------------- Existing Users of OpenFOAM v2.4.0 for Windows: ---------------------------------------------- OpenFOAM, thereby guaranteeing identical results in both Linux and Windows 1) If you have already installed OpenCFD's OpenFOAM v2.4.0 for Windows, you may choose either to, i) Upgrade to 3.0.0, as follows; First, uninstall previous versions of OpenFOAM for Windows from the Control Panel, and then follow the steps described in the Trouble Shooting Guide, paragraph 3), below. ii) Retain earlier versions (i.e. OpenFOAM v2.4.0); a) Please make sure that any image in VirtualBox is in "Power Off" mode. b) Run the Windows Installer of OpenFOAM v3.0.0 c) During installation, uncheck all components associated with installing Docker, since it is already installed. ----------------------- Installation Procedure: ----------------------- 1) Running the OpenFOAM-installer executable will install Docker (including VirtualBox, Git), the precompiled v3.0.0 OpenFOAM executable image and create the working environment. (Please note that this process can take several minutes depending on your system memory.) 2) When the installation is complete, please click on the "OF_Create_Env" shortcut on the Desktop. A shell will open and close automatically, completing setup of the user working environment. This step is mandatory only on the first occasion of OpenFOAM for Windows installation. 3) Click on the "OpenFOAM_Start" shortcut on the Desktop to start the OpenFOAM environment. (Press "Enter" if the bash shell seems to hang.) ------------------------- Uninstallation Procedure: ------------------------- 1) In the Control Panel > Programs (Uninstall a program), click on OpenFOAM4Windows to uninstall. 2) You should additionally remove the following files manually; C:\Users\$UserName\.boot2docker C:\Users\$UserName\.ssh C:\Users\$UserName\.VirtualBox C:\Users\$UserName\VirtualBox VMs/boot2docker-vm 3) You may also choose to uninstall third party tools such as Docker. -------------------------------------------- Working with OpenFOAM in the Working Folder: -------------------------------------------- 1) Please note paragraphs 2) and 3) of the Installation Procedure. 2) The Working Folder is a shared folder with your username (C:\Users\$UserName) and its content will be available to the container. 3) Copy your case (tutorials, etc.) to the Working Folder C:\User\$UserName, and run OpenFOAM as normal from the command line. 4) Post-processing: i) You will need to install Paraview, as mentioned at the start of this document. ii) On simulation completion, create a file with the suffix ".foam" (e.g "touch a.foam") inside case folder. iii) Launch Paraview, browse the case folder and open the file with suffix ".foam" to start visualizing the case. ----------------------- Trouble Shooting Guide: ----------------------- 1) OpenFOAM_Start shortcut is not working? i)Check whether virtualization is enabled. (See instruction in Pre-requisites, paragraph 1)) 2) The Installation is taking too long? i) If the Installer is taking too long in "loading OpenFOAM image", - Check your memory. The installation time usually depends on the memory allocated to boot2docker-vm in VirtualBox. By default, it is half of your system memory. - If it takes longer than typically 15-20mins, follow the steps below (though this is not strictly recommended; and remember to reverse these steps at the end); a) Close the shell "loading OpenFOAM image". Automatically, another shell will open which say "wrapping the installation". Let it complete. b) Right click and open VirtualBox (as Administrator). Make sure that boot2docker-vm is in "Power off" mode. c) Open VirtualBox again (as a normal user, not Administrator),select boot2docker-vm, click on Settings > System, and then increase the memory allocated to 3/4 of maximum. Click "Ok" to save the setting. d) Uninstall OpenFOAM4Windows from the Control Panel. e) Install OpenFOAM, but deselect the boot2docker installation. 3) Please refer to OF_Windows_Guide.pdf in installation folder under Document folder for more details. 4) If the installation no longer works correctly and you want to reinstall it. a) Uninstall Docker, VirtualBox and Git from the Control Panel. Check that all Git library files are deleted, and if not, delete them manually after restarting your system. b) Delete the files C:\Users\$UserName\.boot2docker C:\Users\$UserName\.ssh C:\Users\$UserName\.VirtualBox C:\Users\$UserName\VirtualBox VMs/boot2docker-vm If any of these files are not deleted (giving the message that they are being used by VBox*), then go to the Task Manager and kill the VBox* process. c) Restart your system: Re-run the OpenFOAM Windows Installer ------------------------------------------------------------------- Advanced Use (Development platform including compilation guidance); New in OpenFOAM4Windows v3.0.0: ------------------------------------------------------------------- 1) This OpenFOAM installation environment provides you with both a working and a development platform. To compile modified source code, please do as follows; i) Login as "root" (su root) with password "0fuser2015" ii) Go to /opt/OpenFOAM/OpenFOAM-3.0.0 iii) Run ./Allwmake (it will create the full dependency list and object files) iv) Go to the folder with modified source code, and compile the changed files. 2) Please note that the following third-party utility version have been used to compile OpenFOAM-3.0.0 i) openmpi-10.1.0 ii) Gcc-4.8.2 iii) CGAL-4.3 iv) boost_1_55_0 N.B. Please send any suggestions you might have on this README file or other comments on the OpenFOAM4Windows environment to "enquiries@opencfd.co.uk"