# chientingtung/semidv architecture

> Architecture diagram of the GitHub repository chientingtung/semidv, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/chientingtung/semidv
- Repository: https://github.com/chientingtung/semidv

## Overview

SEMIDV is a 2D semiconductor device simulator for finite-difference Poisson–Drift–Diffusion equations, with optional quantum effects. The principal workflow is to define material properties and a device grid, then run a solver—optionally sweeping contact voltages—and inspect calculated fields and currents through plotting methods. The solver excerpt explicitly shows calls into the device model for Poisson, drift-diffusion, and quantum calculations; the visualizer reads device state. The excerpts do not establish how material properties are passed into device construction, so that link is omitted.

Main entry points: [`semidv/Solve.py`](https://github.com/chientingtung/semidv/blob/main/semidv/Solve.py) (IV Sweep), [`semidv/__init__.py`](https://github.com/chientingtung/semidv/blob/main/semidv/__init__.py) (Package API), [`semidv/Visual.py`](https://github.com/chientingtung/semidv/blob/main/semidv/Visual.py) (Plots and Cuts), [`semidv/Device.py`](https://github.com/chientingtung/semidv/blob/main/semidv/Device.py) (Device State)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_configuration["Device Definition"]
  node_material_data["Material Properties<br/>[Material.py]"]
  node_device_grid["Device Structure<br/>[Device.py]"]
end

subgraph group_simulation["Simulation"]
  node_device_state["Device State<br/>[Device.py]"]
  node_poisson["Poisson Solver<br/>[Device.py]"]
  node_drift_diffusion["Drift-Diffusion<br/>[Device.py]"]
  node_quantum["Quantum Effects<br/>[Device.py]"]
  node_sweep["IV Sweep<br/>[Solve.py]"]
end

subgraph group_inspection["Results Inspection"]
  node_visualizer["Plots and Cuts<br/>[Visual.py]"]
end

node_engineer(("Simulator User"))
node_public_api["Package API<br/>[__init__.py]"]

node_engineer -->|"uses"| node_public_api
node_public_api -->|"exports"| node_material_data
node_public_api -->|"exports"| node_device_grid
node_public_api -->|"exports"| node_sweep
node_public_api -->|"exports"| node_visualizer
node_sweep -->|"updates guesses"| node_device_state
node_sweep -->|"calls"| node_poisson
node_sweep -->|"calls"| node_drift_diffusion
node_sweep -->|"optionally calls"| node_quantum
node_visualizer -->|"reads fields"| node_device_state

click node_public_api "https://github.com/chientingtung/semidv/blob/main/semidv/__init__.py"
click node_material_data "https://github.com/chientingtung/semidv/blob/main/semidv/Material.py"
click node_device_grid "https://github.com/chientingtung/semidv/blob/main/semidv/Device.py"
click node_device_state "https://github.com/chientingtung/semidv/blob/main/semidv/Device.py"
click node_poisson "https://github.com/chientingtung/semidv/blob/main/semidv/Device.py"
click node_drift_diffusion "https://github.com/chientingtung/semidv/blob/main/semidv/Device.py"
click node_quantum "https://github.com/chientingtung/semidv/blob/main/semidv/Device.py"
click node_sweep "https://github.com/chientingtung/semidv/blob/main/semidv/Solve.py"
click node_visualizer "https://github.com/chientingtung/semidv/blob/main/semidv/Visual.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_material_data,node_device_grid,node_engineer toneBlue
class node_device_state,node_poisson,node_drift_diffusion,node_quantum,node_sweep toneAmber
class node_visualizer,node_public_api toneMint
```

## Components

### Device Definition

- [Material Properties](https://github.com/chientingtung/semidv/blob/main/semidv/Material.py): `semidv/Material.py`
- [Device Structure](https://github.com/chientingtung/semidv/blob/main/semidv/Device.py): `semidv/Device.py`

### Simulation

- [Device State](https://github.com/chientingtung/semidv/blob/main/semidv/Device.py): `semidv/Device.py`
- [Poisson Solver](https://github.com/chientingtung/semidv/blob/main/semidv/Device.py): `semidv/Device.py`
- [Drift-Diffusion](https://github.com/chientingtung/semidv/blob/main/semidv/Device.py): `semidv/Device.py`
- [Quantum Effects](https://github.com/chientingtung/semidv/blob/main/semidv/Device.py): `semidv/Device.py`
- [IV Sweep](https://github.com/chientingtung/semidv/blob/main/semidv/Solve.py): `semidv/Solve.py`

### Results Inspection

- [Plots and Cuts](https://github.com/chientingtung/semidv/blob/main/semidv/Visual.py): `semidv/Visual.py`

### Other components

- **Simulator User**
- [Package API](https://github.com/chientingtung/semidv/blob/main/semidv/__init__.py): `semidv/__init__.py`

## Connections

- Simulator User → Package API: uses (evidence: `README.md`)
- Package API → Material Properties: exports (evidence: `semidv/__init__.py`)
- Package API → Device Structure: exports (evidence: `semidv/__init__.py`)
- Package API → IV Sweep: exports (evidence: `semidv/__init__.py`)
- Package API → Plots and Cuts: exports (evidence: `semidv/__init__.py`)
- IV Sweep → Device State: updates guesses (evidence: `semidv/Solve.py`)
- IV Sweep → Poisson Solver: calls (evidence: `semidv/Solve.py`)
- IV Sweep → Drift-Diffusion: calls (evidence: `semidv/Solve.py`)
- IV Sweep → Quantum Effects: optionally calls (evidence: `semidv/Solve.py`)
- Plots and Cuts → Device State: reads fields (evidence: `semidv/Visual.py`)
