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
Improvements to the NOXSolver class documentation #14791
Conversation
247d80a
to
f703dca
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like that you take the time to update the documentation of the class -- good job!
I have a couple of comments about naming arguments, however.
@singima Have you had time to think about the comments above? |
I have not, Ive been busy with preparing for my dissertation defense on the 30th. Once that's done I'll resume my work on it though! |
Sounds good. It is the season for defenses :-) Good luck! |
3d444fa
to
100c71d
Compare
@bangerth sorry for the delay and for the fact that the PR might look different. Had a minor flub when trying to squash things, but I've made the changes you've suggested! |
* A user function that computes the residual @p f based on the | ||
* current solution @p x. | ||
* A function object that users should supply and that is intended to | ||
* compute the residual `u = F(u)`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* compute the residual `u = F(u)`. | |
* compute the residual $F(u)$. |
I'll make the one left-over change myself in a second. |
No description provided.