Skip to content

Conversation

@marc-flex
Copy link
Contributor

@marc-flex marc-flex commented Sep 24, 2025

  • Add docs
  • Modify CHANGELOG

Greptile Overview

Updated On: 2025-09-29 14:36:05 UTC

Summary

This PR adds the Hurkx model for direct band-to-band tunneling (HurkxDirectBandToBandTunneling) to the TCAD components. The implementation follows the established patterns in the codebase and includes proper physics equations, parameter validation, and comprehensive integration.

Key additions:

  • New HurkxDirectBandToBandTunneling class with well-documented physics equation and parameters
  • Proper integration into the RecombinationModelType union type
  • Complete API exports and documentation updates
  • Basic instantiation test to ensure the class can be constructed
  • Clear changelog entry following project conventions

Confidence Score: 4/5

  • This PR is safe to merge with only minor stylistic considerations
  • Score reflects a well-implemented feature following established patterns, but with a minor suggestion about parameter defaults that could improve usability
  • Minor attention to generation_recombination.py for the sigma parameter default value consideration

Important Files Changed

File Analysis

Filename        Score        Overview
tidy3d/components/tcad/generation_recombination.py 4/5 Added new HurkxDirectBandToBandTunneling model class with proper documentation and physics equation; minor suggestion on parameter defaults
tidy3d/components/tcad/types.py 5/5 Properly integrated new HurkxDirectBandToBandTunneling into RecombinationModelType union
tests/test_components/test_heat_charge.py 5/5 Added basic instantiation test for HurkxDirectBandToBandTunneling with valid parameters

Sequence Diagram

sequenceDiagram
    participant User
    participant API as Tidy3D API
    participant HurkxBTBT as HurkxDirectBandToBandTunneling
    participant RecombModel as RecombinationModelType
    participant Simulation as ChargeSimulation

    User->>API: Import tidy3d
    API-->>User: Module loaded with HurkxDirectBandToBandTunneling
    
    User->>HurkxBTBT: Create instance with parameters (A, B, E_0, sigma)
    HurkxBTBT->>HurkxBTBT: Validate parameters (A > 0, E_0 > 0, sigma required)
    HurkxBTBT-->>User: HurkxDirectBandToBandTunneling instance
    
    User->>RecombModel: Add to RecombinationModelType union
    RecombModel-->>User: Model type validated
    
    User->>Simulation: Use in charge simulation setup
    Simulation->>HurkxBTBT: Calculate R_BTBT = A * (np - ni²)/((n+ni)(p+ni)) * (|E|/E₀)^σ * exp(-B/|E| * (Eg/Eg300)^1.5)
    HurkxBTBT-->>Simulation: Band-to-band tunneling recombination rate
    Simulation-->>User: Simulation ready with Hurkx BTBT model
Loading

@marc-flex marc-flex self-assigned this Sep 24, 2025
@marc-flex marc-flex force-pushed the marc/btbt_direct branch 3 times, most recently from e30b4f5 to 6d3483f Compare September 26, 2025 06:28
@marc-flex marc-flex marked this pull request as ready for review September 29, 2025 14:32
Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

6 files reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

@github-actions
Copy link
Contributor

github-actions bot commented Sep 29, 2025

Diff Coverage

Diff: origin/develop...HEAD, staged and unstaged changes

  • tidy3d/components/tcad/generation_recombination.py (100%)

Summary

  • Total: 14 lines
  • Missing: 0 lines
  • Coverage: 100%

@marc-flex marc-flex changed the title Adding direct btbt by Hurkx feat: Band-to-band tunneling and impact ionization [FXC-2838] Oct 21, 2025
@marc-flex marc-flex force-pushed the marc/btbt_direct branch 4 times, most recently from a212d91 to 430dc18 Compare October 22, 2025 12:58
Copy link
Contributor

@damiano-flex damiano-flex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noted a couple of improvements in the docs. But other than that, it looks great!

@marc-flex marc-flex enabled auto-merge November 3, 2025 08:16
@marc-flex marc-flex added this pull request to the merge queue Nov 3, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 3, 2025
@marc-flex marc-flex enabled auto-merge November 3, 2025 09:49
@marc-flex marc-flex added this pull request to the merge queue Nov 3, 2025
Merged via the queue into develop with commit 4787f47 Nov 3, 2025
26 checks passed
@marc-flex marc-flex deleted the marc/btbt_direct branch November 3, 2025 11:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants