Skip to content

Commit 30c11ff

Browse files
committed
more readme udpates
1 parent c1bced4 commit 30c11ff

6 files changed

Lines changed: 37 additions & 5 deletions

File tree

Controls/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Controls
2+
3+
**Author:** Jeff Grasberger and Ratanak So
4+
5+
**Description**
6+
7+
Examples using WEC-Sim with controls
8+
9+
* Declutching - control with optimal declutching time
10+
* Latching - control with optimal latching time
11+
* MPC - model predictive controller (MPC)
12+
* Passive (P) - control with optimal proportional gain
13+
* Reactive (PI) - control with optimal proportional and integral gains
14+
* Reactive with PTO - reactive controller and simple direct drive power take-off (PTO)

OWC/OrificeModel/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,11 @@ file with the _clean suffix.
1818

1919
Run wecSimMCR for orifice area study in mcrOrifice.mat which will work with the
2020
userDefinedFunctions.m
21+
22+
**Relevant Citation(s)**
23+
24+
Add relevant citaions.
25+
26+
Kelly, T., Zabala, I., Peña-Sanchez, Y., Penalba, M., Ringwood, J. V., Henriques, J. C., & Blanco, J. M. (2022). A post-processing technique for removing ‘irregular frequencies’ and other issues in the results from BEM solvers. International Marine Energy Journal, 5(1), 123–131. https://doi.org/10.36688/imej.5.123-131
27+
28+
Lee, C.H., and Newman, J.N. WAMIT User Manual, Cambridge, MA: WAMIT, Inc., 2006. refer to Generalized Body Modes chapter

OWC/README.md

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

77
Examples using WEC-Sim to simulate Oscillating Water Columns (OWCs)
88

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
9+
* FloatingOWC - simulates a Floating OWC using the rigid-body approach.
10+
* OrificeModel - simulates a Floating OWC using the generalized body mode approach
1111

Variable_Hydro/Passive_Yaw/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Variable Hydrodynamics
1+
# Passive Yaw
22

3-
**Author:** Adam Keester
3+
**Author:** Adam Keester and Dominic Forbush
44

55
**Geometry:** OSWEC
66

Variable_Hydro/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Variable Hydrodynamics
2+
3+
**Author:** Adam Kester, Jeff Grasberger, and Dominic Forbush
4+
5+
**Description**
6+
7+
Examples using WEC-Sim with variable hydrodynamics
8+
9+
* Passive Yaw - using variable hydrodynamics feature by comparing it to the passive yaw implementation
10+
* Variable Mass - using variable hydrodynamics feature to model a sphere with a variable mass and draft

Variable_Hydro/Variable_Mass/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Variable Hydrodynamics Variable Mass
1+
# Variable Mass
22

33
**Author:** Jeff Grasberger
44

0 commit comments

Comments
 (0)