p8est_mesh.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_MESH_H
#define P8EST_MESH_H
 
#include <p8est_ghost.h>
 
SC_EXTERN_C_BEGIN;
 
typedef struct
{
  int                 compute_tree_index;     
  int                 compute_level_lists;    
  p8est_connect_type_t btype;                 
  int                 edgehanging_corners;    
}
p8est_mesh_params_t;
 
typedef struct
{
  p4est_locidx_t      local_num_quadrants; 
  p4est_locidx_t      ghost_num_quadrants; 
  p4est_topidx_t     *quad_to_tree;     
  int                *ghost_to_proc;    
  p4est_locidx_t     *quad_to_quad;     
  int8_t             *quad_to_face;     
  sc_array_t         *quad_to_half;     
  sc_array_t         *quad_level;       
  /* These members are NULL if btype in params is < P8EST_CONNECT_EDGE and can
   * be requested in \ref p8est_mesh_new. */
  p4est_locidx_t      local_num_edges;  
  p4est_locidx_t     *quad_to_edge;     
  sc_array_t         *edge_offset;      
  sc_array_t         *edge_quad;        
  sc_array_t         *edge_edge;        
  /* These members are NULL if btype in params is < P8EST_CONNECT_CORNER and can
   * be requested in \ref p8est_mesh_new. */
  p4est_locidx_t      local_num_corners;        
  p4est_locidx_t     *quad_to_corner;   
  sc_array_t         *corner_offset;    
  sc_array_t         *corner_quad;      
  sc_array_t         *corner_corner;    
  p8est_mesh_params_t params;           
}
p8est_mesh_t;
 
typedef struct
{
  /* forest information */
  p8est_t            *p4est;            
  p8est_ghost_t      *ghost;            
  p8est_mesh_t       *mesh;             
  /* quadrant information */
  p4est_topidx_t      which_tree;       
  p4est_locidx_t      quadrant_id;      
  p4est_locidx_t      quadrant_code;    
  /* neighbor information */
  int                 face;     
  int                 subface;  
  /* internal information */
  p4est_locidx_t      current_qtq;      
}
p8est_mesh_face_neighbor_t;
 
size_t              p8est_mesh_memory_used (p8est_mesh_t * mesh);
 
void                p8est_mesh_params_init (p8est_mesh_params_t * params);
 
p8est_mesh_t       *p8est_mesh_new (p8est_t * p8est, p8est_ghost_t * ghost,
                                    p8est_connect_type_t btype);
 
p8est_mesh_t       *p8est_mesh_new_params (p8est_t * p8est,
                                           p8est_ghost_t * ghost,
                                           p8est_mesh_params_t * params);
 
void                p8est_mesh_destroy (p8est_mesh_t * mesh);
 
p8est_quadrant_t   *p8est_mesh_get_quadrant (p8est_t * p4est,
                                             p8est_mesh_t * mesh,
                                             p4est_locidx_t qid);
 
/*** OUTDATED FUNCTION ***/
p4est_locidx_t      p8est_mesh_get_neighbors (p8est_t * p4est,
                                              p8est_ghost_t * ghost,
                                              p8est_mesh_t * mesh,
                                              p4est_locidx_t curr_quad_id,
                                              p4est_locidx_t direction,
                                              sc_array_t * neighboring_quads,
                                              sc_array_t * neighboring_encs,
                                              sc_array_t * neighboring_qids);
 
p8est_quadrant_t   *p8est_mesh_quadrant_cumulative (p8est_t * p8est,
                                                    p8est_mesh_t * mesh,
                                                    p4est_locidx_t
                                                    cumulative_id,
                                                    p4est_topidx_t *
                                                    which_tree,
                                                    p4est_locidx_t *
                                                    quadrant_id);
 
void                p8est_mesh_face_neighbor_init2 (p8est_mesh_face_neighbor_t
                                                    * mfn, p8est_t * p8est,
                                                    p8est_ghost_t * ghost,
                                                    p8est_mesh_t * mesh,
                                                    p4est_topidx_t which_tree,
                                                    p4est_locidx_t
                                                    quadrant_id);
 
void                p8est_mesh_face_neighbor_init (p8est_mesh_face_neighbor_t
                                                   * mfn, p8est_t * p8est,
                                                   p8est_ghost_t * ghost,
                                                   p8est_mesh_t * mesh,
                                                   p4est_topidx_t which_tree,
                                                   p8est_quadrant_t *
                                                   quadrant);
 
p8est_quadrant_t   *p8est_mesh_face_neighbor_next (p8est_mesh_face_neighbor_t
                                                   * mfn,
                                                   p4est_topidx_t * ntree,
                                                   p4est_locidx_t * nquad,
                                                   int *nface, int *nrank);
 
void               *p8est_mesh_face_neighbor_data (p8est_mesh_face_neighbor_t
                                                   * mfn, void *ghost_data);
 
SC_EXTERN_C_END;
 
#endif /* !P8EST_MESH_H */