Struct AssetRef 

pub struct AssetRef(Rc<Asset>);

A wrapper around Asset for storing references in maps.

If the asset has been commissioned, then comparison and hashing is done based on the asset ID, otherwise a combination of other parameters is used.

Ord is implemented for AssetRef, but it will panic for non-commissioned assets.

Tuple Fields

0: Rc<Asset>

Implementations

impl AssetRef

pub fn make_mut(&mut self) -> &mut Asset

Make a mutable reference to the underlying Asset

fn into_for_each_child<F>(self, next_group_id: &mut u32, f: F)

where F: FnMut(Option<&AssetRef>, AssetRef),

Apply a function to each of this asset’s children, consuming the asset in the process.

If this asset is divisible, the first argument to f will be this asset after it has been converted to a parent and the second will be each child.

If this asset is non-divisible (i.e. does not have a discrete capacity), then f will be called with the first argument set to None and the second will be self.

When the asset has a discrete capacity, each of the children will be made up of a single unit of the original asset’s unit size.

Panics if this asset’s state is not Future or Selected.

Methods from Deref<Target = Asset>

pub fn state(&self) -> &AssetState

Get the state of this asset

pub fn process_parameter(&self) -> &ProcessParameter

The process parameter for this asset

pub fn max_decommission_year(&self) -> u32

The last year in which this asset should be decommissioned

pub fn get_activity_per_capacity_limits( &self, time_slice: &TimeSliceID, ) -> RangeInclusive<ActivityPerCapacity>

Get the activity limits per unit of capacity for this asset in a particular time slice

pub fn get_activity_limits_for_selection( &self, time_slice_selection: &TimeSliceSelection, ) -> RangeInclusive<Activity>

Get the activity limits for this asset for a given time slice selection

pub fn iter_activity_limits( &self, ) -> impl Iterator<Item = (TimeSliceSelection, RangeInclusive<Activity>)> + '_

Iterate over activity limits for this asset

pub fn iter_activity_per_capacity_limits( &self, ) -> impl Iterator<Item = (TimeSliceSelection, RangeInclusive<ActivityPerCapacity>)> + '_

Iterate over activity per capacity limits for this asset

pub fn get_total_output_per_activity(&self) -> FlowPerActivity

Gets the total SED/SVD output per unit of activity for this asset

Note: Since we are summing coefficients from different commodities, this ONLY makes sense if these commodities have the same units (e.g., all in PJ). Users are currently not made to give units for commodities, so we cannot possibly enforce this. Something to potentially address in future.

pub fn get_operating_cost( &self, year: u32, time_slice: &TimeSliceID, ) -> MoneyPerActivity

Get the operating cost for this asset in a given year and time slice

pub fn get_revenue_from_flows( &self, prices: &CommodityPrices, time_slice: &TimeSliceID, ) -> MoneyPerActivity

Get the total revenue from all flows for this asset.

If a price is missing, it is assumed to be zero.

pub fn get_revenue_from_flows_excluding_primary( &self, prices: &CommodityPrices, time_slice: &TimeSliceID, ) -> MoneyPerActivity

Get the total revenue from all flows excluding the primary output.

If a price is missing, it is assumed to be zero.

pub fn get_input_cost_from_prices( &self, prices: &CommodityPrices, time_slice: &TimeSliceID, ) -> MoneyPerActivity

Get the total cost of purchasing input commodities per unit of activity for this asset.

If a price is missing, there is assumed to be no cost.

fn get_revenue_from_flows_with_filter<F>( &self, prices: &CommodityPrices, time_slice: &TimeSliceID, filter_for_flows: F, ) -> MoneyPerActivity

where F: FnMut(&ProcessFlow) -> bool,

Get the total revenue from a subset of flows.

Takes a function as an argument to filter the flows. If a price is missing, it is assumed to be zero.

fn get_generic_activity_cost( &self, prices: &CommodityPrices, year: u32, time_slice: &TimeSliceID, ) -> MoneyPerActivity

Get the generic activity cost per unit of activity for this asset.

These are all activity-related costs that are not associated with specific SED/SVD outputs. Includes levies, flow costs, costs of inputs and variable operating costs

pub fn iter_marginal_costs_with_filter<'a>( &'a self, prices: &'a CommodityPrices, year: u32, time_slice: &'a TimeSliceID, filter: impl Fn(&CommodityID) -> bool + 'a, ) -> Box<dyn Iterator<Item = (CommodityID, MoneyPerFlow)> + 'a>

Iterate over marginal costs for a filtered set of SED/SVD output commodities for this asset

For each SED/SVD output commodity, the marginal cost is calculated as the sum of:

• Generic activity costs (variable operating costs, cost of purchasing inputs, plus all levies and flow costs not associated with specific SED/SVD outputs), which are shared equally over all SED/SVD outputs
• Production levies and flow costs for the specific SED/SVD output commodity

pub fn iter_marginal_costs<'a>( &'a self, prices: &'a CommodityPrices, year: u32, time_slice: &'a TimeSliceID, ) -> Box<dyn Iterator<Item = (CommodityID, MoneyPerFlow)> + 'a>

Iterate over marginal costs for all SED/SVD output commodities for this asset

See iter_marginal_costs_with_filter for details.

pub fn get_annual_capital_cost_per_capacity(&self) -> MoneyPerCapacity

Get the annual capital cost per unit of capacity for this asset

pub fn get_annual_fixed_costs_per_activity( &self, annual_activity: Activity, ) -> MoneyPerActivity

Get the annual fixed costs (AFC) per unit of activity for this asset

Total capital costs and fixed opex are shared equally over the year in accordance with the annual activity.

pub fn get_annual_fixed_costs_per_flow( &self, annual_activity: Activity, ) -> MoneyPerFlow

Get the annual fixed costs (AFC) per unit of output flow for this asset

Total capital costs and fixed opex are shared equally across all output flows in accordance with the annual activity and total output per unit of activity.

pub fn max_activity(&self) -> Activity

Maximum activity for this asset

pub fn get_flow(&self, commodity_id: &CommodityID) -> Option<&ProcessFlow>

Get a specific process flow

pub fn iter_flows(&self) -> impl Iterator<Item = &ProcessFlow>

Iterate over the asset’s flows

pub fn iter_output_flows(&self) -> impl Iterator<Item = &ProcessFlow>

Iterate over the asset’s output SED/SVD flows

pub fn primary_output(&self) -> Option<&ProcessFlow>

Get the primary output flow (if any) for this asset

pub fn is_commissioned(&self) -> bool

Whether this asset has been commissioned

pub fn commission_year(&self) -> u32

Get the commission year for this asset

pub fn decommission_year(&self) -> Option<u32>

Get the decommission year for this asset

pub fn region_id(&self) -> &RegionID

Get the region ID for this asset

pub fn process(&self) -> &Process

Get the process for this asset

pub fn process_id(&self) -> &ProcessID

Get the process ID for this asset

pub fn id(&self) -> Option<AssetID>

Get the ID for this asset

pub fn parent(&self) -> Option<&AssetRef>

Get the parent asset of this asset, if any

pub fn is_parent(&self) -> bool

Whether this asset is a parent of divided assets

pub fn num_children(&self) -> Option<u32>

Get the number of children this asset has.

If this asset is not a parent, then None is returned.

pub fn group_id(&self) -> Option<AssetGroupID>

Get the group ID for this asset, if any

pub fn agent_id(&self) -> Option<&AgentID>

Get the agent ID for this asset, if any

pub fn capacity(&self) -> AssetCapacity

Get the capacity for this asset

pub fn total_capacity(&self) -> Capacity

Get the total capacity for this asset

fn decrement_unit_count(&self)

Decrease the unit count (number of units) of this asset by one.

Note that this method uses interior mutability so that we can operate on an immutable ref to self. Accordingly, calling this method will result in a change in the capacity for all Rc copies of the asset, which is potentially dangerous. This method is therefore private and should only be used for the case where we want to decrease the unit count for parent assets.

pub fn get_mothballed_year(&self) -> Option<u32>

Get the mothballed year for the asset

pub fn unit_size(&self) -> Option<Capacity>

Get the unit size for this asset’s capacity (if any)

pub fn max_installable_capacity( &self, commodity_portion: Dimensionless, ) -> Option<AssetCapacity>

For non-commissioned assets, get the maximum capacity permitted to be installed based on the investment constraints for the asset’s process.

The limit is taken from the process’s investment constraints for the asset’s region and commission year, and the portion of the commodity demand being considered.

For divisible assets, the returned capacity will be rounded down to the nearest multiple of the asset’s unit size.

Trait Implementations

impl Clone for AssetRef

fn clone(&self) -> AssetRef

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AssetRef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for AssetRef

type Target = Asset

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<Asset> for AssetRef

fn from(value: Asset) -> Self

Converts to this type from the input type.

impl From<AssetRef> for Rc<Asset>

fn from(value: AssetRef) -> Self

Converts to this type from the input type.

impl From<Rc<Asset>> for AssetRef

fn from(value: Rc<Asset>) -> Self

Converts to this type from the input type.

impl Hash for AssetRef

fn hash<H: Hasher>(&self, state: &mut H)

Hash an asset according to its state:

• Commissioned assets are hashed based on their ID alone
• Selected assets are hashed based on process_id, region_id, commission_year and agent_id
• Candidate assets are hashed based on process_id, region_id and commission_year
• Parent assets are hashed based on agent_id and group_id
• Future and Decommissioned assets cannot currently be hashed

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AssetRef

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for AssetRef

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for AssetRef

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for AssetRef