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

Improvements to the NOXSolver class documentation #14791

Merged
merged 1 commit into from Apr 11, 2023

Conversation

singimarson
Copy link
Contributor

No description provided.

include/deal.II/trilinos/nox.h Outdated Show resolved Hide resolved
include/deal.II/trilinos/nox.h Outdated Show resolved Hide resolved
@singimarson singimarson force-pushed the NOX_edits branch 2 times, most recently from 247d80a to f703dca Compare February 13, 2023 16:38
Copy link
Member

@bangerth bangerth left a 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.

include/deal.II/trilinos/nox.h Outdated Show resolved Hide resolved
include/deal.II/trilinos/nox.h Show resolved Hide resolved
include/deal.II/trilinos/nox.h Outdated Show resolved Hide resolved
include/deal.II/trilinos/nox.h Outdated Show resolved Hide resolved
@bangerth
Copy link
Member

@singima Have you had time to think about the comments above?

@singimarson
Copy link
Contributor Author

@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!

@bangerth
Copy link
Member

Sounds good. It is the season for defenses :-)

Good luck!

@singimarson singimarson reopened this Apr 11, 2023
@singimarson
Copy link
Contributor Author

@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)`.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* compute the residual `u = F(u)`.
* compute the residual $F(u)$.

@bangerth bangerth merged commit 2f73a15 into dealii:master Apr 11, 2023
11 of 14 checks passed
@bangerth
Copy link
Member

I'll make the one left-over change myself in a second.

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

Successfully merging this pull request may close these issues.

None yet

4 participants