Struct ProcessFlow

pub struct ProcessFlow {
    pub commodity: Rc<Commodity>,
    pub coeff: FlowPerActivity,
    pub kind: FlowType,
    pub cost: MoneyPerFlow,
    pub is_primary_output: bool,
}

Represents a maximum annual commodity coeff for a given process

Fields

commodity: Rc<Commodity>

The commodity produced or consumed by this flow

coeff: FlowPerActivity

Maximum annual commodity flow quantity relative to other commodity flows.

Positive value indicates flow out and negative value indicates flow in.

kind: FlowType

Identifies if a flow is fixed or flexible.

cost: MoneyPerFlow

Cost per unit flow.

For example, cost per unit of natural gas produced. The user can apply it to any specified flow.

is_primary_output: bool

Whether this flow is the primary output for the process

Implementations

impl ProcessFlow

pub fn get_total_cost( &self, region_id: &RegionID, year: u32, time_slice: &TimeSliceID, ) -> MoneyPerActivity

Get the cost for this flow with the given parameters.

This includes cost per unit flow and levies/incentives, if any.

fn get_levy( &self, region_id: &RegionID, year: u32, time_slice: &TimeSliceID, ) -> MoneyPerFlow

Get the levy/incentive for this process flow with the given parameters, if any

pub fn is_input(&self) -> bool

Returns true if this flow is an input (i.e., coeff < 0)

pub fn is_output(&self) -> bool

Returns true if this flow is an output (i.e., coeff > 0)

Trait Implementations

impl Clone for ProcessFlow

fn clone(&self) -> ProcessFlow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProcessFlow

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

Formats the value using the given formatter.

impl PartialEq for ProcessFlow

fn eq(&self, other: &ProcessFlow) -> 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 StructuralPartialEq for ProcessFlow