EBGeometry’s user documentation

This is the user documentation for EBGeometry, a small C++ package for efficiently representing implicit functions and signed distance fields for complex geometries. Although EBGeometry is a self-contained package, it is was originally written for usage with embedded boundary (EB) and immersed boundary (IB) codes. EBGeometry provides the geometry representation through an implicit or signed distance function, but does not provide the discrete geometry generation, i.e. the generation of cut-cells for a given geometry.

The basic features of EBGeometry are as follows:

  • Representation of water-tight surface grids as signed distance fields.

  • Many analytic distance functions and transformations.

  • Bounding volume hierarchies (BVHs) for use as acceleration structures for polygon or full object lookup. The BVHs can be represented in full or compact (i.e., linearized) forms.

  • Support for both conventional and accelerated (using BVHs) constructive solid geometry (CSG).

  • Examples of how to couple EBGeometry to AMReX and Chombo.

Important

This is the user documentation for EBGeometry. The source code is found at https://github.com/rmrsk/EBGeometry and a separate Doxygen-generated API of EBGeometry is available at https://rmrsk.github.io/EBGeometry/doxygen/html/index.html.

Introduction

Concepts

Implementation

Examples