Skip to content

Examples.rst

Latest commit

 

History

History
57 lines (44 loc) · 2.65 KB

Examples.rst

File metadata and controls

57 lines (44 loc) · 2.65 KB
Raw

Overview

The :file:`Examples/` folder contains pure EBGeometry examples with no third-party dependencies. Each one can be built directly with a compiler, with GNU Make, or with CMake (see :ref:`Chap:Building`), and every folder ships all three (a GNUmakefile, a CMakeLists.txt, and a plain main.cpp compilable with a single compiler invocation).

Alongside the examples with dedicated pages below, the following BVH and point-cloud examples ship in :file:`Examples/`:

  • BuildBVH -- compares the BVH construction strategies (top-down, SAH, and the Morton, Hilbert, and Nested space-filling-curve builds) by build time.
  • ClosestPointBVH -- closest-point search over a point cloud using the PointCloudBVH class (see :ref:`Chap:ImplemPointCloud`).
  • NearestNeighborBVH -- the k-nearest-neighbor graph of a point cloud via PointCloudBVH::allNearestNeighbors().

Examples that couple EBGeometry to a third-party application code's embedded-boundary grid generation (AMReX, Chombo) live separately under :file:`Integrations/` instead, and additionally require that platform to be installed — see :ref:`Chap:Integrations`.

None of the EBGeometry examples produce output for visualization; they print timing and/or correctness information to the terminal. Each example folder also ships its own README.md with the exact build/run commands reproduced on its page.

Building and running any of them

Every example needs the path to the EBGeometry root — the directory containing EBGeometry.hpp — which is two levels up (../..) when building in place. All three build methods accept the same two overrides: PRECISION/EBGEOMETRY_PRECISION (float or double, default double) and the location of the EBGeometry tree itself (EBGEOMETRY_HOME, default ../..); all three also produce the binary (<Example>.ex) directly in the example's own folder, regardless of where the CMake build tree itself lives:

# CMake
cmake -S . -B build -DEBGEOMETRY_PRECISION=float -DEBGEOMETRY_HOME=/path/to/EBGeometry
cmake --build build
./<Example>.ex

# GNU Make
make PRECISION=float EBGEOMETRY_HOME=/path/to/EBGeometry
./<Example>.ex

# Direct compilation
g++ -std=c++17 -O3 -march=native -DEBGEOMETRY_PRECISION=float -I../.. main.cpp -o <Example>.ex
./<Example>.ex

Run every example from inside its own folder — several resolve a default input mesh relative to the run directory. See :ref:`Chap:Building` for the full detail on each build method.