TcsgenericSolar¶

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

TcsgenericSolar model description

CSP power system model with solar field characterized using a table of optical efficiency values

PySAM.TcsgenericSolar.default(config) → TcsgenericSolar¶

Use financial model-specific default attributes config options:

“GenericCSPSystemAllEquityPartnershipFlip”
“GenericCSPSystemCommercial”
“GenericCSPSystemCommercialPPA”
“GenericCSPSystemIndependentPowerProducer”
“GenericCSPSystemLCOECalculator”
“GenericCSPSystemLeveragedPartnershipFlip”
“GenericCSPSystemNone”
“GenericCSPSystemSaleLeaseback”
“GenericCSPSystemSingleOwner”

PySAM.TcsgenericSolar.new() → TcsgenericSolar¶

PySAM.TcsgenericSolar.wrap(ssc_data_t) → TcsgenericSolar¶: Use existing PySSC data

Warning

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

Functions¶

class PySAM.TcsgenericSolar.TcsgenericSolar¶

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

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

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

Weather Group¶

class PySAM.TcsgenericSolar.TcsgenericSolar.Weather¶

assign() → None¶

Assign attributes from dictionary

Weather_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary

azimuth¶

float: Azimuth angle of surface/axis

Required: True

file_name¶

str: local weather file path

Constraints: LOCAL_FILE

Required: True

tilt¶

float: Tilt angle of surface/axis

Required: True

track_mode¶

float: Tracking mode

Required: True

GenericSolar Group¶

class PySAM.TcsgenericSolar.TcsgenericSolar.GenericSolar¶

assign() → None¶

Assign attributes from dictionary

GenericSolar_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary

system_capacity¶

float: Nameplate capacity [kW]

Required: True

TouTranslator Group¶

class PySAM.TcsgenericSolar.TcsgenericSolar.TouTranslator¶

assign() → None¶

Assign attributes from dictionary

TouTranslator_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary

weekday_schedule¶

sequence[sequence]: 12x24 Time of Use Values for week days

Required: True

weekend_schedule¶

sequence[sequence]: 12x24 Time of Use Values for week end days

Required: True

Type260 Group¶

class PySAM.TcsgenericSolar.TcsgenericSolar.Type260¶

assign() → None¶

Assign attributes from dictionary

Type260_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary

OpticalTable¶

sequence[sequence]: Optical table [none]

Required: True

PC_T_corr¶

float: Power conversion temperature correction mode (1=wetb, 2=dryb) [none]

Constraints: INTEGER

Required: True

T_pcdes¶

float: Power conversion reference temperature [C]

Required: True

T_sfdes¶

float: Solar field design point temperature (dry bulb) [C]

Required: True

Wpar_prodD_coefs¶

sequence: DNI-based production parasitic adjustment coefs. [m2/W]

Required: True

Wpar_prodQ_coefs¶

sequence: Part-load production parasitic adjustment coefs. [1/MWe]

Required: True

Wpar_prodT_coefs¶

sequence: Temp.-based production parasitic adjustment coefs. [1/C]

Required: True

diswos¶

sequence: Time-of-dispatch control for without-solar conditions [none]

Required: True

disws¶

sequence: Time-of-dispatch control for with-solar conditions [none]

Required: True

etaQ_coefs¶

sequence: Part-load power conversion efficiency adjustment coefficients [1/MWt]

Required: True

etaT_coefs¶

sequence: Temp.-based power conversion efficiency adjustment coefs. [1/C]

Required: True

eta_des¶

float: Design power cycle gross efficiency [none]

Required: True

eta_lhv¶

float: Fossil backup lower heating value efficiency [none]

Required: True

eta_opt_gen¶

float: General/other optical derate [none]

Required: True

eta_opt_soil¶

float: Soiling optical derate factor [none]

Required: True

exergy_table¶

sequence[sequence]: Exergy table [none]

Required: True

f_Wpar_fixed¶

float: Fixed capacity-based parasitic loss fraction [MWe/MWcap]

Required: True

f_Wpar_prod¶

float: Production-based parasitic loss fraction [MWe/MWe]

Required: True

f_charge¶

float: Storage charging energy derate [none]

Required: True

f_disch¶

float: Storage discharging energy derate [none]

Required: True

f_etes_0¶

float: Initial fractional charge level of thermal storage (0..1) [none]

Required: True

f_sfhl_ref¶

float: Reference solar field thermal loss fraction [MW/MWcap]

Required: True

f_startup¶

float: Equivalent full-load hours required for power system startup [hours]

Required: True

f_teshl_ref¶

float: Reference heat loss from storage per max stored capacity [kWt/MWhr-stored]

Required: True

f_wmax¶

float: Maximum over-design power cycle operation fraction [none]

Required: True

f_wmin¶

float: Minimum part-load power cycle operation fraction [none]

Required: True

fdisp¶

sequence: Fossil backup output control factors [none]

Required: True

hrs_tes¶

float: Equivalent full-load hours of storage [hours]

Required: True

ibh¶

float: Beam-horizontal irradiation [kJ/hr-m^2]

Required: True

ibn¶

float: Beam-normal (DNI) irradiation [kJ/hr-m^2]

Required: True

interp_arr¶

float: Interpolate the array or find nearest neighbor? (1=interp,2=no) [none]

Constraints: INTEGER

Required: True

irr_des¶

float: Irradiation design point [W/m2]

Required: True

istableunsorted¶

float: Is optical table unsorted format? [none]

Required: True

itoth¶

float: Total horizontal irradiation [kJ/hr-m^2]

Required: True

latitude¶

float: Site latitude

Required: True

longitude¶

float: Site longitude

Required: True

ntod¶

float: Number of time-of-dispatch periods in the dispatch schedule [none]

Required: True

qdisp¶

sequence: TOD power output control factors [none]

Required: True

qsf_des¶

float: Solar field thermal production at design [MWt]

Required: True

rad_type¶

float: Solar resource radiation type (1=DNI,2=horiz.beam,3=tot.horiz) [none]

Constraints: INTEGER

Required: True

sfhlQ_coefs¶

sequence: Irr-based solar field thermal loss adjustment coefficients [1/MWt]

Required: True

sfhlT_coefs¶

sequence: Temp.-based solar field thermal loss adjustment coefficients [1/C]

Required: True

sfhlV_coefs¶

sequence: Wind-based solar field thermal loss adjustment coefficients [1/(m/s)]

Required: True

solarm¶

float: Solar multiple [none]

Required: True

storage_config¶

float: Thermal storage configuration [none]

Required: True

tdb¶

float: Ambient dry-bulb temperature [C]

Required: True

teshlT_coefs¶

sequence: Temp.-based thermal loss adjustment - constant coef. [1/C]

Required: True

teshlX_coefs¶

sequence: Charge-based thermal loss adjustment - constant coef. [1/MWhr-stored]

Required: True

theta_dep¶

float: Solar elevation angle at which the solar field begins operating [deg]

Required: True

theta_stow¶

float: Solar elevation angle at which the solar field stops operating [deg]

Required: True

timezone¶

float: Site timezone [hr]

Required: True

twb¶

float: Ambient wet-bulb temperature [C]

Required: True

vwind¶

float: Wind velocity [m/s]

Required: True

w_des¶

float: Design power cycle gross output [MWe]

Required: True

AdjustmentFactors Group¶

class PySAM.TcsgenericSolar.TcsgenericSolar.AdjustmentFactors¶

assign() → None¶: Assign attributes from dictionary

export() → Dict¶: Export attributes into dictionary

constant¶: type: float

dc_constant¶: DC Constant loss adjustment [%]

dc_hourly¶: DC Hourly Adjustment Factors [%]

dc_periods¶: DC Period-based Adjustment Factors [%]

hourly¶: AC Hourly Adjustment Factors [%]

periods¶: AC Period-based Adjustment Factors [%]

sf_constant¶: DC Constant loss adjustment [%]

sf_hourly¶: DC Hourly Adjustment Factors [%]

sf_periods¶: DC Period-based Adjustment Factors [%]

Outputs Group¶

class PySAM.TcsgenericSolar.TcsgenericSolar.Outputs¶

assign() → None¶

Assign attributes from dictionary

Outputs_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary

annual_energy¶: float: Annual Energy [kWh]

annual_fuel_usage¶: float: Annual fuel usage [kWh]

annual_q_dump_tot¶: float: Total dumped energy [MWht]

annual_q_fossil¶: float: Thermal energy supplied from aux firing [MWht]

annual_q_from_tes¶: float: Thermal energy from storage [MWht]

annual_q_hl_sf¶: float: Solar field thermal losses [MWht]

annual_q_hl_tes¶: float: Thermal losses from storage [MWht]

annual_q_sf¶: float: Solar field delivered thermal power [MWht]

annual_q_startup¶: float: Power conversion startup energy [MWht]

annual_q_to_pb¶: float: Thermal energy to the power conversion system [MWht]

annual_q_to_tes¶: float: Thermal energy into storage [MWht]

annual_w_gr¶: float: Total gross power production [kWh]

beam¶: sequence: Resource Beam normal irradiance [W/m2]

capacity_factor¶: float: Capacity factor [%]

conversion_factor¶: float: Gross to Net Conversion Factor [%]

diff¶: sequence: Resource Diffuse horizontal irradiance [W/m2]

e_in_tes¶: sequence: TES thermal energy available [MWht]

enet¶: sequence: Cycle electrical power output (net) [MWe]

eta_cycle¶: sequence: Cycle efficiency (gross)

eta_opt_sf¶: sequence: Field collector optical efficiency [none]

f_effpc_qtpb¶: sequence: Cycle efficiency load-based correction

f_effpc_tamb¶: sequence: Cycle efficiency temperature-based correction

f_sfhl_qdni¶: sequence: Field thermal power load-based loss correction [none]

f_sfhl_tamb¶: sequence: Field thermal power temp.-based loss correction [none]

f_sfhl_vwind¶: sequence: Field thermal power wind-based loss correction [none]

gen¶: sequence: System power generated [kW]

global¶: sequence: Resource Global horizontal irradiance [W/m2]

hour¶: sequence: Resource Hour of Day

kwh_per_kw¶: float: First year kWh/kW [kWh/kW]

month¶: sequence: Resource Month

monthly_energy¶: sequence: Monthly Energy [kWh]

monthly_q_dump_tot¶: sequence: Total dumped energy [MWt]

monthly_q_fossil¶: sequence: Thermal energy supplied from aux firing [MWt]

monthly_q_from_tes¶: sequence: Thermal energy from storage [MWt]

monthly_q_hl_sf¶: sequence: Solar field thermal losses [MWt]

monthly_q_hl_tes¶: sequence: Thermal losses from storage [MWt]

monthly_q_sf¶: sequence: Solar field delivered thermal power [MWt]

monthly_q_startup¶: sequence: Power conversion startup energy [MWt]

monthly_q_to_pb¶: sequence: Thermal energy to the power conversion system [MWt]

monthly_q_to_tes¶: sequence: Thermal energy into storage [MWt]

monthly_w_gr¶: sequence: Total gross power production [kWh]

pres¶: sequence: Resource Pressure [mbar]

q_dump_teschg¶: sequence: Cycle thermal energy dumped - solar field [MWt]

q_dump_tesfull¶: sequence: Cycle thermal energy dumped - TES is full [MWt]

q_dump_tot¶: sequence: Cycle thermal energy dumped total [MWt]

q_dump_umin¶: sequence: Cycle thermal energy dumped - min. load requirement [MWt]

q_fossil¶: sequence: Fossil thermal power produced [MWt]

q_from_tes¶: sequence: TES thermal energy from storage [MWt]

q_gas¶: sequence: Fossil fuel used [MWt]

q_hl_sf¶: sequence: Field thermal power loss total [MWt]

q_hl_tes¶: sequence: TES thermal losses from tank(s) [MWt]

q_inc¶: sequence: Field thermal power incident [MWt]

q_sf¶: sequence: Field thermal power total produced [MWt]

q_startup¶: sequence: Cycle thermal startup energy [MWt]

q_to_pb¶: sequence: Cycle thermal power input [MWt]

q_to_tes¶: sequence: TES thermal energy into storage [MWt]

solazi¶: sequence: Resource Solar Azimuth [deg]

solzen¶: sequence: Resource Solar Zenith [deg]

system_heat_rate¶: float: System heat rate [MMBtu/MWh]

tdry¶: sequence: Resource Dry bulb temperature [C]

twet¶: sequence: Resource Wet bulb temperature [C]

w_gr¶: sequence: Cycle electrical power output (gross) [MWe]

w_gr_fossil¶: sequence: Cycle electrical power output (gross, fossil share) [MWe]

w_gr_solar¶: sequence: Cycle electrical power output (gross, solar share) [MWe]

w_par_fixed¶: sequence: Fixed parasitic losses [MWh]

w_par_offline¶: sequence: Offline parasitics [MWh]

w_par_online¶: sequence: Online parasitics [MWh]

w_par_prod¶: sequence: Production-based parasitic losses [MWh]

w_par_tot¶: sequence: Total parasitic losses [MWh]

wspd¶: sequence: Resource Wind Speed [m/s]

Table of Contents

This Page

TcsgenericSolar¶

Creating an Instance¶

Functions¶

Weather Group¶

GenericSolar Group¶

TouTranslator Group¶

Type260 Group¶

AdjustmentFactors Group¶

Outputs Group¶