Interface Documentation
Version: invalid
FleCSI Doxygen Mainpage

FleCSI is a compile-time configurable C++ framework designed to support multi-physics application development. As such, FleCSI attempts to provide a very general set of infrastructure design patterns that can be specialized and extended to suit the needs of a broad variety of solver and data requirements. Current support includes multi-dimensional mesh topology, mesh geometry, and mesh adjacency information, n-dimensional hashed-tree data structures, graph partitioning interfaces, and dependency closures (to identify data dependencies between distributed-memory address spaces).

FleCSI also introduces a functional programming model with control, execution, and data abstractions that are consistent state-of-the-art task-based runtimes such as Legion and Charm++. The FleCSI abstraction layer provides the developer with insulation from the underlying runtime, while allowing support for multiple runtime systems, including conventional models like asynchronous MPI. The intent is to give developers a concrete set of user-friendly programming tools that can be used now, while allowing flexibility in choosing runtime implementations and optimizations that can be applied to architectures and runtimes that arise in the future.

FleCSI uses static polymorphism, template meta-programming techniques, and other modern C++ features to achieve high runtime performance, customizability, and to enable DSL-like features in our programming model. In both the mesh and tree topology types, FleCSI adopts a three-tiered approach: a low-level core library that is customized by a mid-level specialization layer to create a high-level application interface. This structure facilitates separation of concerns, both between developer roles, and between the structural components that make up a FleCSI-based application.

FleCSI Code Structure

The FleCSI code base is divided into several namespaces:

Each of these is described in more detail in the developer guide. Documentation is also provide in the corresponding Doxygen modules.

Naming Conventions

The suffix _t is often used to indicate the specialization of interest of a class template of the same name without the suffix:

// Unqualified type.
typename T
struct type_name {};
// Fully-qualified type.
using type_name_t = type_name<double>;

More Documentation

This document is intended only as documentation for the FleCSI C++ interface. The FleCSI Developer and User Guides are available here.