Nanowire Network Attributes¶
Nanowire network (NWN) objects are a child class of NetworkX graphs. All the graph, node, and edge attributes are listed below.
NWN Graph Attributes¶
Attributes accessed via NWN.graph["attribute"]. Most of these are set from
the NWN constructor create_NWN().
NanowireNetwork Attributes
Most of the graph attributes are exposed directly as NanowireNetwork attributes or through getters/setters. The NWN graph attributes are mainly for internal use.
| Attribute | Description |
|---|---|
wire_length |
Length of each nanowire. (l₀) |
length |
x-length of the nanowire network. (l₀) |
width |
y-length of the nanowire network. (l₀) |
shape |
Shape of the network (length, width). (l₀, l₀) |
wire_density |
Wire density of the network not including electrodes. (l₀) |
wire_num |
Number of wires in the network including electrodes. |
junction_conductance |
Conductance of the junctions. (Rₒₙ⁻¹) |
wire_diameter |
Diameter of each nanowire. (D₀) |
wire_resistivity |
Resistivity of each nanowire. (ρ₀) |
electrode_list |
List of electrode nodes. |
lines |
List of the Shapely LineStrings uses to represent the nanowires. |
type |
Type of nanowire network representation ("JDA" or "MNR"). |
units |
Dictionary of characteristic units for the NWN. See NWN Units. |
loc |
(JDA only) Dictionary with a two-tuple of ints as keys and Shapely Points as values. Maps junctions to their location. |
junction_density |
Junction density of the network. (l₀⁻²) |
node_indices |
Dictionary with nodes as keys and indices as values. Maps nodes to a unique index. |
NWN Nodes Attributes¶
The NWN nodes are tuples of integers. In the junction-dominated assumption (JDA) NWN graph representation, these are one-tuples. In the multi-nodal representation (MNR) NWN graph representation, they can either be two-tuples in the general case, or one-tuples in the case of electrodes or wires with only one junction.
| Attribute | Description |
|---|---|
electrode |
Whether or not this node is an electrode. |
loc |
(MNR only) Location of the junction as a Shapely Point. |
NWN Edges Attributes¶
The NWN edges represent the junctions between nanowires for JDA NWNs, or additionally inner-wire connections between nodes for MNR NWNs. They are just a two-tuple of NWN Nodes.
| Attribute | Description |
|---|---|
conductance |
Conductance of the nanowire junction. |
type |
Either "junction" (JDA, MNR) or "inner" (MNR). |
Using NWN.set_state_var("name", val),
an edge attribute name will be added to store the state variable value val
for all edges.