Skip to content

Commit

Permalink
Fix ssc equation docs for mhk equations
Browse files Browse the repository at this point in the history
  • Loading branch information
mjprilliman committed Oct 16, 2023
1 parent 9e215e5 commit 54da8f0
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 4 deletions.
38 changes: 35 additions & 3 deletions ssc/cmod_mhk_eqns.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down
2 changes: 1 addition & 1 deletion ssc/ssc_equations.h
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 54da8f0

Please sign in to comment.