3. h-NUMO Directory Structure

A typical copy of h-NUMO consists of the following:

Makefile
config.user
config.p4est
INSTALL
docs
Examples
lib
make_depend.pl
src
p4est
unused

3.1. bin

Upon successfully compiling h-NUMO, the bin directory will be created along with the executable (numo3d).

3.2. docs

This directory contains the html files that form the documentation that you are now reading.

3.3. Examples

This directory contains several example test cases that can be run with h-NUMO. Each test case is contained in its own sub-directory, which includes input files, run scripts, a clear_data script to remove generated files, and plotting scripts.

3.4. include

This directory contains the *.mod files that are created upon compilation.

3.5. lib

This directory contains the libraries that are used by h-NUMO.

3.6. src

This is the heart of the code and contains all of the source files actively used in h-NUMO. To add a new file to h-NUMO, you have to include it in the file Makefile.

3.7. p4est

h-NUMO uses the p4est library [3] for the data structures and algorithms for parallel mesh generation, partitioning, and load balancing.