Skip to content

Commit c1bced4

Browse files
committed
updated app readmes for #1311
1 parent 4ce0c88 commit c1bced4

4 files changed

Lines changed: 23 additions & 12 deletions

File tree

Body-to-Body_Interactions/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
**Author:** Kelley Ruehl
44

5-
**Geometry:** RM3
6-
75
**Original Version:** WEC-Sim v2.2
86

7+
**Geometry:** RM3
8+
99
**Description**
1010

1111
Example using [Body-to-Body (B2B)](https://wec-sim.github.io/WEC-Sim/main/user/advanced_features.html#body-to-body-interactions) to run WEC-Sim for the RM3 geometry. The scripts run and plot the RM3 model with B2B on/off and with Regular/RegularCIC. Execute the `runB2B.m` script to run this case.

OWC/FloatingOWC/README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,10 @@
88

99
**Description:**
1010

11-
This model simulates a Floating Oscillating Water Column (OWC) device using a rigid-body approach.
12-
It incorporates performance curves for both a Wells Turbine and a generator, providing a realistic
13-
representation of their dynamic behavior. Additionally, the model accounts for the presence of a
14-
mooring system to ensure the stability of the floating body.
11+
This model simulates a Floating Oscillating Water Column (OWC) device using a rigid-body approach. It incorporates performance curves for both a Wells Turbine and a generator, providing a realistic representation of their dynamic behavior. Additionally, the model accounts for the presence of a mooring system to ensure the stability of the floating body.
1512

1613
An optimal control strategy is implemented to maximize turbine efficiency by dynamically adjusting system parameters based on operating speed.
1714

18-
This model is based on the research detailed in:
15+
**Relevant Citation(s)**
1916

2017
Shabara, Mohamed A., et al. "Optimal Control of Floating Oscillating Water Column Wave Energy Converters." The 9th IEEE Conference on Control Technology and Applications (CCTA) 2025.
21-
22-
**Acknowledgment:** This material is based upon work supported by the U.S.Department of Energy’s Office of Energy Efficiency and Renewable Energy under the Water Power Technologies Office Award Number DE-EE0008895

OWC/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Oscillating Water Column
2+
3+
**Author:** Dominic Forbush, Mohamed Shabara, Jeff Grasberger and Jorge Leon-Quiroga
4+
5+
**Description**
6+
7+
Examples using WEC-Sim to simulate Oscillating Water Columns (OWCs)
8+
9+
* FloatingOWC - simulates a Floating Oscillating Water Column (OWC) device using a rigid-body approach.
10+
* OrificeModel - simulates a Floating Oscillating Water Column (OWC) device using the generalized body mode approach
11+

README_template.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,16 @@
22

33
**Author:** First Last
44

5-
**Version:** WEC-Sim version (e.g. v2.0)
5+
**Original Version:** WEC-Sim version (e.g. v2.0)
66

77
**Geometry:** Name of geometry
88

9-
**Dependency:** (optional) additional toolbox dependencies
9+
**Dependencies:** (optional) additional toolbox dependencies
1010

11+
**Description**
1112

12-
Brief description of the example.
13+
Brief description of the example.
14+
15+
**Relevant Citation(s)**
16+
17+
Add relevant citaions.

0 commit comments

Comments
 (0)