Layoutarea

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

Layoutarea model description

Layoutarea

PySAM.Layoutarea.default(config) → Layoutarea

Use financial config-specific default attributes

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

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

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

Use existing PySSC data

Warning

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

Functions

class PySAM.Layoutarea.Layoutarea

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

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

Assign attributes from dictionary

Common_vals = { var: val, ...}

export() → dict

Export attributes into dictionary

positions

Positions within calculataed area

Required: True

Type:sequence[sequence]

Outputs Group

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

Assign attributes from dictionary

Outputs_vals = { var: val, ...}

export() → dict

Export attributes into dictionary

area

Area inside the convex hull

Type:float
convex_hull

Convex hull bounding the region

Type:sequence[sequence]