Skip to content

Commit

Permalink
move list of fixes to changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
rebeccamccabe committed Oct 26, 2024
1 parent bb7b96c commit ba314f1
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 24 deletions.
47 changes: 47 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
**Disclaimer**

** Unreleased **

** [v2.0](https://github.com/symbiotic-engineering/MDOcean/releases/tag/v2.0) - 2024-05-23 - first stable version using MEEM hydrodynamics **
### Added
- Use MEEM instead of analytical Froude Krylov approximations to get hydro coeffs
- Unit tests, continuous integration, and code coverage
- Maximum capture width check
### Changed
- Updated folder structure
### Fixed
- Opex scaled incorrectly with number of WECs
- Powertrain wasn't included in available volume calculation
- Incorrect float waterplane area

** [v1.4](https://github.com/symbiotic-engineering/MDOcean/releases/tag/v1.4) - 2022-08-16 - used for conference presentation **
### Fixed
- Incorrect buckling end condition
- Incorrect implementation of force saturation multiplier
- Incorrect scaling of cost with number of WECs
- Mass of damping plate support tubes not accounted for
- Powertrain and transmission loss not accounted for
- Wave period and wave height were swapped
- Incorrect nominal controller design variables and objective values
- Nominal simulation did not use power saturation
- Incorrect scale factor when summing power over JPD
- Froude Krylov force coefficient too high
- Float maximum displacement constraint not being enforced

** [v1.3](https://github.com/symbiotic-engineering/MDOcean/releases/tag/v1.3) - 2022-06-13 - used for the conference video **
### Added
- Location sensitivity
- Check for which constraints are active
### Fixed
- Depth of submergence
- Parameter sweep slope calculation failed for NaNs

** [v1.2](https://github.com/symbiotic-engineering/MDOcean/releases/tag/v1.2) - 2022-05-17 - used for conference proceedings paper **
### Added
- Comparison of power matrix for 4 designs
- New design variables: h_f_ratio, T_f_ratio, T_s_ratio
- Constrain that float cannot exceed spar height
### Fixed
- Incorrect value for young's modulus of steel

** [v1.0](https://github.com/symbiotic-engineering/MDOcean/releases/tag/v1.0) - 2022-02-15 - used for conference draft submission **
26 changes: 2 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ and has been accepted for publication/presentation in the 2022 ASME IDETC-CIE.
At this conference, the work was presented at the DAC-6 session and is publication number 90227.
A recording of the conference presentation is available [here](https://www.youtube.com/watch?v=LjpfXvujUGY).
The project began as an effort in Cornell course [MAE 5350](https://classes.cornell.edu/browse/roster/FA21/class/MAE/5350).
Known areas for improvement are listed as GitHub issues. If you find any additional errors, please let us know.

Citation: R. McCabe, O. Murphy, and M. N. Haji, “Multidisciplinary Optimization
to Reduce Cost and Power Variation of a Wave Energy Converter,”
Expand All @@ -28,32 +29,9 @@ https://doi.org/10.1115/DETC2022-90227.
- Olivia Murphy, [email protected] (Project contributor) @ommurphy
- Maha Haji, [email protected] (Advisor) @maha-haji

**Disclaimer**

The versions of the simulation used in the conference proceedings paper ([v1.2](https://github.com/symbiotic-engineering/MDOcean/releases/tag/v1.2))
and in the conference video ([v1.3](https://github.com/symbiotic-engineering/MDOcean/releases/tag/v1.3)) were later found to have a number of errors.
These errors have since been corrected, and the current code ([v1.4](https://github.com/symbiotic-engineering/MDOcean/releases/tag/v1.4)) is correct to the best of the authors' knowledge, within the limitations of the stated assumptions.
Known areas for improvement are listed as GitHub issues. If you find any additional errors, please let us know.

Errors that have since been fixed include:
- Incorrect value for young's modulus of steel
- Incorrect implementation of force saturation multiplier
- Wave period and wave height were swapped
- Froude Krylov force coefficient too high
- Incorrect nominal controller design variables and objective values
- Incorrect buckling end condition
- Nominal simulation did not use power saturation
- Incorrect scaling of cost with number of WECs
- Powertrain and transmission loss not accounted for
- Mass of damping plate support tubes not accounted for
- Float maximum displacement constraint not being enforced

*Because the results in the official conference proceedings contain these errors, an updated unofficial version
of the paper will be posted here in early September 2022, containing corrections.*

**License**

This project is released open-source under the MIT License. The validation folder contains code taken from NREL's BEMIO module, which is part of WEC-Sim.
This project is released open-source under the MIT License. The validation folder contains code taken from NREL's WEC-Sim.
The Apache 2.0 license for this open source WEC-Sim code is included.

**File Structure**
Expand Down

0 comments on commit ba314f1

Please sign in to comment.