Skip to content

Commit

Permalink
add note in docs for array slices that output is always centered on t…
Browse files Browse the repository at this point in the history
…he Yee cell (#2605)
  • Loading branch information
oskooi authored Aug 9, 2023
1 parent cd9a7eb commit 4ec4292
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions doc/docs/Python_User_Interface.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -585,6 +585,7 @@ The output functions described above write the data for the fields and materials
@@ Simulation.get_array @@
@@ Simulation.get_dft_array @@

Note that although the various field components are stored at different places in the [Yee lattice](Yee_Lattice.md), internally the DFT fields are all linearly interpolated to the same grid: to the points at the *centers* of the Yee cells, i.e. $(i+0.5,j+0.5,k+0.5)\cdotΔ$ in 3d. Additionally, `get_array` interpolates all fields to the center of the Yee cell. In summary, the output of `get_array` and `get_dft_array` is always centered on the Yee cell.

#### Array Metadata

Expand Down

0 comments on commit 4ec4292

Please sign in to comment.