ThermalrateIph

ThermalrateIph

PySAM.ThermalrateIph.default(config) → ThermalrateIph

Load defaults for the configuration config. Available configurations are:

• “MSLFIPHCommercial”

• “PhysicalTroughIPHCommercial”

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.ThermalrateIph.from_existing(data, optional config) → ThermalrateIph

Share data with an existing PySAM class. If optional config is a valid configuration name, load the module’s defaults for that configuration.

PySAM.ThermalrateIph.new() → ThermalrateIph

PySAM.ThermalrateIph.wrap(ssc_data_t) → ThermalrateIph

Load data from a PySSC object.

Warning

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

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

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

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 = { 'Thermal Rate': { 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.

ThermalRate Group

class PySAM.ThermalrateIph.ThermalrateIph.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

gen_heat

Thermal power generated [kWt]

Required: True

Type:

sequence

thermal_buy_rate_flat_heat_btu

Thermal buy rate flat [$/MMBtu]

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

Type:

float

thermal_buy_rate_option

Thermal buy rate option [0-2]

Options: 0=flat,1=timestep,2=monthly

Constraints: INTEGER,MIN=0,MAX=2

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

Type:

float

thermal_conversion_efficiency

Heat conversion efficiency (buy) [%]

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

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_escalation

Annual load escalation [%/year]

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

Type:

sequence

thermal_load_heat_btu

Thermal load (year 1) [MMBtu/hr]

INOUT: This variable is both an input and an output to the compute module.

Type:

sequence

thermal_monthly_buy_rate_heat_btu

Monthly thermal buy rate [$/MMBtu]

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

Type:

sequence

thermal_monthly_sell_rate_heat_btu

Thermal sell rate monthly [$/MMBtu]

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_flat_heat_btu

Thermal sell rate flat [$/MMBtu]

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

Type:

float

thermal_sell_rate_option

Thermal sell rate option [0-2]

Options: 0=flat,1=timestep,2=monthly

Constraints: INTEGER,MIN=0,MAX=2

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

Type:

float

thermal_timestep_buy_rate_heat_btu

Thermal buy rate [$/MMBtu]

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

Type:

sequence

thermal_timestep_sell_rate_heat_btu

Thermal sell rate timestep [$/MMBtu]

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

Type:

sequence

Lifetime Group

class PySAM.ThermalrateIph.ThermalrateIph.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.ThermalrateIph.ThermalrateIph.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

Thermal cost with system [$]

Type:

sequence

thermal_cost_with_system_year1

Thermal cost with sytem (year 1) [$]

Type:

float

thermal_cost_without_system

Thermal cost without system [$]

Type:

sequence

thermal_cost_without_system_year1

Thermal cost without system (year 1) [$]

Type:

float

thermal_load_year1

Thermal load total [MMBtu/hr]

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

year1_monthly_load_heat

Thermal load [kWht/mo]

Type:

sequence