-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/main' into main
- Loading branch information
Showing
2 changed files
with
180 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| # This is a basic workflow to help you get started with Actions | ||
|
|
||
| name: CI | ||
|
|
||
| # Controls when the action will run. | ||
| on: | ||
| # Triggers the workflow on push or pull request events but only for the main branch | ||
| push: | ||
| branches: [ main ] | ||
| pull_request: | ||
| branches: [ main ] | ||
|
|
||
| # Allows you to run this workflow manually from the Actions tab | ||
| workflow_dispatch: | ||
|
|
||
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | ||
| jobs: | ||
| # This workflow contains a single job called "build" | ||
| build: | ||
| # The type of runner that the job will run on | ||
| runs-on: ubuntu-latest | ||
|
|
||
| # Steps represent a sequence of tasks that will be executed as part of the job | ||
| steps: | ||
| # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | ||
| - uses: actions/checkout@v2 | ||
|
|
||
| # Runs a single command using the runners shell | ||
| - name: Run a one-line script | ||
| run: echo Hello, world! | ||
|
|
||
| # Runs a set of commands using the runners shell | ||
| - name: Run a multi-line script | ||
| run: | | ||
| echo Add other actions to build, | ||
| echo test, and deploy your project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,144 @@ | ||
| ElA Tools: A tool for analyzing anisotropic elastic properties of the 2D and 3D materials | ||
|
|
||
| We introduce a computational method and a user-friendly code, named ElATools, | ||
| developed for the analysis of anisotropic elastic properties. ElATools enables facile | ||
| analysis of the second-order elastic stiffness tensor of two-dimensional (2D) and | ||
| three-dimensional (3D) crystal systems. It computes and displays the main me- | ||
| chanical properties including the bulk modulus, Young’s modulus, shear modulus, | ||
| p-wave modulus, universal anisotropy index, Chung-Buessem anisotropy index, log- | ||
| Euclidean anisotropy parameter, Cauchy pressure, Poisson’s ratio, and Pugh’s ratio, | ||
| using three averaging schemes of Voigt, Reuss, and Hill. ElATools has a database | ||
| with more than 13,000 elastic stiffness constants for 3D materials available to the | ||
| user. The program supports output files of the well-known computational codes | ||
| IRelat, ElaStic, and AELAS. Three types of plotting and visualization tools are | ||
| integrated to conveniently interface with G NUPLOT , X MGRACE , and view3dscene, of- | ||
| fering immediate post-processing of the results. ElATools provides reliable means to | ||
| investigate the mechanical stability based on the calculation of six (three) eigenval- | ||
| ues of the elastic tensor in 3D (2D) materials. It can efficiently identify anomalous | ||
| mechanical properties, such as negative linear compressibility, negative Poisson’s | ||
| ratio, and highly-anisotropic elastic modulus in 2D and 3D materials, which are cen- | ||
| tral properties to design and develop high-performance nanoscale electromechanical | ||
| devices. | ||
| # El _A_ Tools [](https://yalameha.gitlab.io/elastictools/index.html) | ||
|
|
||
| ## _A tool for analyzing anisotropic elastic properties of the 2D and 3D materials_ | ||
|
|
||
| [](https://github.com/shahramyalameha/ElATools/blob/main/LICENSE.md) | ||
| [](https://github.com/shahramyalameha/ElATools/releases/latest) | ||
| [](https://github.com/shahramyalameha/ElATools/issues) | ||
| [](https://github.com/shahramyalameha/ElATools/network) | ||
| [](https://github.com/shahramyalameha/ElATools/stargazers) | ||
| > We introduce a computational method and a user-friendly code, named ElATools,developed for the analysis of anisotropic elastic properties. ElATools enables facile analysis of the second-order elastic stiffness tensor of two-dimensional (2D) and three-dimensional (3D) crystal systems. It computes and displays the main mechanical properties including the bulk modulus, Young’s modulus, shear modulus, p-wave modulus, universal anisotropy index, Chung-Buessem anisotropy index, log-Euclidean anisotropy parameter, Cauchy pressure, Poisson’s ratio, and Pugh’s ratio, using three averaging schemes of Voigt, Reuss, and Hill. ElATools has a database with more than 13,000 elastic stiffness constants for 3D materials available to the user. The program supports output files of the well-known computational codes IRelat, ElaStic, and AELAS. Three types of plotting and visualization tools are integrated to conveniently interface with GNUPLOT, XMGRACE ,and view3dscene, offering immediate post-processing of the results. ElATools provides reliable means to investigate the mechanical stability based on the calculation of six (three) eigenvalues of the elastic tensor in 3D (2D) materials. It can efficiently identify anomalous mechanical properties, such as negative linear compressibility, negative Poisson’s ratio, and highly-anisotropic elastic modulus in 2D and 3D materials, which are central properties to design and develop high-performance nanoscale electromechanical devices. | ||
|
|
||
| ## Features | ||
| The following features of ElATools are highlighted: | ||
| - **3D Elastic Properties of 3D materials:** | ||
| - Bulk modulus | ||
| - Shear modulus | ||
| - Young's modulus | ||
| - P-wave modulus | ||
| - Poisson's ratio | ||
| - Pugh ratio | ||
| - Universal anisotropy index (AU) | ||
| - Log-Euclidean anisotropy parameter (AL) | ||
| - Chung-Buessem Anisotropy Index (Ac) | ||
| - Cauchy pressure (Pc) | ||
| - Kleinman parameter **New** | ||
| - Lame’s first and second parameters **New** | ||
| - Hardness information **New** | ||
|
|
||
| - **Elastic Properties of 2D materials:** | ||
| - Young modulus | ||
| - Poisson's ratio | ||
| - Shaer modulus | ||
| - Area modulus | ||
| - Elastic anisotropy index (A_SU) | ||
| - Ranganathan Elastic anisotropy index (A_Ra) | ||
| - Kube Elastic anisotropy index (A_Kube) | ||
|
|
||
| - **Visualization of 3D materials:** | ||
| - 3D representation of Bulk modulus (tested) | ||
| - 3D representation of Shear modulus (tested) | ||
| - 3D representation of Linear Compressibiliy (tested) | ||
| - 3D representation of Young modulus (tested) | ||
| - 3D representation of Poisson's ratio (tested) | ||
| - 3D representation of Pugh ratio (testing) | ||
| - 3D representation of Phase velocity_P, Fast and slow modes (tested) **New** | ||
| - 3D representation of Group velocity_P, Fast and slow modes (tested) **New** | ||
| - 3D representation of Power flow angle_P, Fast and slow modes (tested) **New** | ||
| - 2D Heat map of Bulk modulus (tested) **New** | ||
| - 2D Heat map of Shear modulus (tested) **New** | ||
| - 2D Heat map of Linear Compressibiliy (tested) **New** | ||
| - 2D Heat map of Young modulus (tested) **New** | ||
| - 2D Heat map of Poisson ratio (tested) **New** | ||
| - 2D Heat map of Pugh ratio (testing) **New** | ||
| - 2D Heat map of Phase velocity_P, Fast and slow modes (tested) **New** | ||
| - 2D Heat map of Group velocity_P, Fast and slow modes (tested) **New** | ||
| - 2D Heat map of Power flow angle_P, Fast and slow modes (tested) **New** | ||
|
|
||
| - **Visualization of 2D materials:** | ||
| - 2D representation of Young’s modulus (tested) | ||
| - 2D representation of Poisson's ratio (tested) | ||
| - 2D representation of Shear modulus (tested) **New** | ||
|
|
||
| - **Interfaces to** | ||
| - IRelast code in WEIN2k (For 3D system) | ||
| - IRelast2D code in WEIN2k (For 2D system) **New** | ||
| - Elast code in WEIN2k (For 3D system) | ||
| - AELAS code for VASP (For 2D and 3D systems) | ||
| - ElaStic code for QE, WEIN2k and Exciting (For 3D systems) **New** | ||
|
|
||
| - **A database with more than 13000 elastic constants (Cij) for 3D materials.** | ||
| - **Supports different symmetries** | ||
| - Cubic | ||
| - Hexagonal | ||
| - Tetragonal | ||
| - Orthorhombic | ||
| - Rhombohedral | ||
| - Monoclinic | ||
|
|
||
| - **Checks stability conditions** | ||
| - Stability conditions of 3D systems | ||
| - Stability conditions of 2D systems | ||
|
|
||
| - **Supports various output files for visualizing data** | ||
| - wrl | ||
| - agr | ||
| - gnu | ||
| - dat | ||
| ## Installation | ||
| You need to install the following packages: | ||
|
|
||
| * Fortran compiler (Ifort (Recom.) or gfortran ) | ||
| * Lapack and Blas library | ||
|
|
||
| Compilation | ||
| ----------- | ||
|
|
||
|
|
||
| Then Go into ElATools_SRC/src directory, Choose and Edit Makefile, Change the blas library ” libs= ” to your lapack+blas library | ||
| After the compliation, the binary ‘Elatools.x , dat2wrl.x, dat2gnu.x and dat2agr.x’ are copied to Elatools.x /bin/, you can put this path to the system PATH with | ||
| :: | ||
|
|
||
| export PATH=/where/you/downloaded/ElaTools_SRC/bin:$PATH | ||
|
|
||
| to the **.bashrc** file in your home directory. | ||
|
|
||
| Usage | ||
| ----- | ||
|
|
||
| Now you can enjoy your exploration for materials with ElATools. | ||
| There is a file you need to prepare, | ||
|
|
||
| * For IRelast code **INVELC-matrix** file, | ||
| * For Elast code **elast.output** file, | ||
| * For AELAS code **ELADAT** file, | ||
| * For any code **Cij.dat/Cij-2D.dat** tensor file. | ||
|
|
||
| After the preparation of this file, you can just run Elatools.x in the same folder | ||
| :: | ||
|
|
||
| Elatools.x | ||
|
|
||
| For 3D representation of properties: | ||
| :: | ||
|
|
||
| dat2wrl.x | ||
|
|
||
| For 2D representation of properties: | ||
| :: | ||
|
|
||
| data2gnu.x | ||
| and | ||
| :: | ||
|
|
||
| dat2agr.x | ||
|
|
||
| Plotting tools | ||
| -------------- | ||
|
|
||
| - `Gnuplot <http://gnuplot.sourceforge.net/>`_ | ||
| - `Xmgrace <http://plasma-gate.weizmann.ac.il/Grace/>`_ | ||
| - `Titania <http://create3000.de/>`_ | ||
| - `Meshlab <http://www.meshlab.net/>`_ | ||
| - `View3dscene <https://castle-engine.io/view3dscene.php>`_ | ||
|
|