OpenFOAM Debug Mode - Revision history

NikLebedenko: clarified breakpoints a bit

2021-12-31T23:31:51Z

clarified breakpoints a bit

← Older revision		Revision as of 23:31, 31 December 2021
Line 33:		Line 33:
	* You should now be able to click on the "Run and Debug" tab on the left side of the screen, selecting "OF-debug" from the drop-down in the top-left.		* You should now be able to click on the "Run and Debug" tab on the left side of the screen, selecting "OF-debug" from the drop-down in the top-left.
	* Open the <code>simpleFoam.C</code> file by navigating back to the "Explorer" tab and clicking on the <code>simpleFoam.C</code> file in the tree.		* Open the <code>simpleFoam.C</code> file by navigating back to the "Explorer" tab and clicking on the <code>simpleFoam.C</code> file in the tree.
	* Add a breakpoint somewhere in the code by left-clicking to the left of the line number you want the breakpoint at - for example, at the line with <code>argList::addNote</code>. See [https://medium.com/@mustafaabbs2/stepping-through-simplefoam-with-vs-code-a-guide-to-debugging-solvers-39bfb1411372 this blog post] if unsure.		* Add a breakpoint somewhere in the code by left-clicking to the left of the line number you want the breakpoint at - for example, at the line with <code>argList::addNote</code>. A red dot should now be visible next to that line number. See [https://medium.com/@mustafaabbs2/stepping-through-simplefoam-with-vs-code-a-guide-to-debugging-solvers-39bfb1411372 this blog post] if unsure.
	* Start debugging by pressing <code>F5</code>.		* Start debugging by pressing <code>F5</code>.
	* After a short while of compiling, the code should run until it hits the breakpoint you set. You can now step through the code, line by line, and see exactly what OpenFOAM is doing under the hood.		* After a short while of compiling, the code should run until it hits the breakpoint you set. You can now step through the code, line by line, and see exactly what OpenFOAM is doing under the hood.

NikLebedenko: finished installation instructions

2021-12-31T23:30:35Z

finished installation instructions

← Older revision		Revision as of 23:30, 31 December 2021
Line 1:		Line 1:
	Here are some instructions on how to enable debugging in OpenFOAM for those using Windows Subsystem for Linux (WSL), mostly based on [https://medium.com/@mustafaabbs2/setting-up-my-openfoam-development-environment-on-windows-37b1575ecd4f this article] and [https://medium.com/@mustafaabbs2/stepping-through-simplefoam-with-vs-code-a-guide-to-debugging-solvers-39bfb1411372 this article] by Mustafa Abbas on his Medium page. He has, however, made a couple of omissions / mistakes in his articles, so I have added some corrections here.		Here are some instructions on how to enable debugging in OpenFOAM for those using Windows Subsystem for Linux (WSL), mostly based on [https://medium.com/@mustafaabbs2/setting-up-my-openfoam-development-environment-on-windows-37b1575ecd4f this article] and [https://medium.com/@mustafaabbs2/stepping-through-simplefoam-with-vs-code-a-guide-to-debugging-solvers-39bfb1411372 this article] by Mustafa Abbas on his Medium page. He has, however, made a couple of omissions / mistakes in his articles, so I have added some corrections here.

			This page is a work-in-progress by Nik Lebedenko. Please let me know if you run into any issues at all (even if they're easily solved; it will help others avoid common pitfalls).

	=== Installing Visual Studio Code with Ubuntu support ===		=== Installing Visual Studio Code with Ubuntu support ===
Line 5:		Line 7:
	* Make sure you have [https://code.visualstudio.com/ Visual Studio Code] (not Visual Studio) installed on your Windows system.		* Make sure you have [https://code.visualstudio.com/ Visual Studio Code] (not Visual Studio) installed on your Windows system.
	* Open Visual Studio Code, and click on the Extensions tab (CTRL+SHIFT+X) on the left side of the screen.		* Open Visual Studio Code, and click on the Extensions tab (CTRL+SHIFT+X) on the left side of the screen.
	* Download these two extensions by pasting their IDs into the search bar and clicking "Install":		* Download these two extensions by pasting their IDs into the search bar, pressing Enter, and clicking "Install":
	** ms-vscode.cpptools		** ms-vscode.cpptools
	** ms-vscode-remote.remote-wsl		** ms-vscode-remote.remote-wsl
	* You should now be able to run <code>code .</code> in a Ubuntu terminal, and it should open Visual Studio Code ~~within~~		* You should now be able to run <code>code .</code> in a Ubuntu terminal, and it should open Visual Studio Code in the same directory you ran the command in.

			=== Compiling OpenFOAM in debug mode ===

			* This step will take a while to run, perhaps an hour or two.
			* Edit <code>$FOAM_ETC/bashrc</code> with your preferred text editor (use <code>nano</code> if in doubt) and change the line with <code>WM_COMPILE_OPTION=Opt</code> to <code>WM_COMPILE_OPTION=Debug</code>
			* Save and close the file, and restart Ubuntu, then run the following commands: <syntaxhighlight lang="bash">
			cd $WM_PROJECT_DIR
			sudo chown -R $USER .
			./Allwmake -j -s -q -l ### this will take time!
			sudo apt install gdb

			</syntaxhighlight>

			=== Setting up the Visual Studio Code files for OpenFOAM ===

			* Copy the source code for <code>simpleFoam</code> into your personal OpenFOAM simulation folder (e.g. ~/OpenFOAM-sims) and open it by running these commands:<syntaxhighlight lang="bash">
			cp -r $FOAM_SOLVERS/incompressible/simpleFoam ~/OpenFOAM-sims
			code ~/OpenFOAM-sims/simpleFoam
			</syntaxhighlight>
			* Download [https://github.com/Rvadrabade/Debugging-OpenFOAM-with-Visual-Studio-Code.git this Github repository], and copy the <code>c_cpp_properties.json</code>, <code>launch.json</code>, and <code>tasks.json</code>, files from the <code>vscode</code> folder you downloaded, into your <code>.vscode</code> folder
			* You should now be able to click on the "Run and Debug" tab on the left side of the screen, selecting "OF-debug" from the drop-down in the top-left.
			* Open the <code>simpleFoam.C</code> file by navigating back to the "Explorer" tab and clicking on the <code>simpleFoam.C</code> file in the tree.
			* Add a breakpoint somewhere in the code by left-clicking to the left of the line number you want the breakpoint at - for example, at the line with <code>argList::addNote</code>. See [https://medium.com/@mustafaabbs2/stepping-through-simplefoam-with-vs-code-a-guide-to-debugging-solvers-39bfb1411372 this blog post] if unsure.
			* Start debugging by pressing <code>F5</code>.
			* After a short while of compiling, the code should run until it hits the breakpoint you set. You can now step through the code, line by line, and see exactly what OpenFOAM is doing under the hood.

			=== Going back to optimised mode ===
			This is as simple as editing <code>$FOAM_ETC/bashrc</code> again, setting <code>WM_COMPILE_OPTION=Opt</code>, and restarting Ubuntu (or re-sourcing that file). OpenFOAM has separate folders to store the binary files for debug and optimised modes, making it easy to switch between them without having to recompile.

NikLebedenko: Created the page

2021-12-31T22:07:31Z

Created the page

New page

Here are some instructions on how to enable debugging in OpenFOAM for those using Windows Subsystem for Linux (WSL), mostly based on [https://medium.com/@mustafaabbs2/setting-up-my-openfoam-development-environment-on-windows-37b1575ecd4f this article] and [https://medium.com/@mustafaabbs2/stepping-through-simplefoam-with-vs-code-a-guide-to-debugging-solvers-39bfb1411372 this article] by Mustafa Abbas on his Medium page. He has, however, made a couple of omissions / mistakes in his articles, so I have added some corrections here.

=== Installing Visual Studio Code with Ubuntu support ===

* Make sure you have [https://code.visualstudio.com/ Visual Studio Code] (not Visual Studio) installed on your Windows system.
* Open Visual Studio Code, and click on the Extensions tab (CTRL+SHIFT+X) on the left side of the screen.
* Download these two extensions by pasting their IDs into the search bar and clicking "Install":
** ms-vscode.cpptools
** ms-vscode-remote.remote-wsl
* You should now be able to run <code>code .</code> in a Ubuntu terminal, and it should open Visual Studio Code within