From ba314f1770bd8492f7c1a9b8371c4539ef19d49c Mon Sep 17 00:00:00 2001 From: rebeccamccabe Date: Sat, 26 Oct 2024 14:21:11 -0400 Subject: [PATCH] move list of fixes to changelog --- CHANGELOG.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ README.md | 26 ++------------------------ 2 files changed, 49 insertions(+), 24 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..2086f634 --- /dev/null +++ b/CHANGELOG.md @@ -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 ** diff --git a/README.md b/README.md index 025e3642..c08905f9 100644 --- a/README.md +++ b/README.md @@ -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,” @@ -28,32 +29,9 @@ https://doi.org/10.1115/DETC2022-90227. - Olivia Murphy, om66@cornell.edu (Project contributor) @ommurphy - Maha Haji, maha@cornell.edu (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**