p8est_connectivity.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_CONNECTIVITY_H
#define P8EST_CONNECTIVITY_H
 
#include <sc_io.h>
#include <p4est_base.h>
 
SC_EXTERN_C_BEGIN;
 
#define P8EST_DIM 3
#define P8EST_FACES (2 * P8EST_DIM)
#define P8EST_CHILDREN 8
#define P8EST_HALF (P8EST_CHILDREN / 2)
#define P8EST_EDGES 12
#define P8EST_INSUL 27
 
#define P8EST_ONLY_P8_LAND(x) && (x)
 
#define P8EST_ONLY_P8_COMMA(x) , (x)
 
#define P8EST_DIM_POW(a) ((a) * (a) * (a))
 
#define P8EST_FTRANSFORM 9
 
#define P8EST_STRING "p8est"
 
#define P8EST_ONDISK_FORMAT 0x3000009
 
typedef enum
{
  /* make sure to have different values 2D and 3D */
  P8EST_CONNECT_SELF = 30,      
  P8EST_CONNECT_FACE = 31,      
  P8EST_CONNECT_EDGE = 32,      
  P8EST_CONNECT_ALMOST = P8EST_CONNECT_EDGE,    
  P8EST_CONNECT_CORNER = 33,    
  P8EST_CONNECT_FULL = P8EST_CONNECT_CORNER     
}
p8est_connect_type_t;
 
#ifdef P4EST_BACKWARD_DEALII
typedef p8est_connect_type_t p8est_balance_type_t;
#endif
 
typedef enum
{
  P8EST_CONN_ENCODE_NONE = SC_IO_ENCODE_NONE,
  P8EST_CONN_ENCODE_LAST        
}
p8est_connectivity_encode_t;
 
int                 p8est_connect_type_int (p8est_connect_type_t btype);
 
const char         *p8est_connect_type_string (p8est_connect_type_t btype);
 
typedef struct p8est_connectivity
{
  p4est_topidx_t      num_vertices; 
  p4est_topidx_t      num_trees;    
  p4est_topidx_t      num_edges;    
  p4est_topidx_t      num_corners;  
  double             *vertices;     
  p4est_topidx_t     *tree_to_vertex; 
  size_t              tree_attr_bytes;  
  char               *tree_to_attr;     
  p4est_topidx_t     *tree_to_tree; 
  int8_t             *tree_to_face; 
  p4est_topidx_t     *tree_to_edge; 
  p4est_topidx_t     *ett_offset; 
  p4est_topidx_t     *edge_to_tree; 
  int8_t             *edge_to_edge; 
  p4est_topidx_t     *tree_to_corner; 
  p4est_topidx_t     *ctt_offset; 
  p4est_topidx_t     *corner_to_tree; 
  int8_t             *corner_to_corner; 
}
p8est_connectivity_t;
 
size_t              p8est_connectivity_memory_used (p8est_connectivity_t *
                                                    conn);
 
typedef struct
{
  p4est_topidx_t      ntree; 
  int8_t              nedge; 
  int8_t              naxis[3]; 
  int8_t              nflip; 
  int8_t              corners; 
}
p8est_edge_transform_t;
 
typedef struct
{
  int8_t              iedge; 
  sc_array_t          edge_transforms; 
}
p8est_edge_info_t;
 
typedef struct
{
  p4est_topidx_t      ntree; 
  int8_t              ncorner; 
}
p8est_corner_transform_t;
 
typedef struct
{
  p4est_topidx_t      icorner; 
  sc_array_t          corner_transforms; 
}
p8est_corner_info_t;
 
typedef struct
{
  p8est_connect_type_t neighbor_type; 
  p4est_topidx_t      neighbor;   
  int8_t              index_self; 
  int8_t              index_neighbor; 
  int8_t              perm[P8EST_DIM]; 
  int8_t              sign[P8EST_DIM]; 
  p4est_qcoord_t      origin_self[P8EST_DIM]; 
  p4est_qcoord_t      origin_neighbor[P8EST_DIM]; 
}
p8est_neighbor_transform_t;
 
/* *INDENT-OFF* */
 
void                p8est_neighbor_transform_coordinates
                      (const p8est_neighbor_transform_t * nt,
                       const p4est_qcoord_t self_coords[P8EST_DIM],
                       p4est_qcoord_t neigh_coords[P8EST_DIM]);
 
void                p8est_neighbor_transform_coordinates_reverse
                      (const p8est_neighbor_transform_t * nt,
                       const p4est_qcoord_t neigh_coords[P8EST_DIM],
                       p4est_qcoord_t self_coords[P8EST_DIM]);
 
void                p8est_connectivity_get_neighbor_transforms
                      (p8est_connectivity_t *conn,
                       p4est_topidx_t tree_id,
                       p8est_connect_type_t boundary_type,
                       int boundary_index,
                       sc_array_t *neighbor_transform_array);
 
/* *INDENT-ON* */
 
extern const int    p8est_face_corners[6][4];
 
extern const int    p8est_face_edges[6][4];
 
extern const int    p8est_face_dual[6];
 
/* face corners */
 
extern const int    p8est_face_permutations[8][4];
 
extern const int    p8est_face_permutation_sets[3][4];
 
extern const int    p8est_face_permutation_refs[6][6];
 
/* face edges */
 
extern const int    p8est_face_edge_permutations[8][4];
 
extern const int    p8est_face_edge_permutation_sets[3][4];
 
extern const int    p8est_edge_faces[12][2];
 
extern const int    p8est_edge_corners[12][2];
 
extern const int    p8est_edge_edge_corners[12][8];
 
extern const int    p8est_edge_face_corners[12][6][2];
 
extern const int    p8est_edge_face_edges[12][6];
 
extern const int    p8est_corner_faces[8][3];
 
extern const int    p8est_corner_edges[8][3];
 
extern const int    p8est_corner_face_corners[8][6];
 
extern const int    p8est_corner_edge_corners[8][12];
 
extern const int    p8est_child_edge_faces[8][12];
 
extern const int    p8est_child_corner_faces[8][8];
 
extern const int    p8est_child_corner_edges[8][8];
 
int                 p8est_connectivity_face_neighbor_corner_set
  (int c, int f, int nf, int set);
 
int                 p8est_connectivity_face_neighbor_face_corner
  (int fc, int f, int nf, int o);
 
int                 p8est_connectivity_face_neighbor_corner
  (int c, int f, int nf, int o);
 
int                 p8est_connectivity_face_neighbor_face_edge
  (int fe, int f, int nf, int o);
 
int                 p8est_connectivity_face_neighbor_edge
  (int e, int f, int nf, int o);
 
int                 p8est_connectivity_edge_neighbor_edge_corner
  (int ec, int o);
 
int                 p8est_connectivity_edge_neighbor_corner
  (int c, int e, int ne, int o);
 
p8est_connectivity_t *p8est_connectivity_new (p4est_topidx_t num_vertices,
                                              p4est_topidx_t num_trees,
                                              p4est_topidx_t num_edges,
                                              p4est_topidx_t num_ett,
                                              p4est_topidx_t num_corners,
                                              p4est_topidx_t num_ctt);
 
p8est_connectivity_t *p8est_connectivity_new_copy (p4est_topidx_t
                                                   num_vertices,
                                                   p4est_topidx_t num_trees,
                                                   p4est_topidx_t num_edges,
                                                   p4est_topidx_t num_corners,
                                                   const double *vertices,
                                                   const p4est_topidx_t * ttv,
                                                   const p4est_topidx_t * ttt,
                                                   const int8_t * ttf,
                                                   const p4est_topidx_t * tte,
                                                   const p4est_topidx_t *
                                                   eoff,
                                                   const p4est_topidx_t * ett,
                                                   const int8_t * ete,
                                                   const p4est_topidx_t * ttc,
                                                   const p4est_topidx_t *
                                                   coff,
                                                   const p4est_topidx_t * ctt,
                                                   const int8_t * ctc);
 
p8est_connectivity_t *p8est_connectivity_bcast (p8est_connectivity_t *
                                                conn_in, int root,
                                                sc_MPI_Comm comm);
 
void                p8est_connectivity_destroy (p8est_connectivity_t *
                                                connectivity);
 
void                p8est_connectivity_set_attr (p8est_connectivity_t * conn,
                                                 size_t bytes_per_tree);
 
int                 p8est_connectivity_is_valid (p8est_connectivity_t *
                                                 connectivity);
 
int                 p8est_connectivity_is_equal (p8est_connectivity_t * conn1,
                                                 p8est_connectivity_t *
                                                 conn2);
 
int                 p8est_connectivity_sink (p8est_connectivity_t * conn,
                                             sc_io_sink_t * sink);
 
sc_array_t         *p8est_connectivity_deflate (p8est_connectivity_t * conn,
                                                p8est_connectivity_encode_t
                                                code);
 
int                 p8est_connectivity_save (const char *filename,
                                             p8est_connectivity_t *
                                             connectivity);
 
p8est_connectivity_t *p8est_connectivity_source (sc_io_source_t * source);
 
p8est_connectivity_t *p8est_connectivity_inflate (sc_array_t * buffer);
 
p8est_connectivity_t *p8est_connectivity_load (const char *filename,
                                               size_t *bytes);
 
p8est_connectivity_t *p8est_connectivity_new_unitcube (void);
 
p8est_connectivity_t *p8est_connectivity_new_periodic (void);
 
p8est_connectivity_t *p8est_connectivity_new_rotwrap (void);
 
p8est_connectivity_t *p8est_connectivity_new_drop (void);
 
p8est_connectivity_t *p8est_connectivity_new_twocubes (void);
 
p8est_connectivity_t *p8est_connectivity_new_twotrees (int l_face,
                                                       int r_face,
                                                       int orientation);
 
p8est_connectivity_t *p8est_connectivity_new_twowrap (void);
 
p8est_connectivity_t *p8est_connectivity_new_rotcubes (void);
 
p8est_connectivity_t *p8est_connectivity_new_brick (int m, int n, int p,
                                                    int periodic_a,
                                                    int periodic_b,
                                                    int periodic_c);
 
p8est_connectivity_t *p8est_connectivity_new_shell (void);
 
p8est_connectivity_t *p8est_connectivity_new_sphere (void);
 
p8est_connectivity_t *p8est_connectivity_new_torus (int nSegments);
 
p8est_connectivity_t *p8est_connectivity_new_byname (const char *name);
 
p8est_connectivity_t *p8est_connectivity_refine (p8est_connectivity_t * conn,
                                                 int num_per_dim);
 
void                p8est_expand_face_transform (int iface, int nface,
                                                 int ftransform[]);
 
p4est_topidx_t      p8est_find_face_transform (p8est_connectivity_t *
                                               connectivity,
                                               p4est_topidx_t itree,
                                               int iface, int ftransform[]);
 
void                p8est_find_edge_transform (p8est_connectivity_t *
                                               connectivity,
                                               p4est_topidx_t itree,
                                               int iedge,
                                               p8est_edge_info_t * ei);
 
void                p8est_find_corner_transform (p8est_connectivity_t *
                                                 connectivity,
                                                 p4est_topidx_t itree,
                                                 int icorner,
                                                 p8est_corner_info_t * ci);
 
void                p8est_connectivity_complete (p8est_connectivity_t * conn);
 
void                p8est_connectivity_reduce (p8est_connectivity_t * conn);
 
void                p8est_connectivity_permute (p8est_connectivity_t * conn,
                                                sc_array_t * perm,
                                                int is_current_to_new);
 
#ifdef P4EST_WITH_METIS
 
void                p8est_connectivity_reorder (sc_MPI_Comm comm, int k,
                                                p8est_connectivity_t * conn,
                                                p8est_connect_type_t ctype);
 
sc_array_t         *p8est_connectivity_reorder_newid (sc_MPI_Comm comm, int k,
                                                      p8est_connectivity_t *
                                                      conn,
                                                      p8est_connect_type_t
                                                      ctype,
                                                      sc_array_t * newid);
 
#endif /* P4EST_WITH_METIS */
 
void                p8est_connectivity_join_faces (p8est_connectivity_t *
                                                   conn,
                                                   p4est_topidx_t tree_left,
                                                   p4est_topidx_t tree_right,
                                                   int face_left,
                                                   int face_right,
                                                   int orientation);
 
int                 p8est_connectivity_is_equivalent (p8est_connectivity_t *
                                                      conn1,
                                                      p8est_connectivity_t *
                                                      conn2);
 
/*@unused@*/
static inline p8est_edge_transform_t *
p8est_edge_array_index (sc_array_t * array, size_t it)
{
  P4EST_ASSERT (array->elem_size == sizeof (p8est_edge_transform_t));
  P4EST_ASSERT (it < array->elem_count);
 
  return (p8est_edge_transform_t *) (array->array +
                                     sizeof (p8est_edge_transform_t) * it);
}
 
/*@unused@*/
static inline p8est_corner_transform_t *
p8est_corner_array_index (sc_array_t * array, size_t it)
{
  P4EST_ASSERT (array->elem_size == sizeof (p8est_corner_transform_t));
  P4EST_ASSERT (it < array->elem_count);
 
  return
    (p8est_corner_transform_t *) (array->array +
                                  sizeof (p8est_corner_transform_t) * it);
}
 
int                 p8est_connectivity_read_inp_stream (FILE * stream,
                                                        p4est_topidx_t *
                                                        num_vertices,
                                                        p4est_topidx_t *
                                                        num_trees,
                                                        double *vertices,
                                                        p4est_topidx_t *
                                                        tree_to_vertex);
 
p8est_connectivity_t *p8est_connectivity_read_inp (const char *filename);
 
SC_EXTERN_C_END;
 
#endif /* !P8EST_CONNECTIVITY_H */