# tiagovla/oiseau architecture

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

- Interactive diagram: https://gitdiagram.com/tiagovla/oiseau
- Repository: https://github.com/tiagovla/oiseau

## Overview

oiseau is a research-oriented DG time-domain framework for electromagnetic and wave-propagation simulation. The intended workflow runs from mesh input through DG discretization and geometric/integration operators to a linear DG solver; time-stepping and plotting provide supporting runtime capabilities, and Python exposes selected interfaces. The README also lists dispersive, anisotropic, and vector-fitting capabilities as planned, not established implementations. Edges are limited to README-documented workflow or source-index/import evidence; unsampled runtime wiring is not inferred.

Main entry points: [`src/oiseau/mesh/mesh.hpp`](https://github.com/tiagovla/oiseau/blob/master/src/oiseau/mesh/mesh.hpp) (Mesh model), [`src/oiseau/dg/solver/linear_dg.cpp`](https://github.com/tiagovla/oiseau/blob/master/src/oiseau/dg/solver/linear_dg.cpp) (Linear DG solver), [`src/oiseau/dg/dg_integration.cpp`](https://github.com/tiagovla/oiseau/blob/master/src/oiseau/dg/dg_integration.cpp) (DG integration), [`src/oiseau/dg/dg_connectivity.hpp`](https://github.com/tiagovla/oiseau/blob/master/src/oiseau/dg/dg_connectivity.hpp) (DG connectivity)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_mesh["Mesh input"]
  node_gmsh["Gmsh I/O<br/>[gmsh_file.cpp]"]
  node_meshmodel["Mesh model<br/>[mesh.hpp]"]
  node_cell["Cell topology<br/>[cell.hpp]"]
end

subgraph group_discretization["DG discretization"]
  node_space["DG space<br/>[dg_space.hpp]"]
  node_reference["Reference elements<br/>[ref_element.hpp]"]
  node_connectivity["DG connectivity"]
  node_geometry["DG geometry<br/>[dg_geometry.cpp]"]
  node_operators["DG integration<br/>[dg_integration.cpp]"]
end

subgraph group_simulation["Simulation runtime"]
  node_equations["Equation system<br/>[equation.hpp]"]
  node_solver["Linear DG solver<br/>[linear_dg.cpp]"]
  node_time["Time integrators<br/>[lsrk54.hpp]"]
  node_plot["Plotting<br/>[triplot.hpp]"]
  node_plannedmedia["Planned media models<br/>[equation.hpp]"]
  node_plannedfitting["Planned vector fitting"]
end

subgraph group_interfaces["User interfaces"]
  node_python["Python bindings<br/>[mesh.cpp]"]
end

node_user(("Simulation user"))

node_user -.->|"provides mesh"| node_gmsh
node_gmsh -.->|"reads mesh"| node_meshmodel
node_meshmodel -.->|"discretizes"| node_space
node_meshmodel -->|"builds adjacency"| node_connectivity
node_meshmodel -->|"computes factors"| node_geometry
node_cell -->|"selects shape"| node_reference
node_reference -->|"builds operators"| node_operators
node_connectivity -->|"supplies faces"| node_operators
node_geometry -->|"scales rules"| node_operators
node_user -.->|"runs simulation"| node_solver
node_solver -->|"uses adjacency"| node_connectivity
node_solver -->|"uses factors"| node_geometry
node_solver -->|"uses operators"| node_operators
node_user -.->|"uses interface"| node_python
node_user -.->|"planned capability"| node_plannedmedia
node_user -.->|"planned capability"| node_plannedfitting

click node_gmsh "https://github.com/tiagovla/oiseau/blob/master/src/oiseau/io/gmsh_file.cpp"
click node_meshmodel "https://github.com/tiagovla/oiseau/blob/master/src/oiseau/mesh/mesh.hpp"
click node_cell "https://github.com/tiagovla/oiseau/blob/master/src/oiseau/mesh/cell.hpp"
click node_space "https://github.com/tiagovla/oiseau/blob/master/src/oiseau/dg/dg_space.hpp"
click node_reference "https://github.com/tiagovla/oiseau/blob/master/src/oiseau/dg/nodal/ref_element.hpp"
click node_connectivity "https://github.com/tiagovla/oiseau/blob/master/src/oiseau/dg/dg_connectivity.hpp"
click node_geometry "https://github.com/tiagovla/oiseau/blob/master/src/oiseau/dg/dg_geometry.cpp"
click node_operators "https://github.com/tiagovla/oiseau/blob/master/src/oiseau/dg/dg_integration.cpp"
click node_equations "https://github.com/tiagovla/oiseau/blob/master/src/oiseau/dg/equation.hpp"
click node_solver "https://github.com/tiagovla/oiseau/blob/master/src/oiseau/dg/solver/linear_dg.cpp"
click node_time "https://github.com/tiagovla/oiseau/blob/master/src/oiseau/time/lsrk54.hpp"
click node_plot "https://github.com/tiagovla/oiseau/blob/master/src/oiseau/plotting/triplot.hpp"
click node_python "https://github.com/tiagovla/oiseau/blob/master/python/oiseau/wrappers/mesh.cpp"
click node_plannedmedia "https://github.com/tiagovla/oiseau/blob/master/src/oiseau/dg/equation.hpp"
click node_plannedfitting "https://github.com/tiagovla/oiseau/tree/master/src/oiseau/dg"

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_gmsh,node_meshmodel,node_cell,node_user toneBlue
class node_space,node_reference,node_connectivity,node_geometry,node_operators toneAmber
class node_equations,node_solver,node_time,node_plot,node_plannedmedia,node_plannedfitting toneMint
class node_python toneRose
```

## Components

### Mesh input

- [Gmsh I/O](https://github.com/tiagovla/oiseau/blob/master/src/oiseau/io/gmsh_file.cpp): `src/oiseau/io/gmsh_file.cpp`
- [Mesh model](https://github.com/tiagovla/oiseau/blob/master/src/oiseau/mesh/mesh.hpp): `src/oiseau/mesh/mesh.hpp`
- [Cell topology](https://github.com/tiagovla/oiseau/blob/master/src/oiseau/mesh/cell.hpp): `src/oiseau/mesh/cell.hpp`

### DG discretization

- [DG space](https://github.com/tiagovla/oiseau/blob/master/src/oiseau/dg/dg_space.hpp): `src/oiseau/dg/dg_space.hpp`
- [Reference elements](https://github.com/tiagovla/oiseau/blob/master/src/oiseau/dg/nodal/ref_element.hpp): `src/oiseau/dg/nodal/ref_element.hpp`
- [DG connectivity](https://github.com/tiagovla/oiseau/blob/master/src/oiseau/dg/dg_connectivity.hpp): `src/oiseau/dg/dg_connectivity.hpp`
- [DG geometry](https://github.com/tiagovla/oiseau/blob/master/src/oiseau/dg/dg_geometry.cpp): `src/oiseau/dg/dg_geometry.cpp`
- [DG integration](https://github.com/tiagovla/oiseau/blob/master/src/oiseau/dg/dg_integration.cpp): `src/oiseau/dg/dg_integration.cpp`

### Simulation runtime

- [Equation system](https://github.com/tiagovla/oiseau/blob/master/src/oiseau/dg/equation.hpp): `src/oiseau/dg/equation.hpp`
- [Linear DG solver](https://github.com/tiagovla/oiseau/blob/master/src/oiseau/dg/solver/linear_dg.cpp): `src/oiseau/dg/solver/linear_dg.cpp`
- [Time integrators](https://github.com/tiagovla/oiseau/blob/master/src/oiseau/time/lsrk54.hpp): `src/oiseau/time/lsrk54.hpp`
- [Plotting](https://github.com/tiagovla/oiseau/blob/master/src/oiseau/plotting/triplot.hpp): `src/oiseau/plotting/triplot.hpp`
- [Planned media models](https://github.com/tiagovla/oiseau/blob/master/src/oiseau/dg/equation.hpp): `src/oiseau/dg/equation.hpp`
- [Planned vector fitting](https://github.com/tiagovla/oiseau/tree/master/src/oiseau/dg): `src/oiseau/dg`

### User interfaces

- [Python bindings](https://github.com/tiagovla/oiseau/blob/master/python/oiseau/wrappers/mesh.cpp): `python/oiseau/wrappers/mesh.cpp`

### Other components

- **Simulation user**

## Connections

- Simulation user → Gmsh I/O: provides mesh
- Gmsh I/O → Mesh model: reads mesh
- Mesh model → DG space: discretizes (evidence: `src/oiseau/dg/dg_space.hpp`)
- Mesh model → DG connectivity: builds adjacency (evidence: `src/oiseau/dg/dg_connectivity.hpp`)
- Mesh model → DG geometry: computes factors (evidence: `src/oiseau/dg/dg_geometry.cpp`)
- Cell topology → Reference elements: selects shape (evidence: `src/oiseau/dg/ref_element_type.hpp`)
- Reference elements → DG integration: builds operators (evidence: `src/oiseau/dg/dg_integration.cpp`)
- DG connectivity → DG integration: supplies faces (evidence: `src/oiseau/dg/dg_integration.cpp`)
- DG geometry → DG integration: scales rules (evidence: `src/oiseau/dg/dg_integration.cpp`)
- Simulation user → Linear DG solver: runs simulation
- Linear DG solver → DG connectivity: uses adjacency (evidence: `src/oiseau/dg/solver/linear_dg.cpp`)
- Linear DG solver → DG geometry: uses factors (evidence: `src/oiseau/dg/solver/linear_dg.cpp`)
- Linear DG solver → DG integration: uses operators (evidence: `src/oiseau/dg/solver/linear_dg.cpp`)
- Simulation user → Python bindings: uses interface
- Simulation user → Planned media models: planned capability
- Simulation user → Planned vector fitting: planned capability
