Skip to content

Commit

Permalink
Updating user documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
SamNewcome committed May 24, 2024
1 parent ca661bc commit 415a44b
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/userdoc/CustomApplications.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ The critical elements to implement are:
Indicator functions that return a `std::array` of all `AttributeNames`, which the functor needs to load from the particle to perform the calculation, as well as which fields are written.
- `isRelevantForTuning()`:
Indicator function to tell the tuning mechanism if iterations using this functor should be considered or not.
- `getNumFLOPs()` and `getHitRate()`:
These functions return the number of FLOPs per traversal of the container and the hit-rate (the ratio of distance calculations
that lead to functor interactions e.g. force contributions.) These functions are only needed if `AUTOPAS_LOG_FLOPS` is
set to `ON`, and can be set to return 0 if you are happy without these statistics.

As an example see [`SPHCalcDensityFunctor`](https://github.com/AutoPas/AutoPas/blob/master/applicationLibrary/sph/SPHLibrary/SPHCalcDensityFunctor.h).

Expand Down

0 comments on commit 415a44b

Please sign in to comment.