WaveFileReader¶
Wrapper for SAM Simulation Core model: cmod_wave_file_reader.cpp
Input Consistency Warning¶
As described in Possible Problems, some input parameters are interdepedent but the equations accounting for these interdependencies that enforce consistency among these input parameters are not available in the 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:
- use_specific_wf_wave
- wave_resource_filename
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.
WaveFileReader model description
WaveFileReader
-
PySAM.WaveFileReader.
default
(config) → WaveFileReader¶ Use default attributes config options:
- “MEwaveLCOECalculator”
-
PySAM.WaveFileReader.
from_existing
(data, optional config) → WaveFileReader¶ Share underlying data with an existing PySAM class. If config provided, default attributes are loaded otherwise.
-
PySAM.WaveFileReader.
new
() → WaveFileReader¶
-
PySAM.WaveFileReader.
wrap
(ssc_data_t) → WaveFileReader¶ Use existing PySSC data
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap
Functions¶
-
class
PySAM.WaveFileReader.
WaveFileReader
¶ 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 = { 'Weather Reader': { 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.
-
WeatherReader Group¶
-
class
PySAM.WaveFileReader.WaveFileReader.
WeatherReader
¶ -
assign
() → None¶ Assign attributes from dictionary
WeatherReader_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
use_specific_wf_wave
¶ user specified file [0/1]
Constraints: INTEGER,MIN=0,MAX=1
Required: If not provided, assumed to be 0
- Changes to this variable may require updating the values of the following:
- wave_resource_filename
Type: float
-
wave_resource_filename
¶ local weather file path
Constraints: LOCAL_FILE
Required: True
- This variable may need to be updated if the values of the following have changed:
- use_specific_wf_wave
Type: str
-
Outputs Group¶
-
class
PySAM.WaveFileReader.WaveFileReader.
Outputs
¶ -
assign
() → None¶ Assign attributes from dictionary
Outputs_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
average_power_flux
¶ Distance to shore [kW/m]
Type: float
-
bathymetry
¶ Bathymetry
Type: str
-
city
¶ City
Type: str
-
country
¶ Country
Type: str
-
data_source
¶ Data source
Type: str
-
lat
¶ Latitude [deg]
Type: float
-
lon
¶ Longitude [deg]
Type: float
-
name
¶ Name
Type: str
-
nearby_buoy_number
¶ Nearby buoy number
Type: str
-
notes
¶ Notes
Type: str
-
sea_bed
¶ Sea bed
Type: str
-
state
¶ State
Type: str
-
tz
¶ Time zone
Type: float
-
wave_resource_matrix
¶ Frequency distribution of resource [m/s]
Type: sequence[sequence]
-