Struct DispatchRun

pub struct DispatchRun<'model, 'run> {
    model: &'model Model,
    existing_assets: &'run [AssetRef],
    candidate_assets: &'run [AssetRef],
    commodities: &'run [CommodityID],
    input_prices: Option<&'run CommodityPrices>,
    year: u32,
}

Provides the interface for running the dispatch optimisation.

The caller can allow the dispatch run to return without error when demand is not met by calling the with_unmet_demand_allowed method.

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

Fields

model: &'model Model

existing_assets: &'run [AssetRef]

candidate_assets: &'run [AssetRef]

commodities: &'run [CommodityID]

input_prices: Option<&'run CommodityPrices>

year: u32

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_candidates(self, candidate_assets: &'run [AssetRef]) -> Self

Include the specified candidate assets in the dispatch run

pub fn with_commodity_subset(self, commodities: &'run [CommodityID]) -> Self

Only apply commodity balance constraints to the specified subset of commodities

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_no_save(&self) -> Result<Solution<'model>>

Run dispatch without saving the results.

This is an internal function as callers always want to save results.

fn run_without_unmet_demand( &self, commodities: &[CommodityID], ) -> Result<Solution<'model>, ModelError>

Run dispatch without unmet demand variables

fn get_regions_and_commodities_with_unmet_demand( &self, commodities: &[CommodityID], ) -> Result<IndexSet<(RegionID, CommodityID)>>

Run dispatch to diagnose which regions and commodities have unmet demand

fn run_internal( &self, commodities: &[CommodityID], allow_unmet_demand: bool, ) -> Result<Solution<'model>, ModelError>

Run dispatch for specified commodities, optionally including unmet demand variables