Skip to content

Commit

Permalink
add more doc
Browse files Browse the repository at this point in the history
  • Loading branch information
antjeHP committed Dec 17, 2024
1 parent a4d2b4e commit b8c3a67
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
8 changes: 1 addition & 7 deletions src/t8_forest/t8_forest_ghost.cxx
Original file line number Diff line number Diff line change
Expand Up @@ -2041,8 +2041,6 @@ t8_forest_ghost_w_search::search_for_ghost_elements (t8_forest_t forest)
/* Reset the data arrays */
sc_array_reset (&data.face_owners);
sc_array_reset (&data.bounds_per_level);
#ifdef T8_ENABLE_DEBUG
#endif
}

t8_forest_ghost_face::t8_forest_ghost_face (const int version)
Expand Down Expand Up @@ -2104,10 +2102,6 @@ t8_forest_ghost_interface_face_version (t8_forest_ghost_interface_c *ghost_inter
void
t8_forest_ghost_stencil::do_ghost (t8_forest_t forest)
{
/**
* Compute bounds for elements
*/

t8_forest_ghost_init (&forest->ghosts, ghost_type);

t8_locidx_t current_index; // counter over all local elements
Expand Down Expand Up @@ -2136,7 +2130,7 @@ t8_forest_ghost_stencil::do_ghost (t8_forest_t forest)
* \param [in] forest a commit uniform forest which is partitioned
* \param [in] eclass_scheme should fit to the element
* \param [in] element compute owner of this
* \param [out] owner
* \return owner of element
* \note: the function use, that the linear id of the element is the same as the global index
* for example this is true for uniform meshes.
* the function also use, that the forest is partitioned.
Expand Down
6 changes: 5 additions & 1 deletion src/t8_forest/t8_forest_ghost_search.hxx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,11 @@ struct t8_forest_ghost_w_search: public t8_forest_ghost_interface
{
public:
/**
* Constructor
* Constructors:
* there are three ways to construct a object of t8_forest_ghost_w_search
* t8_forest_ghost_w_search (),
* t8_forest_ghost_w_search (t8_forest_search_fn search_function),
* t8_forest_ghost_w_search (const t8_ghost_type_t ghost_type)
*/
t8_forest_ghost_w_search ();

Expand Down

0 comments on commit b8c3a67

Please sign in to comment.