cburstedde · pkestene · Sep 6, 2025 · Sep 6, 2025 · Sep 6, 2025 · Sep 6, 2025
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,14 @@
+---
+exclude: sc|doc/attic/|doc/author_*|doc/patch/
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-added-large-files
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.36.2
+    hooks:
+      - id: typos
diff --git a/AUTHORS b/AUTHORS
@@ -61,7 +61,7 @@
   Advanced Computing Center (TACC) for providing them with access to the Ranger
   supercomputer under NSF TeraGrid award MCA04N026, and the National Center for
   Computational Science (NCCS) for early-user access to the Jaguar Cray XT5
-  supercomputer.  Any opinions, findings and conclusions or recomendations
+  supercomputer.  Any opinions, findings and conclusions or recommendations
   expressed in the source code and documentation are those of the authors and
   do not necessarily reflect the views of the National Science Foundation
   (NSF).

diff --git a/INSTALL_WINDOWS b/INSTALL_WINDOWS
@@ -77,7 +77,7 @@ Instructions:
         -Wl,--out-implib,libsc.dll.a -Wl,--export-all-symbols -Wl,--enable-auto-import sc/libb64/.libs/*.o
         -lz -lgomp -lpthread -llua
 
-  7. Open Windows command promt and change directory to that with the compiled package.
+  7. Open Windows command prompt and change directory to that with the compiled package.
       The following instructions create .lib files from .def and .a files.
 
         lib /def:libp4est.def /machine:x64

diff --git a/NEWS b/NEWS
@@ -3,7 +3,7 @@ NEWS
 
  * The current stable version 2 of the p4est code is maintained in branches
    v2.2--v2.5.  It will be backwards compatible as much as possible.
-   The code will remain usable and bugfixed for the forseeable future.
+   The code will remain usable and bugfixed for the foreseeable future.
    The branches master (official) and develop (fairly stable) live here.
  * We have introduced a new development branch leading up to v3.0.
    The v3 API will be optional to use: the v2.2 API is still included.

diff --git a/README b/README
@@ -3,7 +3,7 @@ This is the README file for `p4est`.
 `p4est` is a C library to manage a collection (a forest) of multiple
 connected adaptive quadtrees or octrees in parallel.
 
-Copyright (C) 2010 The University of Texas System  
+Copyright (C) 2010 The University of Texas System
 Additional copyright (C) 2011 individual authors
 
 `p4est` is written by Carsten Burstedde, Lucas C. Wilcox, and Tobin Isaac
@@ -26,7 +26,7 @@ The authors thank the Texas Advanced
 Computing Center (TACC) for providing them with access to the Ranger
 supercomputer under NSF TeraGrid award MCA04N026, and the National Center for
 Computational Science (NCCS) for early-user access to the Jaguar Cray XT5
-supercomputer.  Any opinions, findings and conclusions or recomendations
+supercomputer.  Any opinions, findings and conclusions or recommendations
 expressed in the source code and documentation are those of the authors and do
 not necessarily reflect the views of the National Science Foundation (NSF).
 
@@ -147,7 +147,7 @@ path.
 Note that the `--disable-shared` option suppresses the build of `.so` shared object lib files.
 In case these are also required this option needs to be omitted or changed to `--enable-shared`.
 
-The `configure` call is then followed by the usual `make` and `make install` commands, 
+The `configure` call is then followed by the usual `make` and `make install` commands,
 the latter potentially in `sudo` mode depending on the desired installation directory.
 
 The subpackage `sc` is contained in the tarball and used by default.  It is

diff --git a/_typos.toml b/_typos.toml
@@ -0,0 +1,22 @@
+[files]
+extend-exclude = ["sc/*"]
+
+#[default.extend-words]
+
+[default.extend-identifiers]
+Ba = "Ba"
+MPI_MODE_WRONLY = "MPI_MODE_WRONLY"
+PNGs = "PNGs"
+anc = "anc"
+clen = "clen"
+eiter = "eiter"
+fiter = "fiter"
+fo = "fo"
+halfs = "halfs"
+nce = "nce"
+nd = "nd"
+nin = "nin"
+nown = "nown"
+onl262 = "onl262"
+ot = "ot"
+ue = "ue"
diff --git a/cmake/p4est_config.h.in b/cmake/p4est_config.h.in
@@ -39,7 +39,7 @@
 /* Define to 1 if we enable zlib compression for vtk binary data */
 #cmakedefine P4EST_ENABLE_VTK_COMPRESSION 1
 
-/* Define to 1 if we use depreacted data file format */
+/* Define to 1 if we use deprecated data file format */
 #cmakedefine P4EST_ENABLE_FILE_DEPRECATED 1
 
 /* Define to a macro mangling the given C identifier (in lower and upper
@@ -75,7 +75,7 @@
 #cmakedefine HAVE_LUA 1
 
 /* Define to 1 if we have the <memory.h> header file. */
-#cmakedefine P4EST_HAVE_MEMORY_H 1 
+#cmakedefine P4EST_HAVE_MEMORY_H 1
 
 /* Define to 1 if we have the <netinet/in.h> header file. */
 #cmakedefine P4EST_HAVE_NETINET_IN_H 1

diff --git a/cmake/print_target_properties.cmake b/cmake/print_target_properties.cmake
@@ -3,7 +3,7 @@
 # see https://stackoverflow.com/questions/32183975/how-to-print-all-the-properties-of-a-target-in-cmake
 
 #
-# Get all propreties that cmake supports
+# Get all properties that cmake supports
 #
 execute_process(COMMAND cmake --help-property-list OUTPUT_VARIABLE CMAKE_PROPERTY_LIST)
 

diff --git a/config/p4est_petsc.m4 b/config/p4est_petsc.m4
@@ -111,7 +111,7 @@ EOF
     $1_PETSC_LINK_LIBS=`make -s -f Makefile_config_petsc getlinklibs`
     $1_PETSC_INCLUDE_DIRS=`make -s -f Makefile_config_petsc getincludedirs`
     rm -f Makefile_config_petsc
-  else 
+  else
     AC_MSG_ERROR([unable to find $$1_PETSC_DIR/makefile or $$1_PETSC_DIR/conf/variables\
  or $$1_PETSC_DIR/lib/petsc-conf/variables or $$1_PETSC_DIR/lib/petsc/conf/variables])
   fi

diff --git a/configure.ac b/configure.ac
@@ -26,7 +26,7 @@ P4EST_ARG_ENABLE([debug], [enable debug mode (assertions and extra checks)],
                  [DEBUG])
 P4EST_ARG_ENABLE([vtk-doubles], [use doubles for vtk file data],
                  [VTK_DOUBLES])
-P4EST_ARG_ENABLE([file-deprecated], [use depreacted data file format],
+P4EST_ARG_ENABLE([file-deprecated], [use deprecated data file format],
                  [FILE_DEPRECATED])
 P4EST_ARG_DISABLE([vtk-binary], [write vtk ascii file data],
                   [VTK_BINARY])

diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
@@ -457,7 +457,7 @@ LOOKUP_CACHE_SIZE      = 0
 # than 0 to get more control over the balance between CPU load and processing
 # speed. At this moment only the input processing can be done using multiple
 # threads. Since this is still an experimental feature the default is set to 1,
-# which efficively disables parallel processing. Please report any issues you
+# which effectively disables parallel processing. Please report any issues you
 # encounter. Generating dot graphs in parallel is controlled by the
 # DOT_NUM_THREADS setting.
 # Minimum value: 0, maximum value: 32, default value: 1.

diff --git a/doc/coding_standards.txt b/doc/coding_standards.txt
@@ -75,7 +75,7 @@ library tries to adhere to.
 
        printf ("%jd %ju", (intmax_t) i, (uintmax_t) u);
 
-   since that would be a nice way to accomodate 128 bit integers without
+   since that would be a nice way to accommodate 128 bit integers without
    changing the `printf` code.
    This also holds for `size_t` since support for the following is still
    incomplete:

diff --git a/doc/doxygen/example_particles.dox b/doc/doxygen/example_particles.dox
@@ -61,7 +61,7 @@
  * as a convenience.  The point is dropped if the range becomes empty,
  * and the recursion terminates if the range shrinks to one process.
  *
- * ### Transfering particles to their elements
+ * ### Transferring particles to their elements
  *
  * In this example, if a particle changes process we send it there.
  * Thus every process sends one message per receiver process containing
@@ -117,7 +117,7 @@
  * then \ref p4est_partition it using a \ref p4est_weight_t function
  * that takes into account the number of particles per element.
  *
- * ### Transfering particles on repartitioning
+ * ### Transferring particles on repartitioning
  *
  * We have kept the original refined mesh holding the particles and made
  * a repartitioned mesh that is properly load balanced but still missing the

diff --git a/doc/doxygen/forest.dox b/doc/doxygen/forest.dox
@@ -81,7 +81,7 @@
  * This is a way to keep the application state referenced in a forest object.
  *
  * The resulting \b forest object in the above example represents a uniform mesh
- * (with the coarse mesh topolgy as encoded in the passed \b connectivity)
+ * (with the coarse mesh topology as encoded in the passed \b connectivity)
  * refined to the specified level.
  * It is also possible to create a partition-dependent mesh by changing the two
  * parameters set to 0 and 1 in the example above.
@@ -115,7 +115,7 @@
  * criterion, i.e. a user-defined callback function. This function is
  * partition-dependent if families of leaves are split across processes.
  * Partition-independent forests created using \ref p4est_new or \ref
- * p4est_new_ext as described above do not split families among proccesses.
+ * p4est_new_ext as described above do not split families among processes.
  * In the case that the forest's partition is adjusted, the last call of \ref
  * p4est_partition or \ref p4est_partition_ext must be with
  * allow_for_coarsening activated (cf. the next section) to ensure

diff --git a/doc/doxygen/installation.dox b/doc/doxygen/installation.dox
@@ -58,7 +58,7 @@
  *
  * You may also set environment variables like `CFLAGS="-Wall -g"`.
  *
- * \subsubsection complile_software 4. Compile the software
+ * \subsubsection compile_software 4. Compile the software
  *
  * > `make -j`
  *

diff --git a/doc/doxygen/search.dox b/doc/doxygen/search.dox
@@ -114,7 +114,7 @@
  * whose local mesh they intersect. Based on the actions performed in the
  * intersection callback, the user may proceed for example to
  * communicate with the matching process for any point.
- * The reciever of a point can then continue with a local search to identify
+ * The receiver of a point can then continue with a local search to identify
  * one (or more) mesh elements that the point intersects.
  * An example of this parallel search workflow using non-blocking
  * point-to-point communication on the user side can be found in
@@ -301,4 +301,4 @@
 *    -s | --seed      <INT>       Seed for random queries
 *    -v | --write-vtk [0fFnN1tTyY] Activate vtk output
 *    -c | --clustering-exponent <REAL> Clustering of queries \endverbatim
-*/
+*/
diff --git a/doc/morton/morton.py b/doc/morton/morton.py
@@ -225,7 +225,7 @@ def pairs(s):
   if args.pgfplots:
     print "dimension level length continuous discontinuous contfrac"
     print "# " + " ".join(sys.argv)
-  
+
   for (level,length) in args.segments:
     counts = table.enumerate(level,length)
     if args.pgfplots:

diff --git a/doc/plans.txt b/doc/plans.txt
@@ -1,6 +1,6 @@
 ## List of proposed p4est and libsc API changes
 
-### Backards compatible
+### Backwards compatible
 
 1.  Increase maximum level in 3D to 30.
 1.  Extend the fix for neighborhood_owned to take a btype.

diff --git a/doc/tex/interface-howto.tex b/doc/tex/interface-howto.tex
@@ -165,7 +165,7 @@ \section{Starting point}
   child {
     node (p4estcoarsen) {\texttt{p4est\_coarsen (p)}}
   }
-  child { 
+  child {
     node (p4estbalance) {\texttt{p4est\_balance (p)}}
   }
   child {
@@ -257,7 +257,7 @@ \section{Starting point}
   The \texttt{nodes} and \texttt{lnodes} constructors create a processor-local
   view of globally unique node numbers and the dependency lists for hanging
   nodes for continuous tensor-product piecewise linear and piecewise polynomial
-  finite elements, respectively.  
+  finite elements, respectively.
   The iterator provides a generic way to traverse the refinement structure and to
   have callbacks executed for every face, edge, and corner neighborhood, which can
   then be used to identify node locations and their hanging status for any custom

diff --git a/doc/webpage/cite.html b/doc/webpage/cite.html
@@ -301,7 +301,7 @@ <h3>PETSc</h3>
 Advanced Computing Center (TACC) for providing them with access to the Ranger
 supercomputer under NSF TeraGrid award MCA04N026, and the National Center for
 Computational Science (NCCS) for early-user access to the Jaguar Cray XT5
-supercomputer.  Any opinions, findings and conclusions or recomendations
+supercomputer.  Any opinions, findings and conclusions or recommendations
 expressed on this web page or in the source code and documentation are those of
 the authors and do not necessarily reflect the views of the National Science
 Foundation (NSF).

diff --git a/doc/webpage/gallery.html b/doc/webpage/gallery.html
@@ -53,7 +53,7 @@ <h2 class="nav-item">
 Advanced Computing Center (TACC) for providing them with access to the Ranger
 supercomputer under NSF TeraGrid award MCA04N026, and the National Center for
 Computational Science (NCCS) for early-user access to the Jaguar Cray XT5
-supercomputer.  Any opinions, findings and conclusions or recomendations
+supercomputer.  Any opinions, findings and conclusions or recommendations
 expressed on this web page or in the source code and documentation are those of
 the authors and do not necessarily reflect the views of the National Science
 Foundation (NSF).

diff --git a/doc/webpage/index.html b/doc/webpage/index.html
@@ -145,7 +145,7 @@ <h3>Proprietary / Commercial use</h3>
 The GPL license permits any use whatsoever as long as derived works
 are open-sourced under the same terms.
 For commercial, closed-source use, such as distributing a binary executable
-without the source, you may double-license the software by negotating the terms
+without the source, you may double-license the software by negotiating the terms
 with <a href="mailto:burstedde@ins.uni-bonn.de">myself</a>
 and <a href="https://research.utexas.edu/otc/">UT Austin OTC</a>.
 </p>

diff --git a/doc/webpage/school.html b/doc/webpage/school.html
@@ -76,7 +76,7 @@ <h2>The tutorials/exercises linked below are still being updated.</h2>
 <p>
 During the actual week of the conference, we have been hosting
 video tutorials and Q&amp;A sessions during <em>German afternoon time</em>
-and discussed selected solutions to excercises and best practices.
+and discussed selected solutions to exercises and best practices.
 </p>
 <p>
 You may find the recordings of Big Blue Button sessions in the webpage of the

diff --git a/doc/webpage/tutorial-build.html b/doc/webpage/tutorial-build.html
@@ -206,14 +206,14 @@ <h3>Creating a new example</h3>
 The MPI communicator <code>mpicomm</code> is remembered to determine the ranks
 for logging messages.
 This communicator does <em>not</em> need to be the same as the one later passed
-to <code>p4est_new</code> and friends, but we recommand the later ones to be at
+to <code>p4est_new</code> and friends, but we recommend the later ones to be at
 least subsets with identical rank zero such that the prefixes of log messages
 make sense.
 </p>
 <p class="book">
 If you are not writing your <code>main</code> function but rather use
 <tt>p4est</tt> from library code, replace the two <code>1</code> arguments
-with <code>0</code>, which disables some sytem-level error hooks, and possibly
+with <code>0</code>, which disables some system-level error hooks, and possibly
 bump the log level to <code>SC_LP_ERROR</code> to make the library quiet.
 </p>
 <p class="book">

diff --git a/doc/webpage/tutorial-forest.html b/doc/webpage/tutorial-forest.html
@@ -67,7 +67,7 @@ <h2>Create and manipulate a forest of octrees</h2>
 <h3>Create a forest of octrees</h3>
 <p class="book">
 A fundamental step of a typical workflow with <tt>p4est</tt> is to create a forest
-of octrees or quadtrees. The <tt>p4est</tt> libary offers the functions
+of octrees or quadtrees. The <tt>p4est</tt> library offers the functions
 <code>p4est_new</code> and <code>p4est_new_ext</code> (a version with more
 parameters) to create such a forest.
 </p>
@@ -88,7 +88,7 @@ <h3>Create a forest of octrees</h3>
 href="https://github.com/cburstedde/p4est/blob/prev3-develop/example/simple/simple2.c">example
 simple</a> for a usage example).
 <!--
-By <code>min_quadtrants</code> the user can prescribe the minimal intial number of quadrants per
+By <code>min_quadtrants</code> the user can prescribe the minimal initial number of quadrants per
 processor.
 //-->
 The highest occurring <code>level</code> of refinement is specified.
@@ -127,7 +127,7 @@ <h3>Manipulate the refinement structure and the partition</h3>
 the <code>struct p4est_quadrant</code> is declared and documented.
 </p>
 <p class="book">
-Our next step in the workflow is to manipulate the refinement structure. The <tt>p4est</tt> libary offers the
+Our next step in the workflow is to manipulate the refinement structure. The <tt>p4est</tt> library offers the
 following functions to manipulate the forest of quadtrees (2D) or octrees (3D).
 They are collective over the MPI communicator passed to <code>p4est_new</code>.
 </p>
@@ -144,7 +144,7 @@ <h3>Manipulate the refinement structure and the partition</h3>
 user-defined callback function.</dd>
 <dt><code><a href="https://github.com/cburstedde/p4est/blob/prev3-develop/src/p4est.h#L350-L360">p4est_balance</a></code></dt>
 <dd>This function ensures a 2:1 balance of the size differences of
-neigboring elements in a forest by refining quadrants.
+neighboring elements in a forest by refining quadrants.
 This is accomplished by adding some more refinement where needed.
 </dd>
 <dt><code><a href="https://github.com/cburstedde/p4est/blob/prev3-develop/src/p4est.h#L362-L382">p4est_partition</a></code></dt>

diff --git a/example/CMakeLists.txt b/example/CMakeLists.txt
@@ -132,4 +132,4 @@ endforeach()
 p4est_example (userdata "userdata/userdata2.c;userdata/userdata_run2.c" "userdata")
 if(enable_p8est)
   p8est_example(userdata "userdata/userdata3.c;userdata/userdata_run3.c" "userdata")
-endif()
+endif()
diff --git a/example/dune/dune_interface2.c b/example/dune/dune_interface2.c
@@ -364,7 +364,7 @@ main (int argc, char **argv)
     }
   }
 
-  /* print usage message if error occured up to this point */
+  /* print usage message if error occurred up to this point */
   if (progerr) {
     P4EST_GLOBAL_LERROR (usage);
   }

diff --git a/example/mesh/Makefile.am b/example/mesh/Makefile.am
@@ -16,4 +16,4 @@ example_mesh_p8est_mesh_SOURCES = example/mesh/mesh3.c
 example_mesh_p8est_periodicity_SOURCES = example/mesh/periodicity3.c
 endif
 
-EXTRA_DIST += example/mesh/conndebug.p8c
+EXTRA_DIST += example/mesh/conndebug.p8c
diff --git a/example/points/points2.c b/example/points/points2.c
@@ -66,7 +66,7 @@ read_points (const char *filename,
   sc_MPI_File         file_handle;
   sc_MPI_Offset       mpi_offset;
 
-  /* special treament for brick connectivity */
+  /* special treatment for brick connectivity */
   if(!strcmp (conn_name, "brick"))
     is_brick_connectivity = 1;
   else

diff --git a/example/search/count_quadrants2.c b/example/search/count_quadrants2.c
@@ -27,7 +27,7 @@
  *
  * This 2D example program counts all quadrants in a given tree structure
  * using p4est search routine(s).
- * Both branch quadrants and leaf quadrants are added separetely.
+ * Both branch quadrants and leaf quadrants are added separately.
  * Leaf quadrant are always local to a given process, so their global number
  * is independent of the partition of any given mesh refinement structure.
  * We count branch quadrants only for the process that owns a first descendant,
@@ -240,7 +240,7 @@ main (int argc, char **argv)
   /* Print total quadrants (leaf + branch) in the tree structure. */
   mpiret = sc_MPI_Barrier (p4est->mpicomm);
   SC_CHECK_MPI (mpiret);
-  P4EST_GLOBAL_PRODUCTIONF ("Global aggregrate quadrant count = %lld\n",
+  P4EST_GLOBAL_PRODUCTIONF ("Global aggregate quadrant count = %lld\n",
                             (long long) qs.global_aggregate_count);
 
   /* Free memory. */