Irradproc¶
Wrapper for SAM Simulation Core model: cmod_irradproc.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.
Irradproc model description
Irradproc
-
PySAM.Irradproc.default(config) → Irradproc¶ Use financial config-specific default attributes
-
PySAM.Irradproc.from_existing(data, optional config) → Irradproc¶ Share underlying data with an existing PySAM class. If config provided, default attributes are loaded otherwise.
-
PySAM.Irradproc.new() → Irradproc¶
-
PySAM.Irradproc.wrap(ssc_data_t) → Irradproc¶ Use existing PySSC data
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap
Functions¶
-
class
PySAM.Irradproc.Irradproc¶ 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 = { 'Irradiance Processor': { 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.
-
IrradianceProcessor Group¶
-
class
PySAM.Irradproc.Irradproc.IrradianceProcessor¶ -
assign() → None¶ Assign attributes from dictionary
IrradianceProcessor_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
albedo¶ Ground reflectance (time depend.) [frac]
Info: 0..1
Constraints: LENGTH_EQUAL=beam
Required: False
Type: sequence
-
albedo_const¶ Ground reflectance (single value) [frac]
Info: 0..1
Required: If not provided, assumed to be 0.2
Type: float
-
azimuth¶ Azimuth angle [deg]
Options: E=90,S=180,W=270
Constraints: MIN=0,MAX=360
Required: True
Type: float
-
backtrack¶ Enable backtracking [0/1]
Constraints: BOOLEAN
Required: If not provided, assumed to be 0
Type: float
-
beam¶ Beam normal irradiance [W/m2]
Required: irrad_mode~2
Type: sequence
-
day¶ Day [dy]
Info: 1-days in month
Constraints: LENGTH_EQUAL=beam
Required: True
Type: sequence
-
diffuse¶ Diffuse horizontal irradiance [W/m2]
Constraints: LENGTH_EQUAL=beam
Required: irrad_mode~1
Type: sequence
-
gcr¶ Ground coverage ratio [0..1]
Constraints: MIN=0,MAX=1
Required: True if backtrack=1
Type: float
-
global¶ Global horizontal irradiance [W/m2]
Constraints: LENGTH_EQUAL=beam
Required: irrad_mode~0
Type: sequence
-
hour¶ Hour [hr]
Info: 0-23
Constraints: LENGTH_EQUAL=beam
Required: True
Type: sequence
-
irrad_mode¶ Irradiance input mode [0/1/2]
Info: Beam+Diff,Global+Beam, Global+Diff
Constraints: INTEGER,MIN=0,MAX=2
Required: If not provided, assumed to be 0
Type: float
-
lat¶ Latitude [deg]
Required: True
Type: float
-
lon¶ Longitude [deg]
Required: True
Type: float
-
minute¶ Minute [min]
Info: 0-59
Constraints: LENGTH_EQUAL=beam
Required: True
Type: sequence
-
month¶ Month [mn]
Info: 1-12
Constraints: LENGTH_EQUAL=beam
Required: True
Type: sequence
-
rotlim¶ Rotational limit on tracker [deg]
Constraints: MIN=0,MAX=90
Required: If not provided, assumed to be 45
Type: float
-
sky_model¶ Tilted surface irradiance model [0/1/2]
Info: Isotropic,HDKR,Perez
Constraints: INTEGER,MIN=0,MAX=2
Required: If not provided, assumed to be 2
Type: float
-
tilt¶ Tilt angle [deg]
Options: H=0,V=90
Constraints: MIN=0,MAX=90
Required: False
Type: float
-
track_mode¶ Tracking mode [0/1/2]
Info: Fixed,1Axis,2Axis
Constraints: MIN=0,MAX=2,INTEGER
Required: True
Type: float
-
tz¶ Time zone [hr]
Required: True
Type: float
-
year¶ Year [yr]
Constraints: LENGTH_EQUAL=beam
Required: True
Type: sequence
-
Outputs Group¶
-
class
PySAM.Irradproc.Irradproc.Outputs¶ -
assign() → None¶ Assign attributes from dictionary
Outputs_vals = { var: val, ...}
-
export() → dict¶ Export attributes into dictionary
-
axis_rotation¶ Tracking axis rotation angle [deg]
Type: sequence
-
bt_diff¶ Backtracking difference from ideal rotation [deg]
Type: sequence
-
incidence¶ Incidence angle to surface [deg]
Type: sequence
-
poa_beam¶ Incident Beam Irradiance [W/m2]
Type: sequence
-
poa_gnddiff¶ Incident Ground Reflected Diffuse [W/m2]
Type: sequence
-
poa_skydiff¶ Incident Sky Diffuse [W/m2]
Type: sequence
-
poa_skydiff_cir¶ Incident Diffuse Circumsolar Component [W/m2]
Type: sequence
-
poa_skydiff_hor¶ Incident Diffuse Horizon Brightening Component [W/m2]
Type: sequence
-
poa_skydiff_iso¶ Incident Diffuse Isotropic Component [W/m2]
Type: sequence
-
sun_azm¶ Solar azimuth [deg]
Type: sequence
-
sun_dec¶ Sun declination [deg]
Type: sequence
-
sun_elv¶ Sun elevation [deg]
Type: sequence
-
sun_zen¶ Solar zenith [deg]
Type: sequence
-
surf_azm¶ Surface azimuth angle [deg]
Type: sequence
-
surf_tilt¶ Surface tilt angle [deg]
Type: sequence
-