# saltedc137/vertexfem architecture

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

- Interactive diagram: https://gitdiagram.com/saltedc137/vertexfem
- Repository: https://github.com/saltedc137/vertexfem

## Overview

VertexFEM is an early-stage C++ library for vertex-centered finite element methods. Its intended user workflow is to provide a mesh, define a finite-element space, assemble a problem, solve it with linear algebra support, and optionally write mesh output. The README describes these as independent modules, but the sampled implementations are mostly stubs, so workflow links are dashed and unverified. Memory management, precision/platform configuration, errors, and logging are present runtime foundations; GPU, distributed-memory, and external-solver capabilities are planned or optional.

Main entry points: [`include/base/mem_manager.hpp`](https://github.com/saltedc137/vertexfem/blob/master/include/base/mem_manager.hpp) (Memory manager), [`src/mesh/mesh.cpp`](https://github.com/saltedc137/vertexfem/blob/master/src/mesh/mesh.cpp) (Mesh), [`config/config.hpp`](https://github.com/saltedc137/vertexfem/blob/master/config/config.hpp) (Precision and platform config), [`src/fem/fespace.cpp`](https://github.com/saltedc137/vertexfem/blob/master/src/fem/fespace.cpp) (Finite element space)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_fem["FEM workflow"]
  node_mesh["Mesh<br/>[mesh.cpp]"]
  node_fespace["Finite element space<br/>[fespace.cpp]"]
  node_assembly["Assembly<br/>[assembler.cpp]"]
  node_vector["Linear algebra<br/>[vector.cpp]"]
  node_solver["Linear solver<br/>[linear_solver.cpp]"]
  node_mesh_io["Mesh output<br/>[mesh_write.cpp]"]
end

subgraph group_runtime["Runtime foundations"]
  node_memory["Memory manager<br/>[mem_manager.hpp]"]
  node_errors["Error handling<br/>[error.hpp]"]
  node_logging["Logging<br/>[log.cpp]"]
  node_checks["Runtime checks<br/>[check.hpp]"]
end

subgraph group_platform["Platform support"]
  node_config["Precision and platform config<br/>[config.hpp]"]
  node_gpu["GPU backends"]
  node_mpi["MPI parallelism"]
end

subgraph group_integrations["Solver integrations"]
  node_umpire["Umpire"]
  node_external_solvers["Optional solver libraries"]
end

node_user(("Library user"))

node_user -.->|"provides input"| node_mesh
node_mesh -.->|"supports definition"| node_fespace
node_fespace -.->|"feeds assembly"| node_assembly
node_assembly -.->|"produces system"| node_vector
node_vector -.->|"supports solve"| node_solver
node_mesh -.->|"writes mesh"| node_mesh_io
node_memory -->|"uses configuration"| node_config
node_memory -->|"reports errors"| node_errors
node_checks -->|"logs failed checks"| node_logging
node_config -.->|"defines device abstractions"| node_gpu
node_config -.->|"selects precision type"| node_mpi
node_memory -.->|"optional allocation"| node_umpire
node_solver -.->|"optional solver support"| node_external_solvers

click node_mesh "https://github.com/saltedc137/vertexfem/blob/master/src/mesh/mesh.cpp"
click node_fespace "https://github.com/saltedc137/vertexfem/blob/master/src/fem/fespace.cpp"
click node_assembly "https://github.com/saltedc137/vertexfem/blob/master/src/asm/assembler.cpp"
click node_vector "https://github.com/saltedc137/vertexfem/blob/master/src/linalg/vector.cpp"
click node_solver "https://github.com/saltedc137/vertexfem/blob/master/src/solver/linear_solver.cpp"
click node_mesh_io "https://github.com/saltedc137/vertexfem/blob/master/src/io/mesh_write.cpp"
click node_memory "https://github.com/saltedc137/vertexfem/blob/master/include/base/mem_manager.hpp"
click node_errors "https://github.com/saltedc137/vertexfem/blob/master/include/base/error.hpp"
click node_logging "https://github.com/saltedc137/vertexfem/blob/master/src/utils/log.cpp"
click node_checks "https://github.com/saltedc137/vertexfem/blob/master/include/utils/check.hpp"
click node_config "https://github.com/saltedc137/vertexfem/blob/master/config/config.hpp"

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_mesh,node_fespace,node_assembly,node_vector,node_solver,node_mesh_io,node_user toneBlue
class node_memory,node_errors,node_logging,node_checks toneAmber
class node_config,node_gpu,node_mpi toneMint
class node_umpire,node_external_solvers toneRose
```

## Components

### FEM workflow

- [Mesh](https://github.com/saltedc137/vertexfem/blob/master/src/mesh/mesh.cpp): `src/mesh/mesh.cpp`
- [Finite element space](https://github.com/saltedc137/vertexfem/blob/master/src/fem/fespace.cpp): `src/fem/fespace.cpp`
- [Assembly](https://github.com/saltedc137/vertexfem/blob/master/src/asm/assembler.cpp): `src/asm/assembler.cpp`
- [Linear algebra](https://github.com/saltedc137/vertexfem/blob/master/src/linalg/vector.cpp): `src/linalg/vector.cpp`
- [Linear solver](https://github.com/saltedc137/vertexfem/blob/master/src/solver/linear_solver.cpp): `src/solver/linear_solver.cpp`
- [Mesh output](https://github.com/saltedc137/vertexfem/blob/master/src/io/mesh_write.cpp): `src/io/mesh_write.cpp`

### Runtime foundations

- [Memory manager](https://github.com/saltedc137/vertexfem/blob/master/include/base/mem_manager.hpp): `include/base/mem_manager.hpp`
- [Error handling](https://github.com/saltedc137/vertexfem/blob/master/include/base/error.hpp): `include/base/error.hpp`
- [Logging](https://github.com/saltedc137/vertexfem/blob/master/src/utils/log.cpp): `src/utils/log.cpp`
- [Runtime checks](https://github.com/saltedc137/vertexfem/blob/master/include/utils/check.hpp): `include/utils/check.hpp`

### Platform support

- [Precision and platform config](https://github.com/saltedc137/vertexfem/blob/master/config/config.hpp): `config/config.hpp`
- **GPU backends**
- **MPI parallelism**

### Solver integrations

- **Umpire**
- **Optional solver libraries**

### Other components

- **Library user**

## Connections

- Library user → Mesh: provides input
- Mesh → Finite element space: supports definition
- Finite element space → Assembly: feeds assembly
- Assembly → Linear algebra: produces system
- Linear algebra → Linear solver: supports solve
- Mesh → Mesh output: writes mesh
- Memory manager → Precision and platform config: uses configuration (evidence: `include/base/mem_manager.hpp`)
- Memory manager → Error handling: reports errors (evidence: `include/base/mem_manager.hpp`)
- Runtime checks → Logging: logs failed checks (evidence: `include/utils/check.hpp`)
- Precision and platform config → GPU backends: defines device abstractions
- Precision and platform config → MPI parallelism: selects precision type (evidence: `config/config.hpp`)
- Memory manager → Umpire: optional allocation
- Linear solver → Optional solver libraries: optional solver support
