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.

Sign up for GitHub

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

Jump to bottom

dsl: Introduce ability to define Functions on Subdomains #2245

Open

EdCaunt wants to merge 66 commits into master from funcs_on_subdims

Contributor

EdCaunt commented Oct 24, 2023 •

edited

Loading

Add Functions on SubDomains functionality.

Remaining todo (for future PRs I think):

MPI in full mode + functions on subdomains leads to an error which I haven't had time to debug

EdCaunt requested review from FabioLuporini and rhodrin

October 24, 2023 16:52

codecov bot commented Oct 24, 2023 •

edited

Loading

Codecov Report

Attention: Patch coverage is 97.47145% with 31 lines in your changes missing coverage. Please review.

Project coverage is 87.53%. Comparing base (caaac39) to head (df89a8d).

Files with missing lines	Patch %	Lines
devito/types/grid.py	84.15%	14 Missing and 2 partials ⚠️
devito/mpi/distributed.py	95.12%	4 Missing and 2 partials ⚠️
devito/types/sparse.py	20.00%	4 Missing ⚠️
devito/data/decomposition.py	97.29%	0 Missing and 1 partial ⚠️
devito/deprecations.py	75.00%	1 Missing ⚠️
tests/test_interpolation.py	99.55%	0 Missing and 1 partial ⚠️
tests/test_mpi.py	98.82%	0 Missing and 1 partial ⚠️
tests/test_subdomains.py	99.79%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2245      +/-   ##
==========================================
+ Coverage   87.30%   87.53%   +0.22%     
==========================================
  Files         238      238              
  Lines       46001    46972     +971     
  Branches     4075     4139      +64     
==========================================
+ Hits        40161    41115     +954     
- Misses       5151     5165      +14     
- Partials      689      692       +3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mloubout added the API label

FabioLuporini reviewed

View reviewed changes

devito/types/grid.py Outdated Show resolved Hide resolved

FabioLuporini reviewed

View reviewed changes

devito/types/grid.py Outdated Show resolved Hide resolved

FabioLuporini reviewed

View reviewed changes

devito/types/grid.py Outdated Show resolved Hide resolved

FabioLuporini reviewed

View reviewed changes

devito/types/grid.py Outdated Show resolved Hide resolved

FabioLuporini reviewed

View reviewed changes

devito/types/grid.py Show resolved Hide resolved

EdCaunt force-pushed the funcs_on_subdims branch from 5fc54ee to a0742f0 Compare

November 30, 2023 15:55

review-notebook-app bot commented Nov 30, 2023

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

EdCaunt force-pushed the funcs_on_subdims branch from 9fe8916 to 1092e78 Compare

December 13, 2023 14:14

EdCaunt added the WIP label

EdCaunt force-pushed the funcs_on_subdims branch from 1d37846 to d462af1 Compare

January 17, 2024 16:15

EdCaunt requested review from FabioLuporini and mloubout

January 17, 2024 16:16

FabioLuporini reviewed

View reviewed changes

Contributor

FabioLuporini left a comment •

edited

Loading

For the amount of changes introduced, I'd prefer to see a lot more new tests.

Shouldn't all (most) of the old tests that @rhodrin wrote be here as well?

devito/mpi/distributed.py Outdated Show resolved Hide resolved

devito/mpi/distributed.py Outdated Show resolved Hide resolved

devito/mpi/distributed.py Outdated Show resolved Hide resolved

devito/mpi/distributed.py Outdated Show resolved Hide resolved

devito/mpi/distributed.py Outdated Show resolved Hide resolved

devito/types/dense.py Outdated Show resolved Hide resolved

devito/types/dense.py Outdated Show resolved Hide resolved

devito/types/equation.py Outdated Show resolved Hide resolved

devito/types/grid.py Outdated Show resolved Hide resolved

devito/types/grid.py Outdated Show resolved Hide resolved

EdCaunt force-pushed the funcs_on_subdims branch from 588c25e to 2cd952e Compare

February 2, 2024 15:26

EdCaunt force-pushed the funcs_on_subdims branch from 2cd952e to 341ee08 Compare

February 23, 2024 14:15

EdCaunt requested a review from FabioLuporini

February 23, 2024 14:15

mloubout reviewed

View reviewed changes

Contributor

mloubout left a comment

quick pass

devito/mpi/distributed.py Outdated Show resolved Hide resolved

devito/mpi/distributed.py Outdated Show resolved Hide resolved

devito/mpi/distributed.py Outdated Show resolved Hide resolved

devito/mpi/distributed.py Outdated Show resolved Hide resolved

devito/types/dimension.py Outdated Show resolved Hide resolved

devito/types/dimension.py Outdated Show resolved Hide resolved

devito/types/grid.py Outdated Show resolved Hide resolved

devito/types/grid.py Outdated Show resolved Hide resolved

tests/test_caching.py Outdated Show resolved Hide resolved

EdCaunt requested a review from mloubout

April 4, 2024 13:01

EdCaunt removed the WIP label

EdCaunt force-pushed the funcs_on_subdims branch from 4268c54 to af06ba9 Compare

April 8, 2024 15:41

georgebisbas reviewed

View reviewed changes

devito/data/decomposition.py Outdated Show resolved Hide resolved

devito/data/decomposition.py Outdated Show resolved Hide resolved

devito/data/decomposition.py Outdated Show resolved Hide resolved

devito/types/grid.py Show resolved Hide resolved

devito/types/grid.py Outdated Show resolved Hide resolved

devito/types/grid.py Outdated Show resolved Hide resolved

devito/types/grid.py Outdated Show resolved Hide resolved

devito/types/grid.py Outdated Show resolved Hide resolved

georgebisbas reviewed

View reviewed changes

tests/test_mpi.py Show resolved Hide resolved

FabioLuporini reviewed

View reviewed changes

devito/operations/interpolators.py Outdated Show resolved Hide resolved

FabioLuporini reviewed

View reviewed changes

devito/operator/operator.py Outdated Show resolved Hide resolved

FabioLuporini reviewed

View reviewed changes

devito/operations/interpolators.py Outdated Show resolved Hide resolved

FabioLuporini reviewed

View reviewed changes

devito/mpi/distributed.py Outdated Show resolved Hide resolved

EdCaunt and others added 21 commits

February 14, 2025 11:08


          examples: Replace plot with animation and tidy up

1b0e914


          examples: Introduce acoustic-elastic coupling example

c410bb3


          examples: Coupling tweaks

7a19f63


          examples: Fix variable-rho coupling

5a49a86


          examples: Reflection investigation

7e1aede


          examples: Finished acoustic-elastic coupling example

0cbc357


          examples: Minor tidy up

42c53e8


          examples: Add note on legacy SubDomain API to tutorial notebook

d83b370


          dsl: Add handling for missing subdomain specification in Eq

1db2ec3


          examples: Add nbval ignores

db773b9


          examples: Add nbval skip

c81b78a


          examples: Add rtol and atol to norm checks


          misc: Adjustments and tidy up

7de8801


          dsl: Fixed oversight with differentiable

4f0df08


          examples: Make norms more reliable

4ab500c


          examples: Point users to custom subdomain init examples


          examples: Clean notebook

5c4142a


          docs: Fix SegFault in notebook 7

d2fce3b


          compiler: Fix bad loop in data.py

1a16116


          dsl: Revise interpolation dimensions extraction

32e0a19


          examples: Update plot extent

438b5f7

EdCaunt force-pushed the funcs_on_subdims branch from a3706d7 to 438b5f7 Compare

February 14, 2025 11:09

ZoeLeibowitz reviewed

View reviewed changes

examples/userapi/07_functions_on_subdomains.ipynb Show resolved Hide resolved

examples/userapi/07_functions_on_subdomains.ipynb Show resolved Hide resolved


          misc: Notebook tidy up

8acecc7

FabioLuporini reviewed

View reviewed changes

devito/operations/interpolators.py

                           extra = filter_ordered([i for v in extras for i in v.dimensions
-                                                  if i not in self._gdims and
+                                                  if i not in gdims and

Contributor

FabioLuporini Feb 14, 2025

why didn't the previous version break any test?

devito/operations/interpolators.py Outdated

+                          for v in extras:
+                              try:
+                                  egrid = v.grid
+                                  if egrid is not None and egrid.is_SubDomain:

Contributor

FabioLuporini Feb 14, 2025

egrid is not None isn't needed

the line egrid = v.grid can probably be dropped too

devito/operations/interpolators.py Outdated

                   def _augment_implicit_dims(self, implicit_dims, extras=None):
                       if extras is not None:
+                          # If variables are defined on a SubDomain of the Grid, then temprarily add

Contributor

FabioLuporini Feb 14, 2025

(nitpicking, just a wording thing) this comments reads odd, nothing is really to added to self._gdims

devito/operations/interpolators.py Outdated

                   def _augment_implicit_dims(self, implicit_dims, extras=None):
                       if extras is not None:
+                          # If variables are defined on a SubDomain of the Grid, then temprarily add
+                          # their dimensions to self._gdims for the purpose of checking if extra
+                          # dimensions have been included.

Contributor

FabioLuporini Feb 14, 2025

no full stop needed

devito/types/equation.py Show resolved Hide resolved

devito/types/grid.py

+                      self._shape_local = tuple(0 if i.is_empty else i.end-i.start + 1 if i.is_Interval
+                                                else 1 for i in self.distributor.intervals)
+                  def __subdomain_finalize_legacy__(self, grid):

Contributor

FabioLuporini Feb 14, 2025

if so, we need to do it a way that does not pollute the output log (e.g. emitting one warning per SubDomain instance ... something you can obtain easily by adding a new handler here https://github.com/devitocodes/devito/blob/master/devito/deprecations.py)

EdCaunt added 5 commits

February 14, 2025 13:45


          compiler: Adjust dimension search in interpolation/injection

5adcfa5


          examples: Update the elastic damping

3b6c877


          tests: Add deprecation warning for old subdomain API and update tests

3717e2e


          examples: Update notebook norm

0e33a0c


          tests: Fix typo in interpolation and shore up tests

df89a8d

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

FabioLuporini FabioLuporini left review comments

mloubout mloubout left review comments

georgebisbas georgebisbas left review comments

ZoeLeibowitz ZoeLeibowitz left review comments

rhodrin Awaiting requested review from rhodrin

JDBetteridge Awaiting requested review from JDBetteridge

Labels

API