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

Allow for cylindrical and spherical shell domains #3237

Merged
merged 11 commits into from
Aug 9, 2023

Conversation

brosaplanella
Copy link
Sponsor Member

@brosaplanella brosaplanella commented Aug 4, 2023

Description

Now we only throw and error for non zero-Neumann bcs if the boundary is at r = 0, which means cylindrical and spherical shells can be solved with any boundary condition. Also added some integration tests to check it works.

Fixes #3115

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All tests pass: $ python run-tests.py --all (or $ nox -s tests)
  • The documentation builds: $ python run-tests.py --doctest (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ python run-tests.py --quick (or $ nox -s quick).

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@codecov
Copy link

codecov bot commented Aug 4, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (b6d4f3f) 99.71% compared to head (67dcb1c) 99.71%.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3237   +/-   ##
========================================
  Coverage    99.71%   99.71%           
========================================
  Files          248      248           
  Lines        18861    18861           
========================================
  Hits         18807    18807           
  Misses          54       54           
Files Changed Coverage Δ
pybamm/discretisations/discretisation.py 99.78% <100.00%> (ø)

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

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@valentinsulzer valentinsulzer changed the base branch from develop to 2plus1D-paper-plots August 9, 2023 03:31
@valentinsulzer valentinsulzer changed the base branch from 2plus1D-paper-plots to develop August 9, 2023 03:31
@brosaplanella
Copy link
Sponsor Member Author

This is now ready to review

spatial_methods = {"domain": pybamm.FiniteVolume()}
disc = pybamm.Discretisation(mesh, spatial_methods)
disc.process_model(model)
solver = pybamm.CasadiAlgebraicSolver()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a bit strange to have a solver inside this test. Not the end of the world but would be better without, so that this is really a unit test (and not dependent on the solver). Is there another way to test the same thing?

@brosaplanella
Copy link
Sponsor Member Author

It's an integration test though, isn't it fine to have a solver there?

@valentinsulzer
Copy link
Member

Ah yes true, then it's fine

@valentinsulzer valentinsulzer merged commit a80bca5 into develop Aug 9, 2023
22 checks passed
@valentinsulzer valentinsulzer deleted the issue-3115-shell-domains branch August 9, 2023 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow for cylindrical & spherical shell domains
2 participants