# darkfanxing/matlab-topology-optimization architecture

> Architecture diagram of the GitHub repository darkfanxing/matlab-topology-optimization, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/darkfanxing/matlab-topology-optimization
- Repository: https://github.com/darkfanxing/matlab-topology-optimization

## Overview

##### Project type and purpose
- This is a MATLAB-based topology optimization tool (88 lines of code) that implements structural optimization using methods like MMA (Method of Moving Asymptotes) and Optimality Criteria.
- Its purpose is to read a design scenario (sample geometry/load case), run an iterative optimization loop (compute stiffness, sensitivities, apply filters, update densities), and output a final topology.

##### File structure
- Top-level:
- src/ – all MATLAB code
- src/assets/samples/ – predefined geometry/load cases (.m files returning mesh, loads, BCs)
- src/main.m – entry point, parameter definitions, scenario selection, control loop
- src/topology_optimization.m – core loop implementation
- Subdirectories:
- src/update_methods/mma/ – MMA update functions (init, solver, parameter setup)
- src/utils/ – helper functions (design-variable filters, projection, stiffness matrix, sensitivities)
- No server/client or UI—this is a standalone computational pipeline invoked by main.m.

##### README for additional insights
- main.m drives the run (user sets parameters, chooses sample).
- Users can swap in new samples, change MMA parameters, filters, projection, or stiffness routines.
- References point to the underlying algorithms (MMA paper, 88-line MATLAB implementation).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Core Modules
    Initializer["Entry Point & Parameter Initializer"]:::core
    Engine["Optimization Engine"]:::core
    Output["Result Plot/Export"]:::core

    %% Plugin Modules
    subgraph "Update Methods"
        direction TB
        MMA["MMA Plugin"]:::plugin
        OC["Optimality Criteria Plugin"]:::plugin
    end

    Scenario["Scenario Loader"]:::plugin

    %% Utility Modules
    subgraph "Utilities"
        direction TB
        IF["Filter Initialization"]:::util
        SM["Stiffness Matrix Assembly"]:::util
        PF["Projection Function"]:::util
        DVF["Design Variable Filter"]:::util
        SF["Sensitivity Filter"]:::util
    end

    %% Workflow
    Scenario -->|"sample mesh, loads, BCs"| Initializer
    Initializer -->|"init filters"| IF
    Initializer -->|"init stiffness"| SM
    Initializer -->|"parameters set"| Engine

    Engine -->|"compute stiffness"| SM
    SM -->|"stiffness matrix"| Engine

    Engine -->|"equilibrium solve"| Engine

    Engine -->|"compute projection"| PF
    PF -->|"projected sensitivities"| SF
    Engine -->|"compute sensitivities"| DVF
    DVF -->|"filtered densities"| Engine
    SF -->|"filtered sensitivities"| Engine

    Engine -->|"update densities"| MMA
    Engine -->|"update densities"| OC
    MMA -->|"new densities"| Engine
    OC -->|"new densities"| Engine

    Engine -->|"iterate until convergence"| Engine

    Engine -->|"final design data"| Output

    %% Click Events
    click Scenario "https://github.com/darkfanxing/matlab-topology-optimization/tree/main/src/assets/samples/"
    click Initializer "https://github.com/darkfanxing/matlab-topology-optimization/blob/main/src/main.m"
    click Engine "https://github.com/darkfanxing/matlab-topology-optimization/blob/main/src/topology_optimization.m"
    click MMA "https://github.com/darkfanxing/matlab-topology-optimization/tree/main/src/update_methods/mma/"
    click OC "https://github.com/darkfanxing/matlab-topology-optimization/blob/main/src/update_methods/optimality_criteria.m"
    click DVF "https://github.com/darkfanxing/matlab-topology-optimization/blob/main/src/utils/design_variable_filter.m"
    click SF "https://github.com/darkfanxing/matlab-topology-optimization/blob/main/src/utils/sensitivity_filter.m"
    click PF "https://github.com/darkfanxing/matlab-topology-optimization/blob/main/src/utils/projection_function.m"
    click IF "https://github.com/darkfanxing/matlab-topology-optimization/blob/main/src/utils/init_filter.m"
    click SM "https://github.com/darkfanxing/matlab-topology-optimization/blob/main/src/utils/init_stiffness_matrix.m"

    %% Styles
    classDef core fill:#D0E8FF,stroke:#0366d6,stroke-width:1px;
    classDef plugin fill:#E0F8E0,stroke:#28a745,stroke-width:1px;
    classDef util fill:#FFF4C1,stroke:#d69f00,stroke-width:1px;
```
