Windcsm

Windcsm

PySAM.Windcsm.default(config) → Windcsm

Load defaults for the configuration config. Available configurations are:

None

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.Windcsm.from_existing(data, optional config) → Windcsm: Share data with an existing PySAM class. If optional config is a valid configuration name, load the module’s defaults for that configuration.

PySAM.Windcsm.new() → Windcsm

PySAM.Windcsm.wrap(ssc_data_t) → Windcsm: Load data from a PySSC object.

Warning

Do not call PySSC.data_free on the ssc_data_t provided to wrap()

Windcsm is a wrapper for the SSC compute module cmod_windcsm.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.

None

Functions

class PySAM.Windcsm.Windcsm

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 = { 'wind_csm': { var: val, ...}, ...}

execute(int verbosity) → None: Execute simulation with verbosity level 0 (default) or 1

export() → dict: Export attributes into nested dictionary

get_data_ptr() → Pointer: Get ssc_data_t pointer

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 = { 'wind_csm': { var: val, ...}, ...}

unassign(name) → None: Unassign a value in any of the variable groups.

value(name, optional value) → None | float | dict | sequence | str: Get or set by name a value in any of the variable groups.

WindCsm Group

class PySAM.Windcsm.Windcsm.WindCsm

assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

WindCsm_vals = { var: val, ...}

export() → dict: Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

WindCsm_vals = { var: val, ...}

hub_height

Hub height [m]

Required: True

Type:: float

machine_rating

Machine rating [kW]

Required: True

Type:: float

num_bearings

Number of main bearings

Constraints: INTEGER,MIN=1

Required: False. Automatically set to 2 if not assigned explicitly or loaded from defaults.

Type:: float

num_blades

Number of blades

Constraints: INTEGER,MIN=1

Required: False. Automatically set to 3 if not assigned explicitly or loaded from defaults.

Type:: float

onboard_crane

Onboard crane [0/1]

Constraints: INTEGER,MIN=0,MAX=1

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:: float

rotor_torque

Rotor torque [Nm]

Required: True

Type:: float

turbine_carbon_blades

Turbine carbon blades [0/1]

Constraints: INTEGER,MIN=0,MAX=1

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:: float

turbine_class

Turbine class

Constraints: INTEGER,MIN=0,MAX=3

Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.

Type:: float

turbine_rotor_diameter

Turbine rotor diameter [m]

Required: True

Type:: float

turbine_user_exponent

Turbine user exponent

Required: False. Automatically set to 2.5 if not assigned explicitly or loaded from defaults.

Type:: float

Outputs Group

class PySAM.Windcsm.Windcsm.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, ...}

bedplate_cost

Bedplate cost [$]

Type:: float

blade_cost

Rotor cost [$]

Type:: float

controls_cost

Controls cost [$]

Type:: float

drivetrain_cost

Drivetrain cost [$]

Type:: float

drivetrain_mass

Drivetrain mass [kg]

Type:: float

electrical_connections_cost

Electrical connections cost [$]

Type:: float

gearbox_cost

Gearbox cost [$]

Type:: float

generator_cost

Generator cost [$]

Type:: float

high_speed_side_cost

High speed side cost [$]

Type:: float

hub_cost

Hub cost [$]

Type:: float

hvac_cost

HVAC cost [$]

Type:: float

low_speed_side_cost

Low speed side cost [$]

Type:: float

main_bearings_cost

Main bearings cost [$]

Type:: float

mainframe_cost

Mainframe cost [$]

Type:: float

pitch_cost

Pitch cost [$]

Type:: float

rotor_cost

Rotor cost [$]

Type:: float

rotor_mass

Rotor mass [kg]

Type:: float

spinner_cost

Spinner cost [$]

Type:: float

tower_cost

Tower cost [$]

Type:: float

tower_mass

Tower mass [kg]

Type:: float

transformer_cost

Transformer cost [$]

Type:: float

turbine_cost

Turbine cost [$]

Type:: float

variable_speed_electronics_cost

Variable speed electronics cost [$]

Type:: float

yaw_system_cost

Yaw system cost [$]

Type:: float