Improve documentation for MultigridTransfer::copy_to_mg #5104
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tjhei
requested changes
Sep 18, 2017
| @@ -154,7 +154,9 @@ class MGLevelGlobalTransfer : public MGTransferBase<VectorType> | |||
|
|
|||
| /** | |||
| * Transfer from a vector on the global grid to vectors defined on each of | |||
| * the levels separately, i.a. an @p MGVector. | |||
| * the levels separately, i.e. a @p MGVector, for the active degrees of | |||
There was a problem hiding this comment.
You can go further and say that in a globally refined mesh without renumbering, it is a one-to-one copy to the finest level vector.
| @@ -154,7 +154,9 @@ class MGLevelGlobalTransfer : public MGTransferBase<VectorType> | |||
|
|
|||
| /** | |||
| * Transfer from a vector on the global grid to vectors defined on each of | |||
| * the levels separately, i.a. an @p MGVector. | |||
| * the levels separately, i.e. a @p MGVector, for the active degrees of | |||
There was a problem hiding this comment.
What are you trying to say with MGVector? I don't think this exists as a type? Do you mean "multilevel vector"?
masterleinad
force-pushed
the
doc_copy_to_mg
branch
from
4d4f52d
to
bea0183
Compare
|
@tjhei Here you go. |
typo in "untouched". Nitpicking: It only is a plain copy if you did not renumber the DoFs. (but I don't care if you want to fix this). |
masterleinad
force-pushed
the
doc_copy_to_mg
branch
from
bea0183
to
543282d
Compare
|
Fixed the typo. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Clarify that
copy_to_mgonly acts on active degrees of freedoms. The current documentation led to the assumption that this function would do similar things asrestrict_addfor theMultigridTransferclasses.