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

documentation fixes #13334

Merged
merged 2 commits into from
Feb 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 6 additions & 4 deletions include/deal.II/lac/precondition.h
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,12 @@ namespace LinearAlgebra


/**
* No preconditioning. This class helps you, if you want to use a linear
* solver without preconditioning. All solvers in LAC require a
* preconditioner. Therefore, you must use the identity provided here to avoid
* preconditioning. It can be used in the following way:
* This preconditioner implements the identity operator.
* This class can be used you if you want to use a linear
* solver without preconditioning, because all linear solvers
* require the usage of a preconditioner.
*
* It can be used in the following way:
*
* @code
* SolverControl solver_control (1000, 1e-12);
Expand Down
9 changes: 5 additions & 4 deletions include/deal.II/lac/solver_bicgstab.h
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ namespace internal
* Bicgstab algorithm by van der Vorst.
*
* For the requirements on matrices and vectors in order to work with this
* class, see the documentation of the Solver base class.
* class, see the documentation of the SolverBase base class.
*
* Like all other solver classes, this class has a local structure called @p
* AdditionalData which is used to pass additional parameters to the solver,
Expand All @@ -95,10 +95,11 @@ namespace internal
* classes much easier and guarantees that these will continue to work even if
* number or type of the additional parameters for a certain solver changes.
*
* The Bicgstab-method has two additional parameters: the first is a boolean,
* The Bicgstab method has two additional parameters found in the
* SolverBicgstab::AdditionalData struct: the first, @p exact_residual is a boolean,
* deciding whether to compute the actual residual in each step (@p true) or
* to use the length of the computed orthogonal residual (@p false). Note that
* computing the residual causes a third matrix-vector-multiplication, though
* computing the residual causes a third matrix-vector multiplication, though
* no additional preconditioning, in each step. The reason for doing this is,
* that the size of the orthogonalized residual computed during the iteration
* may be larger by orders of magnitude than the true residual. This is due to
Expand All @@ -108,7 +109,7 @@ namespace internal
* works reasonably as well, the flag should be set to @p false in order to
* increase the performance of the solver.
*
* The second parameter is the size of a breakdown criterion. It is difficult
* The second parameter @p breakdown is the size of a breakdown criterion. It is difficult
* to find a general good criterion, so if things do not work for you, try to
* change this value.
*
Expand Down
2 changes: 1 addition & 1 deletion include/deal.II/lac/solver_control.h
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ class SolverControl : public Subscriptor

/**
* This exception is thrown if a function operating on the vector of history
* data of a SolverControl object id called, but storage of history data was
* data of a SolverControl object is called, but storage of history data was
* not enabled by enable_history_data().
*/
DeclException0(ExcHistoryDataRequired);
Expand Down