TcstroughPhysical¶

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

TcstroughPhysical model description

CSP parabolic trough model based on heat transfer and thermodynamic principles for power generation

PySAM.TcstroughPhysical.default(config) → TcstroughPhysical¶

Use financial model-specific default attributes config options:

“PhysicalTroughAllEquityPartnershipFlip”
“PhysicalTroughCommercial”
“PhysicalTroughIndependentPowerProducer”
“PhysicalTroughLCOECalculator”
“PhysicalTroughLeveragedPartnershipFlip”
“PhysicalTroughNone”
“PhysicalTroughSaleLeaseback”
“PhysicalTroughSingleOwner”

PySAM.TcstroughPhysical.new() → TcstroughPhysical¶

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

Warning

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

Functions¶

class PySAM.TcstroughPhysical.TcstroughPhysical¶

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.TcstroughPhysical.TcstroughPhysical.Weather¶

assign() → None¶

Assign attributes from dictionary

Weather_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary

azimuth¶

float: Azimuth angle of surface/axis [none]

Required: True

file_name¶

str: Local weather file with path [none]

Constraints: LOCAL_FILE

Required: True

tilt¶

float: Tilt angle of surface/axis [none]

Required: True

track_mode¶

float: Tracking mode [none]

Required: True

Trough Group¶

class PySAM.TcstroughPhysical.TcstroughPhysical.Trough¶

assign() → None¶

Assign attributes from dictionary

Trough_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary

system_capacity¶

float: Nameplate capacity [kW]

Required: True

SolarField Group¶

class PySAM.TcstroughPhysical.TcstroughPhysical.SolarField¶

assign() → None¶

Assign attributes from dictionary

SolarField_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary

A_aperture¶

sequence: Reflective aperture area of the collector [m2]

Required: True

AbsorberMaterial¶

sequence[sequence]: Absorber material type [none]

Required: True

AnnulusGas¶

sequence[sequence]: Annulus gas type (1=air, 26=Ar, 27=H2) [none]

Required: True

Ave_Focal_Length¶

sequence: Average focal length of the collector [m]

Required: True

ColperSCA¶

sequence: Number of individual collector sections in an SCA [none]

Required: True

D_2¶

sequence[sequence]: Inner absorber tube diameter [m]

Required: True

D_3¶

sequence[sequence]: Outer absorber tube diameter [m]

Required: True

D_4¶

sequence[sequence]: Inner glass envelope diameter [m]

Required: True

D_5¶

sequence[sequence]: Outer glass envelope diameter [m]

Required: True

D_cpnt¶

sequence[sequence]: Interconnect component diameters, row=intc, col=cpnt [none]

Required: True

D_p¶

sequence[sequence]: Diameter of the absorber flow plug (optional) [m]

Required: True

Design_loss¶

sequence[sequence]: Receiver heat loss at design [W/m]

Required: True

Dirt_HCE¶

sequence[sequence]: Loss due to dirt on the receiver envelope [none]

Required: True

Dirt_mirror¶

sequence: User-defined dirt on mirror derate [none]

Required: True

Distance_SCA¶

sequence: Piping distance between SCA’s in the field [m]

Required: True

EPSILON_4¶

sequence[sequence]: Inner glass envelope emissivities (Pyrex) [none]

Required: True

EPSILON_5¶

sequence[sequence]: Outer glass envelope emissivities (Pyrex) [none]

Required: True

Error¶

sequence: User-defined general optical error derate [none]

Required: True

FieldConfig¶

float: Number of subfield headers [none]

Required: True

Flow_type¶

sequence[sequence]: Flow type through the absorber [none]

Required: True

Fluid¶

float: Field HTF fluid ID number [none]

Required: True

GeomEffects¶

sequence: User-defined geometry effects derate [none]

Required: True

GlazingIntactIn¶

sequence[sequence]: Glazing intact (broken glass) flag {1=true, else=false} [none]

Required: True

HCE_FieldFrac¶

sequence[sequence]: Fraction of the field occupied by this HCE type [none]

Required: True

HDR_rough¶

float: Header pipe roughness [m]

Required: True

IAM_matrix¶

sequence[sequence]: IAM coefficients, matrix for 4 collectors [none]

Required: True

I_bn_des¶

float: Solar irradiation at design [W/m2]

Required: True

K_cpnt¶

sequence[sequence]: Interconnect component minor loss coefficients, row=intc, col=cpnt [none]

Required: True

L_SCA¶

sequence: Length of the SCA [m]

Required: True

L_aperture¶

sequence: Length of a single mirror/HCE unit [m]

Required: True

L_cpnt¶

sequence[sequence]: Interconnect component lengths, row=intc, col=cpnt [none]

Required: True

L_rnr_pb¶

float: Length of runner pipe in power block [m]

Required: True

L_rnr_per_xpan¶

float: Threshold length of straight runner pipe without an expansion loop [m]

Required: True

L_xpan_hdr¶

float: Compined perpendicular lengths of each header expansion loop [m]

Required: True

L_xpan_rnr¶

float: Compined perpendicular lengths of each runner expansion loop [m]

Required: True

Min_rnr_xpans¶

float: Minimum number of expansion loops per single-diameter runner section [none]

Required: True

N_hdr_per_xpan¶

float: Number of collector loops per expansion loop [none]

Required: True

N_max_hdr_diams¶

float: Maximum number of diameters in each of the hot and cold headers [none]

Required: True

P_a¶

sequence[sequence]: Annulus gas pressure [torr]

Required: True

P_ref¶

float: Rated plant capacity [MWe]

Required: True

Pipe_hl_coef¶

float: Loss coefficient from the header, runner pipe, and non-HCE piping [W/m2-K]

Required: True

Rho_mirror_clean¶

sequence: User-defined clean mirror reflectivity [none]

Required: True

Rough¶

sequence[sequence]: Roughness of the internal surface [m]

Required: True

Row_Distance¶

float: Spacing between rows (centerline to centerline) [m]

Required: True

SCADefocusArray¶

sequence: Collector defocus order [none]

Required: True

SCAInfoArray¶

sequence[sequence]: Receiver (,1) and collector (,2) type for each assembly in loop [none]

Required: True

SCA_drives_elec¶

float: Tracking power, in Watts per SCA drive [W/SCA]

Required: True

Shadowing¶

sequence[sequence]: Receiver bellows shadowing loss factor [none]

Required: True

T_fp¶

float: Freeze protection temperature (heat trace activation temperature) [C]

Required: True

T_loop_in_des¶

float: Design loop inlet temperature [C]

Required: True

T_loop_out¶

float: Target loop outlet temperature [C]

Required: True

T_startup¶

float: Required temperature of the system before the power block can be switched on [C]

Required: True

Tau_envelope¶

sequence[sequence]: Envelope transmittance [none]

Required: True

TrackingError¶

sequence: User-defined tracking error derate [none]

Required: True

Type_cpnt¶

sequence[sequence]: Interconnect component type, row=intc, col=cpnt [none]

Required: True

V_hdr_cold_max¶

float: Maximum HTF velocity in the cold headers at design [m/s]

Required: True

V_hdr_cold_min¶

float: Minimum HTF velocity in the cold headers at design [m/s]

Required: True

V_hdr_hot_max¶

float: Maximum HTF velocity in the hot headers at design [m/s]

Required: True

V_hdr_hot_min¶

float: Minimum HTF velocity in the hot headers at design [m/s]

Required: True

W_aperture¶

sequence: The collector aperture width (Total structural area used for shadowing) [m]

Required: True

accept_init¶

float: In acceptance testing mode - require steady-state startup [none]

Required: True

accept_loc¶

float: In acceptance testing mode - temperature sensor location [1/2]

Info: hx/loop

Required: True

accept_mode¶

float: Acceptance testing mode? [0/1]

Info: no/yes

Required: True

alpha_abs¶

sequence[sequence]: Absorber absorptance [none]

Required: True

alpha_env¶

sequence[sequence]: Envelope absorptance [none]

Required: True

calc_design_pipe_vals¶

float: Calculate temps and pressures at design conditions for runners and headers [none]

Required: True

custom_sf_pipe_sizes¶

float: Use custom solar field pipe diams, wallthks, and lengths [none]

Required: True

epsilon_3_11¶

sequence[sequence]: Absorber emittance for receiver type 1 variation 1 [none]

Required: True

epsilon_3_12¶

sequence[sequence]: Absorber emittance for receiver type 1 variation 2 [none]

Required: True

epsilon_3_13¶

sequence[sequence]: Absorber emittance for receiver type 1 variation 3 [none]

Required: True

epsilon_3_14¶

sequence[sequence]: Absorber emittance for receiver type 1 variation 4 [none]

Required: True

epsilon_3_21¶

sequence[sequence]: Absorber emittance for receiver type 2 variation 1 [none]

Required: True

epsilon_3_22¶

sequence[sequence]: Absorber emittance for receiver type 2 variation 2 [none]

Required: True

epsilon_3_23¶

sequence[sequence]: Absorber emittance for receiver type 2 variation 3 [none]

Required: True

epsilon_3_24¶

sequence[sequence]: Absorber emittance for receiver type 2 variation 4 [none]

Required: True

epsilon_3_31¶

sequence[sequence]: Absorber emittance for receiver type 3 variation 1 [none]

Required: True

epsilon_3_32¶

sequence[sequence]: Absorber emittance for receiver type 3 variation 2 [none]

Required: True

epsilon_3_33¶

sequence[sequence]: Absorber emittance for receiver type 3 variation 3 [none]

Required: True

epsilon_3_34¶

sequence[sequence]: Absorber emittance for receiver type 3 variation 4 [none]

Required: True

epsilon_3_41¶

sequence[sequence]: Absorber emittance for receiver type 4 variation 1 [none]

Required: True

epsilon_3_42¶

sequence[sequence]: Absorber emittance for receiver type 4 variation 2 [none]

Required: True

epsilon_3_43¶

sequence[sequence]: Absorber emittance for receiver type 4 variation 3 [none]

Required: True

epsilon_3_44¶

sequence[sequence]: Absorber emittance for receiver type 4 variation 4 [none]

Required: True

eta_pump¶

float: HTF pump efficiency [none]

Required: True

fthrctrl¶

float: Defocusing strategy [none]

Required: True

fthrok¶

float: Flag to allow partial defocusing of the collectors

Constraints: INTEGER

Required: True

m_dot_htfmax¶

float: Maximum loop HTF flow rate [kg/s]

Required: True

m_dot_htfmin¶

float: Minimum loop HTF flow rate [kg/s]

Required: True

mc_bal_cold¶

float: Heat capacity of the balance of plant on the cold side [kWht/K-MWt]

Required: True

mc_bal_hot¶

float: Heat capacity of the balance of plant on the hot side [kWht/K-MWt]

Info: none

Required: True

mc_bal_sca¶

float: Non-HTF heat capacity associated with each SCA - per meter basis [Wht/K-m]

Required: True

nColt¶

float: Number of collector types [none]

Options: constant=4

Required: True

nHCEVar¶

float: Number of HCE variants per type [none]

Required: True

nHCEt¶

float: Number of HCE types [none]

Required: True

nLoops¶

float: Number of loops in the field [none]

Required: True

nSCA¶

float: Number of SCAs in a loop [none]

Required: True

northsouth_field_sep¶

float: North/south separation between subfields. 0 = SCAs are touching [m]

Required: True

offset_xpan_hdr¶

float: Location of first header expansion loop. 1 = after first collector loop [none]

Required: True

sf_hdr_diams¶

sequence: Custom header diameters [m]

Required: True

sf_hdr_lengths¶

sequence: Custom header lengths [m]

Required: True

sf_hdr_wallthicks¶

sequence: Custom header wall thicknesses [m]

Required: True

sf_rnr_diams¶

sequence: Custom runner diameters [m]

Required: True

sf_rnr_lengths¶

sequence: Custom runner lengths [m]

Required: True

sf_rnr_wallthicks¶

sequence: Custom runner wall thicknesses [m]

Required: True

solar_mult¶

float: Solar multiple [none]

Required: True

theta_dep¶

float: Deploy angle [deg]

Required: True

theta_stow¶

float: Stow angle [deg]

Required: True

washing_frequency¶

float: Mirror washing frequency [none]

Required: True

water_usage_per_wash¶

float: Water usage per wash [L/m2_aper]

Required: True

Controller Group¶

class PySAM.TcstroughPhysical.TcstroughPhysical.Controller¶

assign() → None¶

Assign attributes from dictionary

Controller_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary

DP_SGS¶

float: Pressure drop within the steam generator [bar]

Required: True

HDR_rough¶

float: Header pipe roughness - used as general pipe roughness [m]

Required: True

T_set_aux¶

float: Aux heater outlet temp set point [C]

Required: True

T_tank_cold_ini¶

float: Initial cold tank fluid tmeperature [C]

Required: True

T_tank_hot_inlet_min¶

float: Minimum hot tank htf inlet temperature [C]

Required: True

V_tank_hot_ini¶

float: Initial hot tank fluid volume [m3]

Required: True

V_tes_des¶

float: Design-point velocity to size the TES pipe diameters [m/s]

Required: True

W_pb_design¶

float: Rated plant capacity [MWe]

Required: True

aux_array¶

sequence: Coefficients for auxiliary heater parasitics calcs [-]

Required: True

bop_array¶

sequence: Coefficients for balance of plant parasitics calcs [-]

Required: True

cold_tank_Thtr¶

float: Minimum allowable cold tank HTF temp [C]

Required: True

custom_sgs_pipe_sizes¶

float: Use custom SGS pipe diams, wallthks, and lengths [-]

Required: True

custom_tes_p_loss¶

float: TES pipe losses are based on custom lengths and coeffs [-]

Required: True

cycle_cutoff_frac¶

float: Minimum turbine operation fraction before shutdown [-]

Required: True

cycle_max_frac¶

float: Maximum turbine over design operation fraction [-]

Required: True

dt_cold¶

float: Cold side HX approach temp [C]

Required: True

dt_hot¶

float: Hot side HX approach temp [C]

Required: True

eta_pump¶

float: HTF pump efficiency [none]

Required: True

f_tc_cold¶

float: 0=entire tank is hot, 1=entire tank is cold [-]

Required: True

ffrac¶

sequence: Fossil dispatch logic [-]

Required: True

field_fl_props¶

sequence[sequence]: User defined field fluid property data [-]

Required: True

fossil_mode¶

float: Fossil backup mode 1=Normal 2=Topping [-]

Constraints: INTEGER

Required: True

h_tank¶

float: Total height of tank (height of HTF when tank is full [m]

Required: True

h_tank_min¶

float: Minimum allowable HTF height in storage tank [m]

Required: True

has_hot_tank_bypass¶

float: Bypass valve connects field outlet to cold tank [-]

Required: True

hot_tank_Thtr¶

float: Minimum allowable hot tank HTF temp [C]

Required: True

hx_config¶

float: HX configuration [-]

Required: True

is_hx¶

float: Heat exchanger (HX) exists (1=yes, 0=no) [-]

Required: True

k_tes_loss_coeffs¶

sequence: Minor loss coeffs for the coll, gen, and bypass loops [-]

Required: True

nodes¶

float: Nodes modeled in the flow path [-]

Required: True

pb_fixed_par¶

float: Fraction of rated gross power constantly consumed [-]

Required: True

pb_pump_coef¶

float: Pumping power to move 1kg of HTF through PB loop [kW/(kg/s)]

Required: True

q_max_aux¶

float: Max heat rate of auxiliary heater [MWt]

Required: True

q_pb_design¶

float: Design heat input to power block [MWt]

Required: True

sf_type¶

float: Solar field type, 1 = trough, 2 = tower [-]

Required: True

sgs_diams¶

sequence: Custom SGS diameters [m]

Required: True

sgs_lengths¶

sequence: Custom SGS lengths [m]

Required: True

sgs_wallthicks¶

sequence: Custom SGS wall thicknesses [m]

Required: True

store_fl_props¶

sequence[sequence]: User defined storage fluid property data [-]

Required: True

store_fluid¶

float: Material number for storage fluid [-]

Required: True

t_ch_out_max¶

float: Max allowable cold side outlet temp during charge [C]

Required: True

t_dis_out_min¶

float: Min allowable hot side outlet temp during discharge [C]

Required: True

t_standby_reset¶

float: Maximum allowable time for PB standby operation [hr]

Required: True

tank_max_heat¶

float: Rated heater capacity for tank heating [MW]

Required: True

tank_pairs¶

float: Number of equivalent tank pairs [-]

Constraints: INTEGER

Required: True

tanks_in_parallel¶

float: Tanks are in parallel, not in series, with solar field [-]

Required: True

tc_fill¶

float: Thermocline fill material [-]

Required: True

tc_void¶

float: Thermocline void fraction [-]

Required: True

tes_pump_coef¶

float: Pumping power to move 1kg of HTF through tes loop [kW/(kg/s)]

Required: True

tes_type¶

float: 1=2-tank, 2=thermocline [-]

Required: True

tshours¶

float: Equivalent full-load thermal storage hours [hr]

Required: True

tslogic_a¶

sequence: Dispatch logic without solar [-]

Required: True

tslogic_b¶

sequence: Dispatch logic with solar [-]

Required: True

tslogic_c¶

sequence: Dispatch logic for turbine load fraction [-]

Required: True

u_tank¶

float: Loss coefficient from the tank [W/m2-K]

Required: True

vol_tank¶

float: Total tank volume, including unusable HTF at bottom [m3]

Required: True

TouTranslator Group¶

class PySAM.TcstroughPhysical.TcstroughPhysical.TouTranslator¶

assign() → None¶

Assign attributes from dictionary

TouTranslator_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary

weekday_schedule¶

sequence[sequence]: Dispatch 12mx24h schedule for week days

Required: True

weekend_schedule¶

sequence[sequence]: Dispatch 12mx24h schedule for weekends

Required: True

Powerblock Group¶

class PySAM.TcstroughPhysical.TcstroughPhysical.Powerblock¶

assign() → None¶

Assign attributes from dictionary

Powerblock_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary

CT¶

float: Flag for using dry cooling or wet cooling system [none]

Required: set to 0 if not provided.

F_wc¶

sequence: Fraction indicating wet cooling use for hybrid system [none]

Options: constant=[0,0,0,0,0,0,0,0,0]

Required: set to 0 if not provided.

P_boil¶

float: Boiler operating pressure [bar]

Required: set to 0 if not provided.

P_cond_min¶

float: Minimum condenser pressure [inHg]

Required: set to 0 if not provided.

P_cond_ratio¶

float: Condenser pressure ratio [none]

Required: set to 0 if not provided.

T_ITD_des¶

float: ITD at design for dry system [C]

Required: set to 0 if not provided.

T_amb_des¶

float: Reference ambient temperature at design point [C]

Required: set to 0 if not provided.

T_approach¶

float: Cooling tower approach temperature [C]

Required: set to 0 if not provided.

dT_cw_ref¶

float: Reference condenser cooling water inlet/outlet T diff [C]

Required: set to 0 if not provided.

eta_ref¶

float: Reference conversion efficiency at design condition [none]

Required: True

n_pl_inc¶

float: Number of part-load increments for the heat rejection system [none]

Required: set to 0 if not provided.

pb_bd_frac¶

float: Power block blowdown steam fraction [none]

Required: set to 0 if not provided.

pc_config¶

float: 0: Steam Rankine (224), 1: user defined [-]

Constraints: INTEGER

Required: set to 0 if not provided.

q_sby_frac¶

float: Fraction of thermal power required for standby mode [none]

Required: True

startup_frac¶

float: Fraction of design thermal power needed for startup [none]

Required: True

startup_time¶

float: Time needed for power block startup [hr]

Required: True

tech_type¶

float: Turbine inlet pressure control flag (sliding=user, fixed=trough) [1/2/3]

Info: tower/trough/user

Required: set to 0 if not provided.

UserDefinedPC Group¶

class PySAM.TcstroughPhysical.TcstroughPhysical.UserDefinedPC¶

assign() → None¶

Assign attributes from dictionary

UserDefinedPC_vals = { var: val, ...}

export() → dict¶: Export attributes into dictionary

ud_T_amb_des¶

float: Ambient temperature at user-defined power cycle design point [C]