Thermalrate¶
Thermal flat rate structure net revenue calculator
-
PySAM.Thermalrate.
default
(config) → Thermalrate¶ Load defaults for the configuration
config
. Available configurations are:- “FuelCellCommercial”
- “FuelCellSingleOwner”
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.Thermalrate.
from_existing
(data, optional config) → Thermalrate¶ Share data with an existing PySAM class. If
optional config
is a valid configuration name, load the module’s defaults for that configuration.
-
PySAM.Thermalrate.
new
() → Thermalrate¶
-
PySAM.Thermalrate.
wrap
(ssc_data_t) → Thermalrate¶ Load data from a PySSC object.
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap()
Thermalrate is a wrapper for the SSC compute module cmod_thermalrate.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.
- thermal_buy_rate
- thermal_buy_rate_flat
- thermal_buy_rate_option
- thermal_sell_rate
- thermal_sell_rate_flat
- thermal_sell_rate_option
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
-
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 = { 'Thermal Rate': { 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.
-
ThermalRate Group¶
-
class
PySAM.Thermalrate.Thermalrate.
ThermalRate
¶ -
assign
(dict) → None¶ Assign attributes from dictionary, overwriting but not removing values.
ThermalRate_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary.
-
replace
(dict) → None¶ Replace attributes from dictionary, unassigning values not present in input
dict
.ThermalRate_vals = { var: val, ...}
-
en_thermal_rates
¶ Optionally enable/disable thermal_rate [years]
Constraints: INTEGER,MIN=0,MAX=1
Type: float
-
fuelcell_power_thermal
¶ Fuel cell power generated [kW-t]
Required: True
Type: sequence
-
thermal_buy_rate
¶ Thermal buy rate [$/kW-t]
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
The value of
thermal_buy_rate
depends on the following variables:- thermal_buy_rate_flat
- thermal_buy_rate_option
- thermal_sell_rate_flat
- thermal_sell_rate_option
Type: sequence
-
thermal_buy_rate_flat
¶ Thermal buy rate flat [$/kW-t]
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
The value of the following variables depends on
thermal_buy_rate_flat
:- thermal_buy_rate
- thermal_sell_rate
Type: float
-
thermal_buy_rate_option
¶ Thermal buy rate option [0/1]
Options: 0=flat,1=timestep
Constraints: INTEGER,MIN=0,MAX=1
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
The value of the following variables depends on
thermal_buy_rate_option
:- thermal_buy_rate
- thermal_sell_rate
Type: float
-
thermal_degradation
¶ Annual energy degradation [%]
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
Type: sequence
-
thermal_load
¶ Thermal load (year 1) [kW-t]
Type: sequence
-
thermal_load_escalation
¶ Annual load escalation [%/year]
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
Type: sequence
-
thermal_rate_escalation
¶ Annual thermal rate escalation [%/year]
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
Type: sequence
-
thermal_sell_rate
¶ Thermal sell rate [$/kW-t]
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
The value of
thermal_sell_rate
depends on the following variables:- thermal_buy_rate_flat
- thermal_buy_rate_option
- thermal_sell_rate_flat
- thermal_sell_rate_option
Type: sequence
-
thermal_sell_rate_flat
¶ Thermal sell rate flat [$/kW-t]
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
The value of the following variables depends on
thermal_sell_rate_flat
:- thermal_buy_rate
- thermal_sell_rate
Type: float
-
thermal_sell_rate_option
¶ Thermal sell rate option [0/1]
Options: 0=flat,1=timestep
Constraints: INTEGER,MIN=0,MAX=1
Required: False. Automatically set to 0 if not assigned explicitly or loaded from defaults.
The value of the following variables depends on
thermal_sell_rate_option
:- thermal_buy_rate
- thermal_sell_rate
Type: float
-
Lifetime Group¶
-
class
PySAM.Thermalrate.Thermalrate.
Lifetime
¶ -
assign
(dict) → None¶ Assign attributes from dictionary, overwriting but not removing values.
Lifetime_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary.
-
replace
(dict) → None¶ Replace attributes from dictionary, unassigning values not present in input
dict
.Lifetime_vals = { var: val, ...}
-
analysis_period
¶ Number of years in analysis [years]
Constraints: INTEGER,POSITIVE
Required: True
Type: float
-
inflation_rate
¶ Inflation rate [%]
Constraints: MIN=-99
Required: True
Type: float
-
system_use_lifetime_output
¶ Lifetime hourly system outputs [0/1]
Options: 0=hourly first year,1=hourly lifetime
Constraints: INTEGER,MIN=0,MAX=1
Required: True
Type: float
-
Outputs Group¶
-
class
PySAM.Thermalrate.Thermalrate.
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_thermal_value
¶ Thermal value [$]
Type: sequence
-
thermal_cost_with_system_year1
¶ Thermal cost with sytem (year 1) [$]
Type: float
-
thermal_cost_without_system_year1
¶ Thermal cost without system (year 1) [$]
Type: float
-
thermal_load_year1
¶ Thermal load (year 1) [$]
Type: float
-
thermal_revenue_with_system
¶ Thermal revenue with system [$]
Type: sequence
-
thermal_revenue_without_system
¶ Thermal revenue without system [$]
Type: sequence
-
thermal_savings_year1
¶ Thermal savings (year 1) [$]
Type: float
-