Class MarketClearingResult


  • public class MarketClearingResult
    extends Object
    Holds clearing price, sold energy, and updated DemandOrderBook and SupplyOrderBook
    Author:
    Farzad Sarfarazi, Christoph Schimeczek, A. Achraf El Ghazi
    • Constructor Detail

      • MarketClearingResult

        public MarketClearingResult​(double tradedEnergyInMWH,
                                    double marketPriceInEURperMWH)
        Instantiate with price and awarded energy; books are set separately
        Parameters:
        tradedEnergyInMWH - total awarded energy
        marketPriceInEURperMWH - uniform market clearing price
      • MarketClearingResult

        public MarketClearingResult​(ClearingDetails clearingResult,
                                    DemandOrderBook demandBook,
                                    SupplyOrderBook supplyBook)
        Instantiate with tradedEnergyInMWH, marketPriceInEURperMWH, priceSettingDemandBidIdx, priceSettingSupplyBidIdx, and minPriceSettingDemand from a ClearingResult object; and with demandBook, and supplyBook. The priceSettingDemandBidIdx, priceSettingSupplyBidIdx, and minPriceSettingDemand are optional in a ClearingResult object, they are only set if not null.
        Parameters:
        clearingResult - result of market clearing
        demandBook - book of demand bids
        supplyBook - book of supply bids
    • Method Detail

      • setBooks

        public void setBooks​(SupplyOrderBook supplyBook,
                             DemandOrderBook demandBook,
                             OrderBook.DistributionMethod distributionMethod)
        Set and update books, i.e. award contained bids according to their individual results
        Parameters:
        supplyBook - Supply book used to clear the market
        demandBook - Demand book used to clear the market
        distributionMethod - defines method of how to award energy when multiple price-setting bids occur
      • getDemandBook

        public DemandOrderBook getDemandBook()
        Returns:
        updated demand order book used to clear the market
      • getSupplyBook

        public SupplyOrderBook getSupplyBook()
        Returns:
        updated supply order book used to clear the market
      • getTradedEnergyInMWH

        public double getTradedEnergyInMWH()
        Returns:
        total awarded energy
      • getMarketPriceInEURperMWH

        public double getMarketPriceInEURperMWH()
        Returns:
        uniform market clearing price
      • getSystemCostTotalInEUR

        public double getSystemCostTotalInEUR()
        Returns:
        total system cost from generation based on awarded bids and their associated marginal cost
      • setMarketPriceInEURperMWH

        public void setMarketPriceInEURperMWH​(double marketPriceInEURperMWH)
        Parameters:
        marketPriceInEURperMWH - the marketPriceInEURperMWH to set