Template Class t8_partition_search
Defined in File t8_forest_search.hxx
Inheritance Relationships
Base Type
public t8_partition_search_base(Class t8_partition_search_base)
Class Documentation
-
template<typename Udata = void>
class t8_partition_search : public t8_partition_search_base A class that performs a search in the partition of a forest and supports the usage of user data.
- Template Parameters:
Udata –
Public Functions
-
inline t8_partition_search(t8_partition_search_element_callback<Udata> element_callback, t8_forest_t forest = nullptr, Udata *user_data = nullptr)
Constructor for the t8_partition_search class. This constructor initializes a t8_partition_search object with the given element callback, forest, and user data. If the forest is not null, it increments the reference count of the forest and asserts that the forest is committed.
- Parameters:
element_callback – [in] A callback function of type t8_partition_search_element_callback<Udata>.
forest – [in] A pointer to a t8_forest_t object. Defaults to nullptr.
user_data – [in] A pointer to a Udata object. Defaults to nullptr.