ImmersX documentation

ImmersX is a deal.II-based framework for embedded and mixed-dimensional finite-element simulation. The documentation is organized around the task you want to complete.

Find your way around

• Get started: install the prerequisites, build ImmersX, and run your first Poisson example.

• Follow a tutorial: learn the framework through a sequence of runnable simulations.

• Find a how-to: configure applications, boundary conditions, reduced coupling, and output.

• Understand the concepts: read the mathematical and architectural ideas behind the examples.

• Look up the reference: check executable capabilities, parameter groups, and the generated C++ API.

• Integrations: use Coral and dealiiX-platform.

• Performance history: inspect native comparisons, commit regressions, validation failures, and gaps in benchmark coverage.

• Contribute: build, test, document, and extend the project.

• About ImmersX: find references, funding, and the changelog.

The API reference is generated from the public headers. The mathematical background and architecture concepts explain the notation and ownership boundaries used throughout the documentation.