-
Notifications
You must be signed in to change notification settings - Fork 55
Documentation
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.
Installation Guide
Configure Options
Setup t8code on JUWELS and other Slurm based systems
Setup t8code for VTK
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
Documentation
Tree Indexing
Element Indexing
Running on JUWELS using Slurm
Overview of the most used API functions
Known issues
Workflow - FreeCAD to t8code
Reproducing Scaling Results
Coding Guidelines
Tips
Debugging with gdb
Debugging with valgrind
Test driven development
Testing with GoogleTest
Writing C interface code