# laurentnevou/q_kp_multiband_zb architecture

> Architecture diagram of the GitHub repository laurentnevou/q_kp_multiband_zb, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-25). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/laurentnevou/q_kp_multiband_zb
- Repository: https://github.com/laurentnevou/q_kp_multiband_zb

## Overview

##### Project Type and Purpose
- Type: A scientific computing / simulation tool implemented in MATLAB.
- Purpose: Compute electronic band structures of bulk zinc-blende (ZB) semiconductors using various k·p models (3-, 4-, 6-, 8-, 14-, 16-band).

##### High-Level Architectural Breakdown
A. Main Control Layer
– kp_multiband_ZB_Main.m: the entry point script that orchestrates the workflow.
B. Parameter Extraction Layer
– ExtractParameters.m: reads material parameters from CSV databases.
C. Database Layer
– materialDB.csv, materialDB_kp16bands.csv: contain preset parameters for III-V and II-VI semiconductors.
D. Model Implementation Layer
– Library.m: core helper functions (e.g., numerical utilities, matrix builders).
– kZB_f.m: generic zinc-blende Hamiltonian builder.
– kp_*_f.m (e.g., kp_3bands_DKK_f.m, kp_8bands_Kane_Fishman_f.m, kp_16bands_Luttinger_Fishman_f.m): individual k·p model functions that assemble and diagonalize the Hamiltonian for each band model.
E. Visualization / Output Layer
– MATLAB built-in plotting routines invoked by the main script to display band-structure graphs.

##### Relationships and Data Flows
1. User invokes kp_multiband_ZB_Main.m (Main Control).
2. Main Control calls ExtractParameters to read one of the CSVs → returns physical constants & k·p parameters.
3. Main Control selects the appropriate kp_*_f model function based on user input (number of bands & model variant) and passes parameters to it.
4. The model function may in turn call Library.m utilities (e.g., matrix operations).
5. kp_*_f returns eigenvalues (band energies) vs. k-points to Main Control.
6. Main Control feeds results into MATLAB’s plotting engine and displays or exports the figures.

##### Architectural Patterns and Design Principles
- Layered separation:
– Data layer (CSV database)
– Logic layer (parameter extraction + model functions + utility library)
– Presentation layer (main orchestration + plotting)
- Extensibility points: new kp_*.m modules can be dropped in to add more band models.
- Single-process, monolithic MATLAB application—no microservices, but well-modularized by function.

## Diagram (Mermaid)

```mermaid
graph TB
    User["User / MATLAB CLI"]:::actor
    Main["Main Control:\nkp_multiband_ZB_Main.m"]:::main
    Extract["Parameter Extraction:\nExtractParameters.m"]:::compute
    DB1["materialDB.csv"]:::db
    DB2["materialDB_kp16bands.csv"]:::db

    subgraph "Model Functions Library"
        Library["Library.m"]:::compute
        kZB["kZB_f.m"]:::compute
        subgraph "Band Model Functions"
            kp3["kp_3bands_DKK_f.m"]:::compute
            subgraph "4-Band Models"
                kp4a["kp_4bands_Luttinger_Fishman_f.m"]:::compute
                kp4b["kp_4bands_Luttinger_Rosencher_f.m"]:::compute
            end
            subgraph "6-Band Models"
                kp6a["kp_6bands_Luttinger_Bastard_f.m"]:::compute
                kp6b["kp_6bands_Luttinger_Cardona_f.m"]:::compute
                kp6c["kp_6bands_Luttinger_DKK_f.m"]:::compute
                kp6d["kp_6bands_Luttinger_Fishman_f.m"]:::compute
                kp6e["kp_6bands_Luttinger_Kohn_f.m"]:::compute
            end
            subgraph "8-Band Models"
                kp8a["kp_8bands_Kane_Bastard_f.m"]:::compute
                kp8b["kp_8bands_Kane_DKK_f.m"]:::compute
                kp8c["kp_8bands_Kane_Fishman_f.m"]:::compute
                kp8d["kp_8bands_Luttinger_DKK_f.m"]:::compute
                kp8e["kp_8bands_Luttinger_Fishman_f.m"]:::compute
                kp8f["kp_8bands_Luttinger_Pistol_f.m"]:::compute
            end
            kp14["kp_14bands_Luttinger_Fishman_f.m"]:::compute
            kp16["kp_16bands_Luttinger_Fishman_f.m"]:::compute
        end
    end

    Output["Visualization / Output\n(MATLAB plotting)"]:::output

    User -->|invokes| Main
    Main -->|read parameters| Extract
    Extract -->|query CSV| DB1
    Extract -->|query CSV| DB2
    DB1 -->|return data| Extract
    DB2 -->|return data| Extract
    Extract -->|parameters| Main
    Main -->|select model| kp3
    Main --> kp4a
    Main --> kp4b
    Main --> kp6a
    Main --> kp6b
    Main --> kp6c
    Main --> kp6d
    Main --> kp6e
    Main --> kp8a
    Main --> kp8b
    Main --> kp8c
    Main --> kp8d
    Main --> kp8e
    Main --> kp8f
    Main --> kp14
    Main --> kp16
    kp3 -->|use utilities| Library
    kp4a --> Library
    kp4b --> Library
    kp6a --> Library
    kp6b --> Library
    kp6c --> Library
    kp6d --> Library
    kp6e --> Library
    kp8a --> Library
    kp8b --> Library
    kp8c --> Library
    kp8d --> Library
    kp8e --> Library
    kp8f --> Library
    kp14 --> Library
    kp16 --> Library
    Main -->|compute generic HB| kZB
    kZB -->|utilities| Library
    Main -->|render plot| Output

    click Main "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/kp_multiband_ZB_Main.m"
    click Extract "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/ExtractParameters.m"
    click DB1 "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/materialDB.csv"
    click DB2 "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/materialDB_kp16bands.csv"
    click Library "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/Library.m"
    click kZB "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/kZB_f.m"
    click kp3 "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/kp_3bands_DKK_f.m"
    click kp4a "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/kp_4bands_Luttinger_Fishman_f.m"
    click kp4b "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/kp_4bands_Luttinger_Rosencher_f.m"
    click kp6a "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/kp_6bands_Luttinger_Bastard_f.m"
    click kp6b "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/kp_6bands_Luttinger_Cardona_f.m"
    click kp6c "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/kp_6bands_Luttinger_DKK_f.m"
    click kp6d "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/kp_6bands_Luttinger_Fishman_f.m"
    click kp6e "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/kp_6bands_Luttinger_Kohn_f.m"
    click kp8a "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/kp_8bands_Kane_Bastard_f.m"
    click kp8b "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/kp_8bands_Kane_DKK_f.m"
    click kp8c "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/kp_8bands_Kane_Fishman_f.m"
    click kp8d "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/kp_8bands_Luttinger_DKK_f.m"
    click kp8e "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/kp_8bands_Luttinger_Fishman_f.m"
    click kp8f "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/kp_8bands_Luttinger_Pistol_f.m"
    click kp14 "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/kp_14bands_Luttinger_Fishman_f.m"
    click kp16 "https://github.com/laurentnevou/q_kp_multiband_zb/blob/master/kp_16bands_Luttinger_Fishman_f.m"

    classDef actor fill:#FFFFFF,stroke:#000000
    classDef main fill:#FFA500,stroke:#FF8C00,stroke-width:2px
    classDef compute fill:#90EE90,stroke:#006400
    classDef db fill:#ADD8E6,stroke:#0000FF,shape:cylinder
    classDef output fill:#D8BFD8,stroke:#800080
```
