adjoint-helper 0.0.1__py3-none-any.whl

adjoint_helper/__init__.py

@@ -0,0 +1,35 @@
+"""
+Main entry point for Adjoint Helper
+"""
+
+"""
+Adjoint Helper
+Copyright (C) 2026 Ben Cerjan
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+"""
+
+from .core.base_settings import OptimizationSettings, SimulationSettings, DesignRegion
+from .core.defs import (
+    Edge,
+    MaskRegion,
+    ObjectiveReturn,
+    ObjectiveFunction,
+    OptimizationFunction,
+    SimulationReturn,
+)
+from .core.differentiation_defs import anp
+from .core.optimization_history import OptimizationHistory
+from .utils.util import save_fom_history, save_output
+from .utils.normalization_functions import normalize_meep_output

adjoint_helper/backends/meep/utils.py

@@ -0,0 +1,83 @@
+import meep as mp  # type: ignore
+import meep.adjoint as mpa  # type: ignore
+import matplotlib.pyplot as plt
+
+from adjoint_helper.core.defs import (
+    RawWeightsType,
+)
+
+
+def add_flux_box(
+    size: mp.Vector3,
+    center: mp.Vector3 = mp.Vector3(),
+) -> list[mp.FluxRegion]:
+    """
+    Adds 6 flux regions to create a box around the center point with the given
+    size. Specifies the weight parameter on each assuming we care about flux
+    leaving the box (and not entering)
+    """
+
+    out: list[mp.FluxRegion] = []
+
+    top = mp.FluxRegion(
+        center=center + mp.Vector3(0, 0, size.z / 2),
+        size=mp.Vector3(size.x, size.y, 0),
+    )
+
+    bot = mp.FluxRegion(
+        center=center - mp.Vector3(0, 0, size.z / 2),
+        size=mp.Vector3(size.x, size.y, 0),
+        weight=-1,
+    )
+
+    x_r = mp.FluxRegion(
+        center=center + mp.Vector3(size.x / 2, 0, 0),
+        size=mp.Vector3(0, size.y, size.z),
+    )
+
+    x_l = mp.FluxRegion(
+        center=center + mp.Vector3(-size.x / 2, 0, 0),
+        size=mp.Vector3(0, size.y, size.z),
+        weight=-1,
+    )
+
+    y_b = mp.FluxRegion(
+        center=center + mp.Vector3(0, size.y / 2, 0),
+        size=mp.Vector3(size.x, 0, size.z),
+    )
+
+    y_f = mp.FluxRegion(
+        center=center + mp.Vector3(0, -size.y / 2, 0),
+        size=mp.Vector3(size.x, 0, size.z),
+        weight=-1,
+    )
+
+    out.extend([top, bot, x_r, x_l, y_b, y_f])
+
+    return out
+
+
+def get_total_box_flux(fluxes: list[mp.DftFlux]) -> float:
+    flux: float = 0
+
+    for f in fluxes:
+        temp = mp.get_fluxes(f)  # type: ignore
+        flux += temp[0]  # TODO: check!
+
+    return flux
+
+
+def plot_structure(
+    opt: mpa.OptimizationProblem,
+    weights: RawWeightsType | list[RawWeightsType],
+    volume: mp.Volume = mp.Volume(
+        size=mp.Vector3(mp.inf, mp.inf, 0), center=mp.Vector3()
+    ),
+) -> None:
+
+    if not isinstance(weights, list):
+        weights = [weights]
+    opt.update_design(weights)  # type: ignore
+
+    opt.plot2D(True, output_plane=volume)  # type: ignore
+    plt.show()  # type: ignore