-
Notifications
You must be signed in to change notification settings - Fork 61
Documentation
lenaploetzke edited this page Feb 14, 2025
·
2 revisions
t8code uses Doxygen to generate the code documentation. You can find the documentation of our releases on the t8code website.
Follow the steps below to create the documentation locally.
- Set the value of the build option
T8CODE_BUILD_DOCUMENTATIONtoON. - Build the target
Doxygenusing
make Doxygen
and then find the generated files in the /doc subdirectory of your build folder.
- For example, open the
doc/html/index.htmlfile to view the documentation.
General
Step 0 Hello World
Step 1 Creating a coarse mesh
Step 2 Creating a uniform forest
Step 3 Adapting a forest
Step 4 Partition,-Balance,-Ghost
Step 5 Store element data
Step 6 Computing stencils
Step 7 Interpolation
Features
Prerequisites & Compilation
t8_time_forest_partition
t8_time_fractal
t8_time_new_refine
t8_time_partition
t8_time_prism
t8_time_set_join_by_vertices