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

Added documentation for nearest-neighbor-gradient [cont] #169

Merged
merged 12 commits into from
Jun 24, 2022
Prev Previous commit
Next Next commit
Fix spelling of isDataGradientRequired
  • Loading branch information
davidscn committed May 19, 2022
commit 76a2797be49cb217a1d4e31388e05553ce74a193
4 changes: 2 additions & 2 deletions pages/docs/couple-your-code/couple-your-code-gradient-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Now, we will learn how to write gradient data to the mesh.
For this purpose, we use the following API methods:

```cpp
bool isDataGradientRequired(int dataID);
bool isGradientDataRequired(int dataID);

void writeScalarGradientData (
int dataID,
Expand All @@ -42,7 +42,7 @@ void writeBlockVectorGradientData (
bool rowsFirst = false );
```

* `isDataGradientRequired` returns a boolean, indicates if the data corresponding to the ID `dataID` requires additional gradient data.
* `isGradientDataRequired` returns a boolean, indicates if the data corresponding to the ID `dataID` requires additional gradient data.
* `writeScalarGradientData` writes gradient data corresponding to scalar data values, i.e., a vector containing the spatial derivative of a scalar quantity in each space dimension.
* `ẁriteBlockScalarGradintData` writes multiple scalar gradient data at once (analogue to `writeBlockScalarData`).
* `writeVectorGradientData` writes gradient data corresponding to vector-valued data, i.e, a Jacobian matrix. The matrix is passed as a 1D-array. The parameter `rowsFirst` allows to select whether the 1D-array contains the data column-wise or row-wise.
Expand Down