【HyperMesh宝典】二次开发之函数

二次开发有意思的主要的地方就是可以编写自定义函数，而调用别人已经编写调试好的程序包可以大大降低二次开发的难度。

简单地说函数就是打包好了的作为一个整体执行的一系列程序语句的集 合，比方说下面的语句是用来删除模型中所有可见的几何体：

只需要改成如下形式就变成了一个函数：

有实际使用价值的函数未必要很长，而且实际上是恰恰相反，好的函数应该尽可能地短。在 Utility 界面下，opti tab 页的 Del All Opt Entities 功能是被用户使用的频率最高的二次开发功能之一。但是它的代码大概也就10条命令，思路和上面写的几乎一模一样：

在本文的后半部分我们会介绍如何安装 tcllib 这个包，里面会有很多源代码。你会发现很多函数都只有短短几行，函数之间互相调用。函数可以把复杂的程序按照逻辑关系分解为不同的步骤，让程序容易编写也容易理解。

上面的例子没有参数，也有很多函数是带参数的。例如下面这个例子是为了在脚本运行的时候暂时关闭图像界面交互，也是被人使用频率最高的功能之一。该函数通过临时关闭不必要的图形交互功能显著加速脚本的执行速度。该脚本只带一个参数，on 或者 off。

有了函数后每次遇到同样的问题时就可以直接调用已经调试好的函数而不必每次都重复实现，不仅降低了编程的难度，也显著减少了出错的可能性。这也是函数存在最主要的价值——代码重用。我们总是尽可能避免在不同的地方重复实现相同的功能，比如接下来介绍的 getdist 函数以及 角度/弧度转换函数，虽然只有一句也非常值得写成一个函数。

好的函数定义应当是功能单一，逻辑结构清晰，执行结果不依赖外部条件。比如在很多程序里都会存在求两个点之间的距离的需求，我们可以写成一个函数反复调用：

这里的函数参数列表为6个坐标分量，如果输入是两个节点 id 呢？我们先使用节点 id 号获取6个坐标，然后还是调用上面定义好的函数来实现其余功能而不是重新实现一遍 getdist 已经实现的功能。

函数也接受列表作为参数，比如下面这个例子中把一系列的单元 id 号进行分解，把相连的单元作为一组输出。请注意这里的输出 output_list 也是一个列表类型。通常如果需要返回多个值，建议将输出作为一个列表返回。

运行程序前的模型如下：

运行函数后再输入：

得到输出：

这样就实现了把复杂问题分而治之的目的。接下来对每个孔分别进行处理就容易多了，比如我们来创建一些 RBE2，这里需要先从单元 id 号找到对应的节点 id 号，然后才能创建。

此外，函数也可以接受数组名和字典名作为参数，这种用法对于参数较多的情况特别方便，因为只需要一个数组或者字典的名称就可以引用所有数组或字典里的键了。下面这个例子里通过传入一个字典名来保存函数中创建的所有内容。

通常情况函数都会使用值传递，因为使用值传递时 tcl 解释器总是先把参数值在另外的内存中备份一份供函数内部使用而不是直接操纵参数的原始值，所以，参数的原始值不会有被修改的危险（因此，函数无论是第几次调用结果都不会有差别）。而 upvar 表示这里使用的是引用传递而不是值传递，函数会直接指向原始的字典内存，如果还有别的函数也同时使用该字典，那么程序的运行结果会变得无法预测。

程序输出如下：

这里把与用户交互的部分放在了一个函数里面，后续的脚本只需要使用 dict get 命名就可以很方便地获取字典中的相应内容。也就是说数据的输入和数据的处理实现了完全解耦，处理数据输入的函数只需要了解要收集哪些数据以及存放在字典的什么键下而不需要关心这些数据的用途；而使用这些数据的函数也只需要知道各个值保存在字典的哪个键下而不必再费心去关心数据获取的过程。这就是函数化编程的思路，也就是让程序的各个模块尽可能地解耦。

很多情况下我们在定义函数的时候无法确定参数的个数，或者只能确定一部分参数，剩余部分只有在调用函数的时候才能确定，这时我们可以按照下面的格式定义函数的参数列表：

接下来我们可以使用任意个参数调用 max

max 1 2

max 3 4 5

max 4 5 7 9

或者还可以使用如下方式来定义 max 函数：

这时候函数体里面就免去了 lindex 进行输出，同样也很优雅。

函数参数还可以有默认值，请参考下例（这个例子也是很常用的）：

程序说明：

最后的两行注释是测试语句，在这种简单的函数定义的时候我们可以直接把测试语句也用注释的方式写到里面去，如果函数众多或者很复杂，可以使用 tcltest 模块进行单元测试。

最后我们来讲一个关于求解器工况创建的函数作为例子。先给出脚本：

这里的难点是 command.tcl 文件记录了太多的命令，很难从里面挑出需要的命令，大家可以按照以下方法进行甄别。

为确保万无一失，把这些命令复 制到命令窗口运行一下（因为 id 号每次会变化，可以按照上图脚本中的方法临时获取）。这里再次建议大家亲自动手上机实践一下，光看文字可能不会有很深的体会，只有碰几次壁才能真正懂得这里面的精髓。

一个人的知识、能力和时间都是有限的，在二次开发的过程中实际上大部分功能都是通过调用别人已经写好的函数或者你自己之前写好的函数实现的。如果只是调用一些简单的函数我们可以直接使用 souce 命令。souce 命令的效果和把被 source 的文件内容直接复 制到相应位置的效果是完全一致的。对于复杂的包，通常会以 package 的形式存在，而且会自带名字空间。需要使用 package require packagename 的方式来调用包。接下来我们以tcl中非常常用的 tcllib 包的安装使用为例告诉大家如何下载/安装/使用外部包。

目前 tcllib 包里面包含了400多个函数，包括线性代数、微积分、csv、网络工具、集 合数据类型等等。相信能为你的编程提供很大的帮助，而且这些都是带着 tcl 源代码和帮助信息来的（在 activetcl 的帮助中查找），对你学习 tcl 是宝贵的资料。唯一一点不好的就是这个包不是 tcl 默认安装的，如果你的程序使用了 tcllib，你的脚本拷贝到另外一台电脑后可能会无法执行。

在二次开发部分的最后一段，给大家推荐一下 tcl 单元测试的包 tcltest，因为很多人认识 tcl 语言的原因并不是 HyperMesh 的关系，而是作为一个自动化测试语言。