# houkensjtu/gm_cooler architecture

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

- Interactive diagram: https://gitdiagram.com/houkensjtu/gm_cooler
- Repository: https://github.com/houkensjtu/gm_cooler

## Overview

##### Main Components

a) Core Simulation Components:
- Input Processing System
- Numerical Solver (RKGS - Runge-Kutta Method)
- Physical Model Components
- Output Generation System

b) File Structure Components:
- Input Files (.TXT)
- Output Data Files
- Visualization Components (PLT files)

**[Input Layer]**
- ↓
**[Processing Layer]**
- ↓
**[Output Layer]**

##### Detailed Component Breakdown

a) Input Layer:
- "Parameter Setting Module" (parSetting.f)
- Configuration options for different cooler types

b) Processing Layer (Core):
- Central "Numerical Solver" (rkgs.f) component
- "Physical Models" components:
- Valve Models (valve.f, valveStraight.f, valveTrapezoid.f)
- Pressure Assistance (pressureAssist.f)
- Core Functions (fct.f)
- Data Management (data.f)

c) Output Layer:
- Data Output Handler (outp.f)
- Plotting System (plot_disp.plt, plot_disp_group.plt)
- Results Storage

##### Specific Design Elements

b) Specific modules:
**[Parameter Input] → [Parameter Setting]**
- ↓
**[Physical Models] ← → [Numerical Solver]**
- ↓
**[Output Handler] → [Visualization]**

##### Additional Elements

- Version information (free vs. scotch vs. origin)
- Relationship with external dependencies (gfortran compiler)
- File format conversions and data transformations

##### Implementation Notes

- The modular nature of the code
- The separation of concerns between physics modeling and numerical solving
- The data flow from input through processing to output
- The relationship between different implementations (free/scotch/origin)

Remember to include a note about the testing framework and its relationship to the main simulation components, as this appears to be a significant part of the codebase's verification system.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Style Definitions
    classDef input fill:#a8d1ff,stroke:#000
    classDef processing fill:#90EE90,stroke:#000
    classDef output fill:#FFE5B4,stroke:#000
    classDef testing fill:#D3D3D3,stroke:#000

    %% Input Layer
    subgraph InputLayer
        ParamInput["Parameter Input\n(IN.TXT)"]
        ParamSetting["Parameter Setting Module"]
    end
    click ParamInput "https://github.com/houkensjtu/GM_cooler/blob/master/src_free/IN.TXT"
    click ParamSetting "https://github.com/houkensjtu/GM_cooler/blob/master/src_free/parSetting.f"

    %% Processing Layer
    subgraph ProcessingLayer
        MainProgram["Main Program (GM)"]
        click MainProgram "https://github.com/houkensjtu/GM_cooler/blob/master/src_free/GM.f"

        subgraph SolverSystem
            RKGS["Numerical Solver\n(RKGS)"]
            CoreFunctions["Core Functions"]
            DataManagement["Data Management"]
        end
        click RKGS "https://github.com/houkensjtu/GM_cooler/blob/master/src_free/rkgs.f"
        click CoreFunctions "https://github.com/houkensjtu/GM_cooler/blob/master/src_free/fct.f"
        click DataManagement "https://github.com/houkensjtu/GM_cooler/blob/master/src_free/data.f"

        subgraph PhysicalModels
            ValveModels["Valve Models"]
            PressureAssist["Pressure Assistance"]
        end
        click ValveModels "https://github.com/houkensjtu/GM_cooler/blob/master/src_free/valve.f"
        click PressureAssist "https://github.com/houkensjtu/GM_cooler/blob/master/src_free/pressureAssist.f"
    end

    %% Output Layer
    subgraph OutputLayer
        OutputHandler["Output Handler"]
        Visualization["Visualization System"]
    end
    click OutputHandler "https://github.com/houkensjtu/GM_cooler/blob/master/src_free/outp.f"
    click Visualization "https://github.com/houkensjtu/GM_cooler/blob/master/src_free/plot_disp.plt"

    %% Testing Framework
    subgraph TestingFramework
        FirstOrder["RKGS First Order Test"]
        SecondOrder1["RKGS Second Order Test 1"]
        SecondOrder2["RKGS Second Order Test 2"]
    end
    click FirstOrder "https://github.com/houkensjtu/GM_cooler/tree/master/test/rkgs_firstOrder/"
    click SecondOrder1 "https://github.com/houkensjtu/GM_cooler/tree/master/test/rkgs_secondOrder1/"
    click SecondOrder2 "https://github.com/houkensjtu/GM_cooler/tree/master/test/rkgs_secondOrder2/"

    %% Relationships
    ParamInput --> ParamSetting
    ParamSetting --> MainProgram
    MainProgram --> RKGS
    RKGS <--> CoreFunctions
    RKGS <--> DataManagement
    RKGS <--> PhysicalModels
    ValveModels <--> PressureAssist
    RKGS --> OutputHandler
    OutputHandler --> Visualization

    %% Testing Relationships
    RKGS -.-> FirstOrder
    RKGS -.-> SecondOrder1
    RKGS -.-> SecondOrder2

    %% Styling
    ParamInput:::input
    ParamSetting:::input
    MainProgram:::processing
    RKGS:::processing
    CoreFunctions:::processing
    DataManagement:::processing
    ValveModels:::processing
    PressureAssist:::processing
    OutputHandler:::output
    Visualization:::output
    FirstOrder:::testing
    SecondOrder1:::testing
    SecondOrder2:::testing
```
