rtang/ANASEN_analysis
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Sudarsan Balakrishnan 2026-03-12 12:51:54 -04:00
parent 1c63cca714
commit 623e72a197
1 changed files with 19 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
anasen_fem/README.md
View File

@ -1,22 +1,27 @@
README for ANASEN fem simulations: ### README for ANASEN fem simulations:
* There are a few iterations of these simulations that already exist. Be sure to also locate and refer to them if necessary.
* Install gmsh and its python api by running (Ubuntu 22.04 LTS)
* There are a few iterations of these simulations that already exist. Be sure to also locate and refer to them if necessary.
* Install gmsh and its python api by running (Ubuntu 22.04 LTS)
``` ```
sudo apt install gmsh python3-gmsh sudo apt install gmsh python3-gmsh
``` ```
Gmsh gives us the tools to create a meshgrid that samples the 2d space appropriately to plot the field/equipotential lines.
The output file typically has the .msh extension. This is read as input to Elmer, which is the FEM differential-equation solver. * Gmsh gives us the tools to create a meshgrid that samples the 2d space appropriately to plot the field/equipotential lines.
* Install Elmer via the following steps: * The output file typically has the .msh extension. This is read as input to Elmer, which is the FEM differential-equation solver.
* Install Elmer via the following steps:
``` ```
sudo add-apt-repository ppa:elmer-csc-ubuntu/elmer-csc-ppa sudo add-apt-repository ppa:elmer-csc-ubuntu/elmer-csc-ppa
sudo apt install elmerfem-csc-eg sudo apt install elmerfem-csc-eg
``` ```
* Install ParaView for visualizations by downloading from the Linux .tar.gz link at https://www.paraview.org/download/
- The current version is tested to work on Paraview 6.1.0. The default version in Ubuntu 22.04 repositories has some trouble with scripting * Install ParaView for visualizations by downloading from the Linux .tar.gz link at https://www.paraview.org/download/
* v0.0.1, March 10 2026 - The current version is tested to work on Paraview 6.1.0. The default version in Ubuntu 22.04 repositories has some trouble with scripting
- 2d simulations of fields only. gmsh for meshing, elmer for fem, paraview to plot * v0.0.1, March 10 2026
- Before running, open `paraview_plotter.py` to make the bash shebang (#!) point to the location of `pvpython` or `pvbatch` - 2d simulations of fields only. gmsh for meshing, elmer for fem, paraview to plot
- `python3 run.py` should run everything in order, and is hopefully all the files are self-documenting - Before running, open `paraview_plotter.py` to make the bash shebang (#!) point to the location of `pvpython` or `pvbatch`
* v0.0.2, planned TODO - `python3 run.py` should run everything in order, and is hopefully all the files are self-documenting
- Garfield to take Elmer results and perform charge-transport * v0.0.2, planned TODO
- Garfield to take Elmer results and perform charge-transport