Class EnergyCalculationInputs
Holds all the inputs required for an energy calculation
Namespace: SolarFarmerApi.Client
Syntax
public class EnergyCalculationInputs
Properties
EnergyCalculationOptions
The flags that switch on and off various bits of the model chain.
Declaration
public EnergyCalculationOptions EnergyCalculationOptions { get; set; }
Property Value
Type | Description |
---|---|
EnergyCalculationOptions |
HorizonAngles
The angle of the horizon above the horizontal at each azimuth point.
Units: degrees.
Required if the horizon model is enabled in the EnergyCalculationOptions
Declaration
public ICollection<double> HorizonAngles { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.ICollection<System.Double> |
HorizonAzimuths
The azimuths for each of the HorizonAngles
Units: degrees.
Required if the horizon model is enabled in the EnergyCalculationOptions.
Declaration
public ICollection<double> HorizonAzimuths { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.ICollection<System.Double> |
LayoutHintsForUI
Several properties used in the design of the layout regions when using
the 'Import from API JSON' functionality in SolarFarmer desktop user interface.
Not required. These values do not affect the calculation when passed in cloud-based simulations.
Declaration
public LayoutHintsForUI LayoutHintsForUI { get; set; }
Property Value
Type | Description |
---|---|
LayoutHintsForUI |
Location
The location of the plant
Used to calculate the solar position for any given time.
Declaration
public Location Location { get; set; }
Property Value
Type | Description |
---|---|
Location |
MeteorologicalConditionsDataset
The meteo data.
Not required as can be read from a .dat file
Declaration
public MeteorologicalConditionsDataset MeteorologicalConditionsDataset { get; set; }
Property Value
Type | Description |
---|---|
MeteorologicalConditionsDataset |
MonthlyAlbedo
The albedo of the ground. One value for each month of the year.
Fraction of 1. 1 representing all light being reflected, 0 representing no light being reflected.
Required. If albedo is read from meteo file and enabled via EnergyCalculationOptions.UseAlbedoFromMetDataWhenAvailable, these values will be used in case of any missing data.
Declaration
public ICollection<double> MonthlyAlbedo { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.ICollection<System.Double> |
PanFileSupplements
These accompany the pan files. If there is supplementary data associated with a pan file listed in
PanFilePathsOrContents then it should be added here using the same key.
Not required. The pan file is sufficient without these additional data.
Declaration
public IDictionary<string, PanFileSupplements> PanFileSupplements { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IDictionary<System.String, PanFileSupplements> |
PvPlant
The PV plant
This includes all the components, their specifications and how many of each there are and how they are connected together.
Declaration
public PVPlant PvPlant { get; set; }
Property Value
Type | Description |
---|---|
PVPlant |
RequestedResultsPVsystFormat
A list of variables to be included in the PVsyst format results file.
Declaration
public ICollection<string> RequestedResultsPVsystFormat { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.ICollection<System.String> |
SolarPositions
The solar positions.
Optional.
Typically this is left empty and SolarFarmer calculates the solar positions.
Declaration
public SolarPositions SolarPositions { get; set; }
Property Value
Type | Description |
---|---|
SolarPositions |