OpenFOAM installation instructions - Revision history

NikLebedenko: /* Windows 10 and above: Install WSL Ubuntu */

2022-02-01T23:36:00Z

Windows 10 and above: Install WSL Ubuntu

← Older revision		Revision as of 23:36, 1 February 2022
Line 34:		Line 34:
	Install [https://docs.microsoft.com/en-us/windows/wsl/install-manual Windows Subsystem for Linux] version 1 (WSL1, not WSL2).		Install [https://docs.microsoft.com/en-us/windows/wsl/install-manual Windows Subsystem for Linux] version 1 (WSL1, not WSL2).

	If you have never used a command line on Linux (or related systems), then the first 10 minutes of [https://www.youtube.com/watch?v=s3ii48qYBxA&ab_channel=DistroTube this video] might be helpful.		If you have never used a command line on Linux (or related systems), then the first 10 minutes of [https://www.youtube.com/watch?v=s3ii48qYBxA&ab_channel=DistroTube this video] might be helpful. The whole video is great, but the first 10 minutes are the absolute essentials.

	====== ''WSL Version comparison (optional):'' ======		====== ''WSL Version comparison (optional):'' ======

NikLebedenko: /* Windows 10 and above: Install WSL Ubuntu */ added terminal command video

2022-02-01T23:31:15Z

Windows 10 and above: Install WSL Ubuntu: added terminal command video

← Older revision		Revision as of 23:31, 1 February 2022
Line 32:		Line 32:

	==Windows 10 and above: Install WSL Ubuntu==		==Windows 10 and above: Install WSL Ubuntu==
	Install [https://docs.microsoft.com/en-us/windows/wsl/install-manual Windows Subsystem for Linux] version 1 (WSL1, not WSL2)		Install [https://docs.microsoft.com/en-us/windows/wsl/install-manual Windows Subsystem for Linux] version 1 (WSL1, not WSL2).

			If you have never used a command line on Linux (or related systems), then the first 10 minutes of [https://www.youtube.com/watch?v=s3ii48qYBxA&ab_channel=DistroTube this video] might be helpful.

	====== ''WSL Version comparison (optional):'' ======		====== ''WSL Version comparison (optional):'' ======

NikLebedenko: /* Install OpenFOAM on Native Ubuntu or WSL Ubuntu */

2022-02-01T23:25:04Z

Install OpenFOAM on Native Ubuntu or WSL Ubuntu

← Older revision		Revision as of 23:25, 1 February 2022
Line 52:		Line 52:
	sudo apt-get install openfoam2112-default		sudo apt-get install openfoam2112-default
	</syntaxhighlight>		</syntaxhighlight>
	Append the following line to your <code>~/.bashrc</code> file, if not already present. If you don't know how to do this, run <code>nano ~/.bashrc</code>, navigate to the bottom of the file with the arrow keys, and type the line in.		Append the following line to your <code>~/.bashrc</code> file, if not already present. If you don't know how to do this, run <code>nano ~/.bashrc</code>, navigate to the bottom of the file with the arrow keys, and type the line in. <syntaxhighlight lang="bash">

	Remember that <code>^X</code> which is <code>CTRL+X</code> exits nano. <code>^</code> is short for the <code>CTRL</code> button. Make sure to type <code>Y</code> on the prompt <code>Save modified buffer?</code> after pressing <code>CTRL+X</code><syntaxhighlight lang="bash">
	source /usr/lib/openfoam/openfoam2112/etc/bashrc		source /usr/lib/openfoam/openfoam2112/etc/bashrc
	</syntaxhighlight>		</syntaxhighlight>
			Remember that <code>^X</code> which is <code>CTRL+X</code> exits nano. <code>^</code> is short for the <code>CTRL</code> button. Make sure to type <code>Y</code> on the prompt <code>Save modified buffer?</code> after pressing <code>CTRL+X</code>

	Restart Ubuntu. Now check the installation completed correctly by running a tutorial case:<syntaxhighlight lang="bash">		Restart Ubuntu. Now check the installation completed correctly by running a tutorial case:<syntaxhighlight lang="bash">
	cd ~		cd ~

NikLebedenko: /* Install OpenFOAM on Native Ubuntu or WSL Ubuntu */ added nano instructions

2022-02-01T23:24:25Z

Install OpenFOAM on Native Ubuntu or WSL Ubuntu: added nano instructions

← Older revision		Revision as of 23:24, 1 February 2022
Line 52:		Line 52:
	sudo apt-get install openfoam2112-default		sudo apt-get install openfoam2112-default
	</syntaxhighlight>		</syntaxhighlight>
	Append the following line to your <code>~/.bashrc</code> file, if not already present. If you don't know how to do this, run <code>nano ~/.bashrc</code>, ~~remembering~~ that <code>^X</code> which is <code>CTRL+X</code> exits nano. <code>^</code> is short for the <code>CTRL</code> button.<syntaxhighlight lang="bash">		Append the following line to your <code>~/.bashrc</code> file, if not already present. If you don't know how to do this, run <code>nano ~/.bashrc</code>, navigate to the bottom of the file with the arrow keys, and type the line in.

			Remember that <code>^X</code> which is <code>CTRL+X</code> exits nano. <code>^</code> is short for the <code>CTRL</code> button. Make sure to type <code>Y</code> on the prompt <code>Save modified buffer?</code> after pressing <code>CTRL+X</code><syntaxhighlight lang="bash">
	source /usr/lib/openfoam/openfoam2112/etc/bashrc		source /usr/lib/openfoam/openfoam2112/etc/bashrc
	</syntaxhighlight>		</syntaxhighlight>

NikLebedenko: Added fix for common bug

2022-02-01T23:20:03Z

Added fix for common bug

← Older revision		Revision as of 23:20, 1 February 2022
Line 32:		Line 32:

	==Windows 10 and above: Install WSL Ubuntu==		==Windows 10 and above: Install WSL Ubuntu==
	~~I recommend installing~~ [https://docs.microsoft.com/en-us/windows/wsl/install-manual Windows Subsystem for Linux] ~~instead of setting up a dual-boot partition~~ (~~use~~ WSL1, ~~discussion of~~ WSL2 ~~below~~).		Install [https://docs.microsoft.com/en-us/windows/wsl/install-manual Windows Subsystem for Linux] version 1 (WSL1, not WSL2)

	====== ''WSL Version comparison (optional):'' ======		====== ''WSL Version comparison (optional):'' ======
Line 43:		Line 43:
	OpenFOAM is an open-source Computational Fluid Dynamics (CFD) package. We will use it to simulate the fluid (air) flow.		OpenFOAM is an open-source Computational Fluid Dynamics (CFD) package. We will use it to simulate the fluid (air) flow.

	The Ubuntu (Native or WSL) installation instructions as of 31/12/2021 are summarised below (adapted from [https://develop.openfoam.com/Development/openfoam/-/wikis/precompiled/debian this website]):<syntaxhighlight lang="bash">		The Ubuntu (Native or WSL) installation instructions as of 31/12/2021 are summarised below (adapted from [https://develop.openfoam.com/Development/openfoam/-/wikis/precompiled/debian this website])

			First, update the package index and upgrade the packages.<syntaxhighlight lang="bash">
			sudo apt update
			sudo apt upgrade
			</syntaxhighlight>If the first command fails with an error message that looks like <code>Certificate validation failed: The certificate is NOT trusted</code> ... <code>N: Updating from such a repository can't be done securely...</code> then run <code>sudo apt upgrade</code> anyway, and re-run <code>sudo apt update</code>, followed by <code>sudo apt upgrade</code><syntaxhighlight lang="bash">
	curl -s https://dl.openfoam.com/add-debian-repo.sh \| sudo bash		curl -s https://dl.openfoam.com/add-debian-repo.sh \| sudo bash
	sudo apt-get install openfoam2112-default		sudo apt-get install openfoam2112-default
	</syntaxhighlight>		</syntaxhighlight>
	Append the following line to your <code>~/.bashrc</code> file, if not already present:<syntaxhighlight lang="bash">		Append the following line to your <code>~/.bashrc</code> file, if not already present. If you don't know how to do this, run <code>nano ~/.bashrc</code>, remembering that <code>^X</code> which is <code>CTRL+X</code> exits nano. <code>^</code> is short for the <code>CTRL</code> button.<syntaxhighlight lang="bash">
	source /usr/lib/openfoam/openfoam2112/etc/bashrc		source /usr/lib/openfoam/openfoam2112/etc/bashrc
	</syntaxhighlight>		</syntaxhighlight>

NikLebedenko at 12:23, 30 January 2022

2022-01-30T12:23:29Z

← Older revision		Revision as of 12:23, 30 January 2022
Line 1:		Line 1:
	~~This wiki page is~~ also available in [https://www.youtube.com/watch?v=n2iDOBe4h5A&ab_channel=NikL video format]		The Windows installation instructions are also available in [https://www.youtube.com/watch?v=n2iDOBe4h5A&ab_channel=NikL video format]

	'''Important''': These instructions only work for Ubuntu or Windows 10 and above.		'''Important''': These instructions only work for Ubuntu or Windows 10 and above.

NikLebedenko: /* Install OpenFOAM on Ubuntu or WSL Ubuntu */

2022-01-30T12:20:42Z

Install OpenFOAM on Ubuntu or WSL Ubuntu

← Older revision		Revision as of 12:20, 30 January 2022
Line 40:		Line 40:
	**''If you want to use WSL2 anyway, I recommend you install ParaView on Ubuntu to avoid reading between file systems. You must also install XMing to view the GUI. See [https://stackoverflow.com/questions/61110603/how-to-set-up-working-x11-forwarding-on-wsl2 this page] and [https://newbedev.com/how-to-set-up-working-x11-forwarding-on-wsl2 this page] for further information.''		**''If you want to use WSL2 anyway, I recommend you install ParaView on Ubuntu to avoid reading between file systems. You must also install XMing to view the GUI. See [https://stackoverflow.com/questions/61110603/how-to-set-up-working-x11-forwarding-on-wsl2 this page] and [https://newbedev.com/how-to-set-up-working-x11-forwarding-on-wsl2 this page] for further information.''

	==Install OpenFOAM on Ubuntu or WSL Ubuntu==		==Install OpenFOAM on Native Ubuntu or WSL Ubuntu==
	OpenFOAM is an open-source Computational Fluid Dynamics (CFD) package. We will use it to simulate the fluid (air) flow.		OpenFOAM is an open-source Computational Fluid Dynamics (CFD) package. We will use it to simulate the fluid (air) flow.

	The Ubuntu installation instructions as of 31/12/2021 are summarised below (adapted from [https://develop.openfoam.com/Development/openfoam/-/wikis/precompiled/debian this website]):<syntaxhighlight lang="bash">		The Ubuntu (Native or WSL) installation instructions as of 31/12/2021 are summarised below (adapted from [https://develop.openfoam.com/Development/openfoam/-/wikis/precompiled/debian this website]):<syntaxhighlight lang="bash">
	curl -s https://dl.openfoam.com/add-debian-repo.sh \| sudo bash		curl -s https://dl.openfoam.com/add-debian-repo.sh \| sudo bash
	sudo apt-get install openfoam2112-default		sudo apt-get install openfoam2112-default
Line 57:		Line 57:
	blockMesh > log.blockMesh		blockMesh > log.blockMesh
	icoFoam > log.icoFoam		icoFoam > log.icoFoam
	</syntaxhighlight>		touch foam.foam
			</syntaxhighlight>You can now view the results in ParaView:

			* WSL Ubuntu: <code>paraview.exe foam.foam</code>
			* Native Ubuntu: <code>paraview foam.foam</code>

NikLebedenko at 12:18, 30 January 2022

2022-01-30T12:18:33Z

← Older revision		Revision as of 12:18, 30 January 2022
Line 24:		Line 24:
	* Click "OK" on all the dialogue boxes.		* Click "OK" on all the dialogue boxes.

	You can now open files in ParaView from the command line with <code>paraview.exe <file></code>, replacing <code><file></code> the file you wish to open.		You can now open files in ParaView from the command line with <code>paraview.exe <file></code>, replacing <code><file></code> with the file you wish to open.

	=== Ubuntu: ===		=== Ubuntu: ===
	Simply run this command:<syntaxhighlight lang="bash">		Simply run this command:<syntaxhighlight lang="bash">
	sudo apt-get install paraview		sudo apt-get install paraview
	</syntaxhighlight>You can now open files in ParaView from the command line with <code>paraview <file></code>, replacing <code><file></code> the file you wish to open.		</syntaxhighlight>You can now open files in ParaView from the command line with <code>paraview <file></code>, replacing <code><file></code> with the file you wish to open.

	==Windows 10 and above: Install WSL Ubuntu==		==Windows 10 and above: Install WSL Ubuntu==

NikLebedenko: /* Install OpenFOAM on Ubuntu */ clarified things

2022-01-30T12:17:15Z

Install OpenFOAM on Ubuntu: clarified things

← Older revision		Revision as of 12:17, 30 January 2022
Line 31:		Line 31:
	</syntaxhighlight>You can now open files in ParaView from the command line with <code>paraview <file></code>, replacing <code><file></code> the file you wish to open.		</syntaxhighlight>You can now open files in ParaView from the command line with <code>paraview <file></code>, replacing <code><file></code> the file you wish to open.

	==Windows 10 and above: Install Ubuntu==		==Windows 10 and above: Install WSL Ubuntu==
	I recommend installing [https://docs.microsoft.com/en-us/windows/wsl/install-manual Windows Subsystem for Linux] instead of setting up a dual-boot partition (use WSL1, discussion of WSL2 below).		I recommend installing [https://docs.microsoft.com/en-us/windows/wsl/install-manual Windows Subsystem for Linux] instead of setting up a dual-boot partition (use WSL1, discussion of WSL2 below).

Line 40:		Line 40:
	**''If you want to use WSL2 anyway, I recommend you install ParaView on Ubuntu to avoid reading between file systems. You must also install XMing to view the GUI. See [https://stackoverflow.com/questions/61110603/how-to-set-up-working-x11-forwarding-on-wsl2 this page] and [https://newbedev.com/how-to-set-up-working-x11-forwarding-on-wsl2 this page] for further information.''		**''If you want to use WSL2 anyway, I recommend you install ParaView on Ubuntu to avoid reading between file systems. You must also install XMing to view the GUI. See [https://stackoverflow.com/questions/61110603/how-to-set-up-working-x11-forwarding-on-wsl2 this page] and [https://newbedev.com/how-to-set-up-working-x11-forwarding-on-wsl2 this page] for further information.''

	==Install OpenFOAM on Ubuntu==		==Install OpenFOAM on Ubuntu or WSL Ubuntu==
	OpenFOAM is an open-source Computational Fluid Dynamics (CFD) package. We will use it to simulate the fluid (air) flow.		OpenFOAM is an open-source Computational Fluid Dynamics (CFD) package. We will use it to simulate the fluid (air) flow.

NikLebedenko: /* Install ParaView */ clarified things

2022-01-30T12:15:12Z

Install ParaView: clarified things

← Older revision		Revision as of 12:15, 30 January 2022
Line 5:		Line 5:
	MacOS: Please see these instructions on using [https://www.openfoam.com/download/openfoam-installation-on-mac-using-docker a Docker image] to install OpenFOAM. An Ubuntu VM on Mac will not work with these instructions.		MacOS: Please see these instructions on using [https://www.openfoam.com/download/openfoam-installation-on-mac-using-docker a Docker image] to install OpenFOAM. An Ubuntu VM on Mac will not work with these instructions.

	== Install ParaView ==		== Install and Use ParaView ==
	If you wish to view the results of the simulations, the best way to do this is with ParaView.		If you wish to view the results of the simulations, the best way to do this is with ParaView.

	Simply download the executable for ~~your operating system~~ from [https://www.paraview.org/download/ this website].		=== Windows 10 and above: ===
			Simply download the executable for Windows 10 from [https://www.paraview.org/download/ this website].

	The same website also hosts excellent tutorials and documentation PDFs - these should be your first resource when learning how to use ParaView.		The same website also hosts excellent tutorials and documentation PDFs - these should be your first resource when learning how to use ParaView.

	~~Windows 10:~~ In order to run ParaView from the command line, you must add <code>paraview.exe</code> to Path:		In order to run ParaView from the command line, you must add <code>paraview.exe</code> to Path:

	* Find the folder containing your <code>paraview.exe</code> executable, and copy the folder's location (not the file's location) to your clipboard with <code>CTRL+C</code>.		* Find the folder containing your <code>paraview.exe</code> executable, and copy the folder's location (not the file's location) to your clipboard with <code>CTRL+C</code>.
Line 24:		Line 25:

	You can now open files in ParaView from the command line with <code>paraview.exe <file></code>, replacing <code><file></code> the file you wish to open.		You can now open files in ParaView from the command line with <code>paraview.exe <file></code>, replacing <code><file></code> the file you wish to open.

			=== Ubuntu: ===
			Simply run this command:<syntaxhighlight lang="bash">
			sudo apt-get install paraview
			</syntaxhighlight>You can now open files in ParaView from the command line with <code>paraview <file></code>, replacing <code><file></code> the file you wish to open.

	==Windows 10 and above: Install Ubuntu==		==Windows 10 and above: Install Ubuntu==
	I recommend installing [https://docs.microsoft.com/en-us/windows/wsl/install-manual Windows Subsystem for Linux] instead of setting up a dual-boot partition (use WSL1, discussion of WSL2 below).		I recommend installing [https://docs.microsoft.com/en-us/windows/wsl/install-manual Windows Subsystem for Linux] instead of setting up a dual-boot partition (use WSL1, discussion of WSL2 below).

			====== ''WSL Version comparison (optional):'' ======
	*''WSL1 Pros: fairly fast read/write in both Ubuntu and Windows file systems. Cons: much slower at read/write in Ubuntu file system than WSL2.''		*''WSL1 Pros: fairly fast read/write in both Ubuntu and Windows file systems. Cons: much slower at read/write in Ubuntu file system than WSL2.''
	*''WSL2 Pros: lightning fast read/write in Ubuntu. Cons: very slow read/write when moving data between Ubuntu and Windows.''		*''WSL2 Pros: lightning fast read/write in Ubuntu. Cons: very slow read/write when moving data between Ubuntu and Windows.''