Skip to content

Commit

Permalink
more documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
whaeck committed Jun 11, 2024
1 parent 2fd4cf2 commit c3109d0
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/scion/math/InterpolationTable/src/processBoundaries.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,12 @@
* In some cases, the boundary values can point to the second point of a jump. While this is not
* an error (we will never interpolate on a jump), we need the boundaries to point to the first
* point in the jump instead of the second one. When this is encountered, the boundary value is
* adjusted.
* adjusted. This change is made silently as it does not constitute an error on the user side.
*
* A jump at the end of the x grid is also not allowed. If a jump is detected at the end of the
* x grid, and if the last y value is zero, then the last point is just removed. A warning is
* issued if this happens to be the case. If the last y value is any other value, an error is
* raised.
*/
static std::tuple< std::vector< double >,
std::vector< double >,
Expand Down

0 comments on commit c3109d0

Please sign in to comment.