Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #137

Merged
merged 1 commit into from
Mar 15, 2024
Merged

Update README.md #137

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 40 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,40 @@
[![PiPy](https://img.shields.io/pypi/v/femwell)](https://pypi.org/project/femwell/)
[![Downloads](https://static.pepy.tech/badge/femwell/month)](https://pepy.tech/project/femwell)

Finite element based simulation tool for integrated circuits, electric and photonic!
The documentation is lagging behind the state of code,
so there's several features for which there are only examples in the code.
# Welcome to FEMWELL!

**You can try out the examples in the browser!**
**Hover the rocket at the top on the example pages and click live code!**
(Might take some time to load)
FEMWELL is a physics simulation tool that utilises the Finite Element Method (FEM). With FEMWELL, you can simulate integrated circuits, electronic and photonic systems, and so much more.
The project is created to provide an Open-Source FEM solver. You are welcome to contribute to FEMWELL or just use it. Any feedback and input are valuable and will make FEMWELL better!

## What is a FEM simulation?

FEM is a method to solve various types of differential equations that appear in physics, maths or engineering. FEM methods are used when describing how fields behave in an inhomogeneous setting, for example are electromagnetic fields in structured matter described by Maxwell’s equations. FEM uses a mesh to discretize the space and solve Maxwell’s equations via these “finite elements”.

A FEM simulation typically involves the following steps:

1. Discretization (or Meshing) of the structure
2. Calculation of the problem in each element
3. Assembly accounting for boundary conditions between the elements
4. Solution via iterative solvers or direct solution methods

FEM can be applied to various problems, from Maxwell’s equations to fluid simulation, heat transport or structural analysis.

## What is special about FEMWELL?

First and foremost: FEMWELL is open source! You can just use FEMWELL, you can contribute to FEMWELL and you can modify FEMWELL to fit your specific problem.

At the moment we focus on photonic and electronic problems, meaning we concentrate on solving Maxwell’s equation. This is useful to understand the physics in modern devices used in classical or quantum computing technologies.

We are actively working on extending FEMWELL to address other questions. You can find a list of examples below.

## How can I use FEMWELL?

The simplest thing it to try out the examples in the browser! Hover the rocket at the top on the example pages and click live code. (Might take some time to load).
For more involved calculations, we recommend installing FEMWELL following the instructions.
If you can to improve FEMWELL, please get in touch with us. We are looking forward to your contributions!

### Please note:
The documentation is lagging behind the state of code, so there's several features for which there are only examples in the code.

## Features

Expand All @@ -25,6 +52,8 @@ so there's several features for which there are only examples in the code.

## Possible Simulations

### Photonic problems

- Eigenmodes of waveguides and determining their effective refractive index
- Coupling between neighboring waveguides
- Eigenmodes of bent waveguides
Expand All @@ -36,8 +65,6 @@ so there's several features for which there are only examples in the code.
- Eigenmode of a coaxial cable and its specific impedance
- Eigenmodes of electric transmission lines
and determining their propagation constant (in work)
- Static thermal profiles
- Transient thermal behavior
- Static electric fields
- Overlap integrals between waveguide modes
- Overlap integral between a waveguide mode and a fiber mode
Expand All @@ -46,6 +73,10 @@ so there's several features for which there are only examples in the code.
- Pockels based photonic phase shifters
- PN junction depletion modulator (analytical)

### Heat transport
- Static thermal profiles
- Transient thermal behavior

Something missing? Feel free to open an [issue](https://github.com/HelgeGehring/femwell/issues) :)

## Contributors
Expand All @@ -55,7 +86,7 @@ Something missing? Feel free to open an [issue](https://github.com/HelgeGehring/
- Joaquin Matres (Google)
- Marc de Cea Falco (Google, Massachusetts Institute of Technology)
- Lodovico Rossi (Princeton University)
- Doris Reiter (Dortmund University)
- Doris Reiter (TU Dortmund University)
- Yannick Augenstein (Google, Karlsruhe Institute of Technology)
- Niko Savola (Google, Aalto University)
- Rouven Glauert (Idalab)
Expand Down
Loading