You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A**simple** finite element method program, which is short for **AsFem**. AsFem is written in C++ and designed for phase-field modeling and multiphysics coupling. The [PETSc](https://www.mcs.anl.gov/petsc/) library is involved in AsFem for the efficient computing.
5
+
**AsFem**-**A**dvanced**S**imulation kit based on **F**inite **E**lement **M**ethod. AsFem is written in C++ and designed for phase-field modeling and multiphysics coupling. The [PETSc](https://www.mcs.anl.gov/petsc/) library and [MPI](https://www.open-mpi.org/) package are involved in AsFem for the scalable computing.
6
6
7
7
8
8
# Download
9
9
10
10
```
11
-
git clone https://github.com/M3Group/AsFem.git
11
+
git clone https://github.com/MatMechLab/AsFem
12
12
```
13
-
For the detailed usage, one is referred to [AsFem Page](https://m3group.github.io/AsFem/).
13
+
For comprehensive details on usage, please refer to the [AsFem Page](https://matmechlab.github.io/AsFem/).
14
14
15
-
If one has access issues, the alternative link could be [AsFem-Gitee](https://gitee.com/m3group/AsFem.git), the git clone can be done via:
15
+
If you encounter any access issues, an alternative link to explore is [AsFem-Gitee](https://gitee.com/matmechlab/AsFem). Git cloning can be executed using the following command:
16
16
```
17
-
git clone https://gitee.com/m3group/AsFem.git
17
+
git clone https://gitee.com/matmechlab/AsFem.git
18
18
```
19
19
20
20
21
21
# Installation
22
22
23
-
The installation details of AsFem can be found here [AsFem-Installation](https://m3group.github.io/AsFem/install/).
23
+
Detailed installation instructions for AsFem are available at [AsFem-Installation](https://matmechlab.github.io/AsFem/install/).
24
24
25
-
After you've installed your PETSc (PETSC_DIR) and MPI (MPI_DIR), all you have to do is:
25
+
Once you have installed PETSc and MPI (set up your PETSC_DIR and MPI_DIR), the next steps are as follows:
26
26
```
27
27
cmake CMakeLists.txt -DCMAKE_BUILD_TYPE=Release
28
28
make -j4
29
29
```
30
30
31
31
# Demos
32
-
AsFem has several demos, you can visit them either on [Bilibili](https://space.bilibili.com/100272198/channel/detail?cid=90241) or on [Youtube](https://www.youtube.com/playlist?list=PLVEpIo_wvYmaLPoLjj5Lg93YvYy9flkN8).
32
+
33
+
You can explore several AsFem demos on platforms like [Bilibili](https://space.bilibili.com/100272198/channel/collectiondetail?sid=73185) and [Youtube](https://www.youtube.com/playlist?list=PLVEpIo_wvYmaLPoLjj5Lg93YvYy9flkN8).
The tutorial is avialable here https://m3group.github.io/AsFem/Tutorial/step-0/
40
41
41
-
For Chinese users, the video lecture is available on bilibili, please see [AsFem-Lecture](https://space.bilibili.com/100272198/channel/detail?cid=193605).
42
+
The tutorial can be accessed at this link: [AsFem Tutorial](https://matmechlab.github.io/AsFem/Tutorial/step-0/)
42
43
43
-
Currently, one can find the tested input files in both the `AsFem/examples` folder as well as `AsFem/test_input` folder. For a better understanding of how to use AsFem, please take a look at these input files first.
44
+
Chinese users can access the video lecture on Bilibili at [AsFem-Lecture](https://space.bilibili.com/100272198/channel/collectiondetail?sid=73182).
45
+
46
+
At present, the tested input files for AsFem are located in two directories: `AsFem/examples` and `AsFem/test_input`. For an enhanced understanding of how to utilize AsFem effectively, it is recommended to first examine these input files.
44
47
45
48
# Document
46
-
The code is documented by the [Doxygen](https://www.doxygen.nl/index.html) package, one can generate the pdf file or html files via:
49
+
50
+
The code is documented using the [Doxygen](https://www.doxygen.nl/index.html) package. You can generate PDF or HTML files using the following commands:
47
51
```
48
52
doxygen
49
53
```
50
54
51
-
More documents and details can be found in AsFem's [homepage](https://m3group.github.io/AsFem/).
55
+
Additional documentation and details about AsFem are available on its [homepage](https://matmechlab.github.io/AsFem/)
52
56
53
57
# Author
54
58
[Yang Bai](https://yangbai90.github.io/)
@@ -58,32 +62,32 @@ More documents and details can be found in AsFem's [homepage](https://m3group.gi
58
62
```
59
63
@misc{yang_bai_2021_4603558,
60
64
author = {Yang Bai},
61
-
title = {{AsFem: a simple finite element method program for
62
-
phase-field modeling and multiphysics coupling}},
63
-
month = feb,
65
+
title = {{AsFem: Advanced Simulation kit based on Finite
66
+
Element Method}},
67
+
month = mar,
64
68
year = 2021,
65
69
publisher = {Zenodo},
66
-
version = {master},
70
+
version = {V0.8},
67
71
doi = {10.5281/zenodo.4603558},
68
72
url = {https://doi.org/10.5281/zenodo.4603558}
69
73
}
70
74
```
71
75
72
76
# Contribute
73
77
74
-
If you discover bugs in the `AsFem` package, please create an issue at the project repository on GitHub at https://github.com/M3Group/AsFem.
78
+
If you discover bugs in the `AsFem` package, please create an issue at the project repository on GitHub at https://github.com/MatMechLab/AsFem.
75
79
76
-
If you find the AsFem package useful, we welcome your code and documentation contributions. To contribute, fork the repository on GitHub, and submit a pull request at https://github.com/M3Group/AsFem.
80
+
If you find the AsFem package useful, we welcome your code and documentation contributions. To contribute, fork the repository on GitHub, and submit a pull request at https://github.com/MatMechLab/AsFem.
77
81
78
82
79
83
# Contact
80
84
81
-
Submit bug reports and feature requests on the [repository issue tracker](https://github.com/M3Group/AsFem/issues).
85
+
Submit bug reports and feature requests on the [repository issue tracker](https://github.com/MatMechLab/AsFem/issues).
82
86
83
87
84
88
# Discussion
85
89
86
-
If you are interested in AsFem or have any questions, just feel free to send me an email [Mail2Me](mailto:yangbai90@outlook.com) or join the QQ group for more discussion .
90
+
If you have an interest in AsFem or any questions, please don't hesitate to [Mail2Me](mailto:yangbai90@outlook.com), or join our QQ group for further discussions.
0 commit comments