Download OpenAPI specification:Download
A DNV WindFarmer calculation services API.
Energy efficiencies calculation inputs.
Array of objects (WindFarm) Wind farms to be included in the analysis. | |
Array of objects (TurbineModel) Turbine models used in the wind farms. | |
Array of objects or null (WindClimate) The wind climate data provided as frequency and turbulence distributions. For use when this measured data exists. If this list is specified then the WeibullWindClimates list should not be specified. | |
Array of objects or null (WeibullWindClimate) The wind climate data provided as weibull parameters for probabilities and a single turbulence value. For use when measured data is not available. If this list is specified then the WindClimates list should not be specified. | |
object (ReferenceAirDensity) The reference air density and elevation. | |
object (FlowModel) The flow model data. | |
object (EnergyEfficienciesSettings) The Annual Energy Production (AEP) calculation settings. |
{- "windFarms": [
- {
- "name": "string",
- "turbines": [
- {
- "name": "string",
- "associatedWindClimateId": "string",
- "turbineModelId": "string",
- "isInstalled": true,
- "productionYield": 0,
- "confidenceWeighting": 0,
- "location": {
- "easting_m": 0,
- "northing_m": 0,
- "terrainHeightAboveSeaLevel_m": 0
}, - "curtailmentRules": [
- {
- "rulePriority": 0,
- "ruleTypeName": "string",
- "windDirectionFrom": "NaN",
- "windDirectionTo": "NaN",
- "minimumWindSpeed_m_per_s": "NaN",
- "maximumWindSpeed_m_per_s": "NaN",
- "timeFromAsTimeOfDay": "string",
- "timeToAsTimeOfDay": "string",
- "timeFromAsSunRiseOffset": "string",
- "timeToAsSunRiseOffset": "string",
- "timeFromAsSunSetOffset": "string",
- "timeToAsSunSetOffset": "string",
- "startDayOfYear": 0,
- "endDayOfYear": 0,
- "minimumTemperature_degrees_celsius": "NaN",
- "maximumTemperature_degrees_celsius": "NaN",
- "activeMode": "string"
}
], - "parkWakeDecayConstant": 0
}
], - "isNeighbor": true,
- "includeInBlockageCalculation": true
}
], - "turbineModels": [
- {
- "id": "string",
- "rotorDiameter_m": 0,
- "numberOfBlades": 0,
- "hubHeight_m": 0,
- "performanceData": [
- {
- "turbineOperationalMode": "normal",
- "adjustedHighSpeedCutOut_m_per_s": 0,
- "adjustedLowSpeedCutIn_m_per_s": 0,
- "lowSpeedCutIn_m_per_s": 0,
- "highSpeedCutOut_m_per_s": 0,
- "turbulenceIntensity_percentage": 0,
- "airDensity_kg_per_m3": 0,
- "performanceDataPoints": [
- {
- "windSpeed_m_per_s": 0,
- "powerOutput_W": 0,
- "rotorSpeed_radians_per_s": 0,
- "thrustCoefficient": 0,
- "noiseDifferenceFromReferenceCurve_dB": 0
}
]
}
], - "powerControl": "Pitch"
}
], - "windClimates": [
- {
- "id": "string",
- "location": {
- "easting_m": 0,
- "northing_m": 0,
- "terrainHeightAboveSeaLevel_m": 0
}, - "heightAboveGround_m": 0,
- "numberOfDirectionSectors": 0,
- "directionForFirstBinCentre_degrees": 0,
- "windSpeedBinUpperLimits_m_per_s": [
- 0
], - "probabilityDistribution": [
- [
- 0
]
], - "turbulenceIntensity": [
- [
- 0
]
]
}
], - "weibullWindClimates": [
- {
- "id": "string",
- "location": {
- "easting_m": 0,
- "northing_m": 0,
- "terrainHeightAboveSeaLevel_m": 0
}, - "heightAboveGround_m": 0,
- "numberOfDirectionSectors": 0,
- "directionForFirstBinCentre_degrees": 0,
- "sectorWeibullParameters": [
- {
- "a": 100,
- "k": 20,
- "probability": 1
}
], - "turbulenceIntensity": 2
}
], - "referenceAirDensity": {
- "airDensity_kg_per_m3": 0,
- "lapseRate_kg_per_m3_per_m": 0,
- "elevation_m": 0
}, - "flowModel": {
- "referenceDirections_degrees": [
- 0
], - "speedsUps": [
- {
- "locationDescription": "string",
- "easting_m": 0,
- "northing_m": 0,
- "heightAboveGround_m": 0,
- "speedUps": [
- 0
]
}
]
}, - "energyEfficienciesSettings": {
- "calculateEfficiencies": true,
- "calculateIdealYield": true,
- "includeHysteresisEffect": true,
- "includeTurbineManagement": true,
- "turbineFlowAndPerformanceMatrixOutputSettings": {
- "outputMastToTurbineSpeedUp": false,
- "outputAmbientWindSpeed": false,
- "outputAmbientTurbulenceIntensity": false,
- "outputDominantWakeCenterLineWindSpeed": false,
- "outputDominantWakeOffset": false,
- "outputDominantWakeWidth": false,
- "outputWakedWindSpeed": false,
- "outputWakedTurbulenceIntensity": false,
- "outputPowerOutput": false,
- "outputProbabilityDistribution": false,
- "outputUpstreamTurbineCausingWake": false,
- "outputOperationalMode": false,
- "localTurbineWindSpeedsOutputSettings": {
- "outputPowerOutput": false,
- "outputWakedWindSpeed": false,
- "outputProbabilityDistribution": false,
- "outputWakedTurbulenceIntensity": false,
- "outputAmbientTurbulenceIntensity": false,
- "outputOperationalMode": false
}
}, - "numberOfDirectionSectorsForWakeCalculation": 0,
- "maximumWindSpeedForEvaluation_m_per_s": 0,
- "extrapolationAmbientTurbulence": "ConstantWindSpeedStandardDeviation",
- "wakeModel": {
- "wakeModelType": "ModifiedPark",
- "eddyViscosity": {
- "useLargeWindFarmModel": true,
- "largeWindFarmCorrectionParameters": {
- "baseRoughnessZ01": 0,
- "increasedRoughnessZ02": 0,
- "geometricWidthDiameters": 1,
- "recoveryStartDiameters": 60,
- "fiftyPercentRecoveryDiameters": 40
}, - "useCloselySpacedTurbinesWakeModification": false,
- "wakeProfileIntegrationMethod": "Simpsons"
}, - "modifiedPark": {
- "useLargeWindFarmModel": true,
- "largeWindFarmCorrectionParameters": {
- "baseRoughnessZ01": 0,
- "increasedRoughnessZ02": 0,
- "geometricWidthDiameters": 1,
- "recoveryStartDiameters": 60,
- "fiftyPercentRecoveryDiameters": 40
}
}, - "turbOPark": {
- "wakeExpansion": 0.04
}, - "cfdml": {
- "gnnType": "Offshore",
- "gnnStabilityClass": "Stable"
}, - "noWakeModel": {
- "useLargeWindFarmModel": true,
- "largeWindFarmCorrectionParameters": {
- "baseRoughnessZ01": 0,
- "increasedRoughnessZ02": 0,
- "geometricWidthDiameters": 1,
- "recoveryStartDiameters": 60,
- "fiftyPercentRecoveryDiameters": 40
}
}
}, - "blockageModel": {
- "blockageModelType": "NoBlockageModel",
- "beet": {
- "significantAtmosphericStability": true,
- "inclusionOfNeighborsBufferZoneInMeters": 0,
- "blockageCorrectionApplicationMethod": "OnEnergy"
}, - "cfdml": {
- "cfdmlSettings": {
- "gnnType": "Offshore",
- "gnnStabilityClass": "Stable"
}, - "blockageCorrectionApplicationMethod": "OnEnergy"
}
}
}
}
{- "windFarmAepOutputs": [
- {
- "windFarmName": "string",
- "grossAnnualEnergyYield_MWh_per_year": 0,
- "blockageOnAnnualEnergyYield_MWh_per_year": 0,
- "internalWakesOnAnnualEnergyYield_MWh_per_year": 0,
- "hysteresisAdjustmentOnAnnualEnergyYield_MWh_per_year": 0,
- "largeWindFarmCorrectionOnAnnualEnergyYield_MWh_per_year": 0,
- "neighborsWakesOnAnnualEnergyYield_MWh_per_year": 0,
- "fullAnnualEnergyYield_MWh_per_year": 0,
- "turbineResults": [
- {
- "turbineName": "string",
- "turbineLocation": {
- "easting_m": 0,
- "northing_m": 0,
- "terrainHeightAboveSeaLevel_m": 0
}, - "idealAnnualYield_MWh_per_year": 0,
- "grossAnnualYield_MWh_per_year": 0,
- "blockageOnAnnualYield_MWh_per_year": 0,
- "internalWakesOnAnnualYield_MWh_per_year": 0,
- "hysteresisAdjustmentOnAnnualYield_MWh_per_year": 0,
- "largeWindFarmCorrectionOnAnnualYield_MWh_per_year": 0,
- "neighborsWakesOnAnnualYield_MWh_per_year": 0,
- "fullAnnualYield_MWh_per_year": 0,
- "freeMeanWindSpeed_m_per_s": 0,
- "fullMeanWindSpeed_m_per_s": 0,
- "ambientMeanTurbulenceIntensity_percentage": 0,
- "fullMeanTurbulenceIntensity_percentage": 0,
- "airDensityAtHubHeight_kg_per_m3": 0,
- "usedPerformanceTableIds": [
- "string"
]
}
], - "turbineFlowAndPerformanceMatricesWithMastBinning": [
- {
- "turbineName": "string",
- "windFarmName": "string",
- "directionForFirstBinCentre_degrees": 0,
- "binCenterWindSpeedsAtMast_m_per_s": [
- 0
], - "ambientWindSpeed_m_per_s": [
- [
- 0
]
], - "ambientTurbulenceIntensity_percentage": [
- [
- 0
]
], - "dominantWakeCenterLineWindSpeed_m_per_s": [
- [
- 0
]
], - "dominantWakeWidth": [
- [
- 0
]
], - "dominantWakeOffset_m": [
- [
- 0
]
], - "wakedWindSpeed_m_per_s": [
- [
- 0
]
], - "wakedTurbulenceIntensity_percentage": [
- [
- 0
]
], - "spotPowerOutput_W": [
- [
- 0
]
], - "binPowerOutput_W": [
- [
- 0
]
], - "probabilityDistribution": [
- [
- 0
]
], - "upstreamTurbineCausingWake": [
- [
- "string"
]
], - "turbineOperationalMode": [
- [
- "string"
]
], - "mastToTurbineSpeedUp": [
- 0
]
}
], - "turbineFlowAndPerformanceMatricesWithTurbineBinning": [
- {
- "turbineName": "string",
- "windFarmName": "string",
- "directionForFirstBinCentre_degrees": 0,
- "binCenterWindSpeedsAtMast_m_per_s": [
- 0
], - "ambientWindSpeed_m_per_s": [
- [
- 0
]
], - "ambientTurbulenceIntensity_percentage": [
- [
- 0
]
], - "dominantWakeCenterLineWindSpeed_m_per_s": [
- [
- 0
]
], - "dominantWakeWidth": [
- [
- 0
]
], - "dominantWakeOffset_m": [
- [
- 0
]
], - "wakedWindSpeed_m_per_s": [
- [
- 0
]
], - "wakedTurbulenceIntensity_percentage": [
- [
- 0
]
], - "spotPowerOutput_W": [
- [
- 0
]
], - "binPowerOutput_W": [
- [
- 0
]
], - "probabilityDistribution": [
- [
- 0
]
], - "upstreamTurbineCausingWake": [
- [
- "string"
]
], - "turbineOperationalMode": [
- [
- "string"
]
], - "mastToTurbineSpeedUp": [
- 0
]
}
]
}
], - "weightedBlockageEfficiency": 0
}
The blockage model calculation inputs.
Array of objects (TurbineLocation) Details of the turbines on the wind farm. | |
Array of objects (TurbinePerformance) A list of turbine performance characteristics at different wind speeds. | |
significantAtmosphericStability | boolean Specifies whether there is significant atmospheric stability (true), or if the atmosphere is predominantly neutral or unstable (false). |
{- "turbines": [
- {
- "easting_m": 0,
- "northing_m": 0,
- "hubHeight_m": 0,
- "rotorDiameter_m": 0
}
], - "turbinePerformance": [
- {
- "windSpeed_m_per_s": 0,
- "powerOutput_kW": 0,
- "thrustCoefficient": 0,
- "frequency_pc": 0
}
], - "significantAtmosphericStability": true
}
{- "blockageEffect": 0
}