MhkTidal¶
Tidal marine hydrokinetic system
-
PySAM.MhkTidal.
default
(config) → MhkTidal¶ Load defaults for the configuration
config
. Available configurations are:- “MEtidalLCOECalculator”
- “MEtidalNone”
Note
Some inputs do not have default values and may be assigned a value from the variable’s Required attribute. See variable attribute descriptions below.
-
PySAM.MhkTidal.
from_existing
(data, optional config) → MhkTidal¶ Share data with an existing PySAM class. If
optional config
is a valid configuration name, load the module’s defaults for that configuration.
-
PySAM.MhkTidal.
new
() → MhkTidal¶
-
PySAM.MhkTidal.
wrap
(ssc_data_t) → MhkTidal¶ Load data from a PySSC object.
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap()
MhkTidal is a wrapper for the SSC compute module cmod_mhk_tidal.cpp
Interdependent Variables¶
The variables listed below are interdependent with other variables. If you change the value of one of these variables, you may need to change values of other variables. The SAM user interface manages these interdependent variables, but in PySAM, it is up to you change the value of all interdependent variables so they are consistent. See Interdependent Variables for examples and details.
- number_devices
- system_capacity
- tidal_power_curve
Functions¶
-
class
PySAM.MhkTidal.
MhkTidal
¶ This class contains all the variable information for running a simulation. Variables are grouped together in the subclasses as properties. If property assignments are the wrong type, an error is thrown.
-
assign
(dict) → None¶ Assign attributes from nested dictionary, except for Outputs
nested_dict = { 'MHKTidal': { var: val, ...}, ...}
-
execute
(int verbosity) → None¶ Execute simulation with verbosity level 0 (default) or 1
-
export
() → dict¶ Export attributes into nested dictionary
-
replace
(dict) → None¶ Replace attributes from nested dictionary, except for Outputs. Unassigns all values in each Group then assigns from the input dict.
nested_dict = { 'MHKTidal': { var: val, ...}, ...}
-
unassign
(name) → None¶ Unassign a value in any of the variable groups.
-
value
(name, optional value) → Union[None, float, dict, sequence, str]¶ Get or set by name a value in any of the variable groups.
-
MHKTidal Group¶
-
class
PySAM.MhkTidal.MhkTidal.
MHKTidal
¶ -
assign
(dict) → None¶ Assign attributes from dictionary, overwriting but not removing values.
MHKTidal_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary.
-
replace
(dict) → None¶ Replace attributes from dictionary, unassigning values not present in input
dict
.MHKTidal_vals = { var: val, ...}
-
balance_of_system_cost_total
¶ BOS costs [$]
Required: False. Automatically set to 1 if not assigned explicitly or loaded from defaults.
Type: float
-
device_costs_total
¶ Device costs [$]
Required: False. Automatically set to 1 if not assigned explicitly or loaded from defaults.
Type: float
-
financial_cost_total
¶ Financial costs [$]
Required: False. Automatically set to 1 if not assigned explicitly or loaded from defaults.
Type: float
-
fixed_charge_rate
¶ FCR from LCOE Cost page
Required: False. Automatically set to 1 if not assigned explicitly or loaded from defaults.
Type: float
-
loss_additional
¶ Additional losses [%]
Required: True
Type: float
-
loss_array_spacing
¶ Array spacing loss [%]
Required: True
Type: float
-
loss_downtime
¶ Array/WEC downtime loss [%]
Required: True
Type: float
-
loss_resource_overprediction
¶ Resource overprediction loss [%]
Required: True
Type: float
-
loss_transmission
¶ Transmission losses [%]
Required: True
Type: float
-
number_devices
¶ Number of tidal devices in the system
Constraints: INTEGER
Required: False. Automatically set to 1 if not assigned explicitly or loaded from defaults.
The value of the following variables depends on
number_devices
:- system_capacity
The value of
number_devices
depends on the following variables:- tidal_power_curve
Type: float
-
system_capacity
¶ System Nameplate Capacity [kW]
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
The value of
system_capacity
depends on the following variables:- number_devices
- tidal_power_curve
Type: float
-
tidal_power_curve
¶ Power curve of tidal energy device as function of stream speeds [kW]
Required: True
The value of the following variables depends on
tidal_power_curve
:- number_devices
- system_capacity
Type: sequence[sequence]
-
tidal_resource
¶ Frequency distribution of resource as a function of stream speeds
Required: True
Type: sequence[sequence]
-
total_operating_cost
¶ O&M costs [$]
Required: False. Automatically set to 1 if not assigned explicitly or loaded from defaults.
Type: float
-
Outputs Group¶
-
class
PySAM.MhkTidal.MhkTidal.
Outputs
¶ -
assign
(dict) → None¶ Assign attributes from dictionary, overwriting but not removing values.
Outputs_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary.
-
replace
(dict) → None¶ Replace attributes from dictionary, unassigning values not present in input
dict
.Outputs_vals = { var: val, ...}
-
annual_cumulative_energy_distribution
¶ Cumulative annual energy production of array as function of speed [kWh]
Type: sequence
-
annual_energy
¶ Annual energy production of array [kWh]
Type: float
-
annual_energy_distribution
¶ Annual energy production of array as function of speed [kWh]
Type: sequence
-
capacity_factor
¶ Capacity factor [%]
Type: float
-
device_average_power
¶ Average power production of a single device [kW]
Type: float
-
device_rated_capacity
¶ Rated capacity of device [kW]
Type: float
-
tidal_power_end_velocity
¶ Last tidal velocity where power curve is greater than 0 [m/s]
Type: float
-
tidal_power_start_velocity
¶ First tidal velocity where power curve is greater than 0 [m/s]
Type: float
-
tidal_resource_end_velocity
¶ Last tidal velocity where probability distribution is greater than 0 [m/s]
Type: float
-
tidal_resource_start_velocity
¶ First tidal velocity where probability distribution is greater than 0 [m/s]
Type: float
-
total_bos_cost_kwh
¶ Balance of system costs per unit annual energy [$/kWh]
Type: float
-
total_bos_cost_lcoe
¶ BOS cost [%]
Type: float
-
total_bos_cost_per_kw
¶ Balance of Systems cost per kW [$/kW]
Type: float
-
total_capital_cost_kwh
¶ Capital costs per unit annual energy [$/kWh]
Type: float
-
total_capital_cost_lcoe
¶ Capital cost as percentage of overall LCOE [%]
Type: float
-
total_capital_cost_per_kw
¶ Capital cost per kW [$/kW]
Type: float
-
total_device_cost_kwh
¶ Device costs per unit annual energy [$/kWh]
Type: float
-
total_device_cost_lcoe
¶ Device cost [%]
Type: float
-
total_device_cost_per_kw
¶ Device cost per kW [$/kW]
Type: float
-
total_financial_cost_kwh
¶ Financial costs per unit annual energy [$/kWh]
Type: float
-
total_financial_cost_lcoe
¶ Financial cost [%]
Type: float
-
total_financial_cost_per_kw
¶ Financial cost per kW [$/kW]
Type: float
-
total_om_cost_kwh
¶ O&M costs per unit annual energy [$/kWh]
Type: float
-
total_om_cost_lcoe
¶ O&M cost (annual) [%]
Type: float
-
total_operations_cost_per_kw
¶ O&M cost per kW [$/kW]
Type: float
-