Singlediode¶
Wrapper for SAM Simulation Core model: cmod_singlediode.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.
Singlediode model description
Singlediode
-
PySAM.Singlediode.
default
(config) → Singlediode¶ Use default attributes None
-
PySAM.Singlediode.
from_existing
(data, optional config) → Singlediode¶ Share underlying data with an existing PySAM class. If config provided, default attributes are loaded otherwise.
-
PySAM.Singlediode.
new
() → Singlediode¶
-
PySAM.Singlediode.
wrap
(ssc_data_t) → Singlediode¶ Use existing PySSC data
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap
Functions¶
-
class
PySAM.Singlediode.
Singlediode
¶ 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 = { 'Single Diode Model': { 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 = { 'Single Diode Model': { 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.
-
SingleDiodeModel Group¶
-
class
PySAM.Singlediode.Singlediode.
SingleDiodeModel
¶ -
assign
(dict) → None¶ Assign attributes from dictionary, overwriting but not removing values
SingleDiodeModel_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
replace
(dict) → None¶ Replace attributes from dictionary, unassigning values not present in input dict
SingleDiodeModel_vals = { var: val, ...}
-
Il
¶ Light current [A]
Required: True
Type: float
-
Io
¶ Saturation current [A]
Required: True
Type: float
-
Rs
¶ Series resistance [ohm]
Required: True
Type: float
-
Rsh
¶ Shunt resistance [ohm]
Required: True
Type: float
-
Vop
¶ Module operating voltage [V]
Required: False
Type: float
-
a
¶ Modified nonideality factor [1/V]
Required: True
Type: float
-
Outputs Group¶
-
class
PySAM.Singlediode.Singlediode.
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, ...}
-
I
¶ Output current [A]
Type: float
-
Isc
¶ Short circuit current [A]
Type: float
-
V
¶ Output voltage [V]
Type: float
-
Voc
¶ Open circuit voltage [V]
Type: float
-