利用VS Code阅读源码及调试OpenFOAM

更准确的做法应该是通过环境变量WM_COMPILE_OPTION来控制。 即在拷贝求解器后只需要修改Make/files更改一下可执行文件的路径以及名称，然后终端运行WM_COMPILE_OPTION=Debug将默认的Opt编译模式切换成Debug模式。然后wmake即可以调试模式编译求解器。

说明： 终端运行echo $WM_COMPILE_OPTION可以发现该变量的值默认为Opt， 其定义的位置在OpenFOAM的环境加载文件中（即$WM_PROJECT_DIR/etc/bashrc中）， 可以取值Opt、Debug以及Prof，分别表示优化(optimised)，调试(debug)和分析(profiling)。 wmake会根据变量$WM_COMPILE_OPTION的值来加载不同的选项。 $WM_PROJECT_DIR/wmake/rules/linux64Gcc/c++文件中包含语句include $(DEFAULT_RULES)/c++$(WM_COMPILE_OPTION)， 分别可能加载c++Opt、c++Debug和c++Prof文件中的选项设置。这3个文件所包含的内容如下：

可以看到c++Debug文件中开启了-ggdb3，类似于-g选项，用于开启编译功能。 c++Prof中开启-pg选项，编译后的程序可以使用gperf之类的工具进行性能分析。 而默认的c++Opt中-O3则最大限度地优化程序。

拷贝测试算例，并通过File → Open Folder在VSCode中打开测试算例：

Ctrl+Shift+D打开左侧的调试面板（Run），点击create a launch.json file创建launch.json文件

修改launch.json文件：

program的值即为自定义求解器的路径，通过which myicoFoam获得，而stopAtEntry设为true能在main函数处默认设置一个断点。

按F1或Ctrl+Shift+p打开命令面板，然后输入C++ UI，找到C/C++ Configurations (UI)，打开。在其中的includePath中添加前面得到的-I路径以及求解器源码路径（注意与前一节有点差别）。

生成网格，按F5键开始调试。

以上是单OpenFOAM版本，实际场景中经常会安装多个版本，通过alias在各个版本之间切换，那以上调试方法还适用吗？

通过各种尝试折腾，终于想到了一个巧妙的解决方案，即通过包装一个新的gdb脚本来实现，具体方案如下。

讨论两个版本的情况：

$HOME/.bashrc配置如下：

创建一个目录专门用于存放脚本，比如~/OFdebug：

两个脚本的内容分别为：

of6-gdb.sh：

of8-gdb.sh：

修改launch.json文件，通过miDebuggerPath指定编译器自定义的gdb脚本路径，比如使用of6来调试：

调试cavity算例：

在研究gdb调试之前，主要尝试的就是gdbOF[1]，能方便地将求解过程中的变量导出到文件，具体应用可以看[2]的介绍。目前OpenFOAMwiki上介绍适配的最高版本是OF5.x。

gdbOF is an attachable to GNU debugger (gdb) tool that includes macros to debug OpenFOAM’s solvers and applications in an easier way.

另一个角度，[3]介绍了如何使用gdbserver调试。

使用 VS Code 调试远程服务器上的 OpenFOAM 代码。

花了不少时间折腾，写作不易，希望能帮到学习OpenFOAM的小伙伴！

ContribgdbOF 点击跳转 ↩︎

用GdbOF追踪laplacian函数在OpenFOAM中的定义过程 点击跳转 ↩︎

VSCode远程调试OpenFOAM 点击跳转 ↩︎