# natlabrockies/sowfa-6 architecture

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

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

## Overview

SOWFA extends OpenFOAM for atmospheric-boundary-layer and wind-plant CFD. The user configures and runs a solver against a mesh and case data; the runtime advances flow while applying ABL forcing, turbulence models, boundary conditions, and—where selected—actuator turbine models, then produces fields and sampling or averaging outputs. The README documents broader solver and library capabilities than the sampled sources cover. Edges below are limited to README-described relationships or explicit SOURCE INDEX references; unsampled subsystems use supported directory paths.

Main entry points: [`applications/solvers/superDeliciousVanilla/superDeliciousVanilla.C`](https://github.com/natlabrockies/sowfa-6/blob/master/applications/solvers/superDeliciousVanilla/superDeliciousVanilla.C) (Flow solver), [`src/ABLForcing/drivingForce/drivingForce.C`](https://github.com/natlabrockies/sowfa-6/blob/master/src/ABLForcing/drivingForce/drivingForce.C) (ABL forcing), [`src/ABLForcing/perturbationZone/perturbationZone.C`](https://github.com/natlabrockies/sowfa-6/blob/master/src/ABLForcing/perturbationZone/perturbationZone.C) (Perturbation zones), [`src/turbineModels/turbineModelsOpenFAST/horizontalAxisWindTurbinesALMOpenFAST/horizontalAxisWindTurbinesALMOpenFAST.C`](https://github.com/natlabrockies/sowfa-6/blob/master/src/turbineModels/turbineModelsOpenFAST/horizontalAxisWindTurbinesALMOpenFAST/horizontalAxisWindTurbinesALMOpenFAST.C) (OpenFAST actuator line)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_flow["Flow simulation"]
  node_solver["Flow solver"]
  node_initialization["ABL initialization<br/>[setFieldsABL.C]"]
end

subgraph group_physics["ABL physics"]
  node_forcing["ABL forcing<br/>[drivingForce.C]"]
  node_controller["Forcing control"]
  node_perturbation["Perturbation zones<br/>[perturbationZone.C]"]
  node_turbulence["LES turbulence<br/>[kEqnABL.C]"]
  node_boundary["ABL boundary conditions"]
  node_geometry["Geometric transforms"]
end

subgraph group_turbines["Turbine models"]
  node_advancedalm["Advanced actuator line"]
  node_openfastalm["OpenFAST actuator line"]
end

subgraph group_analysis["Analysis and output"]
  node_planar["Planar averaging<br/>[planarAveraging.C]"]
  node_temporal["Temporal averaging"]
  node_lidar["Lidar simulation"]
  node_sampling["Structured sampling"]
  node_vtk["Structured VTK writer"]
  node_meshplanes["Mesh planes<br/>[meshPlanes.H]"]
  node_fieldoutput["Simulation fields"]
end

subgraph group_tools["Case utilities"]
  node_fieldutility["Field initialization utility<br/>[setFieldsABL.C]"]
  node_meshutility["Mesh utilities"]
end

node_user(("Case user"))
node_openfast["OpenFAST"]
node_openfoam["OpenFOAM runtime"]

node_user -->|"runs case"| node_solver
node_user -->|"initializes fields"| node_initialization
node_solver -->|"uses CFD runtime"| node_openfoam
node_solver -.->|"applies forcing"| node_forcing
node_forcing -->|"updates control"| node_controller
node_solver -.->|"applies perturbations"| node_perturbation
node_solver -->|"uses LES model"| node_turbulence
node_solver -->|"uses conditions"| node_boundary
node_solver -->|"couples turbine model"| node_advancedalm
node_solver -.->|"couples optional model"| node_openfastalm
node_openfastalm -->|"couples dynamics"| node_openfast
node_solver -.->|"writes fields"| node_fieldoutput
node_solver -->|"computes averages"| node_planar
node_solver -.->|"computes averages"| node_temporal
node_solver -->|"simulates scans"| node_lidar
node_solver -->|"samples flow"| node_sampling
node_sampling -->|"writes structured data"| node_vtk
node_planar -->|"uses planes"| node_meshplanes
node_perturbation -->|"uses transforms"| node_geometry
node_fieldutility -->|"initializes"| node_initialization
node_user -.->|"prepares mesh"| node_meshutility

click node_solver "https://github.com/natlabrockies/sowfa-6/blob/master/applications/solvers/superDeliciousVanilla/superDeliciousVanilla.C"
click node_initialization "https://github.com/natlabrockies/sowfa-6/blob/master/applications/utilities/setFieldsABL/setFieldsABL.C"
click node_forcing "https://github.com/natlabrockies/sowfa-6/blob/master/src/ABLForcing/drivingForce/drivingForce.C"
click node_controller "https://github.com/natlabrockies/sowfa-6/blob/master/src/ABLForcing/drivingForce/drivingForceController.C"
click node_perturbation "https://github.com/natlabrockies/sowfa-6/blob/master/src/ABLForcing/perturbationZone/perturbationZone.C"
click node_turbulence "https://github.com/natlabrockies/sowfa-6/blob/master/src/TurbulenceModels/turbulenceModels/LES/kEqnABL/kEqnABL.C"
click node_boundary "https://github.com/natlabrockies/sowfa-6/tree/master/src/boundaryConditions"
click node_advancedalm "https://github.com/natlabrockies/sowfa-6/blob/master/src/turbineModels/turbineModelsStandard/horizontalAxisWindTurbinesALMAdvanced/horizontalAxisWindTurbinesALMAdvanced.C"
click node_openfastalm "https://github.com/natlabrockies/sowfa-6/blob/master/src/turbineModels/turbineModelsOpenFAST/horizontalAxisWindTurbinesALMOpenFAST/horizontalAxisWindTurbinesALMOpenFAST.C"
click node_planar "https://github.com/natlabrockies/sowfa-6/blob/master/src/functionObjects/field/planarAveraging/planarAveraging.C"
click node_temporal "https://github.com/natlabrockies/sowfa-6/blob/master/src/functionObjects/field/temporalAveraging/temporalAveragingTemplates.C"
click node_lidar "https://github.com/natlabrockies/sowfa-6/tree/master/src/functionObjects/utilities"
click node_sampling "https://github.com/natlabrockies/sowfa-6/tree/master/src/sampling/sampledSet"
click node_vtk "https://github.com/natlabrockies/sowfa-6/blob/master/src/fileFormats/sampledSetWriters/vtkStructured/vtkStructuredSetWriter.C"
click node_meshplanes "https://github.com/natlabrockies/sowfa-6/blob/master/src/meshTools/meshPlanes/meshPlanes.H"
click node_geometry "https://github.com/natlabrockies/sowfa-6/blob/master/src/miscTools/geometricTransformations/geometricTransformations.C"
click node_fieldutility "https://github.com/natlabrockies/sowfa-6/blob/master/applications/utilities/setFieldsABL/setFieldsABL.C"
click node_meshutility "https://github.com/natlabrockies/sowfa-6/blob/master/applications/utilities/renumberMeshForRefineHexMesh/renumberMeshForRefineHexMesh.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_solver,node_initialization,node_user toneBlue
class node_forcing,node_controller,node_perturbation,node_turbulence,node_boundary,node_geometry toneAmber
class node_advancedalm,node_openfastalm toneMint
class node_planar,node_temporal,node_lidar,node_sampling,node_vtk,node_meshplanes,node_fieldoutput toneRose
class node_fieldutility,node_meshutility,node_openfast,node_openfoam toneIndigo
```

## Components

### Flow simulation

- [Flow solver](https://github.com/natlabrockies/sowfa-6/blob/master/applications/solvers/superDeliciousVanilla/superDeliciousVanilla.C): `applications/solvers/superDeliciousVanilla/superDeliciousVanilla.C`
- [ABL initialization](https://github.com/natlabrockies/sowfa-6/blob/master/applications/utilities/setFieldsABL/setFieldsABL.C): `applications/utilities/setFieldsABL/setFieldsABL.C`

### ABL physics

- [ABL forcing](https://github.com/natlabrockies/sowfa-6/blob/master/src/ABLForcing/drivingForce/drivingForce.C): `src/ABLForcing/drivingForce/drivingForce.C`
- [Forcing control](https://github.com/natlabrockies/sowfa-6/blob/master/src/ABLForcing/drivingForce/drivingForceController.C): `src/ABLForcing/drivingForce/drivingForceController.C`
- [Perturbation zones](https://github.com/natlabrockies/sowfa-6/blob/master/src/ABLForcing/perturbationZone/perturbationZone.C): `src/ABLForcing/perturbationZone/perturbationZone.C`
- [LES turbulence](https://github.com/natlabrockies/sowfa-6/blob/master/src/TurbulenceModels/turbulenceModels/LES/kEqnABL/kEqnABL.C): `src/TurbulenceModels/turbulenceModels/LES/kEqnABL/kEqnABL.C`
- [ABL boundary conditions](https://github.com/natlabrockies/sowfa-6/tree/master/src/boundaryConditions): `src/boundaryConditions`
- [Geometric transforms](https://github.com/natlabrockies/sowfa-6/blob/master/src/miscTools/geometricTransformations/geometricTransformations.C): `src/miscTools/geometricTransformations/geometricTransformations.C`

### Turbine models

- [Advanced actuator line](https://github.com/natlabrockies/sowfa-6/blob/master/src/turbineModels/turbineModelsStandard/horizontalAxisWindTurbinesALMAdvanced/horizontalAxisWindTurbinesALMAdvanced.C): `src/turbineModels/turbineModelsStandard/horizontalAxisWindTurbinesALMAdvanced/horizontalAxisWindTurbinesALMAdvanced.C`
- [OpenFAST actuator line](https://github.com/natlabrockies/sowfa-6/blob/master/src/turbineModels/turbineModelsOpenFAST/horizontalAxisWindTurbinesALMOpenFAST/horizontalAxisWindTurbinesALMOpenFAST.C): `src/turbineModels/turbineModelsOpenFAST/horizontalAxisWindTurbinesALMOpenFAST/horizontalAxisWindTurbinesALMOpenFAST.C`

### Analysis and output

- [Planar averaging](https://github.com/natlabrockies/sowfa-6/blob/master/src/functionObjects/field/planarAveraging/planarAveraging.C): `src/functionObjects/field/planarAveraging/planarAveraging.C`
- [Temporal averaging](https://github.com/natlabrockies/sowfa-6/blob/master/src/functionObjects/field/temporalAveraging/temporalAveragingTemplates.C): `src/functionObjects/field/temporalAveraging/temporalAveragingTemplates.C`
- [Lidar simulation](https://github.com/natlabrockies/sowfa-6/tree/master/src/functionObjects/utilities): `src/functionObjects/utilities`
- [Structured sampling](https://github.com/natlabrockies/sowfa-6/tree/master/src/sampling/sampledSet): `src/sampling/sampledSet`
- [Structured VTK writer](https://github.com/natlabrockies/sowfa-6/blob/master/src/fileFormats/sampledSetWriters/vtkStructured/vtkStructuredSetWriter.C): `src/fileFormats/sampledSetWriters/vtkStructured/vtkStructuredSetWriter.C`
- [Mesh planes](https://github.com/natlabrockies/sowfa-6/blob/master/src/meshTools/meshPlanes/meshPlanes.H): `src/meshTools/meshPlanes/meshPlanes.H`
- **Simulation fields**

### Case utilities

- [Field initialization utility](https://github.com/natlabrockies/sowfa-6/blob/master/applications/utilities/setFieldsABL/setFieldsABL.C): `applications/utilities/setFieldsABL/setFieldsABL.C`
- [Mesh utilities](https://github.com/natlabrockies/sowfa-6/blob/master/applications/utilities/renumberMeshForRefineHexMesh/renumberMeshForRefineHexMesh.C): `applications/utilities/renumberMeshForRefineHexMesh/renumberMeshForRefineHexMesh.C`

### Other components

- **Case user**
- **OpenFAST**
- **OpenFOAM runtime**

## Connections

- Case user → Flow solver: runs case
- Case user → ABL initialization: initializes fields
- Flow solver → OpenFOAM runtime: uses CFD runtime
- Flow solver → ABL forcing: applies forcing
- ABL forcing → Forcing control: updates control (evidence: `src/ABLForcing/drivingForce/drivingForce.H`)
- Flow solver → Perturbation zones: applies perturbations
- Flow solver → LES turbulence: uses LES model
- Flow solver → ABL boundary conditions: uses conditions
- Flow solver → Advanced actuator line: couples turbine model
- Flow solver → OpenFAST actuator line: couples optional model
- OpenFAST actuator line → OpenFAST: couples dynamics
- Flow solver → Simulation fields: writes fields
- Flow solver → Planar averaging: computes averages
- Flow solver → Temporal averaging: computes averages
- Flow solver → Lidar simulation: simulates scans
- Flow solver → Structured sampling: samples flow
- Structured sampling → Structured VTK writer: writes structured data
- Planar averaging → Mesh planes: uses planes
- Perturbation zones → Geometric transforms: uses transforms (evidence: `src/ABLForcing/perturbationZone/perturbationZone.C`)
- Field initialization utility → ABL initialization: initializes
- Case user → Mesh utilities: prepares mesh
