Skip to content
MuPRO Knowledge

协同编码

任何编码合作都有贡献规则,MuPRO 的项目也是如此。

开发 SDK 库

您应该看看开发文件夹中 L1_Electric 或 L1_Elastic 文件夹的结构,并学习如何设计您的新模块。有关模块设计的更多细节将在后面的文档中介绍。

主程序工作

如果当前的主程序不能满足你的需求,那么你有三个选择来定制主程序。它们是根据我的建议排序的,所以你应该尽可能考虑选择 1、选择 2,最后才是选择 3。

这里我们只介绍定制主程序的一般规则,有关如何更改特定类型主程序的详细信息,请参阅该主程序的文档。

选择 1:修改现有主程序

如果您的用例对普通用户非常有用,而且您只想添加几个参数来扩展现有主程序的功能,那么您应该考虑将其添加到现有主程序中。经验法则是不要影响现有参数,否则你的改动可能会破坏他人的程序。切记提交并发布您的更改

选择 2:在现有资源库中添加新的主程序

如果您的用例对普通用户有用,但与现有主程序有很大不同,例如,您仍在进行相场铁电模拟,但现在您的系统有了非均质设置,那么您可以在现有资源库中设置一个新的主程序。对于 PhaseFieldFerroelctric 软件库来说,它和我们的“basic”主程序都在 apps 文件夹中。在创建新主程序时,请记住经常提交和发布更改

选择 3:在新仓库中创建自己的主程序

如果您想为一个完全不同的相场模型编写主程序,那么您应该考虑创建一个新的 git 仓库,并将其作为新的子模块添加到 PhaseFieldSDK 仓库中。