Code cleanup

.github/workflows/tests.yml

@@ -0,0 +1,57 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the "main" branch
+  push:
+    branches: [ "main", "ci"]
+  pull_request:
+    branches: [ "main", "ci"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - name: Checkout branch
+        uses: actions/checkout@v3
+
+      - name: Set up MATLAB
+        uses: matlab-actions/setup-matlab@v1
+
+      - name: Run tests and generate artifacts
+        uses: matlab-actions/run-tests@v1
+        with:
+          source-folder: mdocean
+          test-results-junit: test-results/results.xml
+          test-results-pdf: test-results/testreport.pdf
+          code-coverage-cobertura: code-coverage/coverage.xml
+
+      - name: Publish code coverage
+        if: always()
+        uses: codecov/codecov-action@v1
+        with:
+          file: code-coverage/coverage.xml
+
+      - name: Publish test report
+        uses: mikepenz/action-junit-report@v3
+        if: always()
+        with:
+          report_paths: 'test-results/results.xml'
+
+      - name: Upload test report PDF
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: test-report
+          path: test-results/testreport.pdf

.gitignore

@@ -33,7 +33,14 @@ codegen/
 octave-workspace
 
 # auto-generated optimization functions
-optimization/generated
+mdocean/optimization/generated
 
 # html report files
-html/
+html/
+
+# unit test output folders
+code-coverage/
+test-results/
+
+# mat data files
+*.mat

README.md

@@ -1,3 +1,8 @@
+[![Unit Tests](https://github.com/symbiotic-engineering/MDOcean/actions/workflows/tests.yml/badge.svg)](https://github.com/symbiotic-engineering/MDOcean/actions/workflows/tests.yml)
+[![codecov](https://codecov.io/gh/symbiotic-engineering/MDOcean/branch/code-cleanup/graph/badge.svg?token=PQNFQ72IC8)](https://codecov.io/gh/symbiotic-engineering/MDOcean)
+![GitHub](https://img.shields.io/github/license/symbiotic-engineering/MDOcean)
+[![DOI](https://zenodo.org/badge/410160635.svg)](https://zenodo.org/badge/latestdoi/410160635)
+
 # MDOcean
 This is an open source codebase that uses Multidisciplinary Design Optimization (**MDO**) to optimize an **ocean** wave energy converter (WEC). 
 
@@ -6,13 +11,17 @@ of the Reference Model 3 (RM3) WEC, using a fast simplified frequency domain WEC
 
 **Context**
 
-The project is part of research in the [Symbiotic Engineering Analysis (SEA) Lab](https://sea.mae.cornell.edu/) and has been accepted for publication/presentation 
-in the [2022 ASME IDETC-CIE](https://event.asme.org/IDETC-CIE).
-At this conference, the work was presented at the [DAC-6](https://www.designautomationconference.org/dac-6) session and is publication number 90227.
+The project is part of research in the [Symbiotic Engineering Analysis (SEA) Lab](https://sea.mae.cornell.edu/) 
+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).
 
-Citation: R. McCabe, O. Murphy, and M. N. Haji, “Multidisciplinary Optimization to Reduce Cost and Power Variation of a Wave Energy Converter,” *International Design Engineering Technical Conferences & Computers and Information in Engineering Conference*, St. Louis, MO, August 14-17, 2022.
+Citation: R. McCabe, O. Murphy, and M. N. Haji, “Multidisciplinary Optimization 
+to Reduce Cost and Power Variation of a Wave Energy Converter,” 
+*International Design Engineering Technical Conferences & Computers and 
+Information in Engineering Conference*, St. Louis, MO, August 14-17, 2022.
+https://doi.org/10.1115/DETC2022-90227.
 
 **Authors**
 - Rebecca McCabe, [email protected] (Project lead and point of contact) @rebeccamccabe
@@ -21,7 +30,8 @@ Citation: R. McCabe, O. Murphy, and M. N. Haji, “Multidisciplinary Optimizatio
 
 **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. 
+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.
 

simulation/run/experiments.m → dev/experiments.m

@@ -1,7 +1,7 @@
 clear;clc;close all
 
 p = parameters();
-b = var_bounds(p);
+b = var_bounds();
 
 % X = [ 20 10 30;     % outer diameter of float	
 %       .3 .1 .5;     % inner diameter ratio of float	

optimization/multiobjective/pareto_random.m → dev/pareto_random.m

@@ -1,17 +1,15 @@
 clear;clc
 p = parameters();
-b = var_bounds(p);
+b = var_bounds();
 num_runs = 1e5;
 [LCOE,P_var,feasible] = deal(zeros(1,num_runs));
 
 X = zeros(num_runs,8);
 for i=1:num_runs
     xx = random_x0(b);
     X(i,:) = xx;
-    [LCOE(i), P_var(i), B, FOS1Y, FOS2Y, FOS3Y, ...
-            FOS_buckling, GM, P_elec, D_d, P_matrix, g] = simulation(xx, p);	
-    FOS = min([FOS1Y,FOS2Y,FOS3Y,FOS_buckling]);
-    feasible(i) = is_feasible(B, FOS, GM, P_elec, D_d, g(16), g(17), g(18), p);
+    [LCOE(i), P_var(i), P_matrix, g] = simulation(xx, p);
+    feasible(i) = is_feasible(g, b);
 end
 
 feasible = logical(feasible);

dev/plot_r_k_zeta.m

@@ -0,0 +1,49 @@
+% plot r_k * zeta as a function of omega for optimal control
+% for the nominal design and LCOE-optimal design
+clear 
+
+p = parameters();
+b = var_bounds();
+
+nominalX = [b.X_noms; 1];
+optimalX = gradient_optim(b.X_start_struct,p,b,1);
+Xs = [nominalX, optimalX];
+
+figure
+hold on
+
+linespec = {'','--'};
+for i = 1:2
+    Xi = Xs(:,i);
+    [D_f, D_s_ratio, h_f_ratio, T_s_ratio] = deal(Xi(1),Xi(2),Xi(3),Xi(4));
+    h_f = b.h_f_ratio_nom * D_f;
+    T_f = p.T_f_over_h_f * h_f;
+    D_s = D_s_ratio * D_f;
+    T_s = p.T_s_over_D_s * D_s;
+    h_s = T_s / b.T_s_ratio_nom;
+    h_d = p.h_d_over_D_s * D_s;
+    D_d = p.D_d_over_D_s * D_s;
+
+    w = linspace(0.1,2);
+    T = 2*pi./w;
+    Hs = 1;
+    [w,A,B_h,K_h] = dynamics_simple(Hs, T, D_f, T_f, p.rho_w, p.g);
+    [~, ~, m_float] = geometry(D_s, D_f, T_f, h_f, h_s, ...
+                                                p.t_ft, p.t_fr, p.t_fc, p.t_fb, p.t_sr, ...
+                                                p.t_dt, D_d, p.D_dt, p.theta_dt, T_s, h_d, ...
+                                                b.M_nom, p.rho_m, p.rho_w, p.m_scale);
+    m = m_float + A;
+
+    r_k_zeta = w .* B_h ./ (m*w.^2 - K_h);
+
+
+    plot(w,abs(r_k_zeta),linespec{i})
+end
+
+xlabel('\omega')
+ylabel('|r_k \zeta|')
+title('Simulated Hydro Coeffs')
+ylim([-.5 3])
+grid on
+legend('Nominal','Optimal LCOE')
+improvePlot

dev/power_matrix_compare.m

@@ -4,20 +4,20 @@
 
 % inputs
 p = parameters();
-b = var_bounds(p);
+b = var_bounds();
 X = [b.X_noms; 1];
 
 % unsaturated power
 actual_mech_unsat = readmatrix(filename,'Range','E73:S86','Sheet','Performance & Economics');
-actual_elec_unsat = actual_mech_unsat * p.pto_eff;
-[~, P_var, ~, ~, ~, ~, ~, ~, P_elec, ~, P_matrix] = simulation(X,p);
+actual_elec_unsat = actual_mech_unsat * p.eff_pto;
+[~, ~, P_matrix] = simulation(X,p);
 sim_elec_unsat = P_matrix/1000;
 
 % saturated power
 v = validation_inputs();
 p.power_max = v.power_max;
 actual_elec_sat = readmatrix(filename,'Range','E97:S110','Sheet','Performance & Economics');
-[~, P_var, ~, ~, ~, ~, ~, ~, P_elec, ~, P_matrix] = simulation(X,p);
+[~, ~, P_matrix] = simulation(X,p);
 sim_elec_sat = P_matrix/1000;
 
 % wave resources
@@ -87,7 +87,7 @@
     title(resource_titles{i})
     colorbar
 end
-sgtitle('Wave Resource')
+sgtitle('Wave Resource (kW/m)')
 
 % JPD figure
 JPDs = JPD;