vehicle/running/emissions/components/fuelandelectric/co2gpm.js

  1. /**
  2.  * Calculate journey, fuel and electric ppm, total mileages
  3.  *
  4.  * @module
  5.  * @since 0.1.21
  6.  */
  8. import { isPHEV } from '../../../../classification';
  9. import { getMPGofficalRatio } from '../../../journey/calculate';
  10. import { co2_kg_per_litre as skv_co2_kg_per_litre, production_uplift_percentage } from '../../../../../maths/constants';
  11. import { kmToMiles } from '../../../../../maths/conversions';
  12. import { getIsCSMode } from '../../../util';
  13. import {
  14.     productionUplift,
  15.     tailpipeCO2gPerMile,
  16.     iceCO2gPerMileFromWCCO2gPerMile,
  17.     calculateElectricCO2gPerMile,
  18. } from './calculate';
  20. /**
  21.  * Co2 grams per mile for PHEVs
  22.  * @param {struct} skv_config
  23.  * @returns {number}
  24.  * @module
  25.  */
  27. const iceCO2gPerMileForPHEVs = (skv_config) => {
  28.     // if (skv_config.is_cs_mode) {
  29.     const skv_fuel_cfg = {
  30.         // work out charge sustaining mode first
  31.         co2_kg_per_litre: skv_co2_kg_per_litre[skv_config.fuel_type],
  32.         mpg: skv_config.mpg,
  33.         wc_mpg: skv_config.wc_mpg,
  34.         tailpipe_co2_gpkm: skv_config.tailpipe_co2_gpkm,
  35.         is_cs_mode: skv_config.is_cs_mode,
  36.         battery_range_miles: skv_config.battery_range_miles,
  37.     };
  39.     // get the weighted combined co2 g per mile (i.e electric + ICE)
  40.     const wc_co2_g_per_mile = kmToMiles(skv_fuel_cfg.tailpipe_co2_gpkm, true);
  42.     // remove the electric portion from the weighted combined co2 g per mile
  43.     return iceCO2gPerMileFromWCCO2gPerMile(wc_co2_g_per_mile, skv_config.wc_mpg, skv_config.mpg);
  44. };
  46. /**
  47.  * calculate grams for ICE portion
  48.  * @param {struct} skv_config ice_pp_litre, mpg, vat_percentage
  49.  * @returns {struct}
  50.  */
  51. const iceCO2gPerMile = (skv_config) => {
  52.     const skv_return = {
  53.         tail_pipe: 0,
  54.         production: 0,
  55.     };
  57.     const skv_default_cfg = {
  58.         mpg: '',
  59.         mpg_user: '',
  60.         // weighted combined mpg
  61.         wc_mpg: '',
  62.         // wltp what comes out of tailpipe
  63.         tailpipe_co2_gpkm: '',
  64.         fuel_type: '',
  65.         // is charging sustaining mode likely passed in when calculating a journey
  66.         is_cs_mode: false,
  67.         // for removing the electric portion from weighted combined
  68.         battery_range_miles: '',
  69.     };
  71.     // replace default values with the ones from the config passed in
  72.     const skv_cfg = Object.assign(skv_default_cfg, skv_config);
  74.     if (isPHEV(skv_cfg.mpg, skv_cfg.battery_range_miles)) {
  75.         skv_return.tail_pipe = iceCO2gPerMileForPHEVs(skv_cfg);
  76.         skv_return.production = productionUplift(skv_return.tail_pipe, production_uplift_percentage);
  77.     } else {
  78.         skv_return.tail_pipe = tailpipeCO2gPerMile(skv_cfg.tailpipe_co2_gpkm);
  79.         skv_return.production = productionUplift(skv_return.tail_pipe, production_uplift_percentage);
  80.     }
  82.     // at this point we've calculated co2 gram per mile based on official figures
  83.     // if the user has provided a custom mpg then apply as a ratio
  84.     if (skv_config.mpg_user) {
  85.         const ratio = getMPGofficalRatio(skv_config.mpg, skv_config.mpg_user);
  86.         skv_return.tail_pipe *= ratio;
  87.         skv_return.production *= ratio;
  88.     }
  90.     return skv_return;
  91. };
  93. /**
  94.  * calculate grams for Electric portion
  95.  * @param {struct} skv_config tariff_co2_gpkwh, battery_range_miles, battery_total_capacity_kwh
  96.  * @returns {struct}
  97.  */
  98. const electricCO2gPerMile = (skv_config) => {
  99.     const skv_return = {
  100.         production: 0,
  101.     };
  103.     skv_return.production = calculateElectricCO2gPerMile(skv_config);
  105.     return skv_return;
  106. };
  108. /**
  109.  * get co2 grams on electric and ice
  110.  * @param {struct} skv_config
  111.  * @returns {struct}
  112.  */
  113. const getCO2gPerMile = (skv_config) => {
  114.     let skv_ice_result = {
  115.         tail_pipe: 0,
  116.         production: 0,
  117.     };
  119.     let skv_electric_result = {
  120.         production: 0,
  121.     };
  123.     const skv_default = {
  124.         total_miles: '',
  125.         // ICE
  126.         tailpipe_co2_gpkm: '',
  127.         fuel_type: '',
  128.         mpg: '',
  129.         wc_mpg: '',
  130.         // Electric
  131.         tariff_co2_gpkwh: '',
  132.         battery_range_miles: '',
  133.         battery_total_capacity_kwh: '',
  134.     };
  136.     // replace default values with the ones from the config passed in
  137.     const skv_local_config = Object.assign(skv_default, skv_config);
  139.     // Charge Sustaining mode for phevs
  140.     skv_local_config.is_cs_mode = getIsCSMode(skv_config);
  142.     if (skv_local_config.mpg > 0) {
  143.         skv_ice_result = iceCO2gPerMile(skv_local_config);
  144.     }
  146.     if (skv_config.battery_range_miles > 0) {
  147.         skv_electric_result = electricCO2gPerMile(skv_local_config);
  148.     }
  149.     return {
  150.         electric: skv_electric_result,
  151.         ice: skv_ice_result,
  152.     };
  153. };
  155. export {
  156.     getCO2gPerMile,
  157.     iceCO2gPerMile,
  158.     electricCO2gPerMile,
  159.     iceCO2gPerMileForPHEVs,
  160. };