Added documentation for nearest-neighbor-gradient #166
Conversation
This file contains hidden or 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
Contributor
ariguiba
commented
Apr 22, 2022
ariguiba
commented
- Added section for nearest-neighbor-gradient mapping in the mapping configuration page.
- Added page about how to write gradient data into the interface (under the "Couple Your Code" section).
uekerman
requested changes
Apr 24, 2022
| * `isDataGradientRequired` returns a boolean, indicates if the data corresponding to the ID `dataID` has gradient data. | ||
| * `writeScalarGradientData` writes scalar-valued gradient data, derived in each spatial dimension to the coupling data structure. | ||
| * `ẁriteBlockScalarGradintData` writes multiple scalar gradient data at once, for performance reasons. | ||
| * `writeVectorGradientData` writes vector-valued gradient data to the coupling data structure. The matrix is entered as a 1D-array of each component differentiated first. The parameter `rowsFirst` allows to write the values of the matrix, such as the components are differentiated in the spatial dimensions first. |
There was a problem hiding this comment.
I know, of course, what you mean, but I have troubles understanding the last two sentences.
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.