Extend docu of MatrixFree::initialize_dof_vector() #13484
Merged
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
peterrum
commented
Mar 3, 2022
Comment on lines
+2242
to
+2247
| static_assert(IsBlockVector<VectorType>::value == false, | ||
| "This function is not supported for block vectors."); | ||
|
|
||
| Assert(task_info.n_procs == 1, | ||
| ExcMessage("This function can only be used in serial.")); |
There was a problem hiding this comment.
I also added here some asserts. Hope my understanding about serial non-block vector is correct.
kronbichler
reviewed
Mar 3, 2022
| * defines which component is to be used. | ||
| * Initialize function for a general serial non-block vector. | ||
| * The length of the vector is equal to the total number of | ||
| * degrees in the DoFHandler. Vector entries are initialized with zero. |
There was a problem hiding this comment.
Suggested change
| * degrees in the DoFHandler. Vector entries are initialized with zero. | |
| * degrees of freedom in the DoFHandler. Vector entries are initialized with zero. |
| * @p dof_handler_index defines which component is to be used. | ||
| * | ||
| * @note Serial vectors also include Trilinos and PETSc vectors; however | ||
| * in these cases, MatrixFree has to be in a serial context, i.e., size |
There was a problem hiding this comment.
Suggested change
| * in these cases, MatrixFree has to be in a serial context, i.e., size | |
| * in these cases, MatrixFree has to be used in a serial context, i.e., the size |
peterrum
force-pushed
the
initialize_dof_vector_docu
branch
2 times, most recently
from
df1637d
to
32c8566
Compare
|
@kronbichler I have made the modifications! |
bangerth
reviewed
Mar 3, 2022
Comment on lines
1526
to
1527
| * The length of the vector is equal to the total number of | ||
| * degrees of freedom in the DoFHandler. Vector entries are initialized |
There was a problem hiding this comment.
Maybe say "After a call to this function, the length of the vector..." to make it clear that this function sets the length of the vector to that value?
kronbichler
approved these changes
Mar 8, 2022
There was a problem hiding this comment.
I think we can get this merged if you fix @bangerth's comment.
peterrum
force-pushed
the
initialize_dof_vector_docu
branch
from
32c8566
to
100abfb
Compare
|
@bangerth @kronbichler I have made the modification. |
kronbichler
approved these changes
Mar 9, 2022
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.
follow-up to #13481
FYI @nfehn