UDF总结

UDF使用技巧

1、查找相应的函数的时候，可以现在word里面找到相应的函数名字，然后依次去中文帮助文档、英文帮助文档和网页帮助文档，看看详细解释并找找是否有相应的例子。

2、打个比方来说，thread就是公路，连接的cell和face,cell和face就相当于公路上汽车停靠的站点，

cell_t这个面向的是单元，而face_t面向的是边或者面（二维或三维）

在fluent循环过程中，一般是用thread作线程检索，而cell或者face作检索过程中位置（相当于指示位置的参数）参数的指示

3、对于UDF来说，积分就是做加法，把通过面上每个网格的质量流量相加

4、cell和face的区别，什么时候用cell，什么时候用face？

5、1. begin, end_c_loop macro is used for looping over all the cells in particular thread for serial processing.

2. For parallel processing, the cells inside a partition can be categorized as interior and exterior cells.

3. The macros begin, end_c_loop_int; begin, end_c_loop_ext and begin, end_c_loop_all are used for looping over interior, exterior and all the cells (in a partition) respectively.

4. In parallel simulations, both begin, end_c_loop and begin, end_c_loop_all macros will do the same job.

5. For faces the looping macro in parallel are begin, end_f_loop_int; begin, end_f_loop_ext and begin, end_f_loop for looping over interior, boundary and all faces respectively. For all practical purpose, the user need not separate the interior and boundary faces of a partition. Hence, begin, end_f_loop_int and begin, end_f_loop_ext macros are rarely used.

实际问题

1、DEFINE_UDS_UNSTEADY中的apu包括的函数是不是不包括当前时刻的变量，而su包含前一时刻的变量，所以用了C_STORAGE_R存储前一时刻的变量。

2、等于零是因为计算源项的时候温度还没有更新，所以两个温度值是相等的。这个时候其实是需要两个UDM，分别保存上一步和再上一步的温度。而且可以考虑全部在源项里完成，不用Adjust宏：

source=(C_UDMI(c,t,1)-C_UDMI(c,t,0))/TIME_STEP;

C_UDMI(c,t,0)=C_UDMI(c,t,1);

C_UDMI(c,t,1)=C_T(c,t);

return source;

当然，在刚开始计算的时候要注意下UDM的初始问题，防止出错。

从第三个时间步开始，就是正常的了。

这个方法挺好的，只要一开始的用DEFINE_INIT,对

C_UDMI(c,t,0)=0.；

C_UDMI(c,t,1)=0.；

一、数据类型

二、node

三、cell宏函数

1、

x[]；其中，x[0]代表x方向坐标，x[1]代表y方向坐标，x[2]代表z方向坐标。2、

4、

5、

②C_R_G(c,t)只能用于密度基求解器，C_P_G (c,t)只能用于压力基求解器

③C_YI_G (c,t,i)只能用于密度基求解器，用于压力基求解器要设置，一切

设置好后，输入rpsetvar ’species/save-gradients?#t

④只有当已经求解出包含这个变量的方程时才能得到梯度变量，需要如下

设置solve/set/expert回车然后两个yes。输入q可以返回上级目录

6、

②C_R_RG(c,t)只用于密度基求解器，C_P_RG (c,t)只用于压力基求解器

③C_YI_RG (c,t,i)只能用于密度基求解器

④只有当已经求解出包含这个变量的方程时才能得到梯度变量，需要如下

设置solve/set/expert回车然后两个yes。输入q可以返回上级目录

7、

②详细可以看宏DEFINE_UDS_UNSTEADY( name,c,t,i,apu,su)。

8、

9、

注意：prt

10、

11、

②C_POLLUT(c,t,i)：

0-Mass Fraction of NO；

1-Mass Fraction of HCN；

2-Mass Fraction of NH3；

3-Mass Fraction of N2O；

4-Soot Mass Fraction；

5-Normalized Radical Nuclei

③ Concentration in particles（颗粒浓度） *10(-15次方)/kg，具体公式需要

看fluent中的介绍。

12、

四、Face 宏函数（只能用于压力基求解器）

1、

x[]；其中，x[0]代表x方向坐标，x[1]代表y方向坐标，x[2]代表z方向坐标。2、

3、

4、

值。

②the sign of the flux that is computed by the solver is opposite to that which

is reported in the FLUENT user-interface (e.g., Reports Fluxes...).

五、Connectivity 宏函数

一个面两边的cell可能不是属于同一个thread下的，如果这个面在domain 的外表面上，则只存在C0，如果这个面在domain内部，则存在C0和C1。

1、

和C1

2、

3、INTERIOR_FACE_GEOMETRY（需要增加#include “sg.h”）

INTERIOR_FACE_GEOMETRY(f,t,A,ds,es,A_by_es,dr0,dr1)；/这样可以单独使用。

注意：使用之前需定义下面的变量：(用法和C_CENTROID(x,c,t)类似，调用该函数后相应的值会存放在求解器中，需要哪个值自己再调用)

real A[ND_ND]; the area normal vector面的法向量

real ds; distance between the cell centroids

real es[ND_ND]; the unit normal vector in the direction from cell c0 to c1

real A_by_es; the value

real dr0[ND_ND]; vector that connects the centroid of cell c0 to the face centroid

real dr1[ND_ND]; the vector that connects the centroid of cell c1 to the face centroid 4、BOUNDARY_FACE_GEOMETRY（需要增加#include “sg.h”）

BOUNDARY_FACE_GEOMETRY(f,t,A,ds,es,A_by_es,dr0); /这样可以单独使用。

注意：使用之前需定义下面的变量：(用法和C_CENTROID(x,c,t)类似，调用该函数后相应的值会存放在求解器中，需要哪个值自己再调用)

real A[ND_ND]; the area normal vector面的法向量

real ds; distance between the cell centroid and the face centroid

real es[ND_ND]; unit normal vector in the direction from centroid of cell c0 to face

centroid

real A_by_es; the value

real dr0[ND_ND]; vector that connects the centroid of cell c0 to the face centroid

5

6、BOUNDARY_SECONDARY_GRADIENT_SOURCE（需要增加#include “sg.h”）BOUNDARY_SECONDARY_GRADIENT_SOURCE(source,n,dphi,dx,A_by_es,k) 注意：使用它之前一般会使用BOUNDARY_FACE_GEOMETRY

其他注意事项看看中英文帮助文档

六、Special 宏函数

1、Thread Pointer for Zone ID ( Lookup_Thread)//可以用于边界条件的设置

如果你想对某个边界区域进行操作，你可以使用 Lookup_Thread找到你需要的区域对应的指针t，然后进行相应操作。

使用方法如下：

int zone_ID = 2; // ID是边界区域的编号，可以右击网格就可以查到

Thread *t = Lookup_Thread(domain,zone_ID);

注意：多相流情况下使用会有点麻烦，具体看看帮助

2、Zone ID ( THREAD_ID)

使用方法如下：

int zone_ID = THREAD_ID(t);

可以得到t对应的zone的ID整数值。

3、Domain Pointer ( Get_Domain)

Get_Domain(domain_id);

注意：domain_id是整数，对于混合相是1，对于某一个相，可以查看define-phases找到相应的ID。

Get_Domain(domain_id)经常用在宏DEFINE_ON_DEMAND中，DEFINE_ON_DEMAND这个宏一般用于初始化或迭代后数据进行处理（取平均，最大值，最小值等），不能使用在迭代过程当中。

例：DEFINE_ON_DEMAND(my_udf)

{

Domain *mixture_domain;

mixture_domain = Get_Domain(1);

}

4、Set Boundary Condition Value ( F_PROFILE)

F_PROFILE( f, t, i)=…….;

注意：①F_PROFILE是对面进行操作，一般用于边界条件的设定，改变边界条件上各种参数（压力，速度，组分参数）的值。

②i不需要提前定义或赋值，一般配合DEFINE_PROFILE(pressure_profile,t,i)使用，而这里已经定义了i。具体可以参照DEFINE_PROFILE提供的例子。

5、THREAD_SHADOW(t)

if (!NULLP(ts = THREAD_SHADOW(t)))

{

/* Do things here using the shadow wall thread (ts) */

t是薄壁的一部分，对t进行操作

}

如果边界不是薄壁的一部分，THREAD_SHADOW(t)返回NULL

NULLP()括号里面的如果没有分配内存返回TRUE

七、Time-Sampled Data(C_STORAGE_R)时间取样数据

。

八、Model-Specific Macros用于特定模型的宏

1、DPM宏

2、NOx宏

3、SOx宏

九、User-Defined Scalar (UDS) Transport Equation Macros用户自定义标量输运方程宏

在使用和本节UDS有关的宏的之前，必须先去fluent面板中进行设置标量的个数。Define—User-Defined—Scalars

1、Set_User_Scalar_Name

当你在fluent面板中设置了UDS个数后，系统会给分配的变量相应的名字，例如，分配了2个标量，则两个标量的名字为User Scalar 0和User Scalar 1。

但你可以使用下面的函数对名字进行修改，i代表对第几个标量进行修改，name是字符串格式，可用”……”表示。

Set_User_Scalar_Name(int i,char *name);

注意：上述修改只能修改一次，要改一下改完；最好使用EXECUTE_ON_LOADING宏

2、F_UDSI

s

3、

4、Reserve_User_Scalar_Vars

为避免UDF和UDS冲突，使用这个宏，具体用法如下：

offset = Reserve_User_Scalar_Vars(int num);

这样，UDF library就可以使用C_UDSI(c,t,offset) 到 C_UDSI(c,t,offset+num-1)，其他宏也是这样；它经常用在EXECUTE_ON_LOADING、INIT和ON_DEMAND 宏中

5、N_UDS

可以直接使用它，不需要参数，返回FLUENT中已经规定的UDS输运方程的数目。

十、User-Defined Memory (UDM) Macros 用户自定义存储器宏

本章的宏包括UDM和User-Defined Node Memory (UDNM)宏

在使用本节中提供的宏之前，必须先去fluent界面设置变量个数，方法如下：Define—User-Defined—Memory

1、当你定义了变量个数后，系统会默认给相应变量初始的名字，例：

UDM： User Memory 0, User Memory 1

UDNM：User Node Memory 0, User Node Memory 1

如果你要修改相应的名字，需要使用宏Set_User_Memory_Name和宏Set_User_Node_Memory_Name。

2、Set_User_Memory_Name

Set_User_Memory_Name(int i,char *name);

注意：这个宏只能修改一次，要改几个，一下子改完，最好在EXECUTE_ON_LOADING宏中使用。

3、Set_User_Node_Memory_Name

Set_User_Node_Memory_Name(int i,char *name);

注意：这个宏只能修改一次，要改几个，一下子改完，最好在EXECUTE_ON_LOADING宏中使用。

4、

5、

6、

7、Reserve_User_Memory_Vars

为避免UDF和UDM冲突，使用这个宏，具体用法如下：

offset = Reserve_User_Memory_Vars(int num);

这样，UDF 就可以使用C_UDMI(c,t,offset) 到 C_UDMI(c,t,offset+num-1)，其他宏也是这样；它经常用在EXECUTE_ON_LOADING、INIT和ON_DEMAND 宏中

十一、Looping Macros 循环宏

Looping Over Cell Threads in a Domain ( thread_loop_c)

Looping Over Face Threads in a Domain ( thread_loop_f)

Looping Over Cells in a Cell Thread ( begin_c_loop/ end_c_loop)

Looping Over Faces in a Face Thread ( begin_f_loop/end_f_loop)

Looping Over Faces of a Cell ( c_face_loop)

Looping Over Nodes of a Cell ( c_node_loop)

Looping Over Nodes of a Face ( f_node_loop)

1、Looping Over Cell Threads in a Domain ( thread_loop_c)

用法如下：

Domain *domain;

Thread *c_thread;

thread_loop_c(c_thread, domain) /*loops over all cell threads in domain*/ {

}

2、Looping Over Face Threads in a Domain ( thread_loop_f)

用法如下：

Thread *f_thread;

Domain *domain;

thread_loop_f(f_thread, domain)/* loops over all face threads in a domain*/ {

}

3、Looping Over Cells in a Cell Thread ( begin_c_loop/ end_c_loop)

用法如下：（经常配合thread_loop_c使用）

cell_t c;

Thread *c_thread;

begin_c_loop(c, c_thread) /* loops over cells in a cell thread */

{

}

end_c_loop(c, c_thread)

4、Looping Over Faces in a Face Thread ( begin_f_loop/end_f_loop)

用法如下：（经常配合thread_loop_f使用）

face_t f;

Thread *f_thread;

begin_f_loop(f, f_thread) /* loops over faces in a face thread */

{

}

end_f_loop(f, f_thread)

5、Looping Over Faces of a Cell ( c_face_loop)

用法如下：

cell_t c;

Thread *t;

face_t f;

Thread *tf;

int n;

c_face_loop(c, t, n) /* loops over all faces of a cell */

{

.

f = C_FACE(c,t,n);

tf = C_FACE_THREAD(c,t,n);

.

}

n是the local face index number，C_FACE宏可以获得面， C_FACE_THREAD 宏可以获得面thread，还有一些宏能用于c_face_loop，在帮助文件里找到

6、Looping Over Nodes of a Cell ( c_node_loop)

用法如下：

cell_t c;

Thread *t;

int n;

Node *node;

c_node_loop(c,t,n)

{

.

node = C_NODE(c,t,n);

.

}

n是the local node index number怎么获得的，C_NODE宏可以获得cell结点。

7、Looping Over Nodes of a Face ( f_node_loop)

用法如下：

face_t f;

Thread *t;

int n;

Node *node;

f_node_loop(f,t,n)

{

.

node = F_NODE(f,t,n); .

.

}

n是the local node index number怎么获得的，F_NODE宏可以获得cell结点。十二、Multiphase Looping Macros

本节中介绍的宏只能用在多相UDF中

1、Looping Over Phase Domains in Mixture ( sub_domain_loop)

sub_domain_loop在每个单相域（子域）循环loops over all phase domains，这个宏提供每个单相的指针和phase_domain_index（用来区别不同的相的线，第一相的线为0，第二相的线为1）。

int phase_domain_index; /* index of subdomain pointers */

Domain *mixture_domain;

Domain *subdomain;

sub_domain_loop(subdomain, mixture_domain, phase_domain_index)

subdomain是指向子域的指针，mixture_domain是指向超级域的指针，phase_domain_index子域第一相为0，第二相为1（注意：它和domain_id不同，

domain_id 超级域mixture domain为1，第一相为2，第二相为3）如果sub_domain_loop 宏用在DEFINE函数中并且他的参数还有domain变量，则mixture_domain会被求解器自动使用；如果不能使用，你可以在DEFINE 函数里使用sub_domain_loop 宏之前用get_domain(1)

subdomain and phase_domain_index are set within the sub_domain_loop macro.

2、Looping Over Phase Threads in Mixture ( sub_thread_loop)

sub_thread_loop在每个单相线循环 loops over all phase-level threads with a mixture-level thread

int phase_domain_index;

Thread *subthread;

Thread *mixture_thread;

sub_thread_loop(subthread, mixture_thread, phase_domain_index)

subthread is a pointer to the phase thread, and mixture_thread is a pointer to the mixture-level thread, phase_domain_index is an index of subdomain pointers that can be retrieved using the PHASE_DOMAIN_INDEX macro.

注意：subthread and phase_domain_index are initialized within the sub_thread_loop macro definition.

3、Looping Over Phase Cell Threads in Mixture ( mp_thread_loop_c)

The mp_thread_loop_c macro loops through all cell threads (at the mixture level) within the mixture domain and provides the pointers of the phase-level (cell) threads associated with each mixture-level thread.

Thread **pt;

Thread *cell_threads;

Domain *mixture_domain;

mp_thread_loop_c(cell_threads, mixture_domain, pt)

the macro also returns a pointer array ( pt) that identifies the corresponding phase-level threads. The pointer to the cell thread for the th phase is pt[i], where i is the phase_domain_index. pt[i] can be used as an argument to macros requiring the phase-level thread pointer.

cell_threads is a pointer to the cell threads, and mixture_domain is a pointer to the mixture-level domain. pt is an array pointer whose elements contain pointers to phase-level threads.

如果 mp_thread_loop_c 宏用在DEFINE函数中并且他的参数还有domain变量，则mixture_domain会被求解器自动使用；如果不能使用，你可以在DEFINE 函数里使用 mp_thread_loop_c 宏之前用get_domain(1)

mp_thread_loop_c经常配合begin_c_loop使用，begin_c_loop嵌在 mp_thread_loop_c中

When begin_c_loop is nested within mp_thread_loop_c, you can loop over all cells in all phase cell threads within a mixture.

4、Looping Over Phase Face Threads in Mixture ( mp_thread_loop_f)

The mp_thread_loop_f macro loops through all face threads (at the mixture level)

within the mixture domain and provides the pointers of the phase-level (face) threads associated with each mixture-level thread.

the macro also returns a pointer array ( pt) that identifies the corresponding phase-level threads. The pointer to the face thread for the th phase is pt[i], where i is the phase_domain_index. pt[i] can be used as an argument to macros requiring the phase-level thread pointer.

Thread **pt;

Thread *face_threads;

Domain *mixture_domain;

mp_thread_loop_f(face_threads, mixture_domain, pt)

face_threads is a pointer to the face threads, and mixture_domain is a pointer to the mixture-level domain. pt is an array pointer whose elements contain pointers to phase-level threads.

mp_thread_loop_f经常配合begin_f_loop使用，begin_f_loop嵌在 mp_thread_loop_f中

When begin_f_loop is nested within mp_thread_loop_f, you can loop over all faces in all phase face threads within a mixture.

十三、 Advanced Multiphase Macros

多相流的定义会有不同

1、DEFINE_ADJUST 和 DEFINE_INIT针对的domain只能用于超级域are passed mixture domain variables only，而像ON_DEMAND宏中参数不传递任何变量，所以我们需要相关的宏来表示我们目前针对的对象具体是什么。编写多相模型的UDF时，要牢记多相模型的数据结构，注意函数获得的参数和函数hook在什么域上，同时还要注意你使用的多相模型的类型。

2、Phase Domain Pointer ( DOMAIN_SUB_DOMAIN)

如果你想获得某一个单相的指针，有两种方法：第一，使用Get_Domain；第二，使用DOMAIN_SUB_DOMAIN。

int phase_domain_index = 0; /* primary phase index is 0 */

Domain *mixture_domain;

Domain*subdomain=DOMAIN_SUB_DOMAIN(mixture_domain,phase_domain_index);

当你使用DEFINE宏并且含有 a phase domain index argument ( DEFINE_EXCHANGE_PROPERTY,DEFINE_VECTOR_EXCHANGE_PROPER TY) ，phase_domain_index不需要设置，否则你要指定phase_domain_index的值。

3、Phase-Level Thread Pointer ( THREAD_SUB_THREAD)

THREAD_SUB_THREAD可以得到the phase-level thread (subthread) pointer。

int phase_domain_index = 0; /* primary phase index is 0 */

Thread *mixture_thread; /* mixture-level thread pointer */

Thread*subthread=THREAD_SUB_THREAD(mixture_thread,phase_domain_index);

mixture_thread is a pointer to a mixture-level thread。如果用DEFINE宏（例如 DEFINE_PROFILE），系统会自动调用mixture_thread，如果不能自动调用，要用宏Lookup_Thread。

当你使用DEFINE宏contains a phase domain index argument ，例如( DEFINE_EXCHANGE_PROPERTY,DEFINE_VECTOR_EXCHANGE_PROPER TY) ，UDF会自动调用某个相，否则你要指定phase_domain_index的值。

4、Phase Thread Pointer Array ( THREAD_SUB_THREADS)

Thread *mixture_thread;

Thread **pt; /* initialize pt */

pt = THREAD_SUB_THREADS(mixture_thread);

mixture_thread is a pointer to a mixture-level thread which can represent a cell thread or a face thread. It is automatically passed to your UDF by the FLUENT solver when you use a DEFINE macro that contains a variable thread argument (e.g., DEFINE_PROFILE), and the function is hooked to the mixture. Otherwise, if the mixture thread pointer is not explicitly passed to your UDF, then you will need to use another method to retrieve it. For example you can use the Lookup_Thread utility macro.

pt[i], an element in the array, is a pointer to the corresponding phase-level thread for the th phase, where i is the phase_domain_index. You can use pt[i] as an argument to some cell variable macros when you want to retrieve specific phase information at a cell. For example, C_R(c,pt[i]) can be used to return the density of the th phase fluid at cell c.

5、Mixture Domain Pointer ( DOMAIN_SUPER_DOMAIN)

通过这个宏，你可以通过a particular phase-level domain (subdomain) pointer 获得 the mixture-level domain pointer.。

Domain *subdomain;

Domain *mixture_domain = DOMAIN_SUPER_DOMAIN(subdomain);

It is automatically passed to your UDF by the FLUENT solver when you use a DEFINE macro that contains a domain variable argument (e.g., DEFINE_ADJUST)在上面的例子中，要事先获得子域（即相域）的指针。如果UDF勾在某一相域上，相域的指针也可以由求解器自动传递给UDF。在当前版本FLUENT中，

DOMAIN_SUPER_DOMAIN 与Get_Domain(1)返回的指针是一样的。但是还是建议在UDF中，尽可能使用DOMAIN_SUPER_DOMAIN，考虑到FLUENT版本的更新，未来可能处理多个超级域。

6、Mixture Thread Pointer ( THREAD_SUPER_THREAD)

You can use the THREAD_SUPER_THREAD macro when your UDF has access to a particular phase-level thread (subthread) pointer, and you want to retrieve the mixture-level thread pointer.

Thread *subthread;

Thread *mixture_thread = THREAD_SUPER_THREAD(subthread);

subthread is a pointer to a particular phase-level thread within the multiphase mixture. It is automatically passed to your UDF by the FLUENT solver when you use a DEFINE macro that contains a thread variable argument (e.g., DEFINE_PROFILE), and the function is hooked to a primary or secondary phase in the mixture.

7、Domain ID ( DOMAIN_ID)

Domain *subdomain;

int domain_id = DOMAIN_ID(subdomain);

8、Phase Domain Index ( PHASE_DOMAIN_INDEX)

Domain *subdomain;

int phase_domain_index = PHASE_DOMAIN_INDEX(subdomain);

十四、Vector and Dimension Macros

1、V denotes a vector, S denotes a scalar, and D denotes a sequence of three vector components of which the third is always ignored for a two-dimensional calculation.

2、Macros for Dealing with Two and Three Dimensions

RP_2D and RP_3D

3、The ND Macros

（1）ND_ND

二维的时候ND_ND为2，三维的时候ND_ND为3，但如果用在数组中，都是从0开始使用，一直到n-1。