fix grating couplers in tidy3d

[joamatab]

Fixes grating couplers simulations in tidy3d

Before, as seen in this picture, the derived layers were missing from the simulatoin

@yaugenst

Summary by Sourcery

Fix derived layers in tidy3d simulations for grating couplers.

Bug Fixes:

• Fixed missing derived layers in tidy3d simulations, ensuring their inclusion in grating coupler simulations.

Enhancements:

• Refactored layer handling to include derived layers, updated simulation boundaries calculation, and improved port handling.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request fixes an issue with grating coupler simulations in tidy3d where derived layers were missing from the simulation. This was achieved by refactoring the get_simulation_grating_coupler function to correctly handle derived layers. The updated function now takes a layer_stack argument and uses it to apply derived layers to the component before extracting polygons for simulation. Additionally, the function now supports excluding specific layers from the simulation using the exclude_layers argument.

Class diagram for grating coupler simulation components

classDiagram
    class Component {
        +get_polygons_points()
        +ports
        +layers
    }

    class LayerStack {
        +layers
        +get_component_with_derived_layers()
        +get_layer_to_thickness()
        +get_layer_to_material()
    }

    class Layer {
        +layer
        +zmin
        +thickness
    }

    class LogicalLayer {
        +layer
    }

    class DerivedLayer {
        +layer
    }

    Layer <|-- LogicalLayer
    Layer <|-- DerivedLayer
    LayerStack *-- Layer
    Component --> LayerStack: uses

Loading

File-Level Changes

Change	Details	Files
Refactored the get_simulation_grating_coupler function to handle derived layers correctly.	Added exclude_layers parameter to exclude specific layers from the simulation. Modified the function to use the provided layer_stack to apply derived layers to the component. Updated polygon extraction to use the component with derived layers applied.	gplugins/tidy3d/get_simulation_grating_coupler.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

[sourcery-ai]

issue (code-quality): We've found these issues:

• Extract code out into function (extract-method)
• Low code quality found in get_simulation_grating_coupler - 3% (low-code-quality)

Explanation

The quality score for this function is below the quality threshold of 25%.
This score is a combination of the method length, cognitive complexity and working memory.

How can you solve this?

It might be worth refactoring this function to make it shorter and more readable.

• Reduce the function length by extracting pieces of functionality out into
  their own functions. This is the most important thing you can do - ideally a
  function should be less than 10 lines.
• Reduce nesting, perhaps by introducing guard clauses to return early.
• Ensure that variables are tightly scoped, so that code using related concepts
  sits together within the function rather than being scattered.