Struct ComponentGraph 

pub struct ComponentGraph<N, E>
where
    N: Node,
    E: Edge,
{ /* private fields */ }

A graph representation of the electrical components of a microgrid and the connections between them.

Implementations

impl<N, E> ComponentGraph<N, E>

where N: Node, E: Edge,

ComponentGraph instantiation.

pub fn try_new<NodeIterator: IntoIterator<Item = N>, EdgeIterator: IntoIterator<Item = E>>( components: NodeIterator, connections: EdgeIterator, config: ComponentGraphConfig, ) -> Result<Self, Error>

Creates a new ComponentGraph from the given components and connections.

Returns an error if the graph is invalid.

impl<N, E> ComponentGraph<N, E>

where N: Node, E: Edge,

Meter role identification.

pub fn is_pv_meter(&self, component_id: u64) -> Result<bool, Error>

Returns true if the node is a PV meter.

A meter is identified as a PV meter if:

• it has atleast one successor,
• all its successors are PV inverters.

pub fn is_battery_meter(&self, component_id: u64) -> Result<bool, Error>

Returns true if the node is a battery meter.

A meter is identified as a battery meter if

• it has atleast one successor,
• all its successors are battery inverters.

pub fn is_ev_charger_meter(&self, component_id: u64) -> Result<bool, Error>

Returns true if the node is an EV charger meter.

A meter is identified as an EV charger meter if

• it has atleast one successor,
• all its successors are EV chargers.

pub fn is_chp_meter(&self, component_id: u64) -> Result<bool, Error>

Returns true if the node is a CHP meter.

A meter is identified as a CHP meter if

• has atleast one successor,
• all its successors are CHPs.

pub fn is_component_meter(&self, component_id: u64) -> Result<bool, Error>

Returns true if the node is a component meter.

A meter is a component meter if it is one of the following:

• a PV meter,
• a battery meter,
• an EV charger meter,
• a CHP meter.

impl<N, E> ComponentGraph<N, E>

where N: Node, E: Edge,

Component and Connection retrieval.

pub fn component(&self, component_id: u64) -> Result<&N, Error>

Returns the component with the given component_id, if it exists.

pub fn components(&self) -> Components<'_, N>

Returns an iterator over the components in the graph.

pub fn connections(&self) -> Connections<'_, N, E>

Returns an iterator over the connections in the graph.

pub fn predecessors(&self, component_id: u64) -> Result<Neighbors<'_, N>, Error>

Returns an iterator over the predecessors of the component with the given component_id.

Returns an error if the given component_id does not exist.

pub fn successors(&self, component_id: u64) -> Result<Neighbors<'_, N>, Error>

Returns an iterator over the successors of the component with the given component_id.

Returns an error if the given component_id does not exist.

impl<N, E> ComponentGraph<N, E>

where N: Node, E: Edge,

Formulas for various microgrid metrics.

pub fn consumer_formula(&self) -> Result<AggregationFormula, Error>

Returns the consumer formula for the graph.

pub fn grid_formula(&self) -> Result<AggregationFormula, Error>

Returns the grid formula for the graph.

pub fn producer_formula(&self) -> Result<AggregationFormula, Error>

Returns the producer formula for the graph.

pub fn battery_formula( &self, battery_ids: Option<BTreeSet<u64>>, ) -> Result<AggregationFormula, Error>

Returns the battery formula with the given battery IDs.

If battery_ids is None, the formula will contain all batteries in the graph.

pub fn chp_formula( &self, chp_ids: Option<BTreeSet<u64>>, ) -> Result<AggregationFormula, Error>

Returns the CHP formula for the graph.

pub fn pv_formula( &self, pv_inverter_ids: Option<BTreeSet<u64>>, ) -> Result<AggregationFormula, Error>

Returns the PV formula for the graph.

pub fn ev_charger_formula( &self, ev_charger_ids: Option<BTreeSet<u64>>, ) -> Result<AggregationFormula, Error>

Returns the EV charger formula for the graph.

pub fn component_formula( &self, component_id: u64, ) -> Result<AggregationFormula, Error>

Returns the formula for a specific component by its ID.

pub fn grid_coalesce_formula(&self) -> Result<CoalesceFormula, Error>

Returns the grid coalesce formula for the graph.

This formula is used for non-aggregating metrics like AC voltage or frequency.

The formula is a COALESCE expression that includes all meters, PV inverters, and battery inverters that are directly connected to the grid.

pub fn battery_ac_coalesce_formula( &self, battery_ids: Option<BTreeSet<u64>>, ) -> Result<CoalesceFormula, Error>

Returns the battery AC coalesce formula for the given components.

This formula is used for non-aggregating metrics like AC voltage or frequency.

The formula is a COALESCE expression that includes all the specified battery meters and corresponding inverters.

When the battery_ids parameter is None, it will include all the battery meters and inverters in the graph.

pub fn pv_ac_coalesce_formula( &self, pv_inverter_ids: Option<BTreeSet<u64>>, ) -> Result<CoalesceFormula, Error>

Returns the PV AC coalesce formula for the given components.

This formula is used for non-aggregating metrics like AC voltage or frequency.

The formula is a COALESCE expression that includes all the specified PV meters and corresponding inverters.

When the pv_inverter_ids parameter is None, it will include all the PV meters and inverters in the graph.

pub fn component_ac_coalesce_formula( &self, component_id: u64, ) -> Result<CoalesceFormula, Error>

Returns the AC coalesce formula for a specific component by its ID.

Trait Implementations

impl<N, E> Clone for ComponentGraph<N, E>

where N: Node + Clone, E: Edge + Clone,

Implement Clone for ComponentGraph when the Nodes and Edges implement Clone.

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.