Added About page to docs

deslaughter · deslaughter · commit e437a7c0e139 · 2024-05-17T10:16:20.000-04:00
diff --git a/docs/content/docs/about/campbell-diagram.png b/docs/content/docs/about/campbell-diagram.png
diff --git a/docs/content/docs/about/index.md b/docs/content/docs/about/index.md
@@ -0,0 +1,54 @@
+---
+title: 'About'
+date: 2024-05-14T19:27:37+10:00
+weight: 2
+---
+
+The goal of `ACDC` is to simplify the process of generating Campbell diagrams for wind turbines modeled in OpenFAST. `ACDC` automates the preparation of existing OpenFAST models (input files) to perform linearization across a range of operating conditions. It then post-processes the OpenFAST output files to generate Campbell diagrams and visualize the mode shapes.
+
+## What is OpenFAST
+
+[OpenFAST](https://openfast.readthedocs.io/) is a multi-physics, multi-fidelity tool for simulating the coupled dynamic response of wind turbines. OpenFAST is able to model a range of wind turbine configurations, including two-bladed and three-blade horizontal-axis rotor, rigid or teetering hub, upwind or downwind rotor, and lattice or tubular tower. The wind turbine can be on land, or offshore on fixed-bottom or floating substructures.
+
+## What is a Campbell Diagram?
+
+Campbell diagrams are essential tools in the analysis and design of rotating machinery, including wind turbines. They provide a graphical representation of the relationship between the rotational speed of the machine and its natural frequencies. An example structure-only Campbell Diagram for the NREL 5MW turbine is shown below. 
+
+![NREL 5MW Campbell Diagram](campbell-diagram.png)
+
+Here’s a detailed description of how Campbell diagrams relate to wind turbines:
+
+### Purpose and Importance
+
+- **Vibration Analysis**: Campbell diagrams help in identifying critical speeds at which resonances might occur, leading to excessive vibrations. In wind turbines, managing these vibrations is crucial to ensure the structural integrity and longevity of the components.
+
+- **Avoidance of Resonance**: By mapping the natural frequencies against operational speeds, designers can avoid configurations where the natural frequencies coincide with the harmonic frequencies of the rotating components. This helps prevent resonance conditions that could cause damage.
+
+### Structure of Campbell diagrams
+
+- **Axes**: The horizontal axis represents the rotational speed of the wind turbine (usually in revolutions per minute or RPM). The vertical axis represents the frequency of vibrations (usually in Hertz or Hz).
+
+- **Frequency Lines**: Natural frequencies of the system are plotted as horizontal lines. Harmonic frequencies, which are multiples of the rotational speed, are plotted as diagonal lines (slope depends on the harmonic number).
+
+### Interpretation
+
+- **Intersection Points**: The points where diagonal lines (representing harmonic frequencies) intersect horizontal lines (representing natural frequencies) are critical. These intersections indicate potential resonance conditions.
+
+- **Critical Speeds**: The rotational speeds at which these intersections occur are known as critical speeds. Wind turbine operations should avoid these speeds to prevent resonance.
+
+### Application in Wind Turbines
+
+- **Blade Dynamics**: Wind turbine blades are subject to complex aerodynamic forces. Campbell diagrams help in understanding the dynamic behavior of the blades and ensuring that the operational speeds do not coincide with the blade's natural frequencies.
+
+- **Tower and Nacelle**: The Campbell diagram can also include the natural frequencies of the tower and nacelle. Resonance in these structures can lead to severe operational issues or even catastrophic failure.
+
+- **Design and Testing**: During the design phase, engineers use Campbell diagrams to fine-tune the design of blades, tower, and nacelle to ensure safe operational ranges. In testing and validation, Campbell diagrams help in verifying that the actual natural frequencies match the designed values and that no unexpected resonances occur.
+
+Campbell diagrams are crucial in the wind turbine industry for ensuring that turbines operate safely and efficiently. By providing a clear visual representation of the relationship between rotational speed and natural frequencies, they help engineers design turbines that avoid resonance, thereby enhancing performance and reliability.
+
+## Use Cases
+
+The primary use case for `ACDC` is prepare OpenFAST input files to perform linearization and post-process the results to generate Campbell diagrams. However, `ACDC` can also be used to generate Campbell diagrams from user generated linearization files by browsing for the folder containing those files in the `Results` tab (see [Linearization Folder]({{< ref "results/index.md#linearization-folder" >}}) for details).
+
+In addition, `ACDC` can visual the turbine mode shapes as described in [Mode Visualization]({{< ref "results/index.md#mode-visualization" >}}).
+
diff --git a/docs/content/docs/analysis/index.md b/docs/content/docs/analysis/index.md
@@ -1,7 +1,7 @@
 ---
 title: 'Analysis'
 date: 2024-05-14T19:27:37+10:00
-weight: 6
+weight: 7
 ---
 
 The `Analysis` tab is where the user defines the operating points for the analysis. Multiple sets of operating points, or `Cases`, can be defined for the same model. `Cases` may include aerodynamic effects and a controller may be used adjust the pitch and torque to achieve steady state. Depending on if the `Aerodynamics` and `Controller` options are selected, the interface will include additional inputs for wind speed, trim gain, and rated wind speed. The following figure shows the interface for a `Case` without aerodynamics.
diff --git a/docs/content/docs/evaluate/index.md b/docs/content/docs/evaluate/index.md
@@ -1,7 +1,7 @@
 ---
 title: 'Evaluate'
 date: 2024-05-14T19:27:37+10:00
-weight: 7
+weight: 8
 ---
 
 The `Evaluate` tab runs a case to generate linearization files at each operating point. 
diff --git a/docs/content/docs/install/index.md b/docs/content/docs/install/index.md
@@ -1,7 +1,7 @@
 ---
 title: 'Install'
 date: 2024-05-14T19:27:37+10:00
-weight: 2
+weight: 3
 ---
 
 `ACDC` executables are released for Windows, MacOS, and Linux, which can be downloaded from the project's [Github Releases](https://github.com/openfast/acdc/releases). It may also be compiled from source using [WAILS](https://wails.io/) after following its [Installation Instructions](https://wails.io/docs/gettingstarted/installation). 
diff --git a/docs/content/docs/model/index.md b/docs/content/docs/model/index.md
@@ -1,7 +1,7 @@
 ---
 title: 'Model'
 date: 2024-05-14T19:27:37+10:00
-weight: 4
+weight: 5
 ---
 
 The `Model` tab handles importing and modifying OpenFAST turbine models. The following figure shows the `Model` tab before a model has been imported. The `Import` button opens a dialog for the user to select the main `.fst` file of an OpenFAST model. The main file and all referenced files are read and stored in the `Project` file. Fields relevant to performing linearization are also extracted and made available for user modification inside `ACDC`.
diff --git a/docs/content/docs/project/index.md b/docs/content/docs/project/index.md
@@ -1,7 +1,7 @@
 ---
 title: 'Project'
 date: 2024-05-14T19:27:37+10:00
-weight: 3
+weight: 4
 ---
 
 The `Project` tab handles creating and opening project files which contain the data for building the OpenFAST models, setting up linearization, describing the analysis operating points, and running the simulations. The following figure shows the `ACDC` application when it is first started, and without a project loaded. It presents the options to create a new project, which opens a dialog to save a new project file, or to open an existing project, which opens a dialog to select the project file. A list of recently opened projects is also provided which will load the project file at the given path (full paths removed). 
diff --git a/docs/content/docs/results/index.md b/docs/content/docs/results/index.md
@@ -1,7 +1,7 @@
 ---
 title: 'Results'
 date: 2024-05-14T19:27:37+10:00
-weight: 8
+weight: 9
 ---
 
 The `Results` tab is used process OpenFAST linearization files to generate the Campbell Diagram and visualize the turbine mode shapes.
@@ -34,7 +34,7 @@ The Campbell Diagram is created by clicking the `Generate` button on the `Campbe
 
 - Minimum Frequency: modes with natural frequencies below this value will not appear in the diagram
 - Maximum Frequency: modes with natural frequencies above this value will not appear in the diagram
-- [Spectral Clustering]({{< ref "theory/#spectral-clustering" >}}): use  of each mode's Eigenvectors to reconfigure lines where the mode shape transitions between operating points (slow for large numbers of cross lines)
+- [Spectral Clustering]({{< ref "theory/index.md#spectral-clustering" >}}): use  of each mode's Eigenvectors to reconfigure lines where the mode shape transitions between operating points (slow for large numbers of cross lines)
 - Filter Non-structural Modes: use he location of the maximum value of the mode's eigenvector to determine the dominant state name; remove modes where that state is not in ElastoDyn, BeamDyn, or SubDyn
 
 ![](generate-diagram.png)
diff --git a/docs/content/docs/theory/index.md b/docs/content/docs/theory/index.md
@@ -1,7 +1,7 @@
 ---
 title: 'Theory'
 date: 2024-05-14T19:27:37+10:00
-weight: 9
+weight: 10
 ---
 
 Coming soon!
