@openpv/simshady
    Preparing search index...

    Interface CalculateParams

    Interface for the parameter object for index.ShadingScene.calculate

    interface CalculateParams {
        maxYieldPerSquareMeter?: number;
        progressCallback?: (progress: number, total: number) => void;
        solarToElectricityConversionEfficiency?: number;
    }
    Index

    Properties

    maxYieldPerSquareMeter? progressCallback? solarToElectricityConversionEfficiency?

    Properties

    maxYieldPerSquareMeter?: number

    Upper boundary of annual yield in kWh/m2/year. This value is used to normalize the color of the returned three.js mesh. In Germany this is something like 1400 kWh/m2/year multiplied with the given solarToElectricityConversionEfficiency.

    1400*0.15
    progressCallback?: (progress: number, total: number) => void

    Callback function to indicate the progress of the simulation

    Type declaration

      • (progress: number, total: number): void

      • Parameters

        • progress: number

          number indicating the current progress

        • total: number

          number indicating the final number that progress needs to reach

        Returns void

    solarToElectricityConversionEfficiency?: number

    Efficiency of the conversion from solar energy to electricity. This includes the pv cell efficiency (about 20%) as well as the coverage density of PV panels per area (about 70%). Value in [0,1].

    0.15

    Settings

    Member Visibility

    On This Page

    Properties