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.

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

In step-77, also talk about the other nonlinear solver packages we support. #15128

Merged
merged 1 commit into from
May 8, 2023
Merged

In step-77, also talk about the other nonlinear solver packages we support. #15128

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 13 additions & 1 deletion examples/step-77/doc/intro.dox
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,18 @@ provides a vast amount of finite-element functionality, %SUNDIALS'
KINSOL package provides a vast amount of nonlinear solver
functionality, and we better use it.

@note While this program uses SUNDIAL's KINSOL package as the engine to
solve nonlinear problems, KINSOL is not the only option you have.
deal.II also has interfaces to PETSc's SNES collection of algorithms
(see the PETScWrappers::NonlinearSolver class) as well as to
the Trilinos NOX package (see the TrilinosWrappers::NOXSolver class)
that provide not only very similar functionality, but also a largely
identical interface. If you have installed a version of deal.II that
is configured to use either PETSc or Trilinos, but not SUNDIALS,
then it is not too difficult to switch this program to use either
of the former two packages instead: Basically everything that we
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
of the former two packages instead: Basically everything that we
of the former two packages instead: basically everything that we

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't think this is actually incorrect: The sentence that follows the colon is a complete sentence, and can consequently be capitalized. (See what I'm doing here? ;-)

I agree that the first word should not be capitalized if what follows is not a complete sentence: a list, or half sentence, for example.

Copy link
Contributor

Choose a reason for hiding this comment

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

american vs british english (and the rest of the other languages based on the alphabet ...)

say and do below will also be true and work for these other packages!


<h3> How deal.II interfaces with KINSOL </h3>

Expand Down Expand Up @@ -237,7 +249,7 @@ problem as follows:
independent, and can be broken into separate functions.

There is an assumption here that whenever KINSOL asks for a linear
solver with the (approximation of the) Jacobian, that this will be for
solver with the (approximation of the) Jacobian, that this will be
for an update $\delta U$ (which has zero boundary values), a multiple
of which will be added to the solution (which already has the right
boundary values). This may not be true and if so, we might have to
Expand Down