# natlabrockies/sowfa architecture

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

- Interactive diagram: https://gitdiagram.com/natlabrockies/sowfa
- Repository: https://github.com/natlabrockies/sowfa

## Overview

This repository is a wind-energy-focused OpenFOAM CFD codebase: its tree includes atmospheric-boundary-layer (ABL) and terrain solvers, wind-plant solvers with actuator-disk/line turbine variants, turbine models, lidar diagnostics, and supporting boundary-condition and turbulence models. A typical workflow configures a case, runs a flow solver coupled to turbine representations, then samples or analyzes the resulting flow. The README describes OpenFOAM generally, not these extensions; most solver entry points and integration links were not excerpted, so those links are shown as unverified rather than asserted.

Main entry points: [`applications/solvers/incompressible/windEnergy/ABLSolver/ABLSolver.C`](https://github.com/natlabrockies/sowfa/blob/master/applications/solvers/incompressible/windEnergy/ABLSolver/ABLSolver.C) (ABL solver), [`applications/solvers/incompressible/windEnergy/windPlantSolver.ALM/windPlantSolver.C`](https://github.com/natlabrockies/sowfa/blob/master/applications/solvers/incompressible/windEnergy/windPlantSolver.ALM/windPlantSolver.C) (Plant ALM solver), [`applications/solvers/incompressible/windEnergy/windPlantSolver.ADM/windPlantSolver.C`](https://github.com/natlabrockies/sowfa/blob/master/applications/solvers/incompressible/windEnergy/windPlantSolver.ADM/windPlantSolver.C) (Plant ADM solver), [`src/sampling/sampledSet/cylinder/cylinderSet.C`](https://github.com/natlabrockies/sowfa/blob/master/src/sampling/sampledSet/cylinder/cylinderSet.C) (Mesh sample sets)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_solvers["Flow solvers"]
  node_abl["ABL solver<br/>[ABLSolver.C]"]
  node_terrain["Terrain solver<br/>[ABLTerrainSolver.C]"]
  node_plant_adm["Plant ADM solver<br/>[windPlantSolver.C]"]
  node_plant_alm["Plant ALM solver<br/>[windPlantSolver.C]"]
  node_plant_advanced["Advanced ALM solver<br/>[windPlantSolver.C]"]
  node_plant_fast["OpenFAST plant solver<br/>[windPlantSolver.C]"]
  node_piso_adm["PISO turbine ADM<br/>[pisoFoamTurbine.C]"]
  node_piso_alm["PISO turbine ALM<br/>[pisoFoamTurbine.C]"]
end

subgraph group_turbines["Turbine models"]
  node_adm_model["ADM turbine model"]
  node_alm_model["ALM turbine model"]
  node_advanced_model["Advanced ALM model"]
  node_fast_model["OpenFAST ALM model"]
end

subgraph group_diagnostics["Sampling and diagnostics"]
  node_lidar_scan["Scanning lidar<br/>[scanningLidar.C]"]
  node_lidar_spinner["Spinner lidar<br/>[spinnerLidar.C]"]
  node_samples["Mesh sample sets<br/>[cylinderSet.C]"]
  node_vtk["Structured VTK writer"]
end

subgraph group_physics["Boundary and turbulence physics"]
  node_abl_bc["ABL wall conditions"]
  node_temp_bc["Temperature conditions"]
  node_les["ABL LES model<br/>[KosovicOneEqNBA.C]"]
  node_average_field[("Average field I/O<br/>[AverageIOField.C]")]
end

subgraph group_utilities["Case utilities"]
  node_set_fields["ABL field setup<br/>[setFieldsABL.C]"]
  node_wrf["WRF terrain import"]
  node_boundary_convert["Boundary conversion<br/>[points.py]"]
end

node_user(("Case operator"))

node_user -.->|"configures and runs"| node_abl
node_user -.->|"configures and runs"| node_terrain
node_user -.->|"configures and runs"| node_plant_adm
node_user -.->|"configures and runs"| node_plant_alm
node_user -.->|"configures and runs"| node_plant_advanced
node_user -.->|"configures and runs"| node_plant_fast
node_plant_adm -.->|"dispatches model"| node_adm_model
node_plant_alm -.->|"dispatches model"| node_alm_model
node_plant_advanced -.->|"dispatches model"| node_advanced_model
node_plant_fast -.->|"dispatches model"| node_fast_model
node_piso_adm -.->|"uses model"| node_adm_model
node_piso_alm -.->|"uses model"| node_alm_model
node_user -.->|"prepares case"| node_set_fields
node_wrf -.->|"provides terrain"| node_terrain
node_boundary_convert -.->|"prepares inputs"| node_plant_alm
node_plant_adm -.->|"produces flow for"| node_lidar_scan
node_plant_alm -.->|"produces flow for"| node_lidar_spinner
node_lidar_scan -.->|"samples flow"| node_samples
node_lidar_spinner -.->|"samples flow"| node_samples
node_samples -.->|"exports samples"| node_vtk
node_abl -.->|"uses conditions"| node_abl_bc
node_abl -.->|"uses conditions"| node_temp_bc
node_abl -.->|"uses turbulence model"| node_les
node_average_field -->|"reads and writes averages"| node_average_field

click node_abl "https://github.com/natlabrockies/sowfa/blob/master/applications/solvers/incompressible/windEnergy/ABLSolver/ABLSolver.C"
click node_terrain "https://github.com/natlabrockies/sowfa/blob/master/applications/solvers/incompressible/windEnergy/ABLTerrainSolver/ABLTerrainSolver.C"
click node_plant_adm "https://github.com/natlabrockies/sowfa/blob/master/applications/solvers/incompressible/windEnergy/windPlantSolver.ADM/windPlantSolver.C"
click node_plant_alm "https://github.com/natlabrockies/sowfa/blob/master/applications/solvers/incompressible/windEnergy/windPlantSolver.ALM/windPlantSolver.C"
click node_plant_advanced "https://github.com/natlabrockies/sowfa/blob/master/applications/solvers/incompressible/windEnergy/windPlantSolver.ALMAdvanced/windPlantSolver.C"
click node_plant_fast "https://github.com/natlabrockies/sowfa/blob/master/applications/solvers/incompressible/windEnergy/windPlantSolver.ALMAdvancedOpenFAST/windPlantSolver.C"
click node_piso_adm "https://github.com/natlabrockies/sowfa/blob/master/applications/solvers/incompressible/windEnergy/pisoFoamTurbine.ADM/pisoFoamTurbine.C"
click node_piso_alm "https://github.com/natlabrockies/sowfa/blob/master/applications/solvers/incompressible/windEnergy/pisoFoamTurbine.ALM/pisoFoamTurbine.C"
click node_adm_model "https://github.com/natlabrockies/sowfa/blob/master/src/turbineModels/turbineModelsStandard/horizontalAxisWindTurbinesADM/horizontalAxisWindTurbinesADM.C"
click node_alm_model "https://github.com/natlabrockies/sowfa/blob/master/src/turbineModels/turbineModelsStandard/horizontalAxisWindTurbinesALM/horizontalAxisWindTurbinesALM.C"
click node_advanced_model "https://github.com/natlabrockies/sowfa/blob/master/src/turbineModels/turbineModelsStandard/horizontalAxisWindTurbinesALMAdvanced/horizontalAxisWindTurbinesALMAdvanced.C"
click node_fast_model "https://github.com/natlabrockies/sowfa/blob/master/src/turbineModels/turbineModelsOpenFAST/horizontalAxisWindTurbinesALMOpenFAST/horizontalAxisWindTurbinesALMOpenFAST.C"
click node_lidar_scan "https://github.com/natlabrockies/sowfa/blob/master/src/postProcessing/functionObjects/utilities/scanningLidar/scanningLidar.C"
click node_lidar_spinner "https://github.com/natlabrockies/sowfa/blob/master/src/postProcessing/functionObjects/utilities/spinnerLidar/spinnerLidar.C"
click node_samples "https://github.com/natlabrockies/sowfa/blob/master/src/sampling/sampledSet/cylinder/cylinderSet.C"
click node_vtk "https://github.com/natlabrockies/sowfa/blob/master/src/fileFormats/sampledSetWriters/vtkStructured/vtkStructuredSetWriter.C"
click node_abl_bc "https://github.com/natlabrockies/sowfa/blob/master/src/finiteVolume/fields/fvPatchFields/derived/surfaceVelocityModels/velocityABLWallFunction/velocityABLWallFunctionFvPatchField.C"
click node_temp_bc "https://github.com/natlabrockies/sowfa/blob/master/src/finiteVolume/fields/fvPatchFields/derived/turbulentABLTemperatureControlled/turbulentABLTemperatureControlledFvPatchField.C"
click node_les "https://github.com/natlabrockies/sowfa/blob/master/src/turbulenceModels/incompressible/LES/KosovicOneEqNBA/KosovicOneEqNBA.C"
click node_set_fields "https://github.com/natlabrockies/sowfa/blob/master/applications/utilities/setFieldsABL/setFieldsABL.C"
click node_wrf "https://github.com/natlabrockies/sowfa/blob/master/tools/WRFextraction/extractWRFTerrain.py"
click node_boundary_convert "https://github.com/natlabrockies/sowfa/blob/master/tools/boundaryDataConversion/makeBoundaryDataFiles/points.py"
click node_average_field "https://github.com/natlabrockies/sowfa/blob/master/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFluctuatingFixedValue/AverageIOField.C"

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_abl,node_terrain,node_plant_adm,node_plant_alm,node_plant_advanced,node_plant_fast,node_piso_adm,node_piso_alm toneBlue
class node_adm_model,node_alm_model,node_advanced_model,node_fast_model toneAmber
class node_lidar_scan,node_lidar_spinner,node_samples,node_vtk toneMint
class node_abl_bc,node_temp_bc,node_les,node_average_field toneRose
class node_set_fields,node_wrf,node_boundary_convert,node_user toneIndigo
```

## Components

### Flow solvers

- [ABL solver](https://github.com/natlabrockies/sowfa/blob/master/applications/solvers/incompressible/windEnergy/ABLSolver/ABLSolver.C): `applications/solvers/incompressible/windEnergy/ABLSolver/ABLSolver.C`
- [Terrain solver](https://github.com/natlabrockies/sowfa/blob/master/applications/solvers/incompressible/windEnergy/ABLTerrainSolver/ABLTerrainSolver.C): `applications/solvers/incompressible/windEnergy/ABLTerrainSolver/ABLTerrainSolver.C`
- [Plant ADM solver](https://github.com/natlabrockies/sowfa/blob/master/applications/solvers/incompressible/windEnergy/windPlantSolver.ADM/windPlantSolver.C): `applications/solvers/incompressible/windEnergy/windPlantSolver.ADM/windPlantSolver.C`
- [Plant ALM solver](https://github.com/natlabrockies/sowfa/blob/master/applications/solvers/incompressible/windEnergy/windPlantSolver.ALM/windPlantSolver.C): `applications/solvers/incompressible/windEnergy/windPlantSolver.ALM/windPlantSolver.C`
- [Advanced ALM solver](https://github.com/natlabrockies/sowfa/blob/master/applications/solvers/incompressible/windEnergy/windPlantSolver.ALMAdvanced/windPlantSolver.C): `applications/solvers/incompressible/windEnergy/windPlantSolver.ALMAdvanced/windPlantSolver.C`
- [OpenFAST plant solver](https://github.com/natlabrockies/sowfa/blob/master/applications/solvers/incompressible/windEnergy/windPlantSolver.ALMAdvancedOpenFAST/windPlantSolver.C): `applications/solvers/incompressible/windEnergy/windPlantSolver.ALMAdvancedOpenFAST/windPlantSolver.C`
- [PISO turbine ADM](https://github.com/natlabrockies/sowfa/blob/master/applications/solvers/incompressible/windEnergy/pisoFoamTurbine.ADM/pisoFoamTurbine.C): `applications/solvers/incompressible/windEnergy/pisoFoamTurbine.ADM/pisoFoamTurbine.C`
- [PISO turbine ALM](https://github.com/natlabrockies/sowfa/blob/master/applications/solvers/incompressible/windEnergy/pisoFoamTurbine.ALM/pisoFoamTurbine.C): `applications/solvers/incompressible/windEnergy/pisoFoamTurbine.ALM/pisoFoamTurbine.C`

### Turbine models

- [ADM turbine model](https://github.com/natlabrockies/sowfa/blob/master/src/turbineModels/turbineModelsStandard/horizontalAxisWindTurbinesADM/horizontalAxisWindTurbinesADM.C): `src/turbineModels/turbineModelsStandard/horizontalAxisWindTurbinesADM/horizontalAxisWindTurbinesADM.C`
- [ALM turbine model](https://github.com/natlabrockies/sowfa/blob/master/src/turbineModels/turbineModelsStandard/horizontalAxisWindTurbinesALM/horizontalAxisWindTurbinesALM.C): `src/turbineModels/turbineModelsStandard/horizontalAxisWindTurbinesALM/horizontalAxisWindTurbinesALM.C`
- [Advanced ALM model](https://github.com/natlabrockies/sowfa/blob/master/src/turbineModels/turbineModelsStandard/horizontalAxisWindTurbinesALMAdvanced/horizontalAxisWindTurbinesALMAdvanced.C): `src/turbineModels/turbineModelsStandard/horizontalAxisWindTurbinesALMAdvanced/horizontalAxisWindTurbinesALMAdvanced.C`
- [OpenFAST ALM model](https://github.com/natlabrockies/sowfa/blob/master/src/turbineModels/turbineModelsOpenFAST/horizontalAxisWindTurbinesALMOpenFAST/horizontalAxisWindTurbinesALMOpenFAST.C): `src/turbineModels/turbineModelsOpenFAST/horizontalAxisWindTurbinesALMOpenFAST/horizontalAxisWindTurbinesALMOpenFAST.C`

### Sampling and diagnostics

- [Scanning lidar](https://github.com/natlabrockies/sowfa/blob/master/src/postProcessing/functionObjects/utilities/scanningLidar/scanningLidar.C): `src/postProcessing/functionObjects/utilities/scanningLidar/scanningLidar.C`
- [Spinner lidar](https://github.com/natlabrockies/sowfa/blob/master/src/postProcessing/functionObjects/utilities/spinnerLidar/spinnerLidar.C): `src/postProcessing/functionObjects/utilities/spinnerLidar/spinnerLidar.C`
- [Mesh sample sets](https://github.com/natlabrockies/sowfa/blob/master/src/sampling/sampledSet/cylinder/cylinderSet.C): `src/sampling/sampledSet/cylinder/cylinderSet.C`
- [Structured VTK writer](https://github.com/natlabrockies/sowfa/blob/master/src/fileFormats/sampledSetWriters/vtkStructured/vtkStructuredSetWriter.C): `src/fileFormats/sampledSetWriters/vtkStructured/vtkStructuredSetWriter.C`

### Boundary and turbulence physics

- [ABL wall conditions](https://github.com/natlabrockies/sowfa/blob/master/src/finiteVolume/fields/fvPatchFields/derived/surfaceVelocityModels/velocityABLWallFunction/velocityABLWallFunctionFvPatchField.C): `src/finiteVolume/fields/fvPatchFields/derived/surfaceVelocityModels/velocityABLWallFunction/velocityABLWallFunctionFvPatchField.C`
- [Temperature conditions](https://github.com/natlabrockies/sowfa/blob/master/src/finiteVolume/fields/fvPatchFields/derived/turbulentABLTemperatureControlled/turbulentABLTemperatureControlledFvPatchField.C): `src/finiteVolume/fields/fvPatchFields/derived/turbulentABLTemperatureControlled/turbulentABLTemperatureControlledFvPatchField.C`
- [ABL LES model](https://github.com/natlabrockies/sowfa/blob/master/src/turbulenceModels/incompressible/LES/KosovicOneEqNBA/KosovicOneEqNBA.C): `src/turbulenceModels/incompressible/LES/KosovicOneEqNBA/KosovicOneEqNBA.C`
- [Average field I/O](https://github.com/natlabrockies/sowfa/blob/master/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFluctuatingFixedValue/AverageIOField.C): `src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFluctuatingFixedValue/AverageIOField.C`

### Case utilities

- [ABL field setup](https://github.com/natlabrockies/sowfa/blob/master/applications/utilities/setFieldsABL/setFieldsABL.C): `applications/utilities/setFieldsABL/setFieldsABL.C`
- [WRF terrain import](https://github.com/natlabrockies/sowfa/blob/master/tools/WRFextraction/extractWRFTerrain.py): `tools/WRFextraction/extractWRFTerrain.py`
- [Boundary conversion](https://github.com/natlabrockies/sowfa/blob/master/tools/boundaryDataConversion/makeBoundaryDataFiles/points.py): `tools/boundaryDataConversion/makeBoundaryDataFiles/points.py`

### Other components

- **Case operator**

## Connections

- Case operator → ABL solver: configures and runs
- Case operator → Terrain solver: configures and runs
- Case operator → Plant ADM solver: configures and runs
- Case operator → Plant ALM solver: configures and runs
- Case operator → Advanced ALM solver: configures and runs
- Case operator → OpenFAST plant solver: configures and runs
- Plant ADM solver → ADM turbine model: dispatches model
- Plant ALM solver → ALM turbine model: dispatches model
- Advanced ALM solver → Advanced ALM model: dispatches model
- OpenFAST plant solver → OpenFAST ALM model: dispatches model
- PISO turbine ADM → ADM turbine model: uses model
- PISO turbine ALM → ALM turbine model: uses model
- Case operator → ABL field setup: prepares case
- WRF terrain import → Terrain solver: provides terrain
- Boundary conversion → Plant ALM solver: prepares inputs
- Plant ADM solver → Scanning lidar: produces flow for
- Plant ALM solver → Spinner lidar: produces flow for
- Scanning lidar → Mesh sample sets: samples flow
- Spinner lidar → Mesh sample sets: samples flow
- Mesh sample sets → Structured VTK writer: exports samples
- ABL solver → ABL wall conditions: uses conditions
- ABL solver → Temperature conditions: uses conditions
- ABL solver → ABL LES model: uses turbulence model
- Average field I/O → Average field I/O: reads and writes averages (evidence: `src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFluctuatingFixedValue/AverageIOField.C`)
