Ansys2020R2中Fluent编译UDF简介

1 使用内置编译器

在Ansys Fluent中编译UDF一般都需要额外安装相应版本的Visual Studio编译器,VS的缺点是体量大,占空间,安装后还需要额外进行相关设置才能正常使用。而新版本的Ansys Fluent编译UDF模块中提供了内建编译器(Build-In Compiler),使得脱离VS编译UDF称为可能。

UDF

使用内建编译器编译一个测试UDF来看看效果,所使用的测试udf源码如下:

1
2
3
4
5
6
// message.c
#include "udf.h"
DEFINE_ON_DEMAND(say_hello)
{
Message("hello, fluent udf compiler test\n");
}

按照正常的编译流程走一遍,结果不能顺利编译(相同的错误在ansys论坛中也被提及点击跳转),错误片段如下:

1
2
3
4
5
6
7
8
9
10
...
Copied D:\Documents\fluent_case\UDF_test_case/message.c to libudf\\src
(system "copy "G:\ANSYS Inc\ANSYS Student\v202\fluent"\fluent20.2.0\src\udf\sconstruct.udf "libudf\\win64\3d_host\SConstruct" ")
已复制 1 个文件。
(system "copy "G:\ANSYS Inc\ANSYS Student\v202\fluent"\fluent20.2.0\src\udf\scons_test.bat "libudf\\win64\3d_host\scons_test.bat" ")
已复制 1 个文件。
...
D:\\Documents\\fluent_case\\UDF_test_case\\libudf\\win64\\3d_node>G:\\ANSYS Inc\\ANSYS Student\\v202\\fluent/../commonfiles/CPython/3_7/winx64/Release/python/scons
'G:\\ANSYS' 不是内部或外部命令,也不是可运行的程序
或批处理文件。

注1:Fluent集成的终端中显示中文会乱码,通过写入transcript文件记录终端信息的方式可以正常查看中文信息。
注2: Error for Ansys Fluent 2020 R2 in English version: building UDF “Use Built-In Compiler”(translate section 1.1 of this blog, the problem can be solved): … ANSYS is not recognized as an internal or external command, operable program or batch file

可以看出,Ansys Fluent内建的编译器是通过python的库scons来实现的,与之相关的有两个脚本文件sconstruct.udfscons_test.bat,而错误的原因很明显:路径中包含空格,路径却没有使用双引号!

下面给出解决方法和问题分析,只看解决方法即可,有时间可以看看问题分析

1.1 解决方法

Step1 修改G:\ANSYS Inc\ANSYS Student\v202\fluent\fluent20.2.0\src\udf\scons_test.bat文件,给第3行添加双引号:

1
2
3
set PYTHONHOME=%FLUENT_INC%/../commonfiles/CPython/3_7/winx64/Release/python
set PYTHONPATH=%FLUENT_INC%/../commonfiles/CPython/3_7/winx64/Release/python
"%FLUENT_INC%/../commonfiles/CPython/3_7/winx64/Release/python/scons"

Step2 修改G:\ANSYS Inc\ANSYS Student\v202\fluent\fluent20.2.0\src\udf\sconstruct.udf文件,为bldcld的定义中$CC$CLINK变量添加双引号:

1
2
3
4
5
bld = Builder(action = '"$CC" $CFLAGS $DINCPREFIX $SOURCE')
env.Append(BUILDERS = {'Foo' : bld})

cld = Builder(action = '"$CLINK" $DFLAGS /dll /out:$TARGET $SOURCES')
env.Append(BUILDERS = {'Foo_lib' : cld})

1.2 问题分析

一步一步来解决问题,检查两个脚本文件。在"G:\ANSYS Inc\ANSYS Student\v202\fluent"\fluent20.2.0\src\udf\scons_test.bat(按照自己的路径找该文件)中:

1
2
3
set PYTHONHOME=%FLUENT_INC%/../commonfiles/CPython/3_7/winx64/Release/python
set PYTHONPATH=%FLUENT_INC%/../commonfiles/CPython/3_7/winx64/Release/python
%FLUENT_INC%/../commonfiles/CPython/3_7/winx64/Release/python/scons

果然,line 3中没有添加双引号,如果路径中包含空格(默认安装ansys的路径中包含多个空格),结果就会报错,所以此处自己手动给line3两端添加双引号:"%FLUENT_INC%...scons",即:

1
2
3
set PYTHONHOME=%FLUENT_INC%/../commonfiles/CPython/3_7/winx64/Release/python
set PYTHONPATH=%FLUENT_INC%/../commonfiles/CPython/3_7/winx64/Release/python
"%FLUENT_INC%/../commonfiles/CPython/3_7/winx64/Release/python/scons"

再次使用内置的编译器,按照正常的流程编译,结果还是不能顺利通过,再次检查错误提示:

1
2
3
4
5
6
7
8
G:\\ANSYS Inc\\ANSYS Student\\v202\\fluent\\ntbin\\clang\\bin\\clang-cl 
/c /Za /DUDF_EXPORTING /DUDF_NT /DWIN64 /EHa /wd4224 -Wno-return-type
-Wno-implicit-function-declaration
...(此处抓重点,只看关键部分)
-I D:\\Documents\\fluent_case\\UDF_test_case\\libudf\\win64\\3d_host
-I "G:\\ANSYS Inc\\ANSYS Student\\v202\\fluent\\ntbin\\clang\\VC\\include"
-I "G:\\ANSYS Inc\\ANSYS Student\\v202\\fluent\\ntbin\\clang\\kit\\include\\shared" message.c
'G:\\ANSYS' 不是内部或外部命令,也不是可运行的程序

可以看出,实际调用的编译命令是clang-cl,问题还是一样:路径中包含空格,路径却没有使用双引号!

查看"G:\ANSYS Inc\ANSYS Student\v202\fluent"\fluent20.2.0\src\udf\sconstruct.udf文件204~208行片段:

1
2
3
4
5
bld = Builder(action = '$CC $CFLAGS $DINCPREFIX $SOURCE')
env.Append(BUILDERS = {'Foo' : bld})

cld = Builder(action = '$CLINK $DFLAGS /dll /out:$TARGET $SOURCES')
env.Append(BUILDERS = {'Foo_lib' : cld})

其中$CC即对应这里的编译命令clang-cl,可以看出确实没有添加双引号,同样,下面的链接器也没有添加双引号,手动添加之:

1
2
3
4
5
bld = Builder(action = '"$CC" $CFLAGS $DINCPREFIX $SOURCE')
env.Append(BUILDERS = {'Foo' : bld})

cld = Builder(action = '"$CLINK" $DFLAGS /dll /out:$TARGET $SOURCES')
env.Append(BUILDERS = {'Foo_lib' : cld})

再次使用内建编译器,尝试编译:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# Build
...
2 warnings generated.
"G:\\ANSYS Inc\\ANSYS Student\\v202\\fluent\\ntbin\\clang\\bin\\lld-link" "G:\\ANSYS Inc\\ANSYS Student\\v202\\fluent\\fluent20.2.0\\win64\\3d_node\\fl_mpi2020.lib" "G:\\ANSYS Inc\\ANSYS Student\\v202\\fluent\\fluent20.2.0\\multiport\\win64\\mpi\\shared\\mport.lib" "G:\\ANSYS Inc\\ANSYS Student\\v202\\fluent\\ntbin\\clang\\VC\\lib\\amd64\\libcmt.lib" "G:\\ANSYS Inc\\ANSYS Student\\v202\\fluent\\ntbin\\clang\\VC\\lib\\amd64\\oldnames.lib" "G:\\ANSYS Inc\\ANSYS Student\\v202\\fluent\\ntbin\\clang\\kit\\lib\\winv6.3\\um\\x64\\kernel32.lib" /dll /out:libudf.dll message.obj udf_names.obj
scons: done building targets.

Done.

# Load
...
Laptopyz: Opening library "D:\\Documents\\fluent_case\\UDF_test_case\\libudf"...Done.

Laptopyz: Opening library "D:\\Documents\\fluent_case\\UDF_test_case\\libudf"...
say_hello
Done.

可以看出,结果只有warning,能正常BuildLoad,以及调用。

UDF调用

2 使用Visual Studio编译器

2.1 方法1:修改Fluent环境配置脚本udf.bat(推荐)

如果日常有使用VS的需求,可以通过配置VS环境来编译UDF,一般安装比Ansys版本低的VS即可,具体配置说明如下(参考:B站视频,点击跳转)。

启动Fluent时,查看Environment选项卡,其中指定了默认的VS环境配置脚本udf.bat的路径。

Fluent启动界面

按照该路径打开指定文件,即G:\ANSYS Inc\ANSYS Student\v202\fluent\ntbin\win64\udf.bat,修改相关内容:1)找到与自己所安装的VS版本相对应的配置部分,比如本人电脑安装的是VS2017社区版(对应version 150),找到2017对应的配置部分;2)将默认%ProgramFiles(x86)%替换成VS的安装目录,此处我的VS安装在D:\Program Files (x86)

注:%ProgramFiles(x86)%为系统默认的一个环境变量,指向路径C:\Program Files (x86),因此如果VS安装在默认路径下,应该能直接调用VS的编译器来编译UDF,否则就需要参考此处的做法来修改。

VS编译UDF相关配置

2.2 方法2:使用VS命令提示符

另一种使用VS编译UDF的方式:在VS相关的命令提示符中启动Fluent。

安装VS之后,(在软件启动栏中)能发现随之新添加了几个与VS相关的命令提示符,比如适用于 VS 2017 的 x64 本机工具命令提示。打开该命令提示符,在终端中输入"G:\ANSYS Inc\ANSYS Student\v202\fluent\ntbin\win64\fluent.exe"启动Fluent即可(更方便的做法是:将fluent.exe所在目录的路径添加到环境变量中,之后便只需输入fluent即可启动)。

原理说明:VS相关的命令提示符启动后,首先会激活VS相关的环境变量,在该终端中启用的程序(fluent)会自动应用相关的环境变量,因此可以直接调用VS的编译器来编译链接UDF。

2.3 方法3:使用第三方小软件

此外,还可以使用第三方编译UDF小软件或插件,感兴趣的可以试试。
相关链接: