Ghost interface

benchmarks/time_forest_partition.cxx

@@ -340,7 +340,7 @@ main (int argc, char *argv[])
   int level, level_diff;
   int help = 0, no_vtk, do_ghost, do_balance, use_cad;
   int dim, num_files;
-  int test_tet, test_linear_cylinder, test_cad_cylinder;
+  int test_tet, test_linear_cylinder, test_cad_cylinder, test_hybrid_cube, test_hex_cube;
   int stride;
   int cmesh_level;
   double T, delta_t, cfl;
@@ -390,6 +390,12 @@ main (int argc, char *argv[])
   sc_options_add_switch (opt, 'O', "test-cad-cylinder", &test_cad_cylinder,
                          "Use a cad cmesh to compare linear and cad geometry performance."
                          " If this option is used -o is enabled automatically. Not allowed with -f and -c.");
+  sc_options_add_switch (opt, 'C', "test-hybridcube", &test_hybrid_cube,
+                         "Use a hypercube with Hybercube with Tets, Prism and Hex elements as cmesh."
+                         " If this option is used -o is enabled automatically. Not allowed with -f and -c.");
+  sc_options_add_switch (opt, 'H', "test-hexcube", &test_hex_cube,
+                         "Use a hypercube with Hex elements as cmesh."
+                         " If this option is used -o is enabled automatically. Not allowed with -f and -c.");
   sc_options_add_int (opt, 'l', "level", &level, 0, "The initial uniform refinement level of the forest.");
   sc_options_add_int (opt, 'r', "rlevel", &level_diff, 1,
                       "The number of levels that the forest is refined from the initial level.");
@@ -415,11 +421,12 @@ main (int argc, char *argv[])
   /* check for wrong usage of arguments */
   if (first_argc < 0 || first_argc != argc || dim < 2 || dim > 3
       || (cmeshfileprefix == NULL && mshfileprefix == NULL && test_tet == 0 && test_cad_cylinder == 0
-          && test_linear_cylinder == 0)
+          && test_linear_cylinder == 0 && test_hybrid_cube == 0 && test_hex_cube == 0)
       || stride <= 0 || (num_files - 1) * stride >= mpisize || cfl < 0 || T <= 0
-      || test_tet + test_linear_cylinder + test_cad_cylinder > 1
-      || (cmesh_level >= 0 && (!test_linear_cylinder && !test_cad_cylinder))
-      || ((mshfileprefix != NULL || cmeshfileprefix != NULL) && (test_linear_cylinder || test_cad_cylinder || test_tet))
+      || test_tet + test_linear_cylinder + test_cad_cylinder + test_hybrid_cube + test_hex_cube > 1
+      || (cmesh_level >= 0 && (!test_linear_cylinder && !test_cad_cylinder && !test_hybrid_cube && !test_hex_cube))
+      || ((mshfileprefix != NULL || cmeshfileprefix != NULL)
+          && (test_linear_cylinder || test_cad_cylinder || test_tet || test_hybrid_cube || test_hex_cube))
       || (mshfileprefix == NULL && use_cad)) {
     sc_options_print_usage (t8_get_package_id (), SC_LP_ERROR, opt, NULL);
     return 1;
@@ -454,6 +461,14 @@ main (int argc, char *argv[])
                                             sc_intpow (2, cmesh_level), sc_intpow (2, cmesh_level), test_cad_cylinder);
       test_linear_cylinder ? vtu_prefix = "test_linear_cylinder" : vtu_prefix = "test_cad_cylinder";
     }
+    else if (test_hybrid_cube) {
+      cmesh = t8_cmesh_new_hypercube_hybrid (sc_MPI_COMM_WORLD, 0, 0);
+      vtu_prefix = "test_hypercube_hybrid";
+    }
+    else if (test_hex_cube) {
+      cmesh = t8_cmesh_new_hypercube (T8_ECLASS_HEX, sc_MPI_COMM_WORLD, 0, 0, 0);
+      vtu_prefix = "test_hypercube_hex";
+    }
     else {
       T8_ASSERT (cmeshfileprefix != NULL);
       cmesh

doc/author_henricpetri.txt

@@ -0,0 +1 @@
+I place my contributions to t8code under the FreeBSD license. Antje Henric-Petri ([email protected])

src/Makefile.am

@@ -53,7 +53,12 @@ libt8_installed_headers_forest = \
   src/t8_forest/t8_forest_profiling.h \
   src/t8_forest/t8_forest_io.h \
   src/t8_forest/t8_forest_adapt.h \
-  src/t8_forest/t8_forest_iterate.h src/t8_forest/t8_forest_partition.h
+  src/t8_forest/t8_forest_iterate.h src/t8_forest/t8_forest_partition.h \
+  src/t8_forest/t8_forest_ghost_definition_wrapper.h \
+  src/t8_forest/t8_forest_ghost_definition.h \
+  src/t8_forest/t8_forest_ghost_definition.hxx \
+  src/t8_forest/t8_forest_ghost_search.hxx \
+  src/t8_forest/t8_forest_ghost_stencil.hxx
 libt8_installed_headers_geometry = \
   src/t8_geometry/t8_geometry.h \
   src/t8_geometry/t8_geometry_handler.hxx \

src/t8_forest/t8_forest.cxx

@@ -3,7 +3,7 @@
   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
+  Copyright (C) 2024 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
@@ -29,6 +29,7 @@
 #include <t8_forest/t8_forest_partition.h>
 #include <t8_forest/t8_forest_private.h>
 #include <t8_forest/t8_forest_ghost.h>
+#include <t8_forest/t8_forest_ghost_definition_wrapper.h>
 #include <t8_forest/t8_forest_balance.h>
 #include <t8_element.hxx>
 #include <t8_element_c_interface.h>
@@ -39,6 +40,8 @@
 #include <t8_forest/t8_forest_adapt.h>
 #include <t8_vtk/t8_vtk_writer.h>
 #include <t8_geometry/t8_geometry_base.hxx>
+#include <t8_forest/t8_forest_ghost_definition.hxx>
+#include <t8_forest/t8_forest_ghost_search.hxx>
 #if T8_ENABLE_DEBUG
 #include <t8_geometry/t8_geometry_implementations/t8_geometry_linear.h>
 #include <t8_geometry/t8_geometry_implementations/t8_geometry_linear_axis_aligned.h>
@@ -2948,6 +2951,18 @@ t8_forest_set_balance (t8_forest_t forest, const t8_forest_t set_from, int no_re
   }
 }
 
+void
+t8_forest_set_ghost_ext_new (t8_forest_t forest, const int do_ghost, t8_forest_ghost_definition_c *ghost_definition)
+{
+  T8_ASSERT (t8_forest_is_initialized (forest));
+  T8_ASSERT (!(do_ghost == 1 && ghost_definition == NULL));
+  if (forest->ghost_definition != NULL) {
+    t8_forest_ghost_definition_unref (&(forest->ghost_definition));
+  }
+  forest->do_ghost = do_ghost;
+  forest->ghost_definition = ghost_definition;
+}
+
 void
 t8_forest_set_ghost_ext (t8_forest_t forest, int do_ghost, t8_ghost_type_t ghost_type, int ghost_version)
 {
@@ -2965,8 +2980,8 @@ t8_forest_set_ghost_ext (t8_forest_t forest, int do_ghost, t8_ghost_type_t ghost
     forest->do_ghost = (do_ghost != 0); /* True if and only if do_ghost != 0 */
   }
   if (forest->do_ghost) {
-    forest->ghost_type = ghost_type;
-    forest->ghost_algorithm = ghost_version;
+    t8_forest_ghost_definition_c *ghost_definition = t8_forest_ghost_definition_face_new (ghost_version);
+    t8_forest_set_ghost_ext_new (forest, do_ghost, ghost_definition);
   }
 }
 
@@ -3230,6 +3245,11 @@ t8_forest_commit (t8_forest_t forest)
     forest->scheme_cxx = forest->set_from->scheme_cxx;
     forest->global_num_trees = forest->set_from->global_num_trees;
 
+    if (forest->ghost_definition == NULL && forest->set_from->ghost_definition != NULL) {
+      forest->ghost_definition = forest->set_from->ghost_definition;
+      t8_forest_ghost_definition_ref (forest->ghost_definition);
+    }
+
     /* Compute the maximum allowed refinement level */
     t8_forest_compute_maxlevel (forest);
     if (forest->from_method == T8_FOREST_FROM_COPY) {
@@ -3383,19 +3403,7 @@ t8_forest_commit (t8_forest_t forest)
     /* Construct a ghost layer, if desired */
     if (forest->do_ghost) {
       /* TODO: ghost type */
-      switch (forest->ghost_algorithm) {
-      case 1:
-        t8_forest_ghost_create_balanced_only (forest);
-        break;
-      case 2:
-        t8_forest_ghost_create (forest);
-        break;
-      case 3:
-        t8_forest_ghost_create_topdown (forest);
-        break;
-      default:
-        SC_ABORT ("Invalid choice of ghost algorithm");
-      }
+      t8_forest_ghost_create_ext (forest);
     }
     forest->do_ghost = 0;
   }
@@ -4257,6 +4265,10 @@ t8_forest_reset (t8_forest_t *pforest)
   if (forest->ghosts != NULL) {
     t8_forest_ghost_unref (&forest->ghosts);
   }
+  /* Destroy the ghost_definition class if it exist */
+  if (forest->ghost_definition != NULL) {
+    t8_forest_ghost_definition_unref (&(forest->ghost_definition));
+  }
   /* we have taken ownership on calling t8_forest_set_* */
   if (forest->scheme_cxx != NULL) {
     t8_scheme_cxx_unref (&forest->scheme_cxx);

src/t8_forest/t8_forest_balance.cxx

@@ -3,7 +3,7 @@
   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
+  Copyright (C) 2024 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
@@ -25,6 +25,8 @@
 #include <t8_forest/t8_forest_types.h>
 #include <t8_forest/t8_forest_private.h>
 #include <t8_forest/t8_forest_ghost.h>
+#include <t8_forest/t8_forest_ghost_definition.hxx>
+#include <t8_forest/t8_forest_ghost_definition_wrapper.h>
 #include <t8_forest/t8_forest_general.h>
 #include <t8_forest/t8_forest_profiling.h>
 #include <t8_element.hxx>
@@ -137,6 +139,7 @@ t8_forest_balance (t8_forest_t forest, int repartition)
   int count_partition_stats = 0;
   double ada_time, ghost_time, part_time;
   sc_statinfo_t *adap_stats, *ghost_stats, *partition_stats;
+  int create_ghost_definition = 0; /* flag if create ghost_definition */
 
   t8_global_productionf ("Into t8_forest_balance with %lli global elements.\n",
                          (long long) t8_forest_get_global_num_elements (forest->set_from));
@@ -169,9 +172,21 @@ t8_forest_balance (t8_forest_t forest, int repartition)
   /* This function is reference neutral regarding forest_from */
   t8_forest_ref (forest_from);
 
+  /* if the set_from forest of forest has no ghost layer computed,
+   * compute a ghost layer for the set_from forest */
   if (forest->set_from->ghosts == NULL) {
-    forest->set_from->ghost_type = T8_GHOST_FACES;
+    /* If the forest does not yet have a ghost_definition */
+    if (forest->set_from->ghost_definition == NULL) {
+      /* create a ghost_definition of type face with top-down-search */
+      forest->set_from->ghost_definition = t8_forest_ghost_definition_face_new (3);
+      create_ghost_definition = 1;
+    }
+    /* compute ghost layer for set_from forest */
     t8_forest_ghost_create_topdown (forest->set_from);
+    if (create_ghost_definition) { /* if a ghost_definition has been created, it will be deleted here */
+      t8_forest_ghost_definition_unref (&(forest->set_from->ghost_definition));
+      forest->set_from->ghost_definition = NULL;
+    }
   }
 
   while (!done_global) {

src/t8_forest/t8_forest_general.h

@@ -3,7 +3,7 @@
   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
+  Copyright (C) 2024 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
@@ -32,6 +32,7 @@
 #include <t8_cmesh.h>
 #include <t8_element.h>
 #include <t8_data/t8_containers.h>
+#include <t8_forest/t8_forest_ghost_definition.h>
 
 /** Opaque pointer to a forest implementation. */
 typedef struct t8_forest *t8_forest_t;
@@ -40,10 +41,11 @@ typedef struct t8_tree *t8_tree_t;
 /** This type controls, which neighbors count as ghost elements.
  * Currently, we support face-neighbors. Vertex and edge neighbors will eventually be added. */
 typedef enum {
-  T8_GHOST_NONE = 0, /**< Do not create ghost layer. */
-  T8_GHOST_FACES,    /**< Consider all face (codimension 1) neighbors. */
-  T8_GHOST_EDGES,    /**< Consider all edge (codimension 2) and face neighbors. */
-  T8_GHOST_VERTICES  /**< Consider all vertex (codimension 3) and edge and face neighbors. */
+  T8_GHOST_NONE = 0,   /**< Do not create ghost layer. */
+  T8_GHOST_FACES,      /**< Consider all face (codimension 1) neighbors. */
+  T8_GHOST_EDGES,      /**< Consider all edge (codimension 2) and face neighbors. */
+  T8_GHOST_VERTICES,   /**< Consider all vertex (codimension 3) and edge and face neighbors. */
+  T8_GHOST_USERDEFINED /**< for user-defined neighborhoods */
 } t8_ghost_type_t;
 
 /** This typedef is needed as a helper construct to 
@@ -363,10 +365,22 @@ t8_forest_set_ghost (t8_forest_t forest, int do_ghost, t8_ghost_type_t ghost_typ
  *                                If 2, the iterative algorithm for unbalanced forests.
  *                                If 3, the top-down search algorithm for unbalanced forests.
  * \see t8_forest_set_ghost
+ * \note this function creates an ghost_definition obcejct and call \ref t8_forest_set_ghost_ext_new
  */
 void
 t8_forest_set_ghost_ext (t8_forest_t forest, int do_ghost, t8_ghost_type_t ghost_type, int ghost_version);
 
+/** Set a ghost_definition
+ * In application schoud only used if the user creates its own ghost_definition class (type = userderdefined)
+ * \param [in]    forest          The forest
+ * \param [in]    do_ghost        If 0 no ghost layer will be computed
+ * \param [in]    ghost_definition Pointer to an object of the class ghost_definition or a derived class
+ *                                The forest takes ownership of the ghost_definition
+ * \note if the forest has already a ghost_definition, the old one will be unref and the new one will be set.
+*/
+void
+t8_forest_set_ghost_ext_new (t8_forest_t forest, const int do_ghost, t8_forest_ghost_definition_c *ghost_definition);
+
 /* TODO: use assertions and document that the forest_set (..., from) and
  *       set_load are mutually exclusive. */
 void