Struct CommodityPrices

pub struct CommodityPrices(IndexMap<(CommodityID, RegionID, TimeSliceID), f64>);

A map relating commodity ID + region + time slice to current price (endogenous)

Tuple Fields

0: IndexMap<(CommodityID, RegionID, TimeSliceID), f64>

Implementations

impl CommodityPrices

pub fn from_model_and_solution( model: &Model, solution: &Solution<'_>, assets: &AssetPool, ) -> Self

Calculate commodity prices based on the result of the dispatch optimisation.

Missing prices will be calculated directly from the input data

fn add_from_solution( &mut self, solution: &Solution<'_>, assets: &AssetPool, ) -> HashSet<(CommodityID, RegionID)>

Add commodity prices for which there are values in the solution

Commodity prices are calculated as the sum of the commodity balance duals and the highest capacity dual for each commodity/timeslice.

Arguments

• solution - The solution to the dispatch optimisation
• assets - The asset pool

Returns

The set of commodities for which prices were added.

fn add_remaining<'a, I>( &mut self, commodity_regions: I, time_slice_info: &TimeSliceInfo, )

where I: Iterator<Item = &'a (CommodityID, RegionID)>,

Add prices for any commodity not updated by the dispatch step.

Arguments

• commodity_ids - IDs of commodities to update
• time_slice_info - Information about time slices

pub fn insert( &mut self, commodity_id: &CommodityID, region_id: &RegionID, time_slice: &TimeSliceID, price: f64, )

Insert a price for the given commodity, time slice and region

pub fn iter( &self, ) -> impl Iterator<Item = (&CommodityID, &RegionID, &TimeSliceID, f64)>

Iterate over the map.

Returns

An iterator of tuples containing commodity ID, time slice and price.

Trait Implementations

impl Default for CommodityPrices

fn default() -> CommodityPrices

Returns the “default value” for a type.