Merge pull request #2165 from DLR-AMR/typos

Davknapp · web-flow · commit cdfade797b0d · 2026-02-04T15:01:43.000Z
Improvement: Remove outdated TODOs and fix small typos
diff --git a/benchmarks/t8_time_forest_partition.cxx b/benchmarks/t8_time_forest_partition.cxx
@@ -50,7 +50,7 @@ typedef struct
 {
   double c_min, c_max; /* constants that define the thickness of the refinement region */
   t8_3D_vec normal;    /* normal vector to the plane E */
-  int base_level;      /* A given level that is not coarsend further, see -l argument */
+  int base_level;      /* A given level that is not coarsened further, see -l argument */
   int max_level;       /* A max level that is not refined further, see -L argument */
 } adapt_data_t;
 
@@ -126,7 +126,7 @@ t8_time_forest_cmesh_mshfile (t8_cmesh_t cmesh, const char *vtu_prefix, sc_MPI_C
 
   t8_global_productionf ("Committed cmesh with %lli global trees.\n", (long long) t8_cmesh_get_num_trees (cmesh));
 
-  /* If the input cmesh is partitioned then we use a partitioned cmehs
+  /* If the input cmesh is partitioned then we use a partitioned cmesh
    * and also repartition it in each timestep (happens automatically in
    * t8_forest_commit). We have to initially start with a uniformly refined
    * cmesh in order to be able to construct the forest on it.
diff --git a/src/t8_forest/t8_forest_adapt.h b/src/t8_forest/t8_forest_adapt.h
@@ -24,8 +24,6 @@
  * We define the adapt routine to refine and coarsen a forest of trees in this file.
  */
 
-/* TODO: begin documenting this file: make doxygen 2>&1 | grep t8_forest_adapt */
-
 #ifndef T8_FOREST_ADAPT_H
 #define T8_FOREST_ADAPT_H
 
diff --git a/src/t8_forest/t8_forest_general.h b/src/t8_forest/t8_forest_general.h
@@ -24,8 +24,6 @@
  * We define the forest of trees in this file.
  */
 
-/* TODO: begin documenting this file: make doxygen 2>&1 | grep t8_forest */
-
 #ifndef T8_FOREST_GENERAL_H
 #define T8_FOREST_GENERAL_H
 
diff --git a/src/t8_forest/t8_forest_geometrical.h b/src/t8_forest/t8_forest_geometrical.h
@@ -24,8 +24,6 @@
  * We define the geometrical queries for a forest of trees in this file.
  */
 
-/* TODO: begin documenting this file: make doxygen 2>&1 | grep t8_forest */
-
 #ifndef T8_FOREST_GEOMETRICAL_H
 #define T8_FOREST_GEOMETRICAL_H
 
@@ -123,7 +121,7 @@ t8_forest_element_diam (t8_forest_t forest, t8_locidx_t ltreeid, const t8_elemen
  * \param [in]      forest     The forest.
  * \param [in]      ltreeid    The forest local id of the tree in which the element is.
  * \param [in]      element    The element.
- * \return                     The diameter of the element.
+ * \return                     The volume of the element.
  * \note                       This function assumes d-linear interpolation for the
  *                             tree vertex coordinates.
  *                             \a forest must be committed when calling this function.
diff --git a/src/t8_forest/t8_forest_ghost.h b/src/t8_forest/t8_forest_ghost.h
@@ -25,8 +25,6 @@
  * for a forest of trees in this file.
  */
 
-/* TODO: begin documenting this file: make doxygen 2>&1 | grep t8_forest_ghost */
-
 #ifndef T8_FOREST_GHOST_H
 #define T8_FOREST_GHOST_H
 
diff --git a/src/t8_forest/t8_forest_io.h b/src/t8_forest/t8_forest_io.h
@@ -24,8 +24,6 @@
  * TODO
  */
 
-/* TODO: begin documenting this file: make doxygen 2>&1 | grep t8_forest */
-
 #ifndef T8_FOREST_IO_H
 #define T8_FOREST_IO_H
 
diff --git a/src/t8_forest/t8_forest_iterate.h b/src/t8_forest/t8_forest_iterate.h
@@ -25,8 +25,6 @@
  * callback functions on the leaf elements.
  */
 
-/* TODO: begin documenting this file: make doxygen 2>&1 | grep t8_forest_iterate */
-
 #ifndef T8_FOREST_ITERATE_H
 #define T8_FOREST_ITERATE_H
 
diff --git a/src/t8_forest/t8_forest_partition.h b/src/t8_forest/t8_forest_partition.h
@@ -24,8 +24,6 @@
  * We define the partition routine to partition a forest of trees in this file.
  */
 
-/* TODO: begin documenting this file: make doxygen 2>&1 | grep t8_forest_partition */
-
 #ifndef T8_FOREST_PARTITION_H
 #define T8_FOREST_PARTITION_H
 
diff --git a/src/t8_forest/t8_forest_partition_for_coarsening.h b/src/t8_forest/t8_forest_partition_for_coarsening.h
@@ -33,7 +33,7 @@
 
 T8_EXTERN_C_BEGIN ();
 
-/** \brief Correct the partitioning if element families are split accorss process boundaries.
+/** \brief Correct the partitioning if element families are split across process boundaries.
  *
  *  The default partitioning distributes the elements into equally-sized partitions. For coarsening, however,
  *  all elements of a family have to be on the same process in order to be coarsened into their parent element.
diff --git a/src/t8_forest/t8_forest_private.h b/src/t8_forest/t8_forest_private.h
@@ -25,8 +25,6 @@
  * of the official t8_forest.h interface but used internally.
  */
 
-/* TODO: begin documenting this file: make doxygen 2>&1 | grep t8_forest_private */
-
 #ifndef T8_FOREST_PRIVATE_H
 #define T8_FOREST_PRIVATE_H
 
diff --git a/src/t8_forest/t8_forest_profiling.h b/src/t8_forest/t8_forest_profiling.h
@@ -24,8 +24,6 @@
  * We define the forest of trees in this file.
  */
 
-/* TODO: begin documenting this file: make doxygen 2>&1 | grep t8_forest */
-
 #ifndef T8_FOREST_PROFILING_H
 #define T8_FOREST_PROFILING_H
 
diff --git a/tutorials/general/t8_step4_partition_balance_ghost.cxx b/tutorials/general/t8_step4_partition_balance_ghost.cxx
@@ -131,7 +131,7 @@ t8_step4_partition_ghost (t8_forest_t forest)
   /* Initialize */
   t8_forest_init (&new_forest);
 
-  /* Tell the new_forest that is should partition the existing forest.
+  /* Tell the new_forest that it should partition the existing forest.
    * This will change the distribution of the forest elements among the processes
    * in such a way that afterwards each process has the same number of elements
    * (+- 1 if the number of elements is not divisible by the number of processes).
@@ -157,7 +157,7 @@ t8_step4_partition_ghost (t8_forest_t forest)
 }
 
 /* In this function we adapt a forest as in step3 and balance it.
- * In our main program the input forest is already adapted and then the resulting twice adapted forest will be unbalanced.
+ * In our main program the input forest is already adapted and then the resulting twice adapted forest will be balanced.
  */
 static t8_forest_t
 t8_step4_balance (t8_forest_t forest)

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@`
`33`	`33`
`34`	`34`	`T8_EXTERN_C_BEGIN ();`
`35`	`35`
`36`		`-/** \brief Correct the partitioning if element families are split accorss process boundaries.`
	`36`	`+/** \brief Correct the partitioning if element families are split across process boundaries.`
`37`	`37`	`*`
`38`	`38`	`* The default partitioning distributes the elements into equally-sized partitions. For coarsening, however,`
`39`	`39`	`* all elements of a family have to be on the same process in order to be coarsened into their parent element.`