t8_element_c_interface.h

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_C_INTERFACE_H
#define T8_ELEMENT_C_INTERFACE_H
 
#include <t8_element.h>
 
T8_EXTERN_C_BEGIN ();
 
size_t
t8_element_size (const t8_eclass_scheme_c *ts);
 
int
t8_element_refines_irregular (const t8_eclass_scheme_c *ts);
 
int
t8_element_maxlevel (const t8_eclass_scheme_c *ts);
 
t8_eclass_t
t8_element_child_eclass (const t8_eclass_scheme_c *ts, int childid);
int
t8_element_level (const t8_eclass_scheme_c *ts, const t8_element_t *elem);
 
void
t8_element_copy (const t8_eclass_scheme_c *ts, const t8_element_t *source, t8_element_t *dest);
 
int
t8_element_compare (const t8_eclass_scheme_c *ts, const t8_element_t *elem1, const t8_element_t *elem2);
 
int
t8_element_equal (const t8_eclass_scheme_c *ts, const t8_element_t *elem1, const t8_element_t *elem2);
 
void
t8_element_parent (const t8_eclass_scheme_c *ts, const t8_element_t *elem, t8_element_t *parent);
 
int
t8_element_num_siblings (const t8_eclass_scheme_c *ts, const t8_element_t *elem);
 
void
t8_element_sibling (const t8_eclass_scheme_c *ts, const t8_element_t *elem, int sibid, t8_element_t *sibling);
 
int
t8_element_num_corners (const t8_eclass_scheme_c *ts, const t8_element_t *elem);
 
int
t8_element_num_faces (const t8_eclass_scheme_c *ts, const t8_element_t *elem);
 
int
t8_element_max_num_faces (const t8_eclass_scheme_c *ts, const t8_element_t *elem);
 
int
t8_element_num_children (const t8_eclass_scheme_c *ts, const t8_element_t *elem);
 
int
t8_element_num_face_children (const t8_eclass_scheme_c *ts, const t8_element_t *elem, int face);
 
int
t8_element_get_face_corner (const t8_eclass_scheme_c *ts, const t8_element_t *elem, int face, int corner);
 
int
t8_element_get_corner_face (const t8_eclass_scheme_c *ts, const t8_element_t *elem, int corner, int face);
 
void
t8_element_child (const t8_eclass_scheme_c *ts, const t8_element_t *elem, int childid, t8_element_t *child);
 
void
t8_element_children (const t8_eclass_scheme_c *ts, const t8_element_t *elem, int length, t8_element_t *c[]);
 
int
t8_element_child_id (const t8_eclass_scheme_c *ts, const t8_element_t *elem);
 
int
t8_element_ancestor_id (const t8_eclass_scheme_c *ts, const t8_element_t *elem, int level);
 
int
t8_element_is_family (const t8_eclass_scheme_c *ts, t8_element_t **fam);
 
void
t8_element_nca (const t8_eclass_scheme_c *ts, const t8_element_t *elem1, const t8_element_t *elem2, t8_element_t *nca);
 
t8_element_shape_t
t8_element_face_shape (const t8_eclass_scheme_c *ts, const t8_element_t *elem, int face);
 
void
t8_element_children_at_face (const t8_eclass_scheme_c *ts, const t8_element_t *elem, int face, t8_element_t *children[],
                             int num_children, int *child_indices);
 
int
t8_element_face_child_face (const t8_eclass_scheme_c *ts, const t8_element_t *elem, int face, int face_child);
 
int
t8_element_face_parent_face (const t8_eclass_scheme_c *ts, const t8_element_t *elem, int face);
 
int
t8_element_tree_face (const t8_eclass_scheme_c *ts, const t8_element_t *elem, int face);
 
void
t8_element_transform_face (const t8_eclass_scheme_c *ts, const t8_element_t *elem1, t8_element_t *elem2,
                           int orientation, int sign, int is_smaller_face);
 
int
t8_element_extrude_face (const t8_eclass_scheme_c *ts, const t8_element_t *face, const t8_eclass_scheme_c *face_scheme,
                         t8_element_t *elem, int root_face);
 
void
t8_element_boundary_face (const t8_eclass_scheme_c *ts, const t8_element_t *elem, int face, t8_element_t *boundary,
                          const t8_eclass_scheme_c *boundary_scheme);
 
void
t8_element_first_descendant_face (const t8_eclass_scheme_c *ts, const t8_element_t *elem, int face,
                                  t8_element_t *first_desc, int level);
 
void
t8_element_last_descendant_face (const t8_eclass_scheme_c *ts, const t8_element_t *elem, int face,
                                 t8_element_t *last_desc, int level);
 
int
t8_element_is_root_boundary (const t8_eclass_scheme_c *ts, const t8_element_t *elem, int face);
 
int
t8_element_face_neighbor_inside (const t8_eclass_scheme_c *ts, const t8_element_t *elem, t8_element_t *neigh, int face,
                                 int *neigh_face);
 
t8_element_shape_t
t8_element_shape (const t8_eclass_scheme_c *ts, const t8_element_t *elem);
 
void
t8_element_set_linear_id (const t8_eclass_scheme_c *ts, t8_element_t *elem, int level, t8_linearidx_t id);
 
t8_linearidx_t
t8_element_get_linear_id (const t8_eclass_scheme_c *ts, const t8_element_t *elem, int level);
 
void
t8_element_first_descendant (const t8_eclass_scheme_c *ts, const t8_element_t *elem, t8_element_t *desc, int level);
 
void
t8_element_last_descendant (const t8_eclass_scheme_c *ts, const t8_element_t *elem, t8_element_t *desc, int level);
 
void
t8_element_successor (const t8_eclass_scheme_c *ts, const t8_element_t *elem1, t8_element_t *elem2, int level);
 
void
t8_element_vertex_reference_coords (const t8_eclass_scheme_c *ts, const t8_element_t *t, const int vertex,
                                    double coords[]);
 
/* TODO: deactivate */
/* t8_element_t *t8_element_array_index (sc_array_t *array, size_t it); */
 
t8_gloidx_t
t8_element_count_leafs (const t8_eclass_scheme_c *ts, const t8_element_t *t, int level);
 
t8_gloidx_t
t8_element_count_leafs_from_root (const t8_eclass_scheme_c *ts, int level);
 
void
t8_element_general_function (const t8_eclass_scheme_c *ts, const t8_element_t *elem, const void *indata, void *outdata);
 
#ifdef T8_ENABLE_DEBUG
int
t8_element_is_valid (const t8_eclass_scheme_c *ts, const t8_element_t *elem);
 
void
t8_element_debug_print (const t8_eclass_scheme_c *ts, const t8_element_t *elem);
 
void
t8_element_to_string (const t8_eclass_scheme_c *ts, const t8_element_t *elem, char *debug_string,
                      const int string_size);
#endif
 
void
t8_element_new (const t8_eclass_scheme_c *ts, int length, t8_element_t **elems);
 
void
t8_element_destroy (const t8_eclass_scheme_c *ts, int length, t8_element_t **elems);
 
T8_EXTERN_C_END ();
 
#endif /* !T8_ELEMENT_C_INTERFACE_H */