CFDEM-OpenFOAM-Yade安装教程

在网上搜索与OpenFOAM相关的颗粒两相流计算资料时，发现了一个CFD-DEM coupled simulations with Yade and OpenFOAM。
在此之前，我学习过OpenFOAM自带的颗粒计算求解器，但是自带的求解器有很多缺点，最大的缺点就是颗粒运动方程的求解精度只有一阶。
还学习过CFDEM，是OF+liggghts做联合仿真，这个liggghts学习起来很简单，很多教程可以看，但是CFDEM就没这么多教程了，唯二的一个交流群里的几节入门课程买到了1k，壁垒拉的满满的。这个我简单的跑过一个案例，但是由于参数太多，最终没有继续学下去。

一、文件下载

我们总共需要下载三个文件，第一是OpenFOAM，这里最好安装OpenFOAM-6。

1、OpenFOAM-6

为了方便，我直接下载了东岳流体网站上的OF6虚拟机。

2、Yade

yade的官网提供了Yade的gitlab链接。
yade有两种安装方法，一种是直接使用apt-get方法，另一种是源码编译。为了使用CFDEM，我们需要采用源码编译的方式。
这里我下载的是2020版本的yade，可以看出，该版本是刚刚添加了OF coupling功能。

3、Yade-OpenFOAM-coupling

这个就类似于OF+liggghts中的CFDEM文件，用来耦合流场和颗粒的。
其下载地址在github上。

二、安装步骤

万事具备，现在我们可以进行安装了。Yade官网给出了安装步骤的详细说明，甚至具体到算例运行。

1、安装OpenMPI和OpenFoam

这里我到没有安装openmpi，因为我下载的虚拟机里应该有，因为openfoam可以直接并行计算，肯定是提前有openmpi的

2、安装Yade

这一步在上面的安装步骤中没有直接体现，可能因为作者已经默认我们是yade的使用用户，所以并没指出要安装yade。
至于Enable Openfoam coupling in CMakelists.txt 是在安装yade的过程中执行的步骤。
单看这一步就会发现非常含糊不清了，显著体现了开源软件的不靠谱之处。这里说的其实是在安装yade时在CMakelists.txt文件中需要将支持open foam coupling这个选项打开。但是实际上本来选项默认就是打开的。关于这一点，可以参考这个链接。

安装yade有总共分为以下几个步骤，这里主要参考该篇链接，但是有些地方稍有不同。

2.1、安装依赖包

上面的链接给了一个网站，可以查看相应的ubuntu系统已经yade版本需要安装的依赖包，但是我进入网站之后发现，上面并没有提供版本较新的yade的选项。最后还是在官网里找到了需要安装那些依赖包。

上图说的很清楚，对于ubuntu18.04，直接输入以下命令即可

sudo apt install cmake git freeglut3-dev libboost-all-dev fakeroot \
dpkg-dev build-essential g++ python3-dev python3-ipython python3-matplotlib \
libsqlite3-dev python3-numpy python3-tk gnuplot libgts-dev python3-pygraphviz \
libvtk6-dev libeigen3-dev python3-xlib python3-pyqt5 pyqt5-dev-tools python3-mpi4py \
python3-pyqt5.qtwebkit gtk2-engines-pixbuf python3-pyqt5.qtsvg libqglviewer-dev-qt5 \
python3-pil libjs-jquery python3-sphinx python3-git libxmu-dev libxi-dev libcgal-dev \
help2man libbz2-dev zlib1g-dev libopenblas-dev libsuitesparse-dev \
libmetis-dev python3-bibtexparser python3-future coinor-clp coinor-libclp-dev \
python3-mpmath libmpfr-dev libmpfrc++-dev libmpc-dev texlive-xetex

2.2、cmake

这里就直接参考上面的链接，需要新建一个主文件myYade，然后把yade的安装文件trunk放在这个主文件里，并且新建build和install两个文件。
在build文件夹下执行camke命令，注意，这里与链接里的操作不同，我们需要额外执行ENABLE_MPI，结合链接我们需要执行的命令即为：

cmake -DCMAKE_INSTALL_PREFIX=../install ../trunk -DENABLE_MPI=1 

剩下的步骤就和链接里是一致的了。
先make,再make install。
make的时间很长，得好几个小时，make install就很快了。

3、编译Yade-OpenFOAM

这一步更加简单，直接执行./Allclean，然后执行./Allwmake即可。视频中有详细演示。
需要注意的是，视频中刚好是从这一步直接开始的，因此后续步骤可以直接参考视频即可。

三、运行算例

算例的运行只参考视频也会出错，这里又要说一句开源软件的帮助文档太垃圾。
1、第一步，建立连接库

ln -s /path/to/yade/install/bin/yade-exec yadeimport.py

注意yadeimport.py这个文件，在视频里是yadelib.py，可能是版本的问题，库的名字在不同版本之间名字不同，但是yadeimport.py应该是比较适合我安装的这个版本的。
上面的/path/to/yade/install/bin/yade-exec即yade的可执行文件，我的文件目录是~/myYade/install/bin/yade-2023-07-23.git-88df7b1。
事实上，这个可执行文件就是进入到yade环境的命令。

然后就是正常的利用blockMesh创建网格，采用decomposePar进行分块，最后进行并行计算即可。
这里还有最后一个坑，我们下载的案例文件里有个run.sh文件，按理说我们执行完上面的步骤后直接sh run.sh即可运行，但是会发现报错，为什么，因为需要将

里的python改成python3。欧克，现在可以运行了。

四、补充

本来因为可以运行就万事大吉了，结果我还是高估了这个程序的稳定性，且给大家想用yade-openfoam的人泼一盆冷水。这个东西，它有bug。
首先，把mpiexec后面的-n 1改成-n 2，即用两个核进行颗粒计算，发现程序卡死不动。。。
其次，将算例的时间endTime设置的大一点，发现程序在0.034这个时刻后面卡死不动。。。

于是折腾了半天，最终还是决定放弃不再用这个玩意。。。

最后附上两个yade-openfoam耦合的理论，应该是开发者发的文章和博士论文，但是内容是关于软体纤维的，而且流场计算采用的程序也不是openfoam…
博士论文
期刊论文