# zasexton/svmultiphysics architecture

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

- Interactive diagram: https://gitdiagram.com/zasexton/svmultiphysics
- Repository: https://github.com/zasexton/svmultiphysics

## Overview

svMultiPhysics is a parallel finite-element multiphysics solver. A user supplies a solver XML file; the command-line entry point sets up a Simulation, reads configuration and mesh data, initializes solution state and time integration, then advances the coupled equations and writes results. The source also includes finite-element basis support, linear algebra backends, and utilities for cardiac fiber generation and boundary-condition preparation. Edges are limited to README statements and the provided source index or excerpts; unsampled implementation details are not inferred.

Main entry points: [`Code/Source/solver/main.cpp`](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/main.cpp) (CLI driver), [`Code/Source/solver/eq_assem.h`](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/eq_assem.h) (Equation assembly), [`Code/Source/solver/Simulation.h`](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/Simulation.h) (Simulation state), [`Code/Source/solver/Integrator.h`](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/Integrator.h) (Time integrator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["Simulation runtime"]
  node_cli["CLI driver<br/>[main.cpp]"]
  node_simulation["Simulation state<br/>[Simulation.h]"]
  node_parameters["Input parameters<br/>[Parameters.h]"]
  node_integrator["Time integrator<br/>[Integrator.h]"]
  node_states["Solution states<br/>[SolutionStates.h]"]
end

subgraph group_physics["Physics and equations"]
  node_equations["Equation assembly<br/>[eq_assem.h]"]
  node_fluid["Fluid mechanics<br/>[fluid.cpp]"]
  node_solid["Solid mechanics<br/>[l_elas.cpp]"]
  node_coupling["Multiphysics coupling<br/>[fsi.cpp]"]
  node_electrophys["Electrophysiology<br/>[cep.cpp]"]
end

subgraph group_numerics["Finite-element numerics"]
  node_fem["Finite-element basis"]
  node_arrays["Array primitives<br/>[Array.h]"]
  node_linear["Linear solvers<br/>[gmres.cpp]"]
  node_la["Linear algebra API<br/>[LinearAlgebra.h]"]
end

subgraph group_io["Mesh and results"]
  node_meshread["Mesh loading<br/>[read_msh.h]"]
  node_xmlmesh["VTK XML parser<br/>[vtk_xml_parser.cpp]"]
  node_output["Result output<br/>[output.h]"]
  node_post["Postprocessing<br/>[post.h]"]
end

subgraph group_utilities["Model preparation"]
  node_fiber["Cardiac fiber generation<br/>[fiber_generator.py]"]
  node_laplace["Laplace fields<br/>[laplace_solver.py]"]
  node_bcdata["Boundary data tools"]
end

node_user(("Solver user"))
node_actor(("Simulation outputs"))

node_user -->|"provides XML"| node_cli
node_cli -->|"creates"| node_simulation
node_cli -->|"reads input"| node_parameters
node_cli -->|"loads mesh"| node_meshread
node_meshread -.->|"uses parser"| node_xmlmesh
node_cli -->|"advances"| node_integrator
node_simulation -->|"owns state"| node_states
node_simulation -->|"initializes"| node_integrator
node_cli -->|"assembles equations"| node_equations
node_cli -->|"writes results"| node_output
node_cli -.->|"runs postprocessing"| node_post
node_equations -.->|"supports"| node_fluid
node_equations -.->|"supports"| node_solid
node_equations -.->|"supports"| node_coupling
node_equations -.->|"supports"| node_electrophys
node_integrator -.->|"updates"| node_states
node_equations -.->|"uses basis"| node_fem
node_equations -.->|"uses arrays"| node_arrays
node_cli -->|"configures solver"| node_la
node_la -.->|"uses iterative solver"| node_linear
node_fiber -.->|"solves fields"| node_laplace
node_bcdata -.->|"prepares boundary inputs"| node_cli
node_output -.->|"produces results"| node_actor

click node_cli "https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/main.cpp"
click node_simulation "https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/Simulation.h"
click node_parameters "https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/Parameters.h"
click node_integrator "https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/Integrator.h"
click node_states "https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/SolutionStates.h"
click node_meshread "https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/read_msh.h"
click node_xmlmesh "https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/vtk_xml_parser.cpp"
click node_output "https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/output.h"
click node_post "https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/post.h"
click node_equations "https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/eq_assem.h"
click node_fluid "https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/fluid.cpp"
click node_solid "https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/l_elas.cpp"
click node_coupling "https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/fsi.cpp"
click node_electrophys "https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/cep.cpp"
click node_fem "https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/FE/Basis/NodeOrderingConventions.cpp"
click node_arrays "https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/Array.h"
click node_linear "https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/linear_solver/gmres.cpp"
click node_la "https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/LinearAlgebra.h"
click node_fiber "https://github.com/zasexton/svmultiphysics/blob/main/utilities/fiber_generation/fiber_generation/fiber_generator.py"
click node_laplace "https://github.com/zasexton/svmultiphysics/blob/main/utilities/fiber_generation/fiber_generation/laplace_solver.py"
click node_bcdata "https://github.com/zasexton/svmultiphysics/blob/main/utilities/generate_boundary_condition_data/generate_spatially_variable_robin.py"

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_cli,node_simulation,node_parameters,node_integrator,node_states,node_user toneBlue
class node_equations,node_fluid,node_solid,node_coupling,node_electrophys toneAmber
class node_fem,node_arrays,node_linear,node_la toneMint
class node_meshread,node_xmlmesh,node_output,node_post toneRose
class node_fiber,node_laplace,node_bcdata,node_actor toneIndigo
```

## Components

### Simulation runtime

- [CLI driver](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/main.cpp): `Code/Source/solver/main.cpp`
- [Simulation state](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/Simulation.h): `Code/Source/solver/Simulation.h`
- [Input parameters](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/Parameters.h): `Code/Source/solver/Parameters.h`
- [Time integrator](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/Integrator.h): `Code/Source/solver/Integrator.h`
- [Solution states](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/SolutionStates.h): `Code/Source/solver/SolutionStates.h`

### Physics and equations

- [Equation assembly](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/eq_assem.h): `Code/Source/solver/eq_assem.h`
- [Fluid mechanics](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/fluid.cpp): `Code/Source/solver/fluid.cpp`
- [Solid mechanics](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/l_elas.cpp): `Code/Source/solver/l_elas.cpp`
- [Multiphysics coupling](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/fsi.cpp): `Code/Source/solver/fsi.cpp`
- [Electrophysiology](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/cep.cpp): `Code/Source/solver/cep.cpp`

### Finite-element numerics

- [Finite-element basis](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/FE/Basis/NodeOrderingConventions.cpp): `Code/Source/solver/FE/Basis/NodeOrderingConventions.cpp`
- [Array primitives](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/Array.h): `Code/Source/solver/Array.h`
- [Linear solvers](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/linear_solver/gmres.cpp): `Code/Source/linear_solver/gmres.cpp`
- [Linear algebra API](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/LinearAlgebra.h): `Code/Source/solver/LinearAlgebra.h`

### Mesh and results

- [Mesh loading](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/read_msh.h): `Code/Source/solver/read_msh.h`
- [VTK XML parser](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/vtk_xml_parser.cpp): `Code/Source/solver/vtk_xml_parser.cpp`
- [Result output](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/output.h): `Code/Source/solver/output.h`
- [Postprocessing](https://github.com/zasexton/svmultiphysics/blob/main/Code/Source/solver/post.h): `Code/Source/solver/post.h`

### Model preparation

- [Cardiac fiber generation](https://github.com/zasexton/svmultiphysics/blob/main/utilities/fiber_generation/fiber_generation/fiber_generator.py): `utilities/fiber_generation/fiber_generation/fiber_generator.py`
- [Laplace fields](https://github.com/zasexton/svmultiphysics/blob/main/utilities/fiber_generation/fiber_generation/laplace_solver.py): `utilities/fiber_generation/fiber_generation/laplace_solver.py`
- [Boundary data tools](https://github.com/zasexton/svmultiphysics/blob/main/utilities/generate_boundary_condition_data/generate_spatially_variable_robin.py): `utilities/generate_boundary_condition_data/generate_spatially_variable_robin.py`

### Other components

- **Solver user**
- **Simulation outputs**

## Connections

- Solver user → CLI driver: provides XML (evidence: `Code/Source/solver/main.cpp`)
- CLI driver → Simulation state: creates (evidence: `Code/Source/solver/main.cpp`)
- CLI driver → Input parameters: reads input (evidence: `Code/Source/solver/main.cpp`)
- CLI driver → Mesh loading: loads mesh (evidence: `Code/Source/solver/main.cpp`)
- Mesh loading → VTK XML parser: uses parser
- CLI driver → Time integrator: advances (evidence: `Code/Source/solver/main.cpp`)
- Simulation state → Solution states: owns state (evidence: `Code/Source/solver/Simulation.h`)
- Simulation state → Time integrator: initializes (evidence: `Code/Source/solver/Simulation.h`)
- CLI driver → Equation assembly: assembles equations (evidence: `Code/Source/solver/main.cpp`)
- CLI driver → Result output: writes results (evidence: `Code/Source/solver/main.cpp`)
- CLI driver → Postprocessing: runs postprocessing
- Equation assembly → Fluid mechanics: supports
- Equation assembly → Solid mechanics: supports
- Equation assembly → Multiphysics coupling: supports
- Equation assembly → Electrophysiology: supports
- Time integrator → Solution states: updates (evidence: `Code/Source/solver/Integrator.h`)
- Equation assembly → Finite-element basis: uses basis
- Equation assembly → Array primitives: uses arrays
- CLI driver → Linear algebra API: configures solver (evidence: `Code/Source/solver/main.cpp`)
- Linear algebra API → Linear solvers: uses iterative solver
- Cardiac fiber generation → Laplace fields: solves fields
- Boundary data tools → CLI driver: prepares boundary inputs
- Result output → Simulation outputs: produces results
