feat: "Exported heat/electricity" --> "Sold heat/electricity"

app/containers/Forms/Form.tsx

@@ -159,12 +159,12 @@ export const FormComponent: React.FunctionComponent<Props> = ({
 
     if (hasRequireExportedElectricity && !energyProductsReported.includes(1))
       errors['0'].addError(
-        'Exported Electricity is a required product based on the products you have reported, please refer to the guidance document'
+        'Sold Electricity is a required product based on the products you have reported, please refer to the guidance document'
       );
 
     if (hasRequireExportedHeat && !energyProductsReported.includes(2))
       errors['0'].addError(
-        'Exported Heat is a required product based on the products you have reported, please refer to the guidance document'
+        'Sold Heat is a required product based on the products you have reported, please refer to the guidance document'
       );
 
     if (hasRequireGeneratedElectricity && !energyProductsReported.includes(5))

app/containers/Products/product-schema.json

@@ -63,7 +63,7 @@
       },
       "subtractExportedElectricityEmissions": {
         "type": "boolean",
-        "title": "Exported electricity is subtracted from facility emissions",
+        "title": "Sold electricity is subtracted from facility emissions",
         "enumNames": [" Yes", " No"],
         "default": false
       },
@@ -75,7 +75,7 @@
       },
       "subtractExportedHeatEmissions": {
         "type": "boolean",
-        "title": "Exported heat is subtracted from facility emissions",
+        "title": "Sold heat is subtracted from facility emissions",
         "enumNames": [" Yes", " No"],
         "default": false
       }

schema/data/prod/energy_product.sql

@@ -17,8 +17,8 @@ with rows as (
 insert into ggircs_portal.product(id, product_name, units, product_state, requires_emission_allocation, is_ciip_product, requires_product_amount, is_read_only, is_energy_product)
 overriding system value
 values
-(1, 'Exported electricity', 'MWh', 'published' ,true, true, true, true, true),
-(2, 'Exported heat', 'GJ', 'published' ,true, false, true, true, true),
+(1, 'Sold electricity', 'MWh', 'published' ,true, true, true, true, true),
+(2, 'Sold heat', 'GJ', 'published' ,true, false, true, true, true),
 (3, 'Purchased electricity', 'GWh', 'published' ,true, false, true, true, true),
 (4, 'Purchased heat', 'GJ', 'published' ,true, false, true, true, true),
 (5, 'Generated electricity', 'GWh', 'published' ,true, false, true, true, true),

schema/deploy/computed_columns/application_revision_ciip_incentive.sql

@@ -1,7 +1,6 @@
 -- Deploy ggircs-portal:computed_columns/ciip_incentive to pg
 -- requires: tables/benchmark
 -- requires: views/ciip_production
--- requires: views/ciip_electricity_and_heat
 
 begin;
 
@@ -127,7 +126,7 @@ returns setof ggircs_portal.ciip_incentive_by_product as $function$
               from unnest(reported_products) p
               join ggircs_portal.product _product on
                 p.product_id = _product.id
-                and _product.product_name = 'Exported electricity'
+                and _product.product_name = 'Sold electricity'
             );
           end if;
           if product_data.add_purchased_heat_emissions then
@@ -145,7 +144,7 @@ returns setof ggircs_portal.ciip_incentive_by_product as $function$
               from unnest(reported_products) p
               join ggircs_portal.product _product on
                 p.product_id = _product.id
-                and _product.product_name = 'Exported heat'
+                and _product.product_name = 'Sold heat'
             );
           end if;
           if product_data.add_emissions_from_eios then

schema/deploy/computed_columns/application_revision_ciip_incentive@v1.0.0-rc.11.sql

@@ -0,0 +1,225 @@
+-- Deploy ggircs-portal:computed_columns/ciip_incentive to pg
+-- requires: tables/benchmark
+-- requires: views/ciip_production
+-- requires: views/ciip_electricity_and_heat
+
+begin;
+
+-- Function takes application id and version number:
+create or replace function ggircs_portal.application_revision_ciip_incentive(application_revision ggircs_portal.application_revision)
+returns setof ggircs_portal.ciip_incentive_by_product as $function$
+  declare
+    product record;
+    em_facility numeric;
+    em_product numeric;
+    em_electricity numeric;
+    em_heat numeric;
+    em_intensity numeric;
+    intensity_range numeric;
+    incentive_ratio numeric;
+    incentive_product numeric;
+    incentive_product_max numeric;
+    app_reporting_year int;
+    incremental_carbon_tax_facility numeric;
+    payment_allocation_factor numeric; -- The portion of the facility's carbon tax allocated to the current product
+    reported_products ggircs_portal.ciip_production[]; -- The reported products (ciip and non-ciip) for this application
+    reported_ciip_products ggircs_portal.ciip_production[]; -- The reported ciip products for this application
+    benchmark_data ggircs_portal.benchmark;
+    product_data ggircs_portal.product;
+    product_return ggircs_portal.ciip_incentive_by_product;
+    non_energy_product_count integer;
+    has_products boolean;
+
+  begin
+
+    -- Get emissions for facility
+    select sum(annual_co2e) into em_facility from ggircs_portal.ciip_emission
+    where version_number = application_revision.version_number and application_id = application_revision.application_id and gas_type != 'CO2';
+
+    -- Get reporting year for application
+    select reporting_year into app_reporting_year from ggircs_portal.application
+    where id = application_revision.application_id;
+
+    -- Get carbon tax data for the application
+    select sum(carbon_tax_eligible_for_ciip_flat) into incremental_carbon_tax_facility from ggircs_portal.ciip_carbon_tax_calculation
+    where version_number = application_revision.version_number and application_id = application_revision.application_id;
+
+    reported_products = array(
+      select row(ciip_production.*)
+      from ggircs_portal.ciip_production
+      where
+        version_number = application_revision.version_number
+        and application_id = application_revision.application_id
+    );
+
+    has_products := (select product_id from ggircs_portal.ciip_production  where
+        version_number = application_revision.version_number
+        and application_id = application_revision.application_id limit 1) is not null;
+
+    -- Validate that application is not missing any required energy products
+    if has_products=true then
+      perform ggircs_portal_private.validate_energy_products(reported_products);
+    end if;
+
+    -- ** Test for invalid number of products when a reported product.requires_emission_allocation = false ** --
+    non_energy_product_count := (
+      select count(*)
+      from ggircs_portal.ciip_production
+      where
+        version_number = application_revision.version_number
+        and application_id = application_revision.application_id
+        and is_energy_product=false
+    );
+
+    if (select count(*) from ggircs_portal.ciip_production
+      where
+        version_number = application_revision.version_number
+        and application_id = application_revision.application_id
+        and requires_emission_allocation = false) > 0
+      and non_energy_product_count > 1
+    then
+      raise exception 'When a product has: requires_emission_allocation = false, only one reported product (excluding energy products) is allowed';
+    end if;
+    -- ** End test ** --
+
+    reported_ciip_products = array(
+      select row(ciip_production.*)
+      from ggircs_portal.ciip_production
+      join ggircs_portal.product _product on
+        ciip_production.product_id = _product.id
+        and _product.is_ciip_product = true
+      where
+        version_number = application_revision.version_number
+        and application_id = application_revision.application_id
+    );
+
+    if (select array_length(reported_ciip_products, 1)) > 0 then
+      -- Loop over products
+      foreach product in array reported_ciip_products
+      loop
+         -- Get Product specific data
+        select * into product_data from ggircs_portal.product
+        where id = product.product_id;
+
+        -- Get Incentive Ratio Max and Min, BM and ET for product from Benchmark table
+        select * into benchmark_data from ggircs_portal.benchmark
+          where product_id = product.product_id
+          and start_reporting_year <= app_reporting_year
+          and end_reporting_year >= app_reporting_year;
+
+        -- Calculate Emissions for Product (EmProd)
+        if (product_data.requires_emission_allocation) then
+          em_product = product.product_emissions;
+        else
+          em_product = em_facility;
+          if product_data.add_purchased_electricity_emissions then
+            em_product = em_product + (
+              select p.product_emissions
+              from unnest(reported_products) p
+              join ggircs_portal.product _product on
+                p.product_id = _product.id
+                and _product.product_name = 'Purchased electricity'
+            );
+          end if;
+          if product_data.subtract_exported_electricity_emissions then
+            em_product = em_product - (
+              select p.product_emissions
+              from unnest(reported_products) p
+              join ggircs_portal.product _product on
+                p.product_id = _product.id
+                and _product.product_name = 'Exported electricity'
+            );
+          end if;
+          if product_data.add_purchased_heat_emissions then
+            em_product = em_product + (
+              select p.product_emissions
+              from unnest(reported_products) p
+              join ggircs_portal.product _product on
+                p.product_id = _product.id
+                and _product.product_name = 'Purchased heat'
+            );
+          end if;
+          if product_data.subtract_exported_heat_emissions then
+            em_product = em_product - (
+              select p.product_emissions
+              from unnest(reported_products) p
+              join ggircs_portal.product _product on
+                p.product_id = _product.id
+                and _product.product_name = 'Exported heat'
+            );
+          end if;
+          if product_data.add_emissions_from_eios then
+            em_product = em_product + (
+              select p.product_emissions
+              from unnest(reported_products) p
+              join ggircs_portal.product _product on
+                p.product_id = _product.id
+                and _product.product_name = 'Emissions from EIOs'
+            );
+          end if;
+        end if;
+
+        -- Calculate Emission Intensity
+        em_intensity = em_product / product.product_amount;
+
+
+        -- Calculate Incentive Ratio as
+        -- IncRatio = min(IncRatioMax, max(IncRatioMin, 1 - (EmIntensity - BM)/(ET - BM))
+        intensity_range = 1 - ((em_intensity - benchmark_data.benchmark) / (benchmark_data.eligibility_threshold - benchmark_data.benchmark));
+        incentive_ratio = least(
+          benchmark_data.maximum_incentive_ratio,
+          greatest(
+            benchmark_data.minimum_incentive_ratio, intensity_range
+          )
+        );
+
+        -- Determine the payment allocation factor.
+        if (select array_length(reported_ciip_products, 1)) = 1 then
+          payment_allocation_factor = 1;
+        else
+          payment_allocation_factor = em_product / (select sum(p.product_emissions) from unnest(reported_ciip_products) p) ;
+        end if;
+
+
+        -- Calculate Incentive Amount
+        -- IncAmt = IncRatio * IncMult * PmntAlloc * CTFacility
+        -- 0 if no benchmark exists
+        incentive_product = coalesce (incentive_ratio *
+                            benchmark_data.incentive_multiplier *
+                            payment_allocation_factor *
+                            incremental_carbon_tax_facility, 0);
+
+        incentive_product_max = coalesce (
+                            benchmark_data.incentive_multiplier *
+                            payment_allocation_factor *
+                            incremental_carbon_tax_facility, 0);
+
+        select into product_return
+          row_number() over (),
+          product_data.id,
+          product_data.product_name,
+          product.product_amount,
+          em_product,
+          incentive_ratio,
+          benchmark_data.incentive_multiplier,
+          payment_allocation_factor,
+          incremental_carbon_tax_facility as incremental_carbon_tax,
+          incentive_product,
+          incentive_product_max,
+          em_intensity,
+          benchmark_data.benchmark,
+          benchmark_data.eligibility_threshold;
+
+        return next product_return;
+
+      end loop;
+    end if;
+  end
+
+$function$ language plpgsql stable;
+
+grant execute on function ggircs_portal.application_revision_ciip_incentive to ciip_administrator, ciip_analyst;
+
+comment on function ggircs_portal.application_revision_ciip_incentive is 'Computed column for graphql to get the ciip incentive calculations from application_revision';
+
+commit;