Browse Source

Clarify shifts documentation

tags/v0.3
Jan Petykiewicz 3 years ago
parent
commit
e65f25cc68
1 changed files with 3 additions and 0 deletions
  1. +3
    -0
      gridlock/grid.py

+ 3
- 0
gridlock/grid.py View File

@@ -38,6 +38,9 @@ class Grid(object):
from the properties named as above, or get them for a given grid by using the
self.shifted_*xyz(which_shifts) functions.

The sizes of adjacent cells are taken into account when applying shifts. The
total shift for each edge is chosen using (shift * dx_of_cell_being_moved_through).

It is tricky to determine the size of the right-most cell after shifting,
since its right boundary should shift by shifts[i][a] * dxyz[a][dxyz[a].size],
where the dxyz element refers to a cell that does not exist.


Loading…
Cancel
Save