UiTesCalcs

UiTesCalcs

PySAM.UiTesCalcs.default(config) → UiTesCalcs

Load defaults for the configuration config. Available configurations are:

  • None

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

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

PySAM.UiTesCalcs.new() → UiTesCalcs
PySAM.UiTesCalcs.wrap(ssc_data_t) → UiTesCalcs

Load data from a PySSC object.

Warning

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

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

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

execute(int verbosity) → None

Execute simulation with verbosity level 0 (default) or 1

export() → dict

Export attributes into nested dictionary

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

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.

Common Group

class PySAM.UiTesCalcs.UiTesCalcs.Common
assign(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

Common_vals = { var: val, ...}

export() → dict

Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

Common_vals = { var: val, ...}

P_ref

Power cycle output at design [MWe]

Required: True

Type:float
T_htf_cold_des

Cold design HTF temp into field [C]

Required: True

Type:float
T_htf_hot_des

Hot design HTF temp from field [C]

Required: True

Type:float
design_eff

Power cycle thermal efficiency

Required: True

Type:float
dt_hot

Heat exchanger approach temperature

Required: True

Type:float
field_fl_props

User defined field fluid prop data

Info: 7 columns (T,Cp,dens,visc,kvisc,cond,h), at least 3 rows

Required: True

Type:sequence[sequence]
field_fluid

Field fluid code

Required: True

Type:float
h_tank

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

Required: True

Type:float
h_tank_min

Min. allowable HTF height in storage tank [m]

Required: True

Type:float
store_fl_props

User defined tes storage fluid prop data

Info: 7 columns (T,Cp,dens,visc,kvisc,cond,h), at least 3 rows

Required: True

Type:sequence[sequence]
store_fluid

TES storage fluid code

Required: True

Type:float
tank_pairs

Number of equivalent tank pairs

Required: True

Type:float
tshours

Hours of TES relative to q_dot_pb_des [hr]

Required: True

Type:float
u_tank

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

Required: True

Type:float

Outputs Group

class PySAM.UiTesCalcs.UiTesCalcs.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, ...}

are_htfs_equal

no, 1: yes

Type:float
Type:0
csp_pt_tes_htf_density

HTF dens [kg/m^3]

Type:float
csp_pt_tes_tank_diameter

Single tank diameter [m]

Type:float
q_dot_tes_est

Estimated tank heat loss to env. [MWt]

Type:float
q_tes

TES thermal capacity at design [MWt-hr]

Type:float
tes_avail_vol

Available single temp storage volume [m^3]

Type:float
vol_tank

Total single temp storage volume [m^3]

Type:float