doc locates behaviour

This commit is contained in:
Sven Oesau 2024-02-02 11:12:36 +01:00
parent 79eaf04bb8
commit ad5807f5e6
2 changed files with 5 additions and 3 deletions

View File

@ -71,7 +71,7 @@ public:
using Construct_root_node_contents = unspecified_type; using Construct_root_node_contents = unspecified_type;
/*! /*!
* \brief Functor which distributes a node's contents to its children. * \brief functor which fills the contents of the nodes children.
* *
* Provides the operator: * Provides the operator:
* `void operator()(typename Tree::Node_index, Tree&, const Point_d&)` * `void operator()(typename Tree::Node_index, Tree&, const Point_d&)`
@ -81,6 +81,7 @@ public:
* It must distribute the contents of the node to each of its children. * It must distribute the contents of the node to each of its children.
* For a tree in which each node contains a span, this may mean rearranging the contents of the original node * For a tree in which each node contains a span, this may mean rearranging the contents of the original node
* and producing spans containing a subset of its contents for each of its children. * and producing spans containing a subset of its contents for each of its children.
* For compatibility with locate, the center of the node is considered to be part of the upper half.
*/ */
using Distribute_node_contents = unspecified_type; using Distribute_node_contents = unspecified_type;

View File

@ -544,9 +544,10 @@ public:
/*! /*!
\brief finds the leaf node which contains a particular point in space. \brief finds the leaf node which contains a particular point in space.
Traverses the orthtree and finds the deepest cell that has a Traverses the orthtree and finds the leaf cell that has a
domain enclosing the point passed. The point passed must be within domain enclosing the point passed. The point passed must be within
the region enclosed by the orthtree (bbox of the root node). the region enclosed by the orthtree (bbox of the root node). The point is contained in the
lower cell of each direction if its coordinate is lower than the center.
\param point query point. \param point query point.