UserHtfComparison

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

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.

UserHtfComparison model description

UserHtfComparison

PySAM.UserHtfComparison.default(config) → UserHtfComparison

Use default attributes None

PySAM.UserHtfComparison.from_existing(data, optional config) → UserHtfComparison

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

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

Use existing PySSC data

Warning

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

Functions

class PySAM.UserHtfComparison.UserHtfComparison

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

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.UserHtfComparison.UserHtfComparison.Common
assign() → None

Assign attributes from dictionary

Common_vals = { var: val, ...}

export() → dict

Export attributes into dictionary

HTF_code1

Fluid 1 [-]

Required: True

Type:float
Type:HTF fluid code
HTF_code2

Fluid 2 [-]

Required: True

Type:float
Type:HTF fluid code
fl_props1

User defined field fluid property data, Fluid 1 [-]

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

Required: True

Type:sequence[sequence]
fl_props2

User defined field fluid property data, Fluid 2 [-]

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

Required: True

Type:sequence[sequence]

Outputs Group

class PySAM.UserHtfComparison.UserHtfComparison.Outputs
assign() → None

Assign attributes from dictionary

Outputs_vals = { var: val, ...}

export() → dict

Export attributes into dictionary

are_equal

Input tables are equal, 0: not equal [-]

Type:float
Type:1