Thermalrate

Wrapper for SAM Simulation Core model: cmod_thermalrate.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.

Thermalrate model description

Thermal flat rate structure net revenue calculator

PySAM.Thermalrate.default(config) → Thermalrate

Use financial model-specific default attributes config options:

• “FuelCellCommercial”
• “FuelCellSingleOwner”

PySAM.Thermalrate.new() → Thermalrate

PySAM.Thermalrate.wrap(ssc_data_t) → Thermalrate

Use existing PySSC data

Warning

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

Functions

class PySAM.Thermalrate.Thermalrate

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

execute(int verbosity) → None

Execute simulation with verbosity level 0 (default) or 1

export() → dict

Export attributes into nested dictionary

ThermalRate Group

class PySAM.Thermalrate.Thermalrate.ThermalRate

assign() → None

Assign attributes from dictionary

ThermalRate_vals = { var: val, ...}

export() → dict

Export attributes into dictionary

en_thermal_rates

float: Optionally enable/disable thermal_rate [years]

Constraints: INTEGER,MIN=0,MAX=1

fuelcell_power_thermal

sequence: Fuel cell power generated [kW-t]

Required: True

thermal_buy_rate

sequence: Thermal buy rate [$/kW-t]

Required: set to 0 if not provided.

thermal_buy_rate_flat

float: Thermal buy rate flat [$/kW-t]

Required: set to 0 if not provided.

thermal_buy_rate_option

float: Thermal buy rate option [0/1]

Options: 0=flat,1=timestep

Constraints: INTEGER,MIN=0,MAX=1

Required: set to 0 if not provided.

thermal_degradation

sequence: Annual energy degradation [%]

Required: set to 0 if not provided.

thermal_load

sequence: Thermal load (year 1) [kW-t]

thermal_load_escalation

sequence: Annual load escalation [%/year]

Required: set to 0 if not provided.

thermal_rate_escalation

sequence: Annual thermal rate escalation [%/year]

Required: set to 0 if not provided.

thermal_sell_rate

sequence: Thermal sell rate [$/kW-t]

Required: set to 0 if not provided.

thermal_sell_rate_flat

float: Thermal sell rate flat [$/kW-t]

Required: set to 0 if not provided.

thermal_sell_rate_option

float: Thermal sell rate option [0/1]

Options: 0=flat,1=timestep

Constraints: INTEGER,MIN=0,MAX=1

Required: set to 0 if not provided.

Lifetime Group

class PySAM.Thermalrate.Thermalrate.Lifetime

assign() → None

Assign attributes from dictionary

Lifetime_vals = { var: val, ...}

export() → dict

Export attributes into dictionary

analysis_period

float: Number of years in analysis [years]

Constraints: INTEGER,POSITIVE

Required: True

inflation_rate

float: Inflation rate [%]

Constraints: MIN=-99

Required: True

system_use_lifetime_output

float: Lifetime hourly system outputs [0/1]

Options: 0=hourly first year,1=hourly lifetime

Constraints: INTEGER,MIN=0,MAX=1

Required: True

Outputs Group

class PySAM.Thermalrate.Thermalrate.Outputs

assign() → None

Assign attributes from dictionary

Outputs_vals = { var: val, ...}

export() → dict

Export attributes into dictionary

thermal_cost_with_system_year1

float: Thermal cost with sytem (year 1) [$]

thermal_cost_without_system_year1

float: Thermal cost without system (year 1) [$]

thermal_load_year1

float: Thermal load (year 1) [$]

thermal_revenue_with_system

sequence: Thermal revenue with system [$]

thermal_revenue_without_system

sequence: Thermal revenue without system [$]

thermal_savings_year1

float: Thermal savings (year 1) [$]