diff --git a/CHANGELOG.md b/CHANGELOG.md index c52e8917..c9bc6893 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,7 @@ - Improve plotting function ## v0.1.10 -- Add backward compatability for "Fix Typo: Culomb -> Coulomb" until the end of the year +- Add backward compatibility for "Fix Typo: Culomb -> Coulomb" until the end of the year ## v0.1.9 - Improvements on the Docs diff --git a/docs/benchmarks/mode_solver_rectangle.py b/docs/benchmarks/mode_solver_rectangle.py index 0a828060..918dad0d 100644 --- a/docs/benchmarks/mode_solver_rectangle.py +++ b/docs/benchmarks/mode_solver_rectangle.py @@ -18,8 +18,8 @@ # %% [markdown] # Reproducing {cite}`Hadley2002`, where the modes of a analytically solvable geometry are calculated. # The error for all modes is calculated to be smaller than $\pm 1 \cdot 10^{-8}$. -# We'll show that we get pretty close, but will stop at a resonable resolution to keep the runtime sensible. -# Getting even higher accurancy will be left open for adaptive refinement. +# We'll show that we get pretty close, but will stop at a reasonable resolution to keep the runtime sensible. +# Getting even higher accuracy will be left open for adaptive refinement. # The results are presented here: # %% tags=["remove-stderr", "hide-input"] diff --git a/docs/julia/heater_3d.jl b/docs/julia/heater_3d.jl index e188611f..994f499a 100644 --- a/docs/julia/heater_3d.jl +++ b/docs/julia/heater_3d.jl @@ -206,7 +206,7 @@ display(figure) # end # ``` # -# And then add to each of the calculate-calls the sovler parameter: +# And then add to each of the calculate-calls the solver parameter: # # ```julia # solver = PETScLinearSolver() diff --git a/docs/julia/thermal_fill.jl b/docs/julia/thermal_fill.jl index b8d467e1..22723c75 100644 --- a/docs/julia/thermal_fill.jl +++ b/docs/julia/thermal_fill.jl @@ -21,7 +21,7 @@ # Optically, these structures are supposed to be far enough away that their influence on the structures can be neglected. # But for thermal considerations, those fill structures can have an impact on the temperature distribution on the chip and thus e.g. on the crosstalk between thermal phase shifters. # As it's computationally challenging to include all the small cuboids in the model (which is especially for the meshing a major challenge), -# a preferable approach is to consider the filled area as a homogenous area of higher thermal conductivity. +# a preferable approach is to consider the filled area as a homogeneous area of higher thermal conductivity. # For this, we calculate the effective thermal conductivity of the filled area by examining a single unit cell. # To have an intuitively understandable problem, we consider half of the unit cell to be filled with a highly thermally conductive material (metal/silicon) surrounded by a material with low thermal conductance (e.g. silicon dioxide) diff --git a/docs/julia/thermal_simple.jl b/docs/julia/thermal_simple.jl index 83389206..5babe7ef 100644 --- a/docs/julia/thermal_simple.jl +++ b/docs/julia/thermal_simple.jl @@ -28,7 +28,7 @@ using Femwell.Thermal # %% [markdown] # We start with setting up a square domain. # For the boundary conditions, we tag the left and the right side of the model. -# Furthermore, we create a function which returns 1 indipendent of the tag which is the parameter to descrie the constants of the simplified model. +# Furthermore, we create a function which returns 1 independent of the tag which is the parameter to describe the constants of the simplified model. # %% tags=["hide-output", "remove-stderr"] domain = (-1.0, 1.0, -1.0, 1.0) @@ -84,7 +84,7 @@ println("The computed value for the average current density is $average_current_ # %% [markdown] -# Using this value, we can caluclate the average power density as +# Using this value, we can calculate the average power density as # # $$ # p = k i^2 diff --git a/docs/julia/waveguide_overlap_integral.jl b/docs/julia/waveguide_overlap_integral.jl index ed8c5b21..c104455c 100644 --- a/docs/julia/waveguide_overlap_integral.jl +++ b/docs/julia/waveguide_overlap_integral.jl @@ -22,7 +22,7 @@ # In order to see how good the estimation of the overlap integral is and to see at which distance the coupling is too weak to be estimated precisely using this methodology, # we calculate the coupling as a function of the distance in the following. # -# For this example we chose two silicon nitride waveguides with a width of 1μm and a thickness of 0.3μm. Those waveguides are ontop of a silicon dioxide layer and air-clad. +# For this example we chose two silicon nitride waveguides with a width of 1μm and a thickness of 0.3μm. Those waveguides are on top of a silicon dioxide layer and air-clad. # %% tags=["hide-input","hide-output"] using PyCall diff --git a/docs/math/coupled_mode_theory.md b/docs/math/coupled_mode_theory.md index 7914abbf..4beacdb1 100644 --- a/docs/math/coupled_mode_theory.md +++ b/docs/math/coupled_mode_theory.md @@ -25,9 +25,9 @@ $$ \vec{H}_\nu(\vec{x})\mathrm{e}^{i\beta x_3} $$ -We use as previously Maxwell's equations, but here we include a spatially dependen pertubation, +We use as previously Maxwell's equations, but here we include a spatially dependen perturbation, which is represented by the additionally included polarization $\mathcal{P}$. -As we investigate a linear system, we assume that the pertubation at the same frequency $\omega$ +As we investigate a linear system, we assume that the perturbation at the same frequency $\omega$ $$ & diff --git a/docs/math/dispersion.md b/docs/math/dispersion.md index 80c74caa..c1af1de4 100644 --- a/docs/math/dispersion.md +++ b/docs/math/dispersion.md @@ -15,7 +15,7 @@ $$ kx_3 = \omega t + \mathrm{const}. $$ -From this we can calulate the velocity of points of constant phase as +From this we can calculate the velocity of points of constant phase as $$ v_p = \frac{\mathrm{d}x_3}{\mathrm{d}t} = \frac{\omega}{k}. @@ -77,7 +77,7 @@ $$ v_g = \frac{\mathrm{d}x_3}{\mathrm{d}t} = \frac{\mathrm{d}\omega}{\mathrm{d}k}. $$ -As the energy of a wave is porportional to its field amplitude squared, +As the energy of a wave is proportional to its field amplitude squared, the energie is concentrated in areas where the envelope is large. Thus, the energy (and therefore also information) travels with the group velocity, @@ -95,7 +95,7 @@ $$ \frac{\mathrm{d}}{\mathrm{d}\omega}v_g^{-1} \neq 0 $$ -A dimensionless coefficient for the group velocity dispersion can be defiend as +A dimensionless coefficient for the group velocity dispersion can be defined as $$ D diff --git a/docs/math/maxwell.md b/docs/math/maxwell.md index b5a7501d..55bd8201 100644 --- a/docs/math/maxwell.md +++ b/docs/math/maxwell.md @@ -142,7 +142,7 @@ $$\begin{aligned} ## Interface between piecewise constant materials -It is instructive to consider the well-known case of an interface $I$ between two dielectric materials, which appear in many devices. We assume an interface between two materials called $1$ with dielectric constant $\varepsilon_1$ and $2$ with dielectric constant $\varepsilon_2$. The surface is defined by the normal vector of the interface $\mathbf{n}_{I}$ and there are no external surface charges or currents. For simplicity, we surpress the dependencies $\left(\mathbf{r},t\right)$ here. +It is instructive to consider the well-known case of an interface $I$ between two dielectric materials, which appear in many devices. We assume an interface between two materials called $1$ with dielectric constant $\varepsilon_1$ and $2$ with dielectric constant $\varepsilon_2$. The surface is defined by the normal vector of the interface $\mathbf{n}_{I}$ and there are no external surface charges or currents. For simplicity, we suppress the dependencies $\left(\mathbf{r},t\right)$ here. All fields can then be split into the component parallel to the interface (hence perpendicular to the normal vector) and perpendicular to the interface (hence parallel to the normal vector). For example we consider the electric field: Define the normalized field vector $\hat{\mathbf{E}}=\mathbf{E}/E$ we split it into @@ -249,7 +249,7 @@ $$\begin{aligned} + \epsilon E_3(\mathbf{r}) = 0 \end{aligned} $$ -Now we have reduced the system to two dimensions by excuting the derivatives. +Now we have reduced the system to two dimensions by executing the derivatives. ### Variational eigenvalue problem In FEM simulations, we solve these equations by a variational ansatz. That means, we take test functions, that are defined on the same space that the wave functions, and search for the optimum. To efficiently solve this, we rewrite the equations from above into an eigenvalue problem. diff --git a/docs/math/schroedinger.md b/docs/math/schroedinger.md index f86dc866..ba889c5d 100644 --- a/docs/math/schroedinger.md +++ b/docs/math/schroedinger.md @@ -113,7 +113,7 @@ $$ \varphi_{1/3}(x) $$ -which can similary be solved using +which can similarly be solved using $$ \varphi_{1/3} = C \sin(k^` x) + D \cos(k^` x) @@ -154,7 +154,7 @@ A \sin(k x) + B \cos(k x), &-L/2<&x&