Struct DispatchRun 

pub struct DispatchRun<'model, 'run> {
    model: &'model Model,
    existing_assets: &'run [AssetRef],
    flexible_capacity_assets: &'run [AssetRef],
    candidate_assets: &'run [AssetRef],
    markets_to_balance: &'run [(CommodityID, RegionID)],
    input_prices: Option<&'run CommodityPrices>,
    year: u32,
    capacity_margin: f64,
}

Provides the interface for running the dispatch optimisation.

The run will attempt to meet unmet demand: if the solver reports infeasibility the implementation will rerun including unmet-demand variables to identify offending markets and provide a clearer error message.

For a detailed description, please see the dispatch optimisation formulation.

Fields

model: &'model Model

existing_assets: &'run [AssetRef]

flexible_capacity_assets: &'run [AssetRef]

candidate_assets: &'run [AssetRef]

markets_to_balance: &'run [(CommodityID, RegionID)]

input_prices: Option<&'run CommodityPrices>

year: u32

capacity_margin: f64

Implementations

impl<'model, 'run> DispatchRun<'model, 'run>

pub fn new(model: &'model Model, assets: &'run [AssetRef], year: u32) -> Self

Create a new DispatchRun for the specified model and assets for a given year

pub fn with_flexible_capacity_assets( self, flexible_capacity_assets: &'run [AssetRef], capacity_margin: f64, ) -> Self

Include the specified flexible capacity assets in the dispatch run

pub fn with_candidates(self, candidate_assets: &'run [AssetRef]) -> Self

Include the specified candidate assets in the dispatch run

pub fn with_market_balance_subset( self, markets_to_balance: &'run [(CommodityID, RegionID)], ) -> Self

Only apply commodity balance constraints to the specified subset of markets

pub fn with_input_prices(self, input_prices: &'run CommodityPrices) -> Self

Explicitly provide prices for certain input commodities

pub fn run( &self, run_description: &str, writer: &mut DataWriter, ) -> Result<Solution<'model>>

Perform the dispatch optimisation.

Arguments

• run_description - Which dispatch run for the current year this is
• writer - For saving output data

Returns

A solution containing new commodity flows for assets and prices for (some) commodities or an error.

fn run_without_unmet_demand_variables( &self, markets_to_balance: &[(CommodityID, RegionID)], input_prices: Option<&CommodityPrices>, ) -> Result<Solution<'model>, ModelError>

Run dispatch without unmet demand variables

fn run_internal( &self, markets_to_balance: &[(CommodityID, RegionID)], allow_unmet_demand: bool, input_prices: Option<&CommodityPrices>, ) -> Result<Solution<'model>, ModelError>

Run dispatch to balance the specified markets, optionally including unmet demand variables