TcslinearFresnel

Wrapper for SAM Simulation Core model: cmod_tcslinear_fresnel.cpp

Input Consistency Warning

As described in Possible Problems, some input parameters are interdependent but the equations that enforce consistency are not available in this PySAM module. Therefore, the onus is on the PySAM user to check that interdependencies are correctly handled. The variables which may require additional logic include:

  • ColAz
  • I_bn_des
  • P_boil_des
  • P_turb_des
  • Pipe_hl_coef
  • T_amb_des_sf
  • T_cold_ref
  • T_hot
  • azimuth
  • demand_var
  • eta_ref
  • nLoops
  • nModBoil
  • nModSH
  • q_max_aux
  • q_pb_des
  • solarm
  • system_capacity

Provided for each of these inputs is a list of other inputs that are potentially interdependent.

Creating an Instance

Refer to the Initializing a Model page for details on the different ways to create an instance of a PySAM class.

TcslinearFresnel model description

Process heat linear direct steam

PySAM.TcslinearFresnel.default(config) → TcslinearFresnel

Use default attributes config options:

  • “DSLFAllEquityPartnershipFlip”
  • “DSLFCommercial”
  • “DSLFLCOECalculator”
  • “DSLFLeveragedPartnershipFlip”
  • “DSLFMerchantPlant”
  • “DSLFNone”
  • “DSLFSaleLeaseback”
  • “DSLFSingleOwner”
PySAM.TcslinearFresnel.from_existing(data, optional config) → TcslinearFresnel

Share underlying data with an existing PySAM class. If config provided, default attributes are loaded otherwise.

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

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.

Weather Group

class PySAM.TcslinearFresnel.TcslinearFresnel.Weather
assign() → None

Assign attributes from dictionary

Weather_vals = { var: val, ...}

export() → dict

Export attributes into dictionary

azimuth

Azimuth angle of surface/axis

Required: True

This variable may need to be updated if the values of the following have changed:
  • ColAz
Type:float
file_name

local weather file path

Constraints: LOCAL_FILE

Required: True

Type:str
tilt

Tilt angle of surface/axis

Required: True

Type:float
track_mode

Tracking mode

Required: True

Type:float

LinearFresnelr Group

class PySAM.TcslinearFresnel.TcslinearFresnel.LinearFresnelr
assign() → None

Assign attributes from dictionary

LinearFresnelr_vals = { var: val, ...}

export() → dict

Export attributes into dictionary

system_capacity

Nameplate capacity [kW]

Required: True

This variable may need to be updated if the values of the following have changed:
  • demand_var
Type:float

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

12x24 Time of Use Values for week days

Required: True

Type:sequence[sequence]
weekend_schedule

12x24 Time of Use Values for week end days

Required: True

Type:sequence[sequence]

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

(boiler, SH) Reflective aperture area of the collector module [m^2]

Required: True

Type:sequence[sequence]
AbsorberMaterial

(boiler, SH) Absorber material type [none]

Required: True

Type:sequence[sequence]
AnnulusGas

# field fracs) [none]

Required: True

Type:sequence[sequence]
Type:(boiler, SH) Annulus gas type {1=air; 26=Ar; 27=H2} (4
ColAz

Collector azimuth angle [deg]

Required: True

Changes to this variable may require updating the values of the following:
  • azimuth
Type:float
D_2

(boiler, SH) The inner absorber tube diameter [m]

Required: True

Type:sequence[sequence]
D_3

(boiler, SH) The outer absorber tube diameter [m]

Required: True

Type:sequence[sequence]
D_4

(boiler, SH) The inner glass envelope diameter [m]

Required: True

Type:sequence[sequence]
D_5

(boiler, SH) The outer glass envelope diameter [m]

Required: True

Type:sequence[sequence]
D_p

(boiler, SH) The diameter of the absorber flow plug (optional) [m]

Required: True

Type:sequence[sequence]
Design_loss

# field fracs) [W/m]

Required: True

Type:sequence[sequence]
Type:(boiler, SH) Receiver heat loss at design (4
Dirt_HCE

# field fracs) [none]

Required: True

Type:sequence[sequence]
Type:(boiler, SH) Loss due to dirt on the receiver envelope (4
EPSILON_4

# field fracs) [none]

Required: True

Type:sequence[sequence]
Type:(boiler, SH) Inner glass envelope emissivities (Pyrex) (4
Flow_type

(boiler, SH) The flow type through the absorber [none]

Required: True

Type:sequence[sequence]
GeomEffects

(boiler, SH) User-defined geometry effects derate [none]

Required: True

Type:sequence[sequence]
GlazingIntactIn

# field fracs) [none]

Required: True

Type:sequence[sequence]
Type:(boiler, SH) The glazing intact flag {true=0; false=1} (4
HCE_FieldFrac

# field fracs) [none]

Required: True

Type:sequence[sequence]
Type:(boiler, SH) The fraction of the field occupied by this HCE type (4
HLCharType

(boiler, SH) Flag indicating the heat loss model type {1=poly.; 2=Forristall} [none]

Required: True

Type:sequence[sequence]
HL_W

(boiler, SH) Heat loss coef adj wind velocity (0,1,2,3,4 order terms) [1/(m/s)^order]

Required: True

Type:sequence[sequence]
HL_dT

(boiler, SH) Heat loss coefficient - HTF temperature (0,1,2,3,4 order terms) [W/m-K^order]

Required: True

Type:sequence[sequence]
IAM_L

(boiler, SH) Longitudinal Incident angle modifiers (0,1,2,3,4 order terms) [none]

Required: True

Type:sequence[sequence]
IAM_T

(boiler, SH) Transverse Incident angle modifiers (0,1,2,3,4 order terms) [none]

Required: True

Type:sequence[sequence]
I_bn

Beam normal radiation (input kJ/m2-hr) [W/m2]

Required: True

Type:float
I_bn_des

Design point irradiation value [W/m2]

Required: True

Changes to this variable may require updating the values of the following:
  • nLoops
  • q_max_aux
  • solarm
Type:float
LHV_eff

Fuel LHV efficiency (0..1) [none]

Required: True

Type:float
L_col

(boiler, SH) Active length of the superheater section collector module [m]

Required: True

Type:sequence[sequence]
OptCharType

(boiler, SH) The optical characterization method [none]

Required: True

Type:sequence[sequence]
PB_fixed_par

fraction of rated gross power consumed at all hours of the year [none]

Required: True

Type:float
PB_pump_coef

Pumping power required to move 1kg of HTF through power block flow [kW/kg]

Required: True

Type:float
P_a

# field fracs) [torr]

Required: True

Type:sequence[sequence]
Type:(boiler, SH) Annulus gas pressure (4
P_amb

Ambient pressure [atm]

Required: True

Type:float
P_turb_des

Design-point turbine inlet pressure [bar]

Required: True

This variable may need to be updated if the values of the following have changed:
  • P_boil_des
Type:float
Pipe_hl_coef

Loss coefficient from the header.. runner pipe.. and non-HCE pipin [W/m2-K]

Required: True

Changes to this variable may require updating the values of the following:
  • nLoops
  • q_max_aux
  • solarm
Type:float
Rough

(boiler, SH) Roughness of the internal surface [m]

Required: True

Type:sequence[sequence]
SCA_drives_elec

Tracking power.. in Watts per SCA drive [W/m2]

Required: True

Type:float
Shadowing

# field fracs) [none]

Required: True

Type:sequence[sequence]
Type:(boiler, SH) Receiver bellows shadowing loss factor (4
SolarAz_init

Solar azimuth angle [deg]

Required: True

Type:float
SolarZen

Solar zenith angle [deg]

Required: True

Type:float
T_amb_des_sf

Design-point ambient temperature [C]

Required: True

Changes to this variable may require updating the values of the following:
  • nLoops
  • q_max_aux
  • solarm
Type:float
T_db

Dry bulb air temperature [C]

Required: True

Type:float
T_dp

The dewpoint temperature [C]

Required: True

Type:float
T_fp

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

Required: True

Type:float
T_pb_out_init

Fluid temperature from the power block [C]

Required: True

Type:float
Tau_envelope

# field fracs) [none]

Required: True

Type:sequence[sequence]
Type:(boiler, SH) Envelope transmittance (4
TrackingError

(boiler, SH) User-defined tracking error derate [none]

Required: True

Type:sequence[sequence]
V_wind

Ambient windspeed [m/s]

Required: True

Type:float
V_wind_max

Maximum allowable wind velocity before safety stow [m/s]

Required: True

Type:float
alpha_abs

# field fracs) [none]

Required: True

Type:sequence[sequence]
Type:(boiler, SH) Absorber absorptance (4
alpha_env

# field fracs) [none]

Required: True

Type:sequence[sequence]
Type:(boiler, SH) Envelope absorptance (4
aux_array

Aux_parVal, Aux_parPF, Aux_par0, Aux_par1, Aux_par2 [-]

Required: True

Type:sequence
b_OpticalTable

Values of the optical efficiency table [none]

Required: True

Type:sequence[sequence]
b_eps_HCE1

(temperature) Absorber emittance (eps) [none]

Required: True

Type:sequence[sequence]
b_eps_HCE2

(temperature) Absorber emittance (eps) [none]

Required: True

Type:sequence[sequence]
b_eps_HCE3

(temperature) Absorber emittance (eps) [none]

Required: True

Type:sequence[sequence]
b_eps_HCE4

(temperature) Absorber emittance (eps) [none]

Required: True

Type:sequence[sequence]
bop_array

BOP_parVal, BOP_parPF, BOP_par0, BOP_par1, BOP_par2 [-]

Required: True

Type:sequence
cycle_cutoff_frac

Minimum turbine operation fraction before shutdown [none]

Required: True

Type:float
cycle_max_fraction

Maximum turbine over design operation fraction [none]

Required: True

Type:float
dirt_mirror

(boiler, SH) User-defined dirt on mirror derate [none]

Required: True

Type:sequence[sequence]
dnifc

Forecast DNI [W/m2]

Required: True

Type:float
e_startup

Thermal inertia contribution per sq meter of solar field [kJ/K-m2]

Required: True

Type:float
error

(boiler, SH) User-defined general optical error derate [none]

Required: True

Type:sequence[sequence]
eta_pump

Feedwater pump efficiency [none]

Required: True

Type:float
fP_boil_to_sh

Design-point pressure drop between the boiler and superheater frac [none]

Required: True

Type:float
fP_hdr_c

Average design-point cold header pressure drop fraction [none]

Required: True

Type:float
fP_hdr_h

Average design-point hot header pressure drop fraction [none]

Required: True

Type:float
fP_sf_boil

Design-point pressure drop across the solar field boiler fraction [none]

Required: True

Type:float
fP_sf_sh

Design-point pressure drop across the solar field superheater frac [none]

Required: True

Type:float
ffrac

Fossil dispatch logic - TOU periods [none]

Required: True

Type:sequence
fossil_mode

Operation mode for the fossil backup {1=Normal,2=supp,3=toppin} [none]

Constraints: INTEGER

Required: True

Type:float
is_multgeom

Does the superheater have a different geometry from the boiler {1=yes} [none]

Constraints: INTEGER

Required: True

Type:float
is_oncethru

Flag indicating whether flow is once through with superheat [none]

Constraints: INTEGER

Required: True

Type:float
is_sh

Does the solar field include a superheating section [none]

Constraints: INTEGER

Required: True

Type:float
latitude

Site latitude resource page [deg]

Required: True

Type:float
m_dot_htf_ref

Reference HTF flow rate at design conditions [kg/hr]

Required: True

Type:float
m_dot_min

Minimum loop flow rate [kg/s]

Required: True

Type:float
m_pb_demand

Demand htf flow from the power block [kg/hr]

Required: True

Type:float
nLoops

Number of loops [none]

Required: True

Changes to this variable may require updating the values of the following:
  • q_max_aux
  • solarm
This variable may need to be updated if the values of the following have changed:
  • I_bn_des
  • Pipe_hl_coef
  • T_amb_des_sf
  • T_cold_ref
  • T_hot
  • demand_var
  • eta_ref
  • nModBoil
  • nModSH
Type:float
nModBoil

Number of modules in the boiler section [none]

Constraints: INTEGER

Required: True

Changes to this variable may require updating the values of the following:
  • nLoops
  • q_max_aux
  • solarm
Type:float
nModSH

Number of modules in the superheater section [none]

Constraints: INTEGER

Required: True

Changes to this variable may require updating the values of the following:
  • nLoops
  • q_max_aux
  • solarm
Type:float
q_max_aux

Maximum heat rate of the auxiliary heater [MW]

Required: True

This variable may need to be updated if the values of the following have changed:
  • I_bn_des
  • Pipe_hl_coef
  • T_amb_des_sf
  • T_cold_ref
  • T_hot
  • demand_var
  • eta_ref
  • nLoops
  • nModBoil
  • nModSH
Type:float
q_pb_des

Design heat input to the power block [MW]

Required: True

This variable may need to be updated if the values of the following have changed:
  • demand_var
  • eta_ref
Type:float
q_sby_frac

Fraction of thermal power required for standby [none]

Required: True

Type:float
rho_mirror_clean

(boiler, SH) User-defined clean mirror reflectivity [none]

Required: True

Type:sequence[sequence]
sh_OpticalTable

Values of the optical efficiency table [none]

Required: True

Type:sequence[sequence]
sh_eps_HCE1

(temperature) Absorber emittance (eps) [none]

Required: True

Type:sequence[sequence]
sh_eps_HCE2

(temperature) Absorber emittance (eps) [none]

Required: True

Type:sequence[sequence]
sh_eps_HCE3

(temperature) Absorber emittance (eps) [none]

Required: True

Type:sequence[sequence]
sh_eps_HCE4

(temperature) Absorber emittance (eps) [none]

Required: True

Type:sequence[sequence]
shift

Shift in longitude from local standard meridian [deg]

Required: True

Type:float
solarm

Solar multiple [none]

Required: True

This variable may need to be updated if the values of the following have changed:
  • I_bn_des
  • Pipe_hl_coef
  • T_amb_des_sf
  • T_cold_ref
  • T_hot
  • demand_var
  • eta_ref
  • nLoops
  • nModBoil
  • nModSH
Type:float
t_sby

Low resource standby period [hr]

Required: True

Type:float
tes_hours

Equivalent full-load thermal storage hours [hr]

Required: True

Type:float
theta_dep

deploy angle [deg]

Required: True

Type:float
theta_stow

stow angle [deg]

Required: True

Type:float
x_b_des

Design point boiler outlet steam quality [none]

Required: True

Type:float

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

Mirror washing frequency

Required: True

Type:float
csp_lf_sf_water_per_wash

Water usage per wash [L/m2_aper]

Required: True

Type:float

Powerblock Group

class PySAM.TcslinearFresnel.TcslinearFresnel.Powerblock
assign() → None

Assign attributes from dictionary

Powerblock_vals = { var: val, ...}

export() → dict

Export attributes into dictionary

CT

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

Constraints: INTEGER

Required: True

Type:float
F_wc

Fraction indicating wet cooling use for hybrid system [none]

Required: True

Type:sequence
P_amb_pwb

Ambient pressure [atm]

Required: True

Type:float
P_boil_des

Boiler operating pressure @ design [bar]

Required: True

Changes to this variable may require updating the values of the following:
  • P_turb_des
Type:float
P_cond_min

Minimum condenser pressure [inHg]

Required: True

Type:float
P_cond_ratio

Condenser pressure ratio [none]

Required: True

Type:float
P_rh_ref

Reheater operating pressure at design [bar]

Required: True

Type:float
T_ITD_des

ITD at design for dry system [C]

Required: True

Type:float
T_amb_des

Reference ambient temperature at design point [C]

Required: True

Type:float
T_approach

Cooling tower approach temperature [C]

Required: True

Type:float
T_cold_ref

Reference HTF outlet temperature at design [C]

Required: True

Changes to this variable may require updating the values of the following:
  • nLoops
  • q_max_aux
  • solarm
Type:float
T_db_pwb

Ambient dry bulb temperature [C]

Required: True

Type:float
T_hot

Hot HTF inlet temperature, from storage tank [C]

Required: True

Changes to this variable may require updating the values of the following:
  • nLoops
  • q_max_aux
  • solarm
Type:float
T_wb

Ambient wet bulb temperature [C]

Required: True

Type:float
dT_cw_ref

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

Required: True

Type:float
demand_var

Control signal indicating operational mode [none]

Required: True

Changes to this variable may require updating the values of the following:
  • nLoops
  • q_max_aux
  • q_pb_des
  • solarm
  • system_capacity
Type:float
dp_b

Pressure drop in boiler [Pa]

Required: True

Type:float
dp_rh

Pressure drop in reheater [Pa]

Required: True

Type:float
dp_sh

Pressure drop in superheater [Pa]

Required: True

Type:float
eta_ref

Reference conversion efficiency at design condition [none]

Required: True

Changes to this variable may require updating the values of the following:
  • nLoops
  • q_max_aux
  • q_pb_des
  • solarm
Type:float
f_recSU

Fraction powerblock can run due to receiver startup [none]

Required: True

Type:float
m_dot_st

HTF mass flow rate [kg/hr]

Required: True

Type:float
n_pl_inc

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

Constraints: INTEGER

Required: True

Type:float
pb_bd_frac

Power block blowdown steam fraction [none]

Required: True

Type:float
pc_mode

Cycle part load control, from plant controller [none]

Required: True

Type:float
q_sby_frac

Fraction of thermal power required for standby mode [none]

Required: True

Type:float
relhum

Relative humidity of the ambient air [none]

Required: True

Type:float
rh_frac_ref

Reheater flow fraction at design [none]

Required: True

Type:float
standby_control

Control signal indicating standby mode [none]

Required: True

Type:float
startup_frac

Fraction of design thermal power needed for startup [none]

Required: True

Type:float
startup_time

Time needed for power block startup [hr]

Required: True

Type:float

AdjustmentFactors Group

class PySAM.TcslinearFresnel.TcslinearFresnel.AdjustmentFactors
assign() → None

Assign attributes from dictionary

export() → Dict

Export attributes into dictionary

constant

float

Type:type
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

Cycle thermal energy startup [MWt]

Type:sequence
P_cond

Condenser pressure [Pa]

Type:sequence
P_sf_in

Field steam pressure at inlet [bar]

Type:sequence
P_turb_in

Cycle steam pressure at inlet [bar]

Type:sequence
T_field_in

Field steam temperature at header inlet [C]

Type:sequence
T_field_out

Field steam temperature at header outlet [C]

Type:sequence
T_loop_out

Field steam temperature at collector outlet [C]

Type:sequence
T_pb_in

Cycle steam temperature at inlet [C]

Type:sequence
T_pb_out

Cycle steam temperature at outlet [C]

Type:sequence
W_cool_par

Parasitic power condenser operation [MWe]

Type:sequence
W_cycle_gross

Cycle electrical power output (gross) [MWe]

Type:sequence
W_dot_aux

Parasitic power auxiliary heater operation [MWe]

Type:sequence
W_dot_bop

Parasitic power generation-dependent load [MWe]

Type:sequence
W_dot_col

Parasitic power field collector drives [MWe]

Type:sequence
W_dot_fixed

Parasitic power fixed load [MWe]

Type:sequence
W_dot_pump

Parasitic power solar field pump [MWe]

Type:sequence
W_net

Cycle electrical power output (net) [MWe]

Type:sequence
annual_W_cycle_gross

Electrical source - Power cycle gross output [kWh]

Type:float
annual_energy

Annual Energy [kWh]

Type:float
annual_fuel_usage

Annual fuel usage [kWh]

Type:float
annual_total_water_use

cycle + mirror washing [m3]

Type:float
Type:Total Annual Water Usage
beam

Resource Beam normal irradiance [W/m2]

Type:sequence
capacity_factor

Capacity factor [%]

Type:float
conversion_factor

Gross to Net Conversion Factor [%]

Type:float
dP_tot

Field steam pressure loss [bar]

Type:sequence
defocus

Field collector focus fraction

Type:sequence
eta

Cycle efficiency (gross)

Type:sequence
eta_opt_ave

Field collector optical efficiency

Type:sequence
eta_sf

Field efficiency total

Type:sequence
eta_thermal

Field thermal efficiency

Type:sequence
f_bays

Condenser fraction of operating bays [none]

Type:sequence
gen

System power generated [kW]

Type:sequence
hour

Resource Hour of Day

Type:sequence
kwh_per_kw

First year kWh/kW [kWh/kW]

Type:float
m_dot

Field steam mass flow rate - loop [kg/s]

Type:sequence
m_dot_aux

Fossil steam mass flow rate [kg/hr]

Type:sequence
m_dot_b_tot

Field steam mass flow rate - boiler [kg/hr]

Type:sequence
m_dot_field

Field steam mass flow rate [kg/hr]

Type:sequence
m_dot_makeup

Cycle cooling water mass flow rate - makeup [kg/hr]

Type:sequence
m_dot_to_pb

Cycle steam mass flow rate [kg/hr]

Type:sequence
month

Resource Month

Type:sequence
monthly_energy

Monthly Energy [kWh]

Type:sequence
pres

Resource Pressure [mbar]

Type:sequence
q_aux_fluid

Fossil thermal power produced [MWt]

Type:sequence
q_aux_fuel

Fossil fuel usage [MMBTU]

Type:sequence
q_dump

Cycle thermal energy dumped [MWt]

Type:sequence
q_field_delivered

Field thermal power produced [MWt]

Type:sequence
q_inc_tot

Field thermal power incident [MWt]

Type:sequence
q_loss_piping

Field thermal power header pipe loss [MWt]

Type:sequence
q_loss_rec

Field thermal power receiver loss [MWt]

Type:sequence
q_loss_sf

Field thermal power loss [MWt]

Type:sequence
q_to_pb

Cycle thermal power input [MWt]

Type:sequence
solazi

Resource Solar Azimuth [deg]

Type:sequence
solzen

Resource Solar Zenith [deg]

Type:sequence
system_heat_rate

System heat rate [MMBtu/MWh]

Type:float
tdry

Resource Dry bulb temperature [C]

Type:sequence
tou_value

Resource Time-of-use value

Type:sequence
twet

Resource Wet bulb temperature [C]

Type:sequence
wspd

Resource Wind Speed [m/s]

Type:sequence