p4est_ghost.h

Go to the documentation of this file.

/*
  This file is part of p4est.
  p4est is a C library to manage a collection (a forest) of multiple
  connected adaptive quadtrees or octrees in parallel.
 
  Copyright (C) 2010 The University of Texas System
  Additional copyright (C) 2011 individual authors
  Written by Carsten Burstedde, Lucas C. Wilcox, and Tobin Isaac
 
  p4est 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.
 
  p4est 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 p4est; if not, write to the Free Software Foundation, Inc.,
  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
 
#ifndef P4EST_GHOST_H
#define P4EST_GHOST_H
 
#include <p4est.h>
 
SC_EXTERN_C_BEGIN;
 
typedef struct p4est_ghost
{
  int                 mpisize; 
  p4est_topidx_t      num_trees; 
  p4est_connect_type_t btype; 
  sc_array_t          ghosts;
  p4est_locidx_t     *tree_offsets;     
  p4est_locidx_t     *proc_offsets;     
  sc_array_t          mirrors;
  p4est_locidx_t     *mirror_tree_offsets;      
  p4est_locidx_t     *mirror_proc_mirrors;      
  p4est_locidx_t     *mirror_proc_offsets;      
  p4est_locidx_t     *mirror_proc_fronts;       
  p4est_locidx_t     *mirror_proc_front_offsets;        
}
p4est_ghost_t;
 
int                 p4est_ghost_is_valid (p4est_t * p4est,
                                          p4est_ghost_t * ghost);
 
size_t              p4est_ghost_memory_used (p4est_ghost_t * ghost);
 
int                 p4est_quadrant_find_owner (p4est_t * p4est,
                                               p4est_topidx_t treeid,
                                               int face,
                                               const p4est_quadrant_t * q);
 
p4est_ghost_t      *p4est_ghost_new (p4est_t * p4est,
                                     p4est_connect_type_t btype);
 
p4est_ghost_t      *p4est_ghost_new_local (p4est_t * p4est,
                                           p4est_connect_type_t ctype);
 
void                p4est_ghost_destroy (p4est_ghost_t * ghost);
 
ssize_t             p4est_ghost_bsearch (p4est_ghost_t * ghost,
                                         int which_proc,
                                         p4est_topidx_t which_tree,
                                         const p4est_quadrant_t * q);
 
ssize_t             p4est_ghost_contains (p4est_ghost_t * ghost,
                                          int which_proc,
                                          p4est_topidx_t which_tree,
                                          const p4est_quadrant_t * q);
 
p4est_locidx_t      p4est_face_quadrant_exists (p4est_t * p4est,
                                                p4est_ghost_t * ghost,
                                                p4est_topidx_t treeid,
                                                const p4est_quadrant_t * q,
                                                int *face, int *hang,
                                                int *owner_rank);
 
int                 p4est_quadrant_exists (p4est_t * p4est,
                                           p4est_ghost_t * ghost,
                                           p4est_topidx_t treeid,
                                           const p4est_quadrant_t * q,
                                           sc_array_t * exists_arr,
                                           sc_array_t * rproc_arr,
                                           sc_array_t * rquad_arr);
 
int                 p4est_is_balanced (p4est_t * p4est,
                                       p4est_connect_type_t btype);
 
unsigned            p4est_ghost_checksum (p4est_t * p4est,
                                          p4est_ghost_t * ghost);
 
void                p4est_ghost_exchange_data (p4est_t * p4est,
                                               p4est_ghost_t * ghost,
                                               void *ghost_data);
 
typedef struct p4est_ghost_exchange
{
  int                 is_custom;        
  int                 is_levels;        
  p4est_t            *p4est;            
  p4est_ghost_t      *ghost;            
  int                 minlevel;         
  int                 maxlevel;         
  size_t              data_size;        
  void               *ghost_data;       
  int                *qactive;          
  int                *qbuffer;          
  sc_array_t          requests;         
  sc_array_t          sbuffers;         
  sc_array_t          rrequests;        
  sc_array_t          rbuffers;         
}
p4est_ghost_exchange_t;
 
p4est_ghost_exchange_t *p4est_ghost_exchange_data_begin
  (p4est_t * p4est, p4est_ghost_t * ghost, void *ghost_data);
 
void                p4est_ghost_exchange_data_end
  (p4est_ghost_exchange_t * exc);
 
void                p4est_ghost_exchange_custom (p4est_t * p4est,
                                                 p4est_ghost_t * ghost,
                                                 size_t data_size,
                                                 void **mirror_data,
                                                 void *ghost_data);
 
p4est_ghost_exchange_t *p4est_ghost_exchange_custom_begin
  (p4est_t * p4est, p4est_ghost_t * ghost,
   size_t data_size, void **mirror_data, void *ghost_data);
 
void                p4est_ghost_exchange_custom_end
  (p4est_ghost_exchange_t * exc);
 
void                p4est_ghost_exchange_custom_levels (p4est_t * p4est,
                                                        p4est_ghost_t * ghost,
                                                        int minlevel,
                                                        int maxlevel,
                                                        size_t data_size,
                                                        void **mirror_data,
                                                        void *ghost_data);
 
p4est_ghost_exchange_t *p4est_ghost_exchange_custom_levels_begin
  (p4est_t * p4est, p4est_ghost_t * ghost, int minlevel, int maxlevel,
   size_t data_size, void **mirror_data, void *ghost_data);
 
void                p4est_ghost_exchange_custom_levels_end
  (p4est_ghost_exchange_t * exc);
 
void                p4est_ghost_expand (p4est_t * p4est,
                                        p4est_ghost_t * ghost);
 
SC_EXTERN_C_END;
 
#endif /* !P4EST_GHOST_H */