From 54da8f09bff13f6347e8d7f18e349c98d10cba40 Mon Sep 17 00:00:00 2001 From: Matt Prilliman Date: Mon, 16 Oct 2023 11:14:16 -0500 Subject: [PATCH] Fix ssc equation docs for mhk equations --- ssc/cmod_mhk_eqns.h | 38 +++++++++++++++++++++++++++++++++++--- ssc/ssc_equations.h | 2 +- 2 files changed, 36 insertions(+), 4 deletions(-) diff --git a/ssc/cmod_mhk_eqns.h b/ssc/cmod_mhk_eqns.h index 77c511047..d2756cbc5 100644 --- a/ssc/cmod_mhk_eqns.h +++ b/ssc/cmod_mhk_eqns.h @@ -53,18 +53,50 @@ static const char* me_array_cable_length_doc = SSCEXPORT bool me_array_cable_length(ssc_data_t data); +static const char* tidal_turbine_calculate_powercurve_doc = +"Calculates the tidal energy converter power output for tidal velocity bins in an ME array\\n" +"Input: var_table with key-value pairs\\n" +" 'tidal_turbine_rotor_diameter' - double [m]\\n" +" 'number_rotors' - integer [-]\\n" +" 'tidal_turbine_max_cp' - double [-]\\n" +" 'pto_efficiency' - double [%]\\n" +" 'cut_in' - double [m/s]\\n" +" 'cut_out' - double [m/s]\\n" +" 'tidal_resource' - matrix [-]\\n" +" 'generator_rated_capacity' - matrix [-]\\n" +"Output: key-value pairs added to var_table\\n" +" 'tidal_turbine_powercurve_tidespeeds' - array [m/s]\\n" +" 'tidal_turbine_powercurve_powerout' - array [kW]\\n" +" 'error - string [-]\\n"; + + SSCEXPORT bool tidal_turbine_calculate_powercurve(ssc_data_t data); static const char* me_array_cable_voltage_doc = "Calculates the cable voltages in an ME array\\n" "Input: var_table with key-value pairs\\n" " 'devices_per_row' - double [-]\\n" +" 'device_rated_power' - double [kW]\\n" +" 'system_capacity' - double [kW]\\n" " 'device_spacing_in_row' - double [m]\\n" -" 'number_rows' - double [-]\\n" " 'row_spacing' - double [m]\\n" -" 'cable_system_overbuild' - double [%]\\n" +" 'inter_array_cable_length' - double [m]\\n" +" 'riser_cable_length' - double [m]\\n" +" 'export_cable_length' - double [m]\\n" +" 'use_onshore_substation' - double [-]\\n" +" 'load_grid_voltage' - double [-]\\n" "Output: key-value pairs added to var_table\\n" -" 'inter_array_cable_voltage' - double [m]\\n"; +" 'array_cable_voltage' - double [V]\\n" +" 'array_cable_cost' - double [$]\\n" +" 'array_cable_cost_total' - double [$]\\n" +" 'export_cable_voltage' - double [V]\\n" +" 'export_cable_cost' - double [$]\\n" +" 'export_cable_cost_total' - double [$]\\n" +" 'riser_cable_voltage' - double [V]\\n" +" 'riser_cable_cost' - double [$]\\n" +" 'riser_cable_cost_total' - double [$]\\n" +" 'onshore_substation_cost_total' - double [$]\\n" +" 'offshore_substation_cost_total' - double [$]\\n"; SSCEXPORT bool me_array_cable_voltage(ssc_data_t data); diff --git a/ssc/ssc_equations.h b/ssc/ssc_equations.h index 3c3574fbf..a415ff107 100644 --- a/ssc/ssc_equations.h +++ b/ssc/ssc_equations.h @@ -86,7 +86,7 @@ static ssc_equation_entry ssc_equation_table [] = { "Marine energy", me_array_cable_length_doc, false, true}, {"tidal_turbine_calculate_powercurve", tidal_turbine_calculate_powercurve, - "Marine energy", me_array_cable_length_doc, + "Marine energy", tidal_turbine_calculate_powercurve_doc, false, true}, {"me_array_cable_voltage", me_array_cable_voltage, "Marine energy", me_array_cable_voltage_doc,