TcslinearFresnel¶
Wrapper for SAM Simulation Core model: cmod_tcslinear_fresnel.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.
TcslinearFresnel model description
Process heat linear direct steam
-
PySAM.TcslinearFresnel.
default
(config) → TcslinearFresnel¶ Use financial model-specific default attributes config options:
- “DSLFAllEquityPartnershipFlip”
- “DSLFCommercial”
- “DSLFLCOECalculator”
- “DSLFLeveragedPartnershipFlip”
- “DSLFNone”
- “DSLFSaleLeaseback”
- “DSLFSingleOwner”
-
PySAM.TcslinearFresnel.
new
() → TcslinearFresnel¶
-
PySAM.TcslinearFresnel.
wrap
(ssc_data_t) → TcslinearFresnel¶ Use existing PySSC data
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap
Functions¶
-
class
PySAM.TcslinearFresnel.
TcslinearFresnel
¶ 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.TcslinearFresnel.TcslinearFresnel.
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
-
LinearFresnelr Group¶
TouTranslator Group¶
-
class
PySAM.TcslinearFresnel.TcslinearFresnel.
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
-
Solarfield Group¶
-
class
PySAM.TcslinearFresnel.TcslinearFresnel.
Solarfield
¶ -
assign
() → None¶ Assign attributes from dictionary
Solarfield_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
A_aperture
¶ sequence[sequence]: (boiler, SH) Reflective aperture area of the collector module [m^2]
Required: True
-
AbsorberMaterial
¶ sequence[sequence]: (boiler, SH) Absorber material type [none]
Required: True
-
AnnulusGas
¶ sequence[sequence]: (boiler, SH) Annulus gas type {1=air; 26=Ar; 27=H2} (4: # field fracs) [none]
Required: True
-
ColAz
¶ float: Collector azimuth angle [deg]
Required: True
-
D_2
¶ sequence[sequence]: (boiler, SH) The inner absorber tube diameter [m]
Required: True
-
D_3
¶ sequence[sequence]: (boiler, SH) The outer absorber tube diameter [m]
Required: True
-
D_4
¶ sequence[sequence]: (boiler, SH) The inner glass envelope diameter [m]
Required: True
-
D_5
¶ sequence[sequence]: (boiler, SH) The outer glass envelope diameter [m]
Required: True
-
D_p
¶ sequence[sequence]: (boiler, SH) The diameter of the absorber flow plug (optional) [m]
Required: True
-
Design_loss
¶ sequence[sequence]: (boiler, SH) Receiver heat loss at design (4: # field fracs) [W/m]
Required: True
-
Dirt_HCE
¶ sequence[sequence]: (boiler, SH) Loss due to dirt on the receiver envelope (4: # field fracs) [none]
Required: True
-
EPSILON_4
¶ sequence[sequence]: (boiler, SH) Inner glass envelope emissivities (Pyrex) (4: # field fracs) [none]
Required: True
-
Flow_type
¶ sequence[sequence]: (boiler, SH) The flow type through the absorber [none]
Required: True
-
GeomEffects
¶ sequence[sequence]: (boiler, SH) User-defined geometry effects derate [none]
Required: True
-
GlazingIntactIn
¶ sequence[sequence]: (boiler, SH) The glazing intact flag {true=0; false=1} (4: # field fracs) [none]
Required: True
-
HCE_FieldFrac
¶ sequence[sequence]: (boiler, SH) The fraction of the field occupied by this HCE type (4: # field fracs) [none]
Required: True
-
HLCharType
¶ sequence[sequence]: (boiler, SH) Flag indicating the heat loss model type {1=poly.; 2=Forristall} [none]
Required: True
-
HL_W
¶ sequence[sequence]: (boiler, SH) Heat loss coef adj wind velocity (0,1,2,3,4 order terms) [1/(m/s)^order]
Required: True
-
HL_dT
¶ sequence[sequence]: (boiler, SH) Heat loss coefficient - HTF temperature (0,1,2,3,4 order terms) [W/m-K^order]
Required: True
-
IAM_L
¶ sequence[sequence]: (boiler, SH) Longitudinal Incident angle modifiers (0,1,2,3,4 order terms) [none]
Required: True
-
IAM_T
¶ sequence[sequence]: (boiler, SH) Transverse Incident angle modifiers (0,1,2,3,4 order terms) [none]
Required: True
-
I_bn
¶ float: Beam normal radiation (input kJ/m2-hr) [W/m2]
Required: True
-
I_bn_des
¶ float: Design point irradiation value [W/m2]
Required: True
-
LHV_eff
¶ float: Fuel LHV efficiency (0..1) [none]
Required: True
-
L_col
¶ sequence[sequence]: (boiler, SH) Active length of the superheater section collector module [m]
Required: True
-
OptCharType
¶ sequence[sequence]: (boiler, SH) The optical characterization method [none]
Required: True
-
PB_fixed_par
¶ float: fraction of rated gross power consumed at all hours of the year [none]
Required: True
-
PB_pump_coef
¶ float: Pumping power required to move 1kg of HTF through power block flow [kW/kg]
Required: True
-
P_a
¶ sequence[sequence]: (boiler, SH) Annulus gas pressure (4: # field fracs) [torr]
Required: True
-
P_amb
¶ float: Ambient pressure [atm]
Required: True
-
P_turb_des
¶ float: Design-point turbine inlet pressure [bar]
Required: True
-
Pipe_hl_coef
¶ float: Loss coefficient from the header.. runner pipe.. and non-HCE pipin [W/m2-K]
Required: True
-
Rough
¶ sequence[sequence]: (boiler, SH) Roughness of the internal surface [m]
Required: True
-
SCA_drives_elec
¶ float: Tracking power.. in Watts per SCA drive [W/m2]
Required: True
-
Shadowing
¶ sequence[sequence]: (boiler, SH) Receiver bellows shadowing loss factor (4: # field fracs) [none]
Required: True
-
SolarAz_init
¶ float: Solar azimuth angle [deg]
Required: True
-
SolarZen
¶ float: Solar zenith angle [deg]
Required: True
-
T_amb_des_sf
¶ float: Design-point ambient temperature [C]
Required: True
-
T_db
¶ float: Dry bulb air temperature [C]
Required: True
-
T_dp
¶ float: The dewpoint temperature [C]
Required: True
-
T_fp
¶ float: Freeze protection temperature (heat trace activation temperature) [C]
Required: True
-
T_pb_out_init
¶ float: Fluid temperature from the power block [C]
Required: True
-
Tau_envelope
¶ sequence[sequence]: (boiler, SH) Envelope transmittance (4: # field fracs) [none]
Required: True
-
TrackingError
¶ sequence[sequence]: (boiler, SH) User-defined tracking error derate [none]
Required: True
-
V_wind
¶ float: Ambient windspeed [m/s]
Required: True
-
V_wind_max
¶ float: Maximum allowable wind velocity before safety stow [m/s]
Required: True
-
alpha_abs
¶ sequence[sequence]: (boiler, SH) Absorber absorptance (4: # field fracs) [none]
Required: True
-
alpha_env
¶ sequence[sequence]: (boiler, SH) Envelope absorptance (4: # field fracs) [none]
Required: True
-
aux_array
¶ sequence: Aux_parVal, Aux_parPF, Aux_par0, Aux_par1, Aux_par2 [-]
Required: True
-
b_OpticalTable
¶ sequence[sequence]: Values of the optical efficiency table [none]
Required: True
-
b_eps_HCE1
¶ sequence[sequence]: (temperature) Absorber emittance (eps) [none]
Required: True
-
b_eps_HCE2
¶ sequence[sequence]: (temperature) Absorber emittance (eps) [none]
Required: True
-
b_eps_HCE3
¶ sequence[sequence]: (temperature) Absorber emittance (eps) [none]
Required: True
-
b_eps_HCE4
¶ sequence[sequence]: (temperature) Absorber emittance (eps) [none]
Required: True
-
bop_array
¶ sequence: BOP_parVal, BOP_parPF, BOP_par0, BOP_par1, BOP_par2 [-]
Required: True
-
cycle_cutoff_frac
¶ float: Minimum turbine operation fraction before shutdown [none]
Required: True
-
cycle_max_fraction
¶ float: Maximum turbine over design operation fraction [none]
Required: True
-
dirt_mirror
¶ sequence[sequence]: (boiler, SH) User-defined dirt on mirror derate [none]
Required: True
-
dnifc
¶ float: Forecast DNI [W/m2]
Required: True
-
e_startup
¶ float: Thermal inertia contribution per sq meter of solar field [kJ/K-m2]
Required: True
-
error
¶ sequence[sequence]: (boiler, SH) User-defined general optical error derate [none]
Required: True
-
eta_pump
¶ float: Feedwater pump efficiency [none]
Required: True
-
fP_boil_to_sh
¶ float: Design-point pressure drop between the boiler and superheater frac [none]
Required: True
-
fP_hdr_c
¶ float: Average design-point cold header pressure drop fraction [none]
Required: True
-
fP_hdr_h
¶ float: Average design-point hot header pressure drop fraction [none]
Required: True
-
fP_sf_boil
¶ float: Design-point pressure drop across the solar field boiler fraction [none]
Required: True
-
fP_sf_sh
¶ float: Design-point pressure drop across the solar field superheater frac [none]
Required: True
-
ffrac
¶ sequence: Fossil dispatch logic - TOU periods [none]
Required: True
-
fossil_mode
¶ float: Operation mode for the fossil backup {1=Normal,2=supp,3=toppin} [none]
Constraints: INTEGER
Required: True
-
is_multgeom
¶ float: Does the superheater have a different geometry from the boiler {1=yes} [none]
Constraints: INTEGER
Required: True
-
is_oncethru
¶ float: Flag indicating whether flow is once through with superheat [none]
Constraints: INTEGER
Required: True
-
is_sh
¶ float: Does the solar field include a superheating section [none]
Constraints: INTEGER
Required: True
-
latitude
¶ float: Site latitude resource page [deg]
Required: True
-
m_dot_htf_ref
¶ float: Reference HTF flow rate at design conditions [kg/hr]
Required: True
-
m_dot_min
¶ float: Minimum loop flow rate [kg/s]
Required: True
-
m_pb_demand
¶ float: Demand htf flow from the power block [kg/hr]
Required: True
-
nLoops
¶ float: Number of loops [none]
Required: True
-
nModBoil
¶ float: Number of modules in the boiler section [none]
Constraints: INTEGER
Required: True
-
nModSH
¶ float: Number of modules in the superheater section [none]
Constraints: INTEGER
Required: True
-
q_max_aux
¶ float: Maximum heat rate of the auxiliary heater [MW]
Required: True
-
q_pb_des
¶ float: Design heat input to the power block [MW]
Required: True
-
q_sby_frac
¶ float: Fraction of thermal power required for standby [none]
Required: True
-
rho_mirror_clean
¶ sequence[sequence]: (boiler, SH) User-defined clean mirror reflectivity [none]
Required: True
-
sh_OpticalTable
¶ sequence[sequence]: Values of the optical efficiency table [none]
Required: True
-
sh_eps_HCE1
¶ sequence[sequence]: (temperature) Absorber emittance (eps) [none]
Required: True
-
sh_eps_HCE2
¶ sequence[sequence]: (temperature) Absorber emittance (eps) [none]
Required: True
-
sh_eps_HCE3
¶ sequence[sequence]: (temperature) Absorber emittance (eps) [none]
Required: True
-
sh_eps_HCE4
¶ sequence[sequence]: (temperature) Absorber emittance (eps) [none]
Required: True
-
shift
¶ float: Shift in longitude from local standard meridian [deg]
Required: True
-
solarm
¶ float: Solar multiple [none]
Required: True
-
t_sby
¶ float: Low resource standby period [hr]
Required: True
-
tes_hours
¶ float: Equivalent full-load thermal storage hours [hr]
Required: True
-
theta_dep
¶ float: deploy angle [deg]
Required: True
-
theta_stow
¶ float: stow angle [deg]
Required: True
-
x_b_des
¶ float: Design point boiler outlet steam quality [none]
Required: True
-
Heliostat Group¶
-
class
PySAM.TcslinearFresnel.TcslinearFresnel.
Heliostat
¶ -
assign
() → None¶ Assign attributes from dictionary
Heliostat_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
csp_lf_sf_washes_per_year
¶ float: Mirror washing frequency
Required: True
-
csp_lf_sf_water_per_wash
¶ float: Water usage per wash [L/m2_aper]
Required: True
-
Powerblock Group¶
-
class
PySAM.TcslinearFresnel.TcslinearFresnel.
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]
Constraints: INTEGER
Required: True
-
F_wc
¶ sequence: Fraction indicating wet cooling use for hybrid system [none]
Required: True
-
P_amb_pwb
¶ float: Ambient pressure [atm]
Required: True
-
P_boil_des
¶ float: Boiler operating pressure @ design [bar]
Required: True
-
P_cond_min
¶ float: Minimum condenser pressure [inHg]
Required: True
-
P_cond_ratio
¶ float: Condenser pressure ratio [none]
Required: True
-
P_rh_ref
¶ float: Reheater operating pressure at design [bar]
Required: True
-
T_ITD_des
¶ float: ITD at design for dry system [C]
Required: True
-
T_amb_des
¶ float: Reference ambient temperature at design point [C]
Required: True
-
T_approach
¶ float: Cooling tower approach temperature [C]
Required: True
-
T_cold_ref
¶ float: Reference HTF outlet temperature at design [C]
Required: True
-
T_db_pwb
¶ float: Ambient dry bulb temperature [C]
Required: True
-
T_hot
¶ float: Hot HTF inlet temperature, from storage tank [C]
Required: True
-
T_wb
¶ float: Ambient wet bulb temperature [C]
Required: True
-
dT_cw_ref
¶ float: Reference condenser cooling water inlet/outlet T diff [C]
Required: True
-
demand_var
¶ float: Control signal indicating operational mode [none]
Required: True
-
dp_b
¶ float: Pressure drop in boiler [Pa]
Required: True
-
dp_rh
¶ float: Pressure drop in reheater [Pa]
Required: True
-
dp_sh
¶ float: Pressure drop in superheater [Pa]
Required: True
-
eta_ref
¶ float: Reference conversion efficiency at design condition [none]
Required: True
-
f_recSU
¶ float: Fraction powerblock can run due to receiver startup [none]
Required: True
-
m_dot_st
¶ float: HTF mass flow rate [kg/hr]
Required: True
-
n_pl_inc
¶ float: Number of part-load increments for the heat rejection system [none]
Constraints: INTEGER
Required: True
-
pb_bd_frac
¶ float: Power block blowdown steam fraction [none]
Required: True
-
pc_mode
¶ float: Cycle part load control, from plant controller [none]
Required: True
-
q_sby_frac
¶ float: Fraction of thermal power required for standby mode [none]
Required: True
-
relhum
¶ float: Relative humidity of the ambient air [none]
Required: True
-
rh_frac_ref
¶ float: Reheater flow fraction at design [none]
Required: True
-
standby_control
¶ float: Control signal indicating 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
-
AdjustmentFactors Group¶
-
class
PySAM.TcslinearFresnel.TcslinearFresnel.
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.TcslinearFresnel.TcslinearFresnel.
Outputs
¶ -
assign
() → None¶ Assign attributes from dictionary
Outputs_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
E_bal_startup
¶ sequence: Cycle thermal energy startup [MWt]
-
P_cond
¶ sequence: Condenser pressure [Pa]
-
P_sf_in
¶ sequence: Field steam pressure at inlet [bar]
-
P_turb_in
¶ sequence: Cycle steam pressure at inlet [bar]
-
T_field_in
¶ sequence: Field steam temperature at header inlet [C]
-
T_field_out
¶ sequence: Field steam temperature at header outlet [C]
-
T_loop_out
¶ sequence: Field steam temperature at collector outlet [C]
-
T_pb_in
¶ sequence: Cycle steam temperature at inlet [C]
-
T_pb_out
¶ sequence: Cycle steam temperature at outlet [C]
-
W_cool_par
¶ sequence: Parasitic power condenser operation [MWe]
-
W_cycle_gross
¶ sequence: Cycle electrical power output (gross) [MWe]
-
W_dot_aux
¶ sequence: Parasitic power auxiliary heater operation [MWe]
-
W_dot_bop
¶ sequence: Parasitic power generation-dependent load [MWe]
-
W_dot_col
¶ sequence: Parasitic power field collector drives [MWe]
-
W_dot_fixed
¶ sequence: Parasitic power fixed load [MWe]
-
W_dot_pump
¶ sequence: Parasitic power solar field pump [MWe]
-
W_net
¶ sequence: Cycle electrical power output (net) [MWe]
-
annual_W_cycle_gross
¶ float: Electrical source - Power cycle gross output [kWh]
-
annual_energy
¶ float: Annual Energy [kWh]
-
annual_fuel_usage
¶ float: Annual fuel usage [kWh]
-
annual_total_water_use
¶ float: Total Annual Water Usage: cycle + mirror washing [m3]
-
beam
¶ sequence: Resource Beam normal irradiance [W/m2]
-
capacity_factor
¶ float: Capacity factor [%]
-
conversion_factor
¶ float: Gross to Net Conversion Factor [%]
-
dP_tot
¶ sequence: Field steam pressure loss [bar]
-
defocus
¶ sequence: Field collector focus fraction
-
eta
¶ sequence: Cycle efficiency (gross)
-
eta_opt_ave
¶ sequence: Field collector optical efficiency
-
eta_sf
¶ sequence: Field efficiency total
-
eta_thermal
¶ sequence: Field thermal efficiency
-
f_bays
¶ sequence: Condenser fraction of operating bays [none]
-
gen
¶ sequence: System power generated [kW]
-
hour
¶ sequence: Resource Hour of Day
-
kwh_per_kw
¶ float: First year kWh/kW [kWh/kW]
-
m_dot
¶ sequence: Field steam mass flow rate - loop [kg/s]
-
m_dot_aux
¶ sequence: Fossil steam mass flow rate [kg/hr]
-
m_dot_b_tot
¶ sequence: Field steam mass flow rate - boiler [kg/hr]
-
m_dot_field
¶ sequence: Field steam mass flow rate [kg/hr]
-
m_dot_makeup
¶ sequence: Cycle cooling water mass flow rate - makeup [kg/hr]
-
m_dot_to_pb
¶ sequence: Cycle steam mass flow rate [kg/hr]
-
month
¶ sequence: Resource Month
-
monthly_energy
¶ sequence: Monthly Energy [kWh]
-
pres
¶ sequence: Resource Pressure [mbar]
-
q_aux_fluid
¶ sequence: Fossil thermal power produced [MWt]
-
q_aux_fuel
¶ sequence: Fossil fuel usage [MMBTU]
-
q_dump
¶ sequence: Cycle thermal energy dumped [MWt]
-
q_field_delivered
¶ sequence: Field thermal power produced [MWt]
-
q_inc_tot
¶ sequence: Field thermal power incident [MWt]
-
q_loss_piping
¶ sequence: Field thermal power header pipe loss [MWt]
-
q_loss_rec
¶ sequence: Field thermal power receiver loss [MWt]
-
q_loss_sf
¶ sequence: Field thermal power loss [MWt]
-
q_to_pb
¶ sequence: Cycle thermal power input [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]
-
tou_value
¶ sequence: Resource Time-of-use value
-
twet
¶ sequence: Resource Wet bulb temperature [C]
-
wspd
¶ sequence: Resource Wind Speed [m/s]
-