Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

additional documentation for MaterialGrid #1760

Merged
merged 4 commits into from
Sep 21, 2021

Conversation

oskooi
Copy link
Collaborator

@oskooi oskooi commented Sep 19, 2021

Additional documentation for the MaterialGrid to mention that nonuniform grids are supported including a new figure showing the actual location of the grid points for a 2d example.

Also includes a fix for an off-by-one bug in the unit test test_material_grid.py in which the resolution of the grid did not exactly match what was specified.

@oskooi
Copy link
Collaborator Author

oskooi commented Sep 20, 2021

For clarity, I added a comment to test_material_grid.py to explain why the number of grid points (Nx and Ny) of the MaterialGrid are chosen the way they are.

@stevengj
Copy link
Collaborator

stevengj commented Sep 20, 2021

Maybe the figure should show "Nx=5" and "Ny=4"

@oskooi
Copy link
Collaborator Author

oskooi commented Sep 20, 2021

Maybe the figure should show "Nx=5" and "Ny=4"

Done.

@stevengj stevengj merged commit 1c6e601 into NanoComp:master Sep 21, 2021
@oskooi oskooi deleted the matgrid_docs branch September 21, 2021 00:12
@smartalecH smartalecH mentioned this pull request Oct 1, 2021
4 tasks
mawc2019 pushed a commit to mawc2019/meep that referenced this pull request Nov 3, 2021
* additional documentation for MaterialGrid

* use a higher resolution design grid and add comment to explain number of grid points

* slight tweaks to wording and update schematic

* annotate Nx and Ny in schematic
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants