t8_forest_partition.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_partition */
 
#ifndef T8_FOREST_PARTITION_H
#define T8_FOREST_PARTITION_H
 
#include <t8.h>
#include <t8_forest.h>
 
T8_EXTERN_C_BEGIN ();
/* TODO: document */
void                t8_forest_partition (t8_forest_t forest);
 
void                t8_forest_partition_create_offsets (t8_forest_t forest);
 
int                 t8_forest_partition_next_nonempty_rank (t8_forest_t
                                                            forest, int rank);
 
void                t8_forest_partition_create_first_desc (t8_forest_t
                                                           forest);
 
void                t8_forest_partition_create_tree_offsets (t8_forest_t
                                                             forest);
 
/* TODO: document */
/* data_in has length forest_from->num_local_elements
 * data_out   --  --  forest_to->num_local_elements
 */
void                t8_forest_partition_data (t8_forest_t forest_from,
                                              t8_forest_t forest_to,
                                              const sc_array_t *data_in,
                                              sc_array_t *data_out);
 
T8_EXTERN_C_END ();
 
#endif /* !T8_FOREST_PARTITION_H! */