# arcaneframework/framework architecture

> Architecture diagram of the GitHub repository arcaneframework/framework, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/arcaneframework/framework
- Repository: https://github.com/arcaneframework/framework

## Overview

Arcane is a development platform for parallel unstructured-mesh numerical simulations, with Alien providing distributed linear-algebra and solver integration. The principal workflow is: a simulation supplies case configuration and mesh data; Arcane manages mesh, variables, parallel synchronization, and execution; Alien assembles/indexes linear systems and dispatches configured solver backends; results are written for post-processing or restart. The sampled code strongly evidences mesh ghost exchange, typed data factories, distributed index preparation, and SYCL accelerator integration; broader I/O and time-loop links follow README capabilities.

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["Arcane Runtime"]
  node_arcane_runtime["Arcane Runtime"]
  node_case_config["Case Configuration"]
  node_time_loop["Time Loop"]
  node_result_io["Results and Restart"]
end

subgraph group_meshdata["Mesh and Data"]
  node_mesh_model["Mesh Model"]
  node_data_factory["Data Factory"]
  node_data_type_info["Data Type Info"]
  node_ghost_exchange["Ghost Exchange"]
end

subgraph group_parallel["Parallel Execution"]
  node_parallel_runtime["Parallel Runtime"]
  node_accelerator_engine["Accelerator Engine"]
  node_sycl_environment["SYCL Environment"]
end

subgraph group_alien["Alien Algebra"]
  node_index_manager["Index Manager<br/>[IndexManager.cc]"]
  node_system_assembly["System Assembly"]
  node_linear_algebra["Linear Algebra"]
  node_solver_dispatch["Solver Dispatch"]
end

subgraph group_integrations["Solver Integrations"]
  node_petsc_backend["PETSc Backend"]
  node_hypre_backend["Hypre Backend"]
  node_mtl_backend["MTL Backend"]
  node_composyx_backend["Composyx Backend"]
end

node_simulation_user(("Simulation Code"))
node_mpi_service["MPI Runtime"]

node_simulation_user -->|"runs simulation"| node_arcane_runtime
node_arcane_runtime -->|"reads options"| node_case_config
node_arcane_runtime -->|"manages mesh"| node_mesh_model
node_arcane_runtime -->|"drives iterations"| node_time_loop
node_time_loop -->|"writes results"| node_result_io
node_mesh_model -->|"builds ghosts"| node_ghost_exchange
node_ghost_exchange -->|"exchanges items"| node_parallel_runtime
node_parallel_runtime -.->|"uses messaging"| node_mpi_service
node_data_factory -->|"records type"| node_data_type_info
node_data_factory -->|"creates data"| node_mesh_model
node_mesh_model -->|"provides items"| node_index_manager
node_index_manager -->|"distributes indices"| node_parallel_runtime
node_system_assembly -->|"builds systems"| node_linear_algebra
node_linear_algebra -->|"solves systems"| node_solver_dispatch
node_solver_dispatch -.->|"dispatches optionally"| node_petsc_backend
node_solver_dispatch -.->|"dispatches optionally"| node_hypre_backend
node_solver_dispatch -.->|"dispatches optionally"| node_mtl_backend
node_solver_dispatch -.->|"dispatches optionally"| node_composyx_backend
node_arcane_runtime -->|"runs kernels"| node_accelerator_engine
node_accelerator_engine -.->|"uses SYCL"| node_sycl_environment

click node_arcane_runtime "https://github.com/arcaneframework/framework/tree/main/arcane/src/arcane"
click node_case_config "https://github.com/arcaneframework/framework/tree/main/axlstar/Arcane.Axl/Arcane.Axl.Generator.Cpp"
click node_time_loop "https://github.com/arcaneframework/framework/tree/main/arcane/src/arcane"
click node_mesh_model "https://github.com/arcaneframework/framework/tree/main/arcane/src/arcane/mesh"
click node_data_factory "https://github.com/arcaneframework/framework/blob/main/arcane/src/arcane/impl/DataStorageFactory.h"
click node_data_type_info "https://github.com/arcaneframework/framework/blob/main/arcane/src/arcane/core/datatype/DataStorageTypeInfo.h"
click node_ghost_exchange "https://github.com/arcaneframework/framework/blob/main/arcane/src/arcane/mesh/ExtraGhostItemsManager.cc"
click node_parallel_runtime "https://github.com/arcaneframework/framework/tree/main/arcane/src/arcane/core"
click node_accelerator_engine "https://github.com/arcaneframework/framework/blob/main/alien/ArcaneInterface/modules/arcane_tools/src/alien/arcane_tools/accelerator/ArcaneParallelEngine.cc"
click node_sycl_environment "https://github.com/arcaneframework/framework/blob/main/alien/standalone/src/core/alien/kernels/sycl/data/SYCLParallelEngine.cc"
click node_index_manager "https://github.com/arcaneframework/framework/blob/main/alien/standalone/src/core/alien/index_manager/IndexManager.cc"
click node_system_assembly "https://github.com/arcaneframework/framework/tree/main/alien/ArcaneInterface/modules/arcane_tools/src/alien/arcane_tools/assembly_tools"
click node_linear_algebra "https://github.com/arcaneframework/framework/tree/main/alien/ArcaneInterface/modules/core_solvers/src/alien/kernels/common"
click node_solver_dispatch "https://github.com/arcaneframework/framework/blob/main/alien/ArcaneInterface/modules/core_solvers/src/alien/kernels/common/linear_solver/arcane/AlienLinearSolver.cc"
click node_petsc_backend "https://github.com/arcaneframework/framework/tree/main/alien/ArcaneInterface/modules/external_packages/src/alien/kernels/petsc"
click node_hypre_backend "https://github.com/arcaneframework/framework/tree/main/alien/ArcaneInterface/modules/external_packages/src/alien/kernels/hypre"
click node_mtl_backend "https://github.com/arcaneframework/framework/tree/main/alien/ArcaneInterface/modules/external_packages/src/alien/kernels/mtl"
click node_composyx_backend "https://github.com/arcaneframework/framework/tree/main/alien/ArcaneInterface/modules/composyx/src/alien/kernels/composyx"
click node_result_io "https://github.com/arcaneframework/framework/tree/main/arcane/src/arcane"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_arcane_runtime,node_case_config,node_time_loop,node_result_io toneBlue
class node_mesh_model,node_data_factory,node_data_type_info,node_ghost_exchange toneAmber
class node_parallel_runtime,node_accelerator_engine,node_sycl_environment toneMint
class node_index_manager,node_system_assembly,node_linear_algebra,node_solver_dispatch toneRose
class node_petsc_backend,node_hypre_backend,node_mtl_backend,node_composyx_backend,node_simulation_user,node_mpi_service toneIndigo
```

## Components

### Arcane Runtime

- [Arcane Runtime](https://github.com/arcaneframework/framework/tree/main/arcane/src/arcane): `arcane/src/arcane`
- [Case Configuration](https://github.com/arcaneframework/framework/tree/main/axlstar/Arcane.Axl/Arcane.Axl.Generator.Cpp): `axlstar/Arcane.Axl/Arcane.Axl.Generator.Cpp`
- [Time Loop](https://github.com/arcaneframework/framework/tree/main/arcane/src/arcane): `arcane/src/arcane`
- [Results and Restart](https://github.com/arcaneframework/framework/tree/main/arcane/src/arcane): `arcane/src/arcane`

### Mesh and Data

- [Mesh Model](https://github.com/arcaneframework/framework/tree/main/arcane/src/arcane/mesh): `arcane/src/arcane/mesh`
- [Data Factory](https://github.com/arcaneframework/framework/blob/main/arcane/src/arcane/impl/DataStorageFactory.h): `arcane/src/arcane/impl/DataStorageFactory.h`
- [Data Type Info](https://github.com/arcaneframework/framework/blob/main/arcane/src/arcane/core/datatype/DataStorageTypeInfo.h): `arcane/src/arcane/core/datatype/DataStorageTypeInfo.h`
- [Ghost Exchange](https://github.com/arcaneframework/framework/blob/main/arcane/src/arcane/mesh/ExtraGhostItemsManager.cc): `arcane/src/arcane/mesh/ExtraGhostItemsManager.cc`

### Parallel Execution

- [Parallel Runtime](https://github.com/arcaneframework/framework/tree/main/arcane/src/arcane/core): `arcane/src/arcane/core`
- [Accelerator Engine](https://github.com/arcaneframework/framework/blob/main/alien/ArcaneInterface/modules/arcane_tools/src/alien/arcane_tools/accelerator/ArcaneParallelEngine.cc): `alien/ArcaneInterface/modules/arcane_tools/src/alien/arcane_tools/accelerator/ArcaneParallelEngine.cc`
- [SYCL Environment](https://github.com/arcaneframework/framework/blob/main/alien/standalone/src/core/alien/kernels/sycl/data/SYCLParallelEngine.cc): `alien/standalone/src/core/alien/kernels/sycl/data/SYCLParallelEngine.cc`

### Alien Algebra

- [Index Manager](https://github.com/arcaneframework/framework/blob/main/alien/standalone/src/core/alien/index_manager/IndexManager.cc): `alien/standalone/src/core/alien/index_manager/IndexManager.cc`
- [System Assembly](https://github.com/arcaneframework/framework/tree/main/alien/ArcaneInterface/modules/arcane_tools/src/alien/arcane_tools/assembly_tools): `alien/ArcaneInterface/modules/arcane_tools/src/alien/arcane_tools/assembly_tools`
- [Linear Algebra](https://github.com/arcaneframework/framework/tree/main/alien/ArcaneInterface/modules/core_solvers/src/alien/kernels/common): `alien/ArcaneInterface/modules/core_solvers/src/alien/kernels/common`
- [Solver Dispatch](https://github.com/arcaneframework/framework/blob/main/alien/ArcaneInterface/modules/core_solvers/src/alien/kernels/common/linear_solver/arcane/AlienLinearSolver.cc): `alien/ArcaneInterface/modules/core_solvers/src/alien/kernels/common/linear_solver/arcane/AlienLinearSolver.cc`

### Solver Integrations

- [PETSc Backend](https://github.com/arcaneframework/framework/tree/main/alien/ArcaneInterface/modules/external_packages/src/alien/kernels/petsc): `alien/ArcaneInterface/modules/external_packages/src/alien/kernels/petsc`
- [Hypre Backend](https://github.com/arcaneframework/framework/tree/main/alien/ArcaneInterface/modules/external_packages/src/alien/kernels/hypre): `alien/ArcaneInterface/modules/external_packages/src/alien/kernels/hypre`
- [MTL Backend](https://github.com/arcaneframework/framework/tree/main/alien/ArcaneInterface/modules/external_packages/src/alien/kernels/mtl): `alien/ArcaneInterface/modules/external_packages/src/alien/kernels/mtl`
- [Composyx Backend](https://github.com/arcaneframework/framework/tree/main/alien/ArcaneInterface/modules/composyx/src/alien/kernels/composyx): `alien/ArcaneInterface/modules/composyx/src/alien/kernels/composyx`

### Other components

- **Simulation Code**
- **MPI Runtime**

## Connections

- Simulation Code → Arcane Runtime: runs simulation
- Arcane Runtime → Case Configuration: reads options
- Arcane Runtime → Mesh Model: manages mesh
- Arcane Runtime → Time Loop: drives iterations
- Time Loop → Results and Restart: writes results
- Mesh Model → Ghost Exchange: builds ghosts
- Ghost Exchange → Parallel Runtime: exchanges items
- Parallel Runtime → MPI Runtime: uses messaging
- Data Factory → Data Type Info: records type
- Data Factory → Mesh Model: creates data
- Mesh Model → Index Manager: provides items
- Index Manager → Parallel Runtime: distributes indices
- System Assembly → Linear Algebra: builds systems
- Linear Algebra → Solver Dispatch: solves systems
- Solver Dispatch → PETSc Backend: dispatches optionally
- Solver Dispatch → Hypre Backend: dispatches optionally
- Solver Dispatch → MTL Backend: dispatches optionally
- Solver Dispatch → Composyx Backend: dispatches optionally
- Arcane Runtime → Accelerator Engine: runs kernels
- Accelerator Engine → SYCL Environment: uses SYCL
