t8_default_hex_cxx.hxx

/*
  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.
*/
 
#ifndef T8_DEFAULT_HEX_HXX
#define T8_DEFAULT_HEX_HXX
 
#include <p8est.h>
#include <t8_element_cxx.hxx>
#include <t8_schemes/t8_default/t8_default_quad/t8_default_quad_cxx.hxx>
 
typedef p8est_quadrant_t t8_phex_t;
 
struct t8_default_scheme_hex_c:public t8_default_scheme_common_c
{
public:
  t8_default_scheme_hex_c ();
 
  ~t8_default_scheme_hex_c ();
 
  virtual void        t8_element_new (int length, t8_element_t **elem) const;
 
  virtual void        t8_element_init (int length, t8_element_t *elem,
                                       int called_new) const;
 
  virtual int         t8_element_level (const t8_element_t *elem) const;
 
  virtual int         t8_element_maxlevel (void) const;
 
  virtual void        t8_element_copy (const t8_element_t *source,
                                       t8_element_t *dest) const;
 
  virtual int         t8_element_compare (const t8_element_t *elem1,
                                          const t8_element_t *elem2) const;
 
  virtual void        t8_element_parent (const t8_element_t *elem,
                                         t8_element_t *parent) const;
 
  virtual void        t8_element_sibling (const t8_element_t *elem,
                                          int sibid,
                                          t8_element_t *sibling) const;
 
  virtual int         t8_element_num_faces (const t8_element_t *elem) const;
 
  virtual int         t8_element_max_num_faces (const t8_element_t *elem)
    const;
 
  virtual int         t8_element_num_children (const t8_element_t *elem)
    const;
 
  virtual int         t8_element_num_face_children (const t8_element_t *elem,
                                                    int face) const;
  virtual int         t8_element_get_face_corner (const t8_element_t *element,
                                                  int face, int corner) const;
 
  virtual int         t8_element_get_corner_face (const t8_element_t *element,
                                                  int corner, int face) const
  {
    SC_ABORT ("This function is not implemented yet.\n");
    return 0;                   /* suppresses compiler warning */
  }
 
  virtual t8_eclass_t t8_element_child_eclass (int childid) const;
 
  virtual void        t8_element_child (const t8_element_t *elem,
                                        int childid,
                                        t8_element_t *child) const;
 
  virtual void        t8_element_children (const t8_element_t *elem,
                                           int length,
                                           t8_element_t *c[]) const;
 
  virtual int         t8_element_child_id (const t8_element_t *elem) const;
 
  virtual int         t8_element_ancestor_id (const t8_element_t *elem,
                                              int level) const;
 
  virtual int         t8_element_is_family (t8_element_t **fam) const;
 
  virtual void        t8_element_nca (const t8_element_t *elem1,
                                      const t8_element_t *elem2,
                                      t8_element_t *nca) const;
 
  virtual t8_element_shape_t t8_element_face_shape (const t8_element_t *elem,
                                                    int face) const;
 
  virtual void        t8_element_children_at_face (const t8_element_t *elem,
                                                   int face,
                                                   t8_element_t *children[],
                                                   int num_children,
                                                   int *child_indices) const;
 
  virtual int         t8_element_face_child_face (const t8_element_t *elem,
                                                  int face,
                                                  int face_child) const;
 
  virtual int         t8_element_face_parent_face (const t8_element_t *elem,
                                                   int face) const;
 
  virtual int         t8_element_tree_face (const t8_element_t *elem,
                                            int face) const;
 
  virtual void        t8_element_transform_face (const t8_element_t *elem1,
                                                 t8_element_t *elem2,
                                                 int orientation, int sign,
                                                 int is_smaller_face) const
  {
    SC_ABORT ("This function is not implemented yet.\n");
    return;                     /* suppresses compiler warning */
  }
 
  virtual int         t8_element_extrude_face (const t8_element_t *face,
                                               const t8_eclass_scheme_c
                                               *face_scheme,
                                               t8_element_t *elem,
                                               int root_face) const;
 
  virtual void        t8_element_first_descendant_face (const t8_element_t
                                                        *elem, int face,
                                                        t8_element_t
                                                        *first_desc,
                                                        int level) const;
 
  virtual void        t8_element_last_descendant_face (const t8_element_t
                                                       *elem, int face,
                                                       t8_element_t
                                                       *last_desc,
                                                       int level) const;
 
  virtual void        t8_element_boundary_face (const t8_element_t *elem,
                                                int face,
                                                t8_element_t *boundary,
                                                const t8_eclass_scheme_c
                                                *boundary_scheme) const;
 
  virtual void        t8_element_boundary (const t8_element_t *elem,
                                           int min_dim, int length,
                                           t8_element_t **boundary) const;
 
  virtual int         t8_element_is_root_boundary (const t8_element_t *elem,
                                                   int face) const;
 
  virtual int         t8_element_face_neighbor_inside (const t8_element_t
                                                       *elem,
                                                       t8_element_t *neigh,
                                                       int face,
                                                       int *neigh_face) const;
 
  virtual void        t8_element_set_linear_id (t8_element_t *elem,
                                                int level,
                                                t8_linearidx_t id) const;
 
  virtual t8_linearidx_t t8_element_get_linear_id (const
                                                   t8_element_t *elem,
                                                   int level) const;
 
  virtual void        t8_element_first_descendant (const t8_element_t *elem,
                                                   t8_element_t *desc,
                                                   int level) const;
 
  virtual void        t8_element_last_descendant (const t8_element_t *elem,
                                                  t8_element_t *desc,
                                                  int level) const;
 
  virtual void        t8_element_successor (const t8_element_t *t,
                                            t8_element_t *s, int level) const;
 
  virtual void        t8_element_anchor (const t8_element_t *elem,
                                         int anchor[3]) const;
 
  virtual int         t8_element_root_len (const t8_element_t *elem) const;
 
  virtual void        t8_element_vertex_coords (const t8_element_t *elem,
                                                int vertex,
                                                int coords[]) const;
 
  virtual void        t8_element_vertex_reference_coords (const t8_element_t
                                                          *elem,
                                                          const int vertex,
                                                          double coords[])
    const;
 
  virtual void        t8_element_reference_coords (const t8_element_t *elem,
                                                   const double *ref_coords,
                                                   const void *user_data,
                                                   double *out_coords)
    const;
 
  virtual int         t8_element_refines_irregular (void) const;
 
#ifdef T8_ENABLE_DEBUG
  virtual int         t8_element_is_valid (const t8_element_t *t) const;
 
  virtual void        t8_element_debug_print (const t8_element_t *elem) const;
#endif
};
 
#endif /* !T8_DEFAULT_HEX_HXX */