t8_forest_ghost.h

Go to the documentation of this file.

/*
  This file is part of t8code.
  t8code is a C library to manage a collection (a forest) of multiple
  connected adaptive space-trees of general element classes in parallel.
 
  Copyright (C) 2015 the developers
 
  t8code is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.
 
  t8code is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with t8code; if not, write to the Free Software Foundation, Inc.,
  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
 
/* TODO: begin documenting this file: make doxygen 2>&1 | grep t8_forest_ghost */
 
#ifndef T8_FOREST_GHOST_H
#define T8_FOREST_GHOST_H
 
#include <t8.h>
#include <t8_forest/t8_forest_types.h>
 
T8_EXTERN_C_BEGIN ();
 
/* We enumerate the ghost trees by 0, 1, ..., num_ghost_trees - 1
 * In the context of a forest we add the number of local trees as offset,
 * so that we have a range of trees:
 *
 * | 0, 1, ..., num_trees - 1 | num_trees, ..., num_trees + num_ghosts - 1 |
 *
 *      local trees                           ghost trees
 *
 * For the funcions in this header an argument lghost_tree always
 * means a number 0 <= lghost_tree < num_ghost_trees - 1
 */
 
/* TODO: comment */
void                t8_forest_ghost_init (t8_forest_ghost_t *pghost,
                                          t8_ghost_type_t ghost_type);
 
/* TODO: document */
/* returns 0 if ghost structure doesnt exist */
t8_locidx_t         t8_forest_ghost_num_trees (t8_forest_t forest);
 
t8_locidx_t         t8_forest_ghost_get_tree_element_offset (t8_forest_t
                                                             forest,
                                                             t8_locidx_t
                                                             lghost_tree);
 
/* TODO: document */
t8_locidx_t         t8_forest_ghost_tree_num_elements (t8_forest_t forest,
                                                       t8_locidx_t
                                                       lghost_tree);
 
t8_element_array_t *t8_forest_ghost_get_tree_elements (t8_forest_t forest,
                                                       t8_locidx_t
                                                       lghost_tree);
 
t8_locidx_t         t8_forest_ghost_get_ghost_treeid (t8_forest_t forest,
                                                      t8_gloidx_t gtreeid);
 
/* TODO: document */
t8_eclass_t         t8_forest_ghost_get_tree_class (t8_forest_t forest,
                                                    t8_locidx_t lghost_tree);
 
t8_gloidx_t         t8_forest_ghost_get_global_treeid (t8_forest_t forest,
                                                       t8_locidx_t
                                                       lghost_tree);
 
/* TODO: document */
t8_element_t       *t8_forest_ghost_get_element (t8_forest_t forest,
                                                 t8_locidx_t lghost_tree,
                                                 t8_locidx_t lelement);
 
int                *t8_forest_ghost_get_remotes (t8_forest_t forest,
                                                 int *num_remotes);
 
t8_locidx_t         t8_forest_ghost_remote_first_tree (t8_forest_t forest,
                                                       int remote);
 
t8_locidx_t         t8_forest_ghost_remote_first_elem (t8_forest_t forest,
                                                       int remote);
 
void                t8_forest_ghost_ref (t8_forest_ghost_t ghost);
 
void                t8_forest_ghost_unref (t8_forest_ghost_t *pghost);
 
void                t8_forest_ghost_destroy (t8_forest_ghost_t *pghost);
 
void                t8_forest_ghost_create (t8_forest_t forest);
 
void                t8_forest_ghost_create_balanced_only (t8_forest_t forest);
 
/* experimental version using the ghost_v3 algorithm */
void                t8_forest_ghost_create_topdown (t8_forest_t forest);
 
T8_EXTERN_C_END ();
 
#endif /* !T8_FOREST_GHOST_H! */