unit test and documentation for MaterialGrid #1508
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stevengj
reviewed
Feb 24, 2021
stevengj
reviewed
Feb 24, 2021
stevengj
reviewed
Feb 24, 2021
stevengj
reviewed
Feb 24, 2021
stevengj
reviewed
Feb 24, 2021
doc/docs/Python_User_Interface.md
Outdated
| function defining an interface at $u(x)=\eta$ with a smoothing factor $\beta$ ($\beta=\infty$ gives an unsmoothed, | ||
| discontinuous interface). The projection operator is `tanh(beta*eta) + tanh(beta*(x-eta))) / (tanh(beta*eta) + | ||
| tanh(beta*(1-eta)))` involving the parameters `beta` ($\beta$: "smoothness" of the turn on) and `eta` ($\eta$: | ||
| erosion/dilation). The level set provides a general approach for defining a *discontinuous* representation of the otherwise |
There was a problem hiding this comment.
s/representation of the otherwise/function from otherwise/
stevengj
reviewed
Feb 24, 2021
doc/docs/Python_User_Interface.md
Outdated
| scheme with properties `subpixel_maxeval` and `subpixel_tol` which can be specified using the [`Simulation`](#Simulation) | ||
| constructor. | ||
|
|
||
| Grids which are symmetric (e.g., mirror, rotation) must be explicitly defined. This requires overlapping a given |
There was a problem hiding this comment.
s/This requires/One way to implement this is by/
stevengj
reviewed
Feb 24, 2021
doc/docs/Python_User_Interface.md
Outdated
| constructor. | ||
|
|
||
| Grids which are symmetric (e.g., mirror, rotation) must be explicitly defined. This requires overlapping a given | ||
| `MaterialGrid` object with a symmetrized copy of itself. In this case, the overlapping grid points are combined using |
There was a problem hiding this comment.
In the case of spatially overlapping MaterialGrid objects (with no intervening objects), any overlapping points are computed using
stevengj
reviewed
Feb 24, 2021
doc/docs/Python_User_Interface.md
Outdated
|
|
||
| Grids which are symmetric (e.g., mirror, rotation) must be explicitly defined. This requires overlapping a given | ||
| `MaterialGrid` object with a symmetrized copy of itself. In this case, the overlapping grid points are combined using | ||
| the method `grid_type` which is one of `"U_MIN"` (minimum of two grid values), `"U_PROD"` (product), `"U_SUM"` (sum), |
There was a problem hiding this comment.
minimum of the overlapping grid values
There was a problem hiding this comment.
U_SUM is the mean, not the sum
There was a problem hiding this comment.
Maybe it should be renamed to U_MEAN
stevengj
reviewed
Feb 24, 2021
| Creates a `MaterialGrid` object. | ||
|
|
||
| The input are two materials `medium1` and `medium2` which are linearly interpolated at each grid point using | ||
| a NumPy array `design_parameters` of size `grid_size` (a 3-tuple or `Vector3` of integers) with floating-point values in |
There was a problem hiding this comment.
Maybe call it weights and a "weight function"
stevengj
reviewed
Feb 24, 2021
python/tests/material_grid.py
Outdated
| self.assertAlmostEqual(freq_ref, freq_matgrid[-1], 2) | ||
|
|
||
| ## verify that the relative error is decreasing with increasing resolution | ||
| self.assertLess(abs(freq_matgrid[1]-freq_ref),abs(freq_matgrid[0]-freq_ref)) |
There was a problem hiding this comment.
We really should check that it's less by some factor, say by a factor of 3 (ideally 4, but…)
bencbartlett
pushed a commit
to bencbartlett/meep
that referenced
this pull request
Sep 9, 2021
* unit test and documentation for MaterialGrid * fixes and tweaks * more fixes * fix test
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a unit test and documentation to the User Interface for
MaterialGrid.A test (
python/tests/material_grid.py) was added in #1242 but it does not seem to actually be doing anything (other than verify that an instance of theMaterialGridobject can be instantiated). The test added in this PR is based on the resonant mode calculation from #1500 which was later modified to use subpixel smoothing in #1503.Separately, it might be useful to rename the member variable
design_parameterof theMaterialGridclass to e.g.density_gridto make it more general since usage of theMaterialGriddoes not necessarily always have to involve the adjoint solver.