Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
Co-authored-by: Marcel Koch <[email protected]>
  • Loading branch information
yhmtsai and MarcelKoch committed May 17, 2024
1 parent d6946d4 commit fab8ede
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions include/ginkgo/core/solver/multigrid.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -203,9 +203,10 @@ class Multigrid : public EnableLinOp<Multigrid>,
/**
* Custom selector size_type (size_type level, const LinOp* fine_matrix)
* Selector function returns the element index in the vector for any
* given level index and the matrix of the fine level.
* For each level, this function is used to select the smoothers
* and multigrid level generation from the respective lists.
* given level index and the matrix of the fine level. The level 0 is
* the finest level and it is ascending when going coarse levels.
* For each level, this function is used to select the smoothers and
* multigrid level generation from the respective lists.
* For example,
* ```
* [](size_type level, const LinOp* fine_matrix) {
Expand Down

0 comments on commit fab8ede

Please sign in to comment.