t8_element_cxx.hxx

Go to the documentation of this file.

/*
  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_ELEMENT_CXX_HXX
#define T8_ELEMENT_CXX_HXX
 
#include <sc_refcount.h>
#include <t8_eclass.h>
#include <t8_element.h>
 
T8_EXTERN_C_BEGIN ();
 
/* TODO: Implement a set of rules that have to hold between different eclass,
 *       i.e. lines must have a greater or equal maxlevel than quads and triangles.
 *       Check whether this rules are fulfilled in the construction of a scheme.
 */
/* TODO: Implement a test that boundary and extrude leads to the original element. */
 
struct t8_eclass_scheme
{
 protected:
  size_t element_size; 
  void *ts_context;    
 public:
  t8_eclass_t eclass;
  virtual ~t8_eclass_scheme ()
  {
  }
 
  virtual size_t
  t8_element_size (void) const;
 
  virtual int
  t8_element_refines_irregular (void) const
    = 0;
 
  virtual int
  t8_element_maxlevel (void) const
    = 0;
 
  virtual t8_eclass_t
  t8_element_child_eclass (int childid) const
    = 0;
 
  virtual int
  t8_element_level (const t8_element_t *elem) const
    = 0;
 
  virtual void
  t8_element_copy (const t8_element_t *source, t8_element_t *dest) const
    = 0;
 
  virtual int
  t8_element_compare (const t8_element_t *elem1, const t8_element_t *elem2) const
    = 0;
 
  virtual int
  t8_element_equal (const t8_element_t *elem1, const t8_element_t *elem2) const
    = 0;
 
  virtual void
  t8_element_parent (const t8_element_t *elem, t8_element_t *parent) const
    = 0;
 
  virtual int
  t8_element_num_siblings (const t8_element_t *elem) const
    = 0;
 
  virtual void
  t8_element_sibling (const t8_element_t *elem, int sibid, t8_element_t *sibling) const
    = 0;
 
  virtual int
  t8_element_num_corners (const t8_element_t *elem) const
    = 0;
 
  virtual int
  t8_element_num_faces (const t8_element_t *elem) const
    = 0;
 
  virtual int
  t8_element_max_num_faces (const t8_element_t *elem) const
    = 0;
 
  virtual int
  t8_element_num_children (const t8_element_t *elem) const
    = 0;
 
  virtual int
  t8_element_num_face_children (const t8_element_t *elem, int face) const
    = 0;
 
  /* TODO: Prism order, Pyramid order. */
  virtual int
  t8_element_get_face_corner (const t8_element_t *element, int face, int corner) const
    = 0;
 
  virtual int
  t8_element_get_corner_face (const t8_element_t *element, int corner, int face) const
    = 0;
 
  virtual void
  t8_element_child (const t8_element_t *elem, int childid, t8_element_t *child) const
    = 0;
 
  virtual void
  t8_element_children (const t8_element_t *elem, int length, t8_element_t *c[]) const
    = 0;
 
  virtual int
  t8_element_child_id (const t8_element_t *elem) const
    = 0;
 
  virtual int
  t8_element_ancestor_id (const t8_element_t *elem, int level) const
    = 0;
 
  virtual int
  t8_element_is_family (t8_element_t **fam) const
    = 0;
 
  /* TODO: This could be problematic for pyramids, since elem1 and elem2
   *       could be of different classes. Would need two eclass_schemes as input */
  virtual void
  t8_element_nca (const t8_element_t *elem1, const t8_element_t *elem2, t8_element_t *nca) const
    = 0;
 
  virtual t8_element_shape_t
  t8_element_face_shape (const t8_element_t *elem, int face) const
    = 0;
 
  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
    = 0;
 
  virtual int
  t8_element_face_child_face (const t8_element_t *elem, int face, int face_child) const
    = 0;
 
  virtual int
  t8_element_face_parent_face (const t8_element_t *elem, int face) const
    = 0;
 
  virtual int
  t8_element_tree_face (const t8_element_t *elem, int face) const
    = 0;
 
  virtual void
  t8_element_transform_face (const t8_element_t *elem1, t8_element_t *elem2, int orientation, int sign,
                             int is_smaller_face) const
    = 0;
 
  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
    = 0;
 
  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
    = 0;
 
  virtual void
  t8_element_first_descendant_face (const t8_element_t *elem, int face, t8_element_t *first_desc, int level) const
    = 0;
 
  virtual void
  t8_element_last_descendant_face (const t8_element_t *elem, int face, t8_element_t *last_desc, int level) const
    = 0;
 
  virtual int
  t8_element_is_root_boundary (const t8_element_t *elem, int face) const
    = 0;
 
  virtual int
  t8_element_face_neighbor_inside (const t8_element_t *elem, t8_element_t *neigh, int face, int *neigh_face) const
    = 0;
  virtual t8_element_shape_t
  t8_element_shape (const t8_element_t *elem) const
    = 0;
 
  virtual void
  t8_element_set_linear_id (t8_element_t *elem, int level, t8_linearidx_t id) const
    = 0;
 
  virtual t8_linearidx_t
  t8_element_get_linear_id (const t8_element_t *elem, int level) const
    = 0;
 
  virtual void
  t8_element_first_descendant (const t8_element_t *elem, t8_element_t *desc, int level) const
    = 0;
 
  virtual void
  t8_element_last_descendant (const t8_element_t *elem, t8_element_t *desc, int level) const
    = 0;
 
  virtual void
  t8_element_successor (const t8_element_t *t, t8_element_t *s, int level) const
    = 0;
 
  virtual void
  t8_element_vertex_reference_coords (const t8_element_t *t, const int vertex, double coords[]) const
    = 0;
 
  virtual void
  t8_element_reference_coords (const t8_element_t *elem, const double *ref_coords, const size_t num_coords,
                               double *out_coords) const
    = 0;
 
  /* TODO: deactivate */
  virtual t8_element_t *
  t8_element_array_index (sc_array_t *array, size_t it) const;
 
  virtual t8_gloidx_t
  t8_element_count_leafs (const t8_element_t *t, int level) const
    = 0;
 
  virtual t8_gloidx_t
  t8_element_count_leafs_from_root (int level) const
    = 0;
 
  virtual void
  t8_element_general_function (const t8_element_t *elem, const void *indata, void *outdata) const
    = 0;
 
#ifdef T8_ENABLE_DEBUG
  virtual int
  t8_element_is_valid (const t8_element_t *elem) const
    = 0;
 
  virtual void
  t8_element_debug_print (const t8_element_t *elem) const
    = 0;
 
  virtual void
  t8_element_to_string (const t8_element_t *elem, char *debug_string, const int string_size) const
    = 0;
#endif
 
  /* TODO: would it be better to directly allocate an array of elements,
   *       not element pointers? */
  virtual void
  t8_element_new (int length, t8_element_t **elem) const
    = 0;
 
  virtual void
  t8_element_init (int length, t8_element_t *elem, int called_new) const
    = 0;
 
  virtual void
  t8_element_destroy (int length, t8_element_t **elem) const
    = 0;
};
 
void
t8_scheme_cxx_destroy (t8_scheme_cxx_t *s);
 
T8_EXTERN_C_END ();
 
#endif /* !T8_ELEMENT_CXX_HXX */