Calculation parameters

Parameters affecting that calculations can be specified in the calculationParameters meber

var configurationOverrides = {
    ...
    calculationParameters: IClientCalculationsParameters,
    ...
}

The interface IClientCalculationsParameters is deinfed as:

interface IClientCalculationsParameters {
    energyLoan: IEnergyLoan;
    CO2Conversions?: ICO2Conversion;
}

energyLoan

The IEnergyLoan interface is defined in the following way. Note that all members must be defined

interface IEnergyLoan {
    house: IScenarioEnergyLoan;
    apartment: IScenarioEnergyLoan;
    "multi-resident": IScenarioEnergyLoan;
}

IScenarioEnergyLoan

interface IEnergyLoan {
    defaultInterestRate: number,
    loanPeriod: number,
    loanType: "annuityLoan" | "straightAmortization",
    minLoanAmount?: number,
    maxLoanAmount?: number,
}

Example loan parameters override

calculationParameters: {
    ...
    energyLoan: {
        [ResidenceType.APARTMENT]: {
            defaultInterestRate: 0.065,
            loanType: LoanType.STRAIGHT_AMORTIZATION,
            loanPeriod: 5,
            minLoanAmount: UNSECURED_LOAN_MIN_AMOUNT,
        },
        [ResidenceType.HOUSE]: {
            defaultInterestRate: 0.0372,
            loanType: LoanType.ANNUITY_LOAN,
            loanPeriod: 10,
            minLoanAmount: UNSECURED_LOAN_MIN_AMOUNT,
        },
        [ResidenceType.MULTI_RESIDENT]: {
            defaultInterestRate: 0,
            loanType: LoanType.STRAIGHT_AMORTIZATION,
            loanPeriod: 0,
        },
    },
    ...
}

CO2Conversions

The ICO2Conversion interface is defined in the following way. The value is CO2/kWh

interface ICO2Conversion {
    districtHeating?: number;
    electricity?: number;
    firewood?: number;
    gas?: number;
    oil?: number;
    pellets?: number;
    localPV?: number;
    greenElectricity?: number;
}

Example of CO2 conversion override

calculationParameters: {
    ...
    CO2Conversions: {
        electricity: 0.024,
        greenElectricity: 0,
        oil: 0.248,
        districtHeating: 0.085,
        firewood: 0,
        pellets: 0,
        gas: 0.2,
    },
    ...
}