MhkTidal¶
Wrapper for SAM Simulation Core model: cmod_mhk_tidal.cpp
Creating an Instance¶
There are three methods to create a new instance of a PySAM module. Using default
populates the newclass’ attributes with default values specific to a config
. Each technology-financialconfiguration corresponds to a SAM GUI configuration. Using new
creates an instance with empty attributes. The wrap
function allows compatibility with PySSC, for details, refer to PySSC.
MhkTidal model description
Tidal marine hydrokinetic system
-
PySAM.MhkTidal.
default
(config) → MhkTidal¶ Use financial config-specific default attributes config options:
- “MEtidalLCOECalculator”
-
PySAM.MhkTidal.
from_existing
(data, optional config) → MhkTidal¶ Share underlying data with an existing PySAM class. If config provided, default attributes are loaded otherwise.
-
PySAM.MhkTidal.
new
() → MhkTidal¶
-
PySAM.MhkTidal.
wrap
(ssc_data_t) → MhkTidal¶ Use existing PySSC data
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap
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
-
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
() → None¶ Assign attributes from dictionary
MHKTidal_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
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: If not provided, assumed to be 1
- This variable may need to be updated if the values of the following have changed:
- tidal_power_curve
Type: float
-
tidal_power_curve
¶ Power curve of tidal energy device as function of stream speeds [kW]
Required: True
- Changes to this variable may require updating the values of the following:
- number_devices
Type: sequence[sequence]
-
tidal_resource
¶ Frequency distribution of resource as a function of stream speeds
Required: True
Type: sequence[sequence]
-
Outputs Group¶
-
class
PySAM.MhkTidal.MhkTidal.
Outputs
¶ -
assign
() → None¶ Assign attributes from dictionary
Outputs_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
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 of array [%]
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
-