p8est.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 P8EST_H
#define P8EST_H
 
/* p8est_connectivity.h includes p4est_base.h sc_containers.h */
#include <p8est_connectivity.h>
 
SC_EXTERN_C_BEGIN;
 
#define P8EST_OLD_MAXLEVEL 19   /* old means prior to mid-2020 */
#define P8EST_MAXLEVEL 30
 
#define P8EST_OLD_QMAXLEVEL 18  /* old means prior to mid-2020 */
#define P8EST_QMAXLEVEL 29
 
#define P8EST_ROOT_LEN ((p4est_qcoord_t) 1 << P8EST_MAXLEVEL)
 
#define P8EST_QUADRANT_LEN(l) ((p4est_qcoord_t) 1 << (P8EST_MAXLEVEL - (l)))
 
#define P8EST_QUADRANT_MASK(l) (~(P8EST_QUADRANT_LEN (l) - 1))
 
#define P8EST_LAST_OFFSET(l) (P8EST_ROOT_LEN - P8EST_QUADRANT_LEN (l))
 
typedef struct p8est_quadrant
{
  p4est_qcoord_t      x, y, z;  
  int8_t              level,    
                      pad8;     
  int16_t             pad16;    
  union p8est_quadrant_data
  {
    void               *user_data;      
    long                user_long;      
    int                 user_int;       
    p4est_topidx_t      which_tree;     
    struct
    {
      p4est_topidx_t      which_tree;
      int                 owner_rank;
    }
    piggy1; 
    struct
    {
      p4est_topidx_t      which_tree;
      p4est_topidx_t      from_tree;
    }
    piggy2; 
    struct
    {
      p4est_topidx_t      which_tree;
      p4est_locidx_t      local_num;
    }
    piggy3; 
  }
  p; 
}
p8est_quadrant_t;
 
typedef struct p8est_tree
{
  sc_array_t          quadrants;             
  p8est_quadrant_t    first_desc,            
                      last_desc;             
  p4est_locidx_t      quadrants_offset;      
  p4est_locidx_t      quadrants_per_level[P8EST_MAXLEVEL + 1];
  int8_t              maxlevel;              
}
p8est_tree_t;
 
typedef struct p8est_inspect p8est_inspect_t;
 
typedef struct p8est
{
  sc_MPI_Comm         mpicomm;          
  int                 mpisize,          
                      mpirank;          
  int                 mpicomm_owned;    
  size_t              data_size;        
  void               *user_pointer;     
  long                revision;         
  p4est_topidx_t      first_local_tree; 
  p4est_topidx_t      last_local_tree;  
  p4est_locidx_t      local_num_quadrants;   
  p4est_gloidx_t      global_num_quadrants;  
  p4est_gloidx_t     *global_first_quadrant; 
  p8est_quadrant_t   *global_first_position; 
  p8est_connectivity_t *connectivity; 
  sc_array_t         *trees;          
  sc_mempool_t       *user_data_pool; 
  /*   WARNING: This is NULL if data size
     equals zero. */
  sc_mempool_t       *quadrant_pool;  
  p8est_inspect_t    *inspect;        
}
p8est_t;
 
size_t              p8est_memory_used (p8est_t * p8est);
 
long                p8est_revision (p8est_t * p8est);
 
typedef void        (*p8est_init_t) (p8est_t * p8est,
                                     p4est_topidx_t which_tree,
                                     p8est_quadrant_t * quadrant);
 
typedef int         (*p8est_refine_t) (p8est_t * p8est,
                                       p4est_topidx_t which_tree,
                                       p8est_quadrant_t * quadrant);
 
typedef int         (*p8est_coarsen_t) (p8est_t * p8est,
                                        p4est_topidx_t which_tree,
                                        p8est_quadrant_t * quadrants[]);
 
typedef int         (*p8est_weight_t) (p8est_t * p8est,
                                       p4est_topidx_t which_tree,
                                       p8est_quadrant_t * quadrant);
 
extern void        *P8EST_DATA_UNINITIALIZED;
 
#define P8EST_QUADRANT_INIT(q) \
  ((void) memset ((q), -1, sizeof (p8est_quadrant_t)))
 
void                p8est_qcoord_to_vertex (p8est_connectivity_t *
                                            connectivity,
                                            p4est_topidx_t treeid,
                                            p4est_qcoord_t x,
                                            p4est_qcoord_t y,
                                            p4est_qcoord_t z, double vxyz[3]);
 
p8est_t            *p8est_new (sc_MPI_Comm mpicomm,
                               p8est_connectivity_t * connectivity,
                               size_t data_size,
                               p8est_init_t init_fn, void *user_pointer);
 
void                p8est_destroy (p8est_t * p8est);
 
p8est_t            *p8est_copy (p8est_t * input, int copy_data);
 
void                p8est_reset_data (p8est_t * p8est, size_t data_size,
                                      p8est_init_t init_fn,
                                      void *user_pointer);
 
void                p8est_refine (p8est_t * p8est,
                                  int refine_recursive,
                                  p8est_refine_t refine_fn,
                                  p8est_init_t init_fn);
 
void                p8est_coarsen (p8est_t * p8est,
                                   int coarsen_recursive,
                                   p8est_coarsen_t coarsen_fn,
                                   p8est_init_t init_fn);
 
void                p8est_balance (p8est_t * p8est,
                                   p8est_connect_type_t btype,
                                   p8est_init_t init_fn);
 
void                p8est_partition (p8est_t * p8est,
                                     int allow_for_coarsening,
                                     p8est_weight_t weight_fn);
 
unsigned            p8est_checksum (p8est_t * p8est);
 
unsigned            p8est_checksum_partition (p8est_t * p8est);
 
void                p8est_save (const char *filename, p8est_t * p8est,
                                int save_data);
 
p8est_t            *p8est_load (const char *filename, sc_MPI_Comm mpicomm,
                                size_t data_size, int load_data,
                                void *user_pointer,
                                p8est_connectivity_t ** connectivity);
 
/*@unused@*/
static inline p8est_tree_t *
p8est_tree_array_index (sc_array_t * array, p4est_topidx_t it)
{
  P4EST_ASSERT (array->elem_size == sizeof (p8est_tree_t));
  P4EST_ASSERT (it >= 0 && (size_t) it < array->elem_count);
 
  return (p8est_tree_t *) (array->array +
                           sizeof (p8est_tree_t) * (size_t) it);
}
 
/*@unused@*/
static inline p8est_quadrant_t *
p8est_quadrant_array_index (sc_array_t * array, size_t it)
{
  P4EST_ASSERT (array->elem_size == sizeof (p8est_quadrant_t));
  P4EST_ASSERT (it < array->elem_count);
 
  return (p8est_quadrant_t *) (array->array + sizeof (p8est_quadrant_t) * it);
}
 
static inline p8est_quadrant_t *
p8est_quadrant_array_push_copy (sc_array_t * array,
                                const p8est_quadrant_t *qsrc)
{
  p8est_quadrant_t *q;
 
  P4EST_ASSERT (array->elem_size == sizeof (p8est_quadrant_t));
 
  q = (p8est_quadrant_t *) sc_array_push (array);
  *q = *qsrc;
  return q;
}
 
/*@unused@*/
static inline p8est_quadrant_t *
p8est_quadrant_array_push (sc_array_t * array)
{
  p8est_quadrant_t *q;
 
  P4EST_ASSERT (array->elem_size == sizeof (p8est_quadrant_t));
 
  q = (p8est_quadrant_t *) sc_array_push (array);
  P8EST_QUADRANT_INIT(q);
  return q;
}
 
/*@unused@*/
static inline p8est_quadrant_t *
p8est_quadrant_mempool_alloc (sc_mempool_t * mempool)
{
  P4EST_ASSERT (mempool->elem_size == sizeof (p8est_quadrant_t));
 
  return (p8est_quadrant_t *) sc_mempool_alloc (mempool);
}
 
/*@unused@*/
static inline p8est_quadrant_t *
p8est_quadrant_list_pop (sc_list_t * list)
{
  return (p8est_quadrant_t *) sc_list_pop (list);
}
 
SC_EXTERN_C_END;
 
#endif /* !P8EST_H */