jan/gridlock
2
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Clarify shifts documentation

Browse source
This commit is contained in:
Jan Petykiewicz 2017-09-25 00:43:13 -07:00
commit e65f25cc68
1 changed files with 3 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
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.