Merge branch 'main' of github.com:HelgeGehring/femwell

docs/_toc.yml

@@ -37,6 +37,7 @@ parts:
     - file: photonics/examples/coupled_mode_theory.py
     - file: photonics/examples/depletion_waveguide.py
     - file: photonics/examples/refinement.py
+    - file: electronics/examples/capacitor.py
 
   - caption: Julia Examples
     chapters:

docs/electronics/examples/capacitor.py

@@ -0,0 +1,301 @@
+# ---
+# jupyter:
+#   jupytext:
+#     text_representation:
+#       extension: .py
+#       format_name: light
+#       format_version: '1.5'
+#       jupytext_version: 1.15.2
+#   kernelspec:
+#     display_name: waveguidesmodes
+#     language: python
+#     name: python3
+# ---
+
+# # Lumped capacitor
+#
+# The capacitance $C$ of a system given a potential difference $\Delta V$ between two conductors can be calculated from
+#
+# $$ C = \frac{2W}{(\Delta V)^2} $$
+#
+# with
+#
+# $$ W = \frac{1}{2} \int_\Omega \epsilon E \cdot E d\Omega $$
+#
+# where $\epsilon$ is the permittivity distribution, $E$ the electric field, and $\Omega$ the domain. The integrand is only non-zero close to the conductors, where the field is concentrated.
+#
+# In this notebook we compute the capacitance of a parallel-plate capacitor, and show that we recover the theoretical result $C = \frac{\epsilon A}{d}$ in the limit of negligible fringe fields.
+#
+# First, we parametrize a simple geometry:
+
+# +
+from collections import OrderedDict
+
+import matplotlib.pyplot as plt
+import numpy as np
+import shapely
+import shapely.affinity
+from meshwell.model import Model
+from meshwell.polysurface import PolySurface
+from scipy.constants import epsilon_0, speed_of_light
+from shapely.ops import clip_by_rect
+from skfem import (
+    Basis,
+    BilinearForm,
+    ElementDG,
+    ElementTriN1,
+    ElementTriN2,
+    ElementTriP0,
+    ElementTriP1,
+    ElementTriP2,
+    ElementVector,
+    Functional,
+    InteriorFacetBasis,
+    LinearForm,
+    Mesh,
+    condense,
+    solve,
+)
+from skfem.helpers import dot
+from skfem.io.meshio import from_meshio
+
+from femwell.coulomb import solve_coulomb
+from femwell.maxwell.waveguide import compute_modes
+from femwell.visualization import plot_domains, plot_subdomain_boundaries
+
+# -
+
+# Define some parameters for the capacitor:
+
+dielectric_epsilon = 16
+separation = 4
+metal_thickness = 1
+delta_voltage = 1
+
+
+# Make a mesh
+#
+# <div class="alert alert-success">
+# Note: below we use meshwell instead of femwell's built-in backend. You can install meshwell with `pip install meshwell`
+# </div>
+
+
+def parallel_plate_capacitor_mesh(
+    width,
+    separation=separation,
+    thickness=metal_thickness,
+):
+    top_plate_polygon = shapely.geometry.box(
+        -width / 2, separation / 2, width / 2, separation / 2 + thickness
+    )
+    bottom_plate_polygon = shapely.geometry.box(
+        -width / 2, -separation / 2 - thickness, width / 2, -separation / 2
+    )
+    dielectric_polygon = shapely.geometry.box(
+        -width / 2, -separation / 2, width / 2, separation / 2
+    )
+
+    capacitor_polygon = shapely.unary_union(
+        [top_plate_polygon, bottom_plate_polygon, dielectric_polygon]
+    )
+    air_polygon = capacitor_polygon.buffer(20, resolution=8)
+
+    model = Model()
+
+    top_plate = PolySurface(
+        polygons=top_plate_polygon,
+        model=model,
+        physical_name="top_plate",
+        mesh_bool=False,
+        resolution={"resolution": 0.5, "DistMax": 2},
+        mesh_order=1,
+    )
+    bottom_plate = PolySurface(
+        polygons=bottom_plate_polygon,
+        model=model,
+        physical_name="bottom_plate",
+        mesh_bool=False,
+        resolution={"resolution": 0.5, "DistMax": 2},
+        mesh_order=2,
+    )
+    dielectric = PolySurface(
+        polygons=dielectric_polygon,
+        model=model,
+        physical_name="dielectric",
+        mesh_bool=True,
+        mesh_order=3,
+    )
+    air = PolySurface(
+        polygons=air_polygon,
+        model=model,
+        physical_name="air",
+        mesh_bool=True,
+        mesh_order=4,
+    )
+
+    return from_meshio(
+        model.mesh(
+            entities_list=[top_plate, bottom_plate, dielectric, air],
+            filename="mesh.msh",
+            default_characteristic_length=0.5,
+        )
+    )
+
+
+mesh = parallel_plate_capacitor_mesh(
+    width=2,
+    separation=separation,
+    thickness=metal_thickness,
+)
+mesh.draw().show()
+
+plot_domains(mesh)
+plt.show()
+
+plot_subdomain_boundaries(mesh)
+
+
+# Since the electric field inside a metal is zero, we define the voltage on the boundary of the metal, and exclude the metal from the mesh:
+
+
+# +
+def potential(mesh, dV=delta_voltage, dielectric_epsilon=16):
+    basis_epsilon = Basis(mesh, ElementTriP0())
+    epsilon = basis_epsilon.ones()
+
+    epsilon[basis_epsilon.get_dofs(elements=("dielectric"))] = dielectric_epsilon
+
+    basis_u, u = solve_coulomb(
+        basis_epsilon,
+        epsilon,
+        {
+            "top_plate___dielectric": dV,
+            "top_plate___air": dV,
+            "bottom_plate___dielectric": 0,
+            "bottom_plate___air": 0,
+        },
+    )
+
+    return basis_u, u, basis_epsilon, epsilon
+
+
+basis_u, u, basis_epsilon, epsilon = potential(mesh, dV=delta_voltage)
+# -
+
+fig, ax = plt.subplots()
+for subdomain in basis_epsilon.mesh.subdomains.keys() - {"gmsh:bounding_entities"}:
+    basis_epsilon.mesh.restrict(subdomain).draw(ax=ax, boundaries_only=True)
+basis_u.plot(u, ax=ax, shading="gouraud", colorbar=True)
+# basis_vec.plot(-u_grad, ax=ax)
+plt.show()
+
+# +
+for subdomain in basis_epsilon.mesh.subdomains.keys() - {"gmsh:bounding_entities"}:
+    basis_epsilon.mesh.restrict(subdomain).draw(ax=ax, boundaries_only=True)
+basis_grad = basis_u.with_element(ElementDG(basis_u.elem))
+
+fig, ax = plt.subplots()
+e_x = basis_u.project(-basis_epsilon.interpolate(epsilon) * basis_u.interpolate(u).grad[0])
+basis_u.plot(e_x, ax=ax, shading="gouraud", colorbar=True)
+plt.show()
+
+fig, ax = plt.subplots()
+e_y = basis_u.project(-basis_epsilon.interpolate(epsilon) * basis_u.interpolate(u).grad[1])
+basis_u.plot(e_y, ax=ax, shading="gouraud", colorbar=True)
+plt.show()
+
+
+# -
+
+
+def capacitance(
+    width=2,
+    separation=separation,
+    thickness=metal_thickness,
+    dV=delta_voltage,
+    dielectric_epsilon=dielectric_epsilon,
+):
+    mesh = parallel_plate_capacitor_mesh(
+        width=width,
+        separation=separation,
+        thickness=thickness,
+    )
+    basis_u, u, basis_epsilon, epsilon = potential(
+        mesh, dV=dV, dielectric_epsilon=dielectric_epsilon
+    )
+
+    @Functional(dtype=complex)
+    def W(w):
+        return 0.5 * w["epsilon"] * dot(w["u"].grad, w["u"].grad)
+
+    C = (
+        2
+        * W.assemble(
+            basis_u,
+            epsilon=basis_epsilon.interpolate(epsilon),
+            u=basis_u.interpolate(u),
+        )
+        / dV**2
+    )
+
+    return C
+
+
+# +
+import tqdm
+
+widths = np.linspace(1, 50, 11)
+Cs_dict = {}
+for dielectric_epsilon in [1, 3.9, 16]:
+    Cs = []
+    for width in tqdm.tqdm(widths):
+        Cs.append(
+            capacitance(
+                width=width,
+                separation=separation,
+                thickness=metal_thickness,
+                dV=delta_voltage,
+                dielectric_epsilon=dielectric_epsilon,
+            )
+        )
+    Cs_dict[dielectric_epsilon] = Cs
+
+# +
+colors = ["tab:blue", "tab:orange", "tab:green"]
+
+for dielectric_epsilon, color in zip([1, 3.9, 16], colors):
+    plt.plot(
+        widths,
+        np.array(Cs_dict[dielectric_epsilon]),
+        color=color,
+        linestyle="-",
+        label=dielectric_epsilon,
+    )
+    plt.plot(
+        widths, np.array(widths) * dielectric_epsilon / separation, color=color, linestyle="--"
+    )
+    plt.xlabel("Width (a.u.)")
+    plt.ylabel(r"Capacitance per unit length / $\epsilon_0$ (a.u.)")
+
+plt.legend(title="Dielectric")
+
+# +
+colors = ["tab:blue", "tab:orange", "tab:green"]
+
+for dielectric_epsilon, color in zip([1, 3.9, 16], colors):
+    reference = np.array(widths) * dielectric_epsilon / separation
+
+    plt.plot(
+        widths,
+        np.array(Cs_dict[dielectric_epsilon]) / reference,
+        color=color,
+        linestyle="-",
+        label=dielectric_epsilon,
+    )
+    plt.xlabel("Width (a.u.)")
+    plt.ylabel(r"Relative error in capacitance per unit length / $\epsilon_0$ (a.u.)")
+
+plt.legend(title="Dielectric")
+# -
+
+# The solver reproduces the parallel-plate capacitor result. For small widths, there is a greater discrepancy between the theoretical parallel plate and the simulated due to the higher relative impact of fringe fields. There is also a constant offset that persists at large widths due to the fringe field contribution. The relative importance of the fringe fields is reduced with increasing dielectric constant which forces more field lines between the two electrodes, as expected.

pyproject.toml

@@ -32,7 +32,7 @@ scikit-fem = ">=8.1.0"
 gmsh = "*"
 pygmsh = "*"
 matplotlib = "*"
-shapely = ">=2.0.0"
+meshwell = "1.0.2"
 
 [tool.poetry.group.test.dependencies]
 pytest = "*"