# huamaniluciano/porosim architecture

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

- Interactive diagram: https://gitdiagram.com/huamaniluciano/porosim
- Repository: https://github.com/huamaniluciano/porosim

## Overview

POROSIM models axisymmetric nanopore electrokinetics through three documented stages: geometry and meshing, coupled PNP solving, then analysis of solution files. Users can run pillars separately or through the multipage portal. The graph preserves the mesher’s geometry layers and the extractor’s distinct analysis families. Cross-pillar file handoffs and portal behavior are documented in the README; internal links are limited to relationships shown by the source index or excerpts.

Main entry points: [`3_extractor/gui_extractor_app.py`](https://github.com/huamaniluciano/porosim/blob/main/3_extractor/gui_extractor_app.py) (Extractor GUI), [`3_extractor/modulos/porosim_comun.py`](https://github.com/huamaniluciano/porosim/blob/main/3_extractor/modulos/porosim_comun.py) (Extractor shared I/O), [`2_solver/motor_pnp.py`](https://github.com/huamaniluciano/porosim/blob/main/2_solver/motor_pnp.py) (PNP motor), [`1_mesher/capa4_malla.py`](https://github.com/huamaniluciano/porosim/blob/main/1_mesher/capa4_malla.py) (Mesh generation)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_meshing["Geometry and meshing"]
  node_geometry_model["Geometry model<br/>[capa1_modelo.py]"]
  node_geometry_loops["Geometry loops<br/>[capa2_loops.py]"]
  node_gmsh_geometry["Gmsh geometry<br/>[capa3_gmsh.py]"]
  node_mesh_generation["Mesh generation<br/>[capa4_malla.py]"]
end

subgraph group_solver["PNP solver"]
  node_solver_batch["Solver batch entry<br/>[solver.py]"]
  node_solver_inputs["Solver prompts<br/>[preguntas.py]"]
  node_solver_motor["PNP motor<br/>[motor_pnp.py]"]
  node_solver_constants["Physics constants<br/>[constantes.py]"]
  node_electrolyte["Electrolyte model<br/>[electrolito.py]"]
end

subgraph group_analysis["Solution analysis"]
  node_common_io["Extractor shared I/O<br/>[porosim_comun.py]"]
  node_potential["Potential maps<br/>[potential.py]"]
  node_ion_maps["Ion maps<br/>[ions.py]"]
  node_axial_profiles["Axial profiles"]
  node_iv_metrics["I-V metrics<br/>[iv_metrics.py]"]
  node_precipitation["Precipitation maps<br/>[precipitation.py]"]
  node_precipitation_onset["Precipitation onset"]
  node_summary["Run summary"]
end

subgraph group_portal["User interfaces"]
  node_portal_app["Web portal<br/>[launch_porosim.py]"]
  node_mesh_gui["Mesher GUI<br/>[gui_app.py]"]
  node_solver_gui["Solver GUI<br/>[gui_app.py]"]
  node_extractor_gui["Extractor GUI"]
end

node_user(("User"))
node_mesh_store[("Mesh files")]
node_solution_store[("Solutions and I-V")]
node_analysis_outputs["Figures and tables"]

node_user -->|"launches"| node_portal_app
node_portal_app -->|"opens"| node_mesh_gui
node_portal_app -->|"opens"| node_solver_gui
node_portal_app -->|"opens"| node_extractor_gui
node_user -->|"configures"| node_mesh_gui
node_mesh_gui -->|"uses"| node_geometry_model
node_mesh_gui -->|"runs"| node_mesh_generation
node_geometry_loops -->|"uses"| node_geometry_model
node_gmsh_geometry -->|"uses"| node_geometry_model
node_gmsh_geometry -->|"uses"| node_geometry_loops
node_mesh_generation -->|"uses"| node_geometry_model
node_mesh_generation -->|"uses"| node_gmsh_geometry
node_mesh_generation -->|"writes mesh"| node_mesh_store
node_user -->|"configures"| node_solver_gui
node_user -->|"runs"| node_solver_batch
node_solver_gui -->|"calls"| node_solver_motor
node_solver_batch -->|"prompts"| node_solver_inputs
node_solver_batch -->|"calls"| node_solver_motor
node_solver_motor -->|"uses"| node_solver_constants
node_solver_motor -->|"uses"| node_electrolyte
node_solver_batch -->|"reads mesh"| node_mesh_store
node_solver_motor -->|"writes results"| node_solution_store
node_user -->|"selects solution"| node_extractor_gui
node_extractor_gui -->|"uses"| node_common_io
node_extractor_gui -->|"dispatches"| node_potential
node_extractor_gui -->|"dispatches"| node_ion_maps
node_extractor_gui -->|"dispatches"| node_axial_profiles
node_extractor_gui -->|"dispatches"| node_iv_metrics
node_extractor_gui -->|"dispatches"| node_precipitation
node_extractor_gui -->|"dispatches"| node_precipitation_onset
node_solution_store -->|"loads solution"| node_common_io
node_common_io -->|"provides shared I/O"| node_potential
node_common_io -->|"provides shared I/O"| node_ion_maps
node_common_io -->|"provides shared I/O"| node_axial_profiles
node_common_io -->|"provides shared I/O"| node_iv_metrics
node_common_io -->|"provides shared I/O"| node_precipitation
node_common_io -->|"provides shared I/O"| node_precipitation_onset
node_precipitation_onset -->|"uses"| node_precipitation
node_summary -->|"uses metrics"| node_iv_metrics
node_potential -->|"exports figures"| node_analysis_outputs
node_ion_maps -->|"exports figures"| node_analysis_outputs
node_axial_profiles -->|"exports profiles"| node_analysis_outputs
node_iv_metrics -->|"produces metrics"| node_analysis_outputs
node_precipitation -->|"exports maps"| node_analysis_outputs
node_precipitation_onset -->|"produces onset"| node_analysis_outputs
node_summary -->|"writes report"| node_analysis_outputs

click node_portal_app "https://github.com/huamaniluciano/porosim/blob/main/launch_porosim.py"
click node_mesh_gui "https://github.com/huamaniluciano/porosim/blob/main/1_mesher/gui_app.py"
click node_solver_gui "https://github.com/huamaniluciano/porosim/blob/main/2_solver/gui_app.py"
click node_extractor_gui "https://github.com/huamaniluciano/porosim/blob/main/3_extractor/gui_extractor_app.py"
click node_geometry_model "https://github.com/huamaniluciano/porosim/blob/main/1_mesher/capa1_modelo.py"
click node_geometry_loops "https://github.com/huamaniluciano/porosim/blob/main/1_mesher/capa2_loops.py"
click node_gmsh_geometry "https://github.com/huamaniluciano/porosim/blob/main/1_mesher/capa3_gmsh.py"
click node_mesh_generation "https://github.com/huamaniluciano/porosim/blob/main/1_mesher/capa4_malla.py"
click node_mesh_store "https://github.com/huamaniluciano/porosim/tree/main/RESULTS/meshes"
click node_solver_batch "https://github.com/huamaniluciano/porosim/blob/main/2_solver/solver.py"
click node_solver_inputs "https://github.com/huamaniluciano/porosim/blob/main/2_solver/console_backup/preguntas.py"
click node_solver_motor "https://github.com/huamaniluciano/porosim/blob/main/2_solver/motor_pnp.py"
click node_solver_constants "https://github.com/huamaniluciano/porosim/blob/main/2_solver/constantes.py"
click node_electrolyte "https://github.com/huamaniluciano/porosim/blob/main/2_solver/electrolito.py"
click node_solution_store "https://github.com/huamaniluciano/porosim/tree/main/RESULTS/solutions"
click node_common_io "https://github.com/huamaniluciano/porosim/blob/main/3_extractor/modulos/porosim_comun.py"
click node_potential "https://github.com/huamaniluciano/porosim/blob/main/3_extractor/modulos/potential_map/potential.py"
click node_ion_maps "https://github.com/huamaniluciano/porosim/blob/main/3_extractor/modulos/ion_maps/ions.py"
click node_axial_profiles "https://github.com/huamaniluciano/porosim/blob/main/3_extractor/modulos/axial_profiles/axis_profile_ions.py"
click node_iv_metrics "https://github.com/huamaniluciano/porosim/blob/main/3_extractor/modulos/iv_analysis/iv_metrics.py"
click node_precipitation "https://github.com/huamaniluciano/porosim/blob/main/3_extractor/modulos/precipitation_map/precipitation.py"
click node_precipitation_onset "https://github.com/huamaniluciano/porosim/blob/main/3_extractor/modulos/precipitation_map/precipitation_onset.py"
click node_summary "https://github.com/huamaniluciano/porosim/blob/main/3_extractor/solution_summary/solution_summary.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_geometry_model,node_geometry_loops,node_gmsh_geometry,node_mesh_generation,node_user toneBlue
class node_solver_batch,node_solver_inputs,node_solver_motor,node_solver_constants,node_electrolyte,node_mesh_store,node_solution_store toneAmber
class node_common_io,node_potential,node_ion_maps,node_axial_profiles,node_iv_metrics,node_precipitation,node_precipitation_onset,node_summary toneMint
class node_portal_app,node_mesh_gui,node_solver_gui,node_extractor_gui toneRose
class node_analysis_outputs toneIndigo
```

## Components

### Geometry and meshing

- [Geometry model](https://github.com/huamaniluciano/porosim/blob/main/1_mesher/capa1_modelo.py): `1_mesher/capa1_modelo.py`
- [Geometry loops](https://github.com/huamaniluciano/porosim/blob/main/1_mesher/capa2_loops.py): `1_mesher/capa2_loops.py`
- [Gmsh geometry](https://github.com/huamaniluciano/porosim/blob/main/1_mesher/capa3_gmsh.py): `1_mesher/capa3_gmsh.py`
- [Mesh generation](https://github.com/huamaniluciano/porosim/blob/main/1_mesher/capa4_malla.py): `1_mesher/capa4_malla.py`

### PNP solver

- [Solver batch entry](https://github.com/huamaniluciano/porosim/blob/main/2_solver/solver.py): `2_solver/solver.py`
- [Solver prompts](https://github.com/huamaniluciano/porosim/blob/main/2_solver/console_backup/preguntas.py): `2_solver/console_backup/preguntas.py`
- [PNP motor](https://github.com/huamaniluciano/porosim/blob/main/2_solver/motor_pnp.py): `2_solver/motor_pnp.py`
- [Physics constants](https://github.com/huamaniluciano/porosim/blob/main/2_solver/constantes.py): `2_solver/constantes.py`
- [Electrolyte model](https://github.com/huamaniluciano/porosim/blob/main/2_solver/electrolito.py): `2_solver/electrolito.py`

### Solution analysis

- [Extractor shared I/O](https://github.com/huamaniluciano/porosim/blob/main/3_extractor/modulos/porosim_comun.py): `3_extractor/modulos/porosim_comun.py`
- [Potential maps](https://github.com/huamaniluciano/porosim/blob/main/3_extractor/modulos/potential_map/potential.py): `3_extractor/modulos/potential_map/potential.py`
- [Ion maps](https://github.com/huamaniluciano/porosim/blob/main/3_extractor/modulos/ion_maps/ions.py): `3_extractor/modulos/ion_maps/ions.py`
- [Axial profiles](https://github.com/huamaniluciano/porosim/blob/main/3_extractor/modulos/axial_profiles/axis_profile_ions.py): `3_extractor/modulos/axial_profiles/axis_profile_ions.py`
- [I-V metrics](https://github.com/huamaniluciano/porosim/blob/main/3_extractor/modulos/iv_analysis/iv_metrics.py): `3_extractor/modulos/iv_analysis/iv_metrics.py`
- [Precipitation maps](https://github.com/huamaniluciano/porosim/blob/main/3_extractor/modulos/precipitation_map/precipitation.py): `3_extractor/modulos/precipitation_map/precipitation.py`
- [Precipitation onset](https://github.com/huamaniluciano/porosim/blob/main/3_extractor/modulos/precipitation_map/precipitation_onset.py): `3_extractor/modulos/precipitation_map/precipitation_onset.py`
- [Run summary](https://github.com/huamaniluciano/porosim/blob/main/3_extractor/solution_summary/solution_summary.py): `3_extractor/solution_summary/solution_summary.py`

### User interfaces

- [Web portal](https://github.com/huamaniluciano/porosim/blob/main/launch_porosim.py): `launch_porosim.py`
- [Mesher GUI](https://github.com/huamaniluciano/porosim/blob/main/1_mesher/gui_app.py): `1_mesher/gui_app.py`
- [Solver GUI](https://github.com/huamaniluciano/porosim/blob/main/2_solver/gui_app.py): `2_solver/gui_app.py`
- [Extractor GUI](https://github.com/huamaniluciano/porosim/blob/main/3_extractor/gui_extractor_app.py): `3_extractor/gui_extractor_app.py`

### Other components

- **User**
- [Mesh files](https://github.com/huamaniluciano/porosim/tree/main/RESULTS/meshes): `RESULTS/meshes`
- [Solutions and I-V](https://github.com/huamaniluciano/porosim/tree/main/RESULTS/solutions): `RESULTS/solutions`
- **Figures and tables**

## Connections

- User → Web portal: launches (evidence: `README.md`)
- Web portal → Mesher GUI: opens (evidence: `README.md`)
- Web portal → Solver GUI: opens (evidence: `README.md`)
- Web portal → Extractor GUI: opens (evidence: `README.md`)
- User → Mesher GUI: configures (evidence: `README.md`)
- Mesher GUI → Geometry model: uses (evidence: `1_mesher/gui_app.py`)
- Mesher GUI → Mesh generation: runs (evidence: `1_mesher/gui_app.py`)
- Geometry loops → Geometry model: uses (evidence: `1_mesher/capa2_loops.py`)
- Gmsh geometry → Geometry model: uses (evidence: `1_mesher/capa3_gmsh.py`)
- Gmsh geometry → Geometry loops: uses (evidence: `1_mesher/capa3_gmsh.py`)
- Mesh generation → Geometry model: uses (evidence: `1_mesher/capa4_malla.py`)
- Mesh generation → Gmsh geometry: uses (evidence: `1_mesher/capa4_malla.py`)
- Mesh generation → Mesh files: writes mesh (evidence: `README.md`)
- User → Solver GUI: configures (evidence: `README.md`)
- User → Solver batch entry: runs (evidence: `README.md`)
- Solver GUI → PNP motor: calls (evidence: `2_solver/gui_app.py`)
- Solver batch entry → Solver prompts: prompts (evidence: `2_solver/solver.py`)
- Solver batch entry → PNP motor: calls (evidence: `2_solver/solver.py`)
- PNP motor → Physics constants: uses (evidence: `2_solver/motor_pnp.py`)
- PNP motor → Electrolyte model: uses (evidence: `2_solver/motor_pnp.py`)
- Solver batch entry → Mesh files: reads mesh (evidence: `README.md`)
- PNP motor → Solutions and I-V: writes results (evidence: `README.md`)
- User → Extractor GUI: selects solution (evidence: `README.md`)
- Extractor GUI → Extractor shared I/O: uses (evidence: `3_extractor/gui_extractor_app.py`)
- Extractor GUI → Potential maps: dispatches (evidence: `3_extractor/gui_extractor_app.py`)
- Extractor GUI → Ion maps: dispatches (evidence: `3_extractor/gui_extractor_app.py`)
- Extractor GUI → Axial profiles: dispatches (evidence: `3_extractor/gui_extractor_app.py`)
- Extractor GUI → I-V metrics: dispatches (evidence: `3_extractor/gui_extractor_app.py`)
- Extractor GUI → Precipitation maps: dispatches (evidence: `3_extractor/gui_extractor_app.py`)
- Extractor GUI → Precipitation onset: dispatches (evidence: `3_extractor/gui_extractor_app.py`)
- Solutions and I-V → Extractor shared I/O: loads solution (evidence: `README.md`)
- Extractor shared I/O → Potential maps: provides shared I/O (evidence: `3_extractor/modulos/potential_map/potential.py`)
- Extractor shared I/O → Ion maps: provides shared I/O (evidence: `3_extractor/modulos/ion_maps/ions.py`)
- Extractor shared I/O → Axial profiles: provides shared I/O (evidence: `3_extractor/modulos/axial_profiles/axis_profile_ions.py`)
- Extractor shared I/O → I-V metrics: provides shared I/O (evidence: `3_extractor/modulos/iv_analysis/iv_metrics.py`)
- Extractor shared I/O → Precipitation maps: provides shared I/O (evidence: `3_extractor/modulos/precipitation_map/precipitation.py`)
- Extractor shared I/O → Precipitation onset: provides shared I/O (evidence: `3_extractor/modulos/precipitation_map/precipitation_onset.py`)
- Precipitation onset → Precipitation maps: uses (evidence: `3_extractor/modulos/precipitation_map/precipitation_onset.py`)
- Run summary → I-V metrics: uses metrics (evidence: `3_extractor/solution_summary/solution_summary.py`)
- Potential maps → Figures and tables: exports figures (evidence: `README.md`)
- Ion maps → Figures and tables: exports figures (evidence: `README.md`)
- Axial profiles → Figures and tables: exports profiles (evidence: `README.md`)
- I-V metrics → Figures and tables: produces metrics (evidence: `README.md`)
- Precipitation maps → Figures and tables: exports maps (evidence: `README.md`)
- Precipitation onset → Figures and tables: produces onset (evidence: `README.md`)
- Run summary → Figures and tables: writes report (evidence: `README.md`)
