Documentation: stepsize and Newton Solver

festim-dev / FESTIM

Coupled hydrogen/tritium transport and heat transfer modelling using FEniCS

https://festim.readthedocs.io/en/stable/

Apache License 2.0

78 stars 16 forks source link

Documentation: stepsize and Newton Solver #777

Closed KulaginVladimir closed 3 weeks ago

KulaginVladimir commented 4 weeks ago

Proposed changes

Based on #775, this PR updates docs for Stepsize and adds some information on the usage of a custom NewtonSolver.

Types of changes

What types of changes does your code introduce to FESTIM?

[ ] Bugfix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] Code refactoring
[x] Documentation Update (if none of the other choices apply)
[ ] New tests

Checklist

[ ] Black formatted
[ ] Unit tests pass locally with my changes
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] I have added necessary documentation (if appropriate)

KulaginVladimir commented 4 weeks ago

@RemDelaporteMathurin All comments on text were included. Another warning was added.

I also included another example for a CustomSolver. Let me know what you think.

Concerning the last example, maybe a full simulation case, e.g. Poisson problem or whatever, will be better? Say, I'll add a simple problem with a plot of convergence dynamics similar to this: https://github.com/festim-dev/FESTIM/issues/673#issuecomment-2016071196

codecov[bot] commented 4 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 99.53%. Comparing base (8e0649d) to head (bea2ccc).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #777 +/- ## ======================================= Coverage 99.53% 99.53% ======================================= Files 59 59 Lines 2577 2577 ======================================= Hits 2565 2565 Misses 12 12 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

RemDelaporteMathurin commented 4 weeks ago

Concerning the last example, maybe a full simulation case, e.g. Poisson problem or whatever, will be better?

Maybe a tutorial in the workshop is better?

KulaginVladimir commented 4 weeks ago

If the included examples are fine, I can make a new tutorial task for the workshop.