Skip to content

Commit ca4be58

Browse files
zmjt-cnzmjt-cn
committed
Add Readme file
1 parent 3500d8a commit ca4be58

File tree

3 files changed

+88
-60
lines changed

3 files changed

+88
-60
lines changed

‎CS_script(python)/Readme.txt

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@
44
=========Version V2.1.4=========
55
============20230327============
66

7-
Authors: Ren Yabin (任亚斌), Yang Bo (杨波)
7+
en-us
8+
{
9+
Authors: Ren Yabin(zmjt-cn), Yang Bo
810
Address: School of Mechanical Engineering, Hebei University of Technology, Tianjin 300401, People's Republic of China
9-
Emails: <s1345358@126.com>, <boyang@hebut.edu.cn>
11+
Emails: <s1345358@126.com>, <boyang@hebut.edu.cn>
12+
Webside: https://github.com/zmjt-cn/C-S-Stress-Field
1013
Licence: Apache License 2.0
1114

12-
en-us
13-
{
1415
To apply a compressive-shear biaxial stress field to the unit cell and calculate the compressive-shear stress, this program has been developed.
1516

1617
>>The program features the following:
@@ -55,6 +56,12 @@ To apply a compressive-shear biaxial stress field to the unit cell and calculate
5556

5657
zh-cn
5758
{
59+
作者：任亚斌(zmjt-cn)，杨波
60+
地址：河北工业大学机械工程学院，天津 300401，中国
61+
邮箱：<s1345358@126.com>，<boyang@hebut.edu.cn>
62+
网址：https://github.com/zmjt-cn/C-S-Stress-Field
63+
协议：Apache License 2.0
64+
5865
为了对晶胞施加压缩-剪切双轴应力场，计算压缩-剪切应力，开发了本程序。
5966

6067
>>程序已经实现的功能：

‎GSFE_script(python)/Readme.txt

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@
44
=========Version V1.1.5=========
55
============20221125============
66

7-
Authors: Ren Yabin (任亚斌), Yang Bo (杨波)
7+
en-us
8+
{
9+
Authors: Ren Yabin(zmjt-cn), Yang Bo
810
Address: School of Mechanical Engineering, Hebei University of Technology, Tianjin 300401, People's Republic of China
9-
Emails: <s1345358@126.com>, <boyang@hebut.edu.cn>
11+
Emails: <s1345358@126.com>, <boyang@hebut.edu.cn>
12+
Webside: https://github.com/zmjt-cn/C-S-Stress-Field
1013
Licence: Apache License 2.0
1114

12-
en-us
13-
{
1415
To calculate generalized stacking fault energy (GSFE), (Contains cases where compressive stress is present)
1516

1617
>> Functions implemented in the program:
@@ -29,7 +30,7 @@ To calculate generalized stacking fault energy (GSFE), (Contains cases where com
2930
The 'POSCAR0' file generated is a backup of the original 'POSCAR' file submitted. If you want to redo the calculation, there is no need to change any parameters or input files, the program will automatically overwrite. 'POSorder' is the file obtained after transforming the coordinates of the original 'POSCAR' file (if the parameter for 'ifanimation' is set to '1').
3031
The 'POSCAR_0', 'POSCAR_1', etc. files are generated when calculating the GSFE-surface. If calculating the GSFE for a specific crystal direction, only the 'POSCAR_0' file will be generated.
3132
The data files generated, such as '0gsf.dat', '1gsf.dat', etc., contain the calculated results of the program in units of GPa.
32-
The 'cs.dat' file is the final data file, actually a collection of all data such as '0cs.dat', '1cs.dat', etc.
33+
The 'gsf.dat' file is the final data file, actually a collection of all data such as '0gsf.dat', '1gsf.dat', etc.
3334

3435
>>Introduction to the parameters of the 'input.dat' file:
3536
<< cellname sigma_0 iforder ifanimation >>
@@ -56,6 +57,13 @@ To calculate generalized stacking fault energy (GSFE), (Contains cases where com
5657

5758
zh-cn
5859
{
60+
61+
作者：任亚斌(zmjt-cn)，杨波
62+
地址：河北工业大学机械工程学院，天津 300401，中国
63+
邮箱：<s1345358@126.com>，<boyang@hebut.edu.cn>
64+
网址：https://github.com/zmjt-cn/C-S-Stress-Field
65+
协议：Apache License 2.0
66+
5967
计算广义层错能（包含了有压应力的情况）。
6068

6169
>>程序已经实现的功能:
@@ -74,7 +82,7 @@ zh-cn
7482
生成的“POSCAR0”文件为提交的原始“POSCAR”文件的备份（如果想重复提交运算，所有参数与输入文件均不需要改动，程序会自动覆盖），“POSorder”为原始文件“POSCAR”坐标轮换后的文件（如果你将是否坐标转换参数设置为“1”）。
7583
生成的“POSCAR_0”、“POSCAR_1”等文件是计算面层错能生成的，若选择计算特定晶向层错能，只会生成“POSCAR_0”文件。
7684
“0gsf.dat”、“1gsf.dat”等数据文件是生成的运算结果数据，单位为GPa。
77-
“cs.dat”文件是最终生成的数据文件，实际为“0cs.dat”、“1cs.dat”等所有数据的集合。
85+
“cs.dat”文件是最终生成的数据文件，实际为“0gsf.dat”、“1gsf.dat”等所有数据的集合。
7886

7987
>>“input.dat”文件的参数介绍：
8088
<< 晶胞名称 sigma_0/单位GPa 是否坐标转换 是否开启动画 >>

‎Readme.txt

Lines changed: 63 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11

22

3-
Authors: Ren Yabin (任亚斌), Yang Bo (杨波)
3+
en-us
4+
{
5+
Authors: Ren Yabin(zmjt-cn), Yang Bo
46
Address: School of Mechanical Engineering, Hebei University of Technology, Tianjin 300401, People's Republic of China
5-
Emails: <s1345358@126.com>, <boyang@hebut.edu.cn>
7+
Emails: <s1345358@126.com>, <boyang@hebut.edu.cn>
8+
Webside: https://github.com/zmjt-cn/C-S-Stress-Field
69
Licence: Apache License 2.0
710

811
================================
@@ -11,8 +14,6 @@ Licence: Apache License 2.0
1114
=========Version V2.1.4=========
1215
============20230327============
1316

14-
en-us
15-
{
1617
To apply a compressive-shear biaxial stress field to the unit cell and calculate the compressive-shear stress, this program has been developed.
1718

1819
>>The program features the following:
@@ -32,39 +33,14 @@ To apply a compressive-shear biaxial stress field to the unit cell and calculate
3233
Generated files such as 'POSCAR0', 'POSCAR1', correspond to the step 0 structure of the crystal direction you calculated (i.e., the file following the initial rotation).
3334
Data files such as '0cs.dat' and '1cs.dat' are the calculation result data of one crystal direction, given in GPa.
3435
The 'cs.dat' file is the final generated data file, which collects data from all crystal data such as '0cs.dat' and '1cs.dat'.
35-
}
36-
37-
zh-cn
38-
{
39-
为了对晶胞施加压缩-剪切双轴应力场，计算压缩-剪切应力，开发了本程序。
40-
41-
>>程序已经实现的功能：
42-
1.计算压缩-剪切双轴应力场作用下晶体的各向异性，实现自动转向计算。
43-
2.双线程模式计算时每30秒保存一次“CONTCAR”文件，可用于查看关键结构的变形过程，分析结构相变机理。
44-
3.input文件中提供了更多详细信息。
45-
46-
>>程序运行必要的文件：
47-
“INCAR”、“POSCAR”、“POTCAR”和“KPOINTS”，VASP软件的输入文件。
48-
“CS.py”、“animation.py”和“Thread.py”，程序运行的python脚本。
49-
“input.dat”，重要的参数输入文件。
50-
如果您使用的是远程超算服务器，还需要用于提交任务的pbs文件，算例中已经提供了一个“cs.pbs”文件。
51-
52-
>>程序生成文件介绍：
53-
在程序完成计算后，会生成“0pi12”、“1pi12”等文件夹，该类文件夹内有你所计算的晶向的压缩-剪切双轴应力场的原始数据结果，以及将本晶向所有CONTCAR文件结果集合到一起的“allCONTCAR”文件夹（如果你将是否开启动画的参数设置为“1”）。
54-
生成的“POSCAR0”文件为提交的原始“POSCAR”文件的备份（如果想重复提交运算，所有参数与输入文件均不需要改动，程序会自动覆盖），“POSorder”为原始文件“POSCAR”坐标轮换后的文件（如果你将是否坐标转换参数设置为“1”）。
55-
生成的“POSCAR_0”、“POSCAR_1”等文件对应的是你所计算的晶向的第0步结构（即原始文件转向后的文件）。
56-
“0cs.dat”、“1cs.dat”等数据文件是单条晶向的运算结果数据，单位为GPa。
57-
“cs.dat”文件是最终生成的数据文件，实际为“0cs.dat”、“1cs.dat”等所有晶向数据的集合。
58-
}
5936

6037
================================
6138
============GSFE.py=============
6239
================================
6340
=========Version V1.1.5=========
6441
============20221125============
6542

66-
en-us
67-
{
43+
6844
To calculate generalized stacking fault energy (GSFE), (Contains cases where compressive stress is present)
6945

7046
>> Functions implemented in the program:
@@ -83,13 +59,52 @@ To calculate generalized stacking fault energy (GSFE), (Contains cases where com
8359
The 'POSCAR0' file generated is a backup of the original 'POSCAR' file submitted. If you want to redo the calculation, there is no need to change any parameters or input files, the program will automatically overwrite. 'POSorder' is the file obtained after transforming the coordinates of the original 'POSCAR' file (if the parameter for 'ifanimation' is set to '1').
8460
The 'POSCAR_0', 'POSCAR_1', etc. files are generated when calculating the GSFE-surface. If calculating the GSFE for a specific crystal direction, only the 'POSCAR_0' file will be generated.
8561
The data files generated, such as '0gsf.dat', '1gsf.dat', etc., contain the calculated results of the program in units of GPa.
86-
The 'cs.dat' file is the final data file, actually a collection of all data such as '0cs.dat', '1cs.dat', etc.
62+
The 'gsf.dat' file is the final data file, actually a collection of all data such as '0gsf.dat', '1gsf.dat', etc.
8763

8864
Thank you for using! Feedback is always welcome!
8965
}
9066

9167
zh-cn
9268
{
69+
70+
作者：任亚斌(zmjt-cn)，杨波
71+
地址：河北工业大学机械工程学院，天津 300401，中国
72+
邮箱：<s1345358@126.com>，<boyang@hebut.edu.cn>
73+
网址：https://github.com/zmjt-cn/C-S-Stress-Field
74+
协议：Apache License 2.0
75+
76+
================================
77+
=============CS.py==============
78+
================================
79+
=========Version V2.1.4=========
80+
============20230327============
81+
82+
为了对晶胞施加压缩-剪切双轴应力场，计算压缩-剪切应力，开发了本程序。
83+
84+
>>程序已经实现的功能：
85+
1.计算压缩-剪切双轴应力场作用下晶体的各向异性，实现自动转向计算。
86+
2.双线程模式计算时每30秒保存一次“CONTCAR”文件，可用于查看关键结构的变形过程，分析结构相变机理。
87+
3.input文件中提供了更多详细信息。
88+
89+
>>程序运行必要的文件：
90+
“INCAR”、“POSCAR”、“POTCAR”和“KPOINTS”，VASP软件的输入文件。
91+
“CS.py”、“animation.py”和“Thread.py”，程序运行的python脚本。
92+
“input.dat”，重要的参数输入文件。
93+
如果您使用的是远程超算服务器，还需要用于提交任务的pbs文件，算例中已经提供了一个“cs.pbs”文件。
94+
95+
>>程序生成文件介绍：
96+
在程序完成计算后，会生成“0pi12”、“1pi12”等文件夹，该类文件夹内有你所计算的晶向的压缩-剪切双轴应力场的原始数据结果，以及将本晶向所有CONTCAR文件结果集合到一起的“allCONTCAR”文件夹（如果你将是否开启动画的参数设置为“1”）。
97+
生成的“POSCAR0”文件为提交的原始“POSCAR”文件的备份（如果想重复提交运算，所有参数与输入文件均不需要改动，程序会自动覆盖），“POSorder”为原始文件“POSCAR”坐标轮换后的文件（如果你将是否坐标转换参数设置为“1”）。
98+
生成的“POSCAR_0”、“POSCAR_1”等文件对应的是你所计算的晶向的第0步结构（即原始文件转向后的文件）。
99+
“0cs.dat”、“1cs.dat”等数据文件是单条晶向的运算结果数据，单位为GPa。
100+
“cs.dat”文件是最终生成的数据文件，实际为“0cs.dat”、“1cs.dat”等所有晶向数据的集合。
101+
102+
================================
103+
============GSFE.py=============
104+
================================
105+
=========Version V1.1.5=========
106+
============20221125============
107+
93108
计算广义层错能（包含了有压应力的情况）。
94109

95110
>>程序已经实现的功能:
@@ -108,29 +123,27 @@ zh-cn
108123
生成的“POSCAR0”文件为提交的原始“POSCAR”文件的备份（如果想重复提交运算，所有参数与输入文件均不需要改动，程序会自动覆盖），“POSorder”为原始文件“POSCAR”坐标轮换后的文件（如果你将是否坐标转换参数设置为“1”）。
109124
生成的“POSCAR_0”、“POSCAR_1”等文件是计算面层错能生成的，若选择计算特定晶向层错能，只会生成“POSCAR_0”文件。
110125
“0gsf.dat”、“1gsf.dat”等数据文件是生成的运算结果数据，单位为GPa。
111-
“cs.dat”文件是最终生成的数据文件，实际为“0cs.dat”、“1cs.dat”等所有数据的集合。
126+
“gsf.dat”文件是最终生成的数据文件，实际为“0gsf.dat”、“1gsf.dat”等所有数据的集合。
112127

113128
感谢您的使用，欢迎您的指正!
114129
}
115130

116131
>>CS.py Changelog:
117-
118-
# -------- (move.py) v0.0 --------
119-
# v0.0.0, 1st Written Mar 14, 2022. Original version. Modified for the first time.
120-
# -------- (move.py) v1.0 --------
121-
# v1.0.0, 2nd Overhaul May 28, 2022. In order to apply the compressive-shear biaxial stress field to the model and calculate the stress.
122-
# --------- (cs.py) v2.0 ---------
123-
# v2.0.0, 3rd Overhaul Aug 23, 2022. Program renaming & optimization.
124-
# --------- (CS.py) v2.1 ---------
125-
# v2.1.0, 4th written Feb 22, 2023. Program structure adjustment and optimization.
126-
# v2.1.4, 8th written Mar 27, 2023. Program optimization.
127-
# ...
132+
# -------- (move.py) v0.0 --------
133+
# v0.0.0, 1st Written Mar 14, 2022. Original version. Modified for the first time.
134+
# -------- (move.py) v1.0 --------
135+
# v1.0.0, 2nd Overhaul May 28, 2022. In order to apply the compressive-shear biaxial stress field to the model and calculate the stress.
136+
# --------- (cs.py) v2.0 ---------
137+
# v2.0.0, 3rd Overhaul Aug 23, 2022. Program renaming & optimization.
138+
# --------- (CS.py) v2.1 ---------
139+
# v2.1.0, 4th written Feb 22, 2023. Program structure adjustment and optimization.
140+
# v2.1.4, 8th written Mar 27, 2023. Program optimization.
141+
# ...
128142

129143
>>GSFE.py Changelog:
130-
131-
# ------------- v1.0 -------------
132-
# v1.0.0, 1st written Sep 15, 2022. Calculate the GSFE of the crystal plane.(stress-free)
133-
# ------------- v1.1 -------------
134-
# v1.1.0, 1st Overhaul Nov 23, 2022. Program optimization. Add cases where compressive stress is present.
135-
# v1.1.5, 6th written Mar 28, 2023. Program optimization. Add broad applicability.
136-
# ...
144+
# ------------- v1.0 -------------
145+
# v1.0.0, 1st written Sep 15, 2022. Calculate the GSFE of the crystal plane.(stress-free)
146+
# ------------- v1.1 -------------
147+
# v1.1.0, 1st Overhaul Nov 23, 2022. Program optimization. Add cases where compressive stress is present.
148+
# v1.1.5, 6th written Mar 28, 2023. Program optimization. Add broad applicability.
149+
# ...

0 commit comments

Comments
 (0)