DLR-AMR / t8code

Parallel algorithms and data structures for tree-based adaptive mesh refinement (AMR) with arbitrary element shapes.
https://dlr-amr.github.io/t8code/
GNU General Public License v2.0
138 stars 52 forks source link

Remove new forest from adapt callback arguments #1279

Open lukasdreyer opened 2 days ago

lukasdreyer commented 2 days ago

Feature request

Remove non committed new forest from adapt callback, see: https://github.com/DLR-AMR/t8code/blob/facc24c067dfa0b4299af4919a064e3a9770c2e0/src/t8_forest/t8_forest_general.h#L112-L113

Estimated priority Which of these is most applicable (remove the others):

"Priority: medium" Should be solved within half a year

Additional context Add any other context or screenshots about the feature request here.

dutkalex commented 2 days ago

Hi! This is indeed a good idea IMO, as the current API is really confusing and I really can't think of a valid usecase for querying the not-yet-commited forest. I would just like to advocate for this breaking change to be handled through an explicit deprecation process to give users a little bit of time and flexibility. I don't know your policy regarding C++ standards, but if you could ship with both the new API (without the not-yet-commited forest) and the old one, with a [[ deprecated ( "please migrate to the new API" ) ]] attribute (which requires C++14 IIRC), that would be great :)