Enum BuildError 

pub enum BuildError {
    TwoCurrentExcitations {
        first_edge: EdgeIndex,
        second_edge: EdgeIndex,
        graph: UnGraph<usize, Type>,
    },
    DeadEnd {
        node: NodeIndex,
        graph: UnGraph<usize, Type>,
    },
    ShortCircuit {
        edge: EdgeIndex,
        graph: UnGraph<usize, Type>,
    },
    NotAllEdgesConnected,
    OverdefinedByCurrentSources {
        edge: EdgeIndex,
        graph: UnGraph<usize, Type>,
    },
    OverdefinedByVoltageSources {
        edge: EdgeIndex,
        graph: UnGraph<usize, Type>,
    },
}

An error returned from a failed attempt of creating a Network from a graph.

The diagram below shows a graph which fails to represent a valid electrical circuit:

 ┌──┬─[1]─┬─[5]─
 │  │    [2]
 │ [0]    │
 │  │    [3]
 └──┴─[4]─┘

• Edge 0 is short-circuited. To fix this issue, it needs to be removed from the network.
• If both edge 2 and 4 would have a current excitation, the current flowing through the edges 2, 3 and 4 cannot be defined. To fix this issue, one of the excitations needs to be removed.
• Edge 5 is a dead end. It can simply be deleted.

Variants

TwoCurrentExcitations

Two (or more) current excitations are defined without a “junction node” (more than two edges) in between. For example, if a node is used by only two edges and both edges have a current excitation, the current going through the edges is not unambiguous (except for the trivial case of both current excitations being equal, however in this case one of them can be omitted anyway).

Variant contains the indices of the two offending current sources and the input graph.

Fields

first_edge: EdgeIndex

second_edge: EdgeIndex

graph: UnGraph<usize, Type>

DeadEnd

A node is a “dead end” (has only one edge using it). Since the circuit is not closed, no current can go through this edge and it can be omitted.

Variant contains the index of the “dead end” node and the input graph.

Fields

node: NodeIndex

graph: UnGraph<usize, Type>

ShortCircuit

An edge is short-circuited (source and target node are identical). In this case, the edge can be omitted.

Variant contains the index of the short-circuited edge and the input graph.

Fields

edge: EdgeIndex

graph: UnGraph<usize, Type>

NotAllEdgesConnected

Some edges are not connected to other edges, or in other words, the graph represents two or more circuits instead of one.

OverdefinedByCurrentSources

For each edge, at least one of the possible loops containing it must not have more than one current source. Otherwise, the network cannot be solved for the general case, since some current sources are contradicting.

Example: If 0, 6 and 3 are current sources, the network is overdefined, since there is no possible loop without two current sources.

 ┌─[1]─┬─[2]─┐
[0]   [6]   [3]
 └─[5]─┴─[4]─┘

Variant contains the index of one current source edge which must be changed to make the graph valid as well as the input graph.

Fields

edge: EdgeIndex

graph: UnGraph<usize, Type>

OverdefinedByVoltageSources

For each edge, all possible loops containing it must not have only voltage sources. Otherwise, the network cannot be solved for the general case, since some voltage sources are contradicting.

Example: If 0 and 1 are voltage sources, the network is overdefined, since the loop 0 -> 1 contains only voltage sources.

 ┌───┬───┐
[0] [1] [2]
 └───┴───┘

Variant contains the index of one voltage source edge which must be changed to make the graph valid as well as the input graph.

Fields

edge: EdgeIndex

graph: UnGraph<usize, Type>

Trait Implementations

impl Clone for BuildError

fn clone(&self) -> BuildError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuildError

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

Formats the value using the given formatter.

impl Display for BuildError

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

Formats the value using the given formatter.

impl Error for BuildError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.